Struct graphene::Box

source ·

pub struct Box { /* private fields */ }

Expand description

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

GLib type: Inline allocated boxed type with stack copy semantics.

Implementations§

source §

impl Box

source

pub fn as_ptr(&self) -> *mut graphene_box_t

source

pub unsafe fn from_glib_ptr_borrow<'a>(ptr: *const graphene_box_t) -> &'a Self

Borrows the underlying C value.

source

pub unsafe fn from_glib_ptr_borrow_mut<'a>( ptr: *mut graphene_box_t, ) -> &'a mut Self

Borrows the underlying C value mutably.

source §

impl Box

source

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

source

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

source

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

source

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

source

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

source

pub fn bounding_sphere(&self) -> Sphere

Computes the bounding Sphere capable of containing the given Box.

§Returns

§`sphere`

return location for the bounding sphere

source

pub fn center(&self) -> Point3D

Retrieves the coordinates of the center of a Box.

§Returns

§`center`

return location for the coordinates of the center

source

pub fn depth(&self) -> f32

Retrieves the size of the self on the Z axis.

§Returns

the depth of the box

source

pub fn height(&self) -> f32

Retrieves the size of the self on the Y axis.

§Returns

the height of the box

source

pub fn max(&self) -> Point3D

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

§Returns

§`max`

return location for the maximum point

source

pub fn min(&self) -> Point3D

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

§Returns

§`min`

return location for the minimum point

source

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

source

pub fn width(&self) -> f32

Retrieves the size of the self on the X axis.

§Returns

the width of the box

source

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

source

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

source