Struct graphene::Box

pub struct Box(_);

A 3D box, described as the volume between a minimum and a maximum vertices.

Implementations

impl Box

pub fn contains_box(&self, b: &Box) -> bool

Checks whether the Box self contains the given Box b.

b

a Box

Returns

true if the box is contained in the given box

pub fn contains_point(&self, point: &Point3D) -> bool

Checks whether self contains the given point.

point

the coordinates to check

Returns

true if the point is contained in the given box

pub fn expand(&self, point: &Point3D) -> Box

Expands the dimensions of self to include the coordinates at point.

point

the coordinates of the point to include

Returns

res

return location for the expanded box

pub fn expand_scalar(&self, scalar: f32) -> Box

Expands the dimensions of self by the given scalar value.

If scalar is positive, the Box will grow; if scalar is negative, the Box will shrink.

scalar

a scalar value

Returns

res

return location for the expanded box

pub fn expand_vec3(&self, vec: &Vec3) -> Box

Expands the dimensions of self to include the coordinates of the given vector.

vec

the coordinates of the point to include, as a Vec3

Returns

res

return location for the expanded box

pub fn bounding_sphere(&self) -> Sphere

Computes the bounding Sphere capable of containing the given Box.

Returns

sphere

return location for the bounding sphere

pub fn center(&self) -> Point3D

Retrieves the coordinates of the center of a Box.

Returns

center

return location for the coordinates of the center

pub fn depth(&self) -> f32

Retrieves the size of the self on the Z axis.

Returns

the depth of the box

pub fn height(&self) -> f32

Retrieves the size of the self on the Y axis.

Returns

the height of the box

pub fn max(&self) -> Point3D

Retrieves the coordinates of the maximum point of the given Box.

Returns

max

return location for the maximum point

pub fn min(&self) -> Point3D

Retrieves the coordinates of the minimum point of the given Box.

Returns

min

return location for the minimum point

pub fn size(&self) -> Vec3

Retrieves the size of the box on all three axes, and stores it into the given size vector.

Returns

size

return location for the size

pub fn width(&self) -> f32

Retrieves the size of the self on the X axis.

Returns

the width of the box

pub fn init(&mut self, min: Option<&Point3D>, max: Option<&Point3D>)

Initializes the given Box with two vertices.

min

the coordinates of the minimum vertex

max

the coordinates of the maximum vertex

Returns

the initialized Box

pub fn init_from_box(&mut self, src: &Box)

Initializes the given Box with the vertices of another Box.

src

a Box

Returns

the initialized Box

pub fn init_from_vec3(&mut self, min: Option<&Vec3>, max: Option<&Vec3>)

Initializes the given Box with two vertices stored inside Vec3.

min

the coordinates of the minimum vertex

max

the coordinates of the maximum vertex

Returns

the initialized Box

pub fn intersection(&self, b: &Box) -> Option<Box>

Intersects the two given Box.

If the two boxes do not intersect, res will contain a degenerate box initialized with empty().

b

a Box

Returns

true if the two boxes intersect

res

return location for the result

pub fn union(&self, b: &Box) -> Box

Unions the two given Box.

b

the box to union to self

Returns

res

return location for the result

pub fn empty() -> Box

A degenerate Box that can only be expanded.

The returned value is owned by Graphene and should not be modified or freed.

Returns

a Box

pub fn infinite() -> Box

A degenerate Box that cannot be expanded.

The returned value is owned by Graphene and should not be modified or freed.

Returns

a Box

pub fn minus_one() -> Box

A Box with the minimum vertex set at (-1, -1, -1) and the maximum vertex set at (0, 0, 0).

The returned value is owned by Graphene and should not be modified or freed.

Returns

a Box

pub fn one() -> Box

A Box with the minimum vertex set at (0, 0, 0) and the maximum vertex set at (1, 1, 1).

The returned value is owned by Graphene and should not be modified or freed.

Returns

a Box

pub fn one_minus_one() -> Box

A Box with the minimum vertex set at (-1, -1, -1) and the maximum vertex set at (1, 1, 1).

The returned value is owned by Graphene and should not be modified or freed.

Returns

a Box

pub fn zero() -> Box

A Box with both the minimum and maximum vertices set at (0, 0, 0).

The returned value is owned by Graphene and should not be modified or freed.

Returns

a Box

impl Box

pub fn vertices(&self) -> [Vec3; 8]

Computes the vertices of the given Box.

Returns

vertices

return location for an array of 8 Vec3

pub fn init_from_points(&mut self, points: &[&Point3D])

Initializes the given Box with the given array of vertices.

If n_points is 0, the returned box is initialized with empty().

points

an array of Point3D

Returns

the initialized Box

pub fn init_from_vectors(&mut self, vectors: &[&Vec3])

Initializes the given Box with the given array of vertices.

If n_vectors is 0, the returned box is initialized with empty().

vectors

an array of Vec3

Returns

the initialized Box

pub fn new(min: Option<&Point3D>, max: Option<&Point3D>) -> Box

pub fn from_box(src: &Box) -> Box

pub fn from_points(&mut self, points: &[&Point3D]) -> Box

pub fn from_vec3(min: Option<&Vec3>, max: Option<&Vec3>) -> Box

pub fn from_vectors(vectors: &[&Vec3]) -> Box

Trait Implementations

impl Clone for Box

fn clone(&self) -> Box

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Box

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for Box

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for Box

fn cmp(&self, other: &Box) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Box> for Box

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<Box> for Box

fn partial_cmp(&self, other: &Box) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for Box

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Box