Struct Box2D 

pub struct Box2D { /* private fields */ }

Available on crate feature v1_12 only.

A 2D box, described as the axis-aligned area between a minimum and a maximum vertices lying on the same plane.

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

Implementations

impl Box2D

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

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

Borrows the underlying C value.

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

Borrows the underlying C value mutably.

impl Box2D

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

Checks whether the Box2D self contains the given Box2D b.

b

a Box2D

Returns

true if the box is contained in the given box

pub fn contains_point(&self, point: &Point) -> 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 contains_rect(&self, rect: &Rect) -> bool

Checks whether self contains the given rect.

rect

the rectangle to check

Returns

true if the rectangle is contained in the given box

pub fn expand(&self, point: &Point) -> Box2D

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) -> Box2D

Expands the dimensions of self by the given scalar value.

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

scalar

a scalar value

Returns

res

return location for the expanded box

pub fn expand_vec2(&self, vec: &Vec2) -> Box2D

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

vec

the coordinates of the point to include, as a Vec2

Returns

res

return location for the expanded box

pub fn center(&self) -> Point

Retrieves the coordinates of the center of a Box2D.

Returns

center

return location for the coordinates of the center

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) -> Point

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

Returns

max

return location for the maximum point

pub fn min(&self) -> Point

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

Returns

min

return location for the minimum point

pub fn minmax(&self) -> (Point, Point)

Retrieves the coordinates of the minimum and maximum points of the given Box2D.

Returns

min

return location for the minimum point

max

return location for the maximum point

pub fn size(&self) -> Vec2

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 intersection(&self, b: &Box2D) -> Option<Box2D>

Intersects the two given Box2D.

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

b

a Box2D

Returns

true if the two boxes intersect

res

return location for the result

pub fn intersects(&self, b: &Box2D) -> bool

Checks whether two boxes intersect.

See also: intersection()

b

a Box2D

Returns

true if the boxes intersect, and false otherwise

pub fn scale_offset( &self, scale: Option<&Vec2>, offset: Option<&Point>, ) -> Box2D

Applies a scale and an offset to the vertices of the given box.

If scale is None, the box will be scaled by (1.0, 1.0).

If offset is None, the box will be offset by (0.0, 0.0).

scale

a vector with two scaling factors to be applied to the box

offset

the offset to apply to the box

Returns

res

the transformed box

pub fn to_rect(&self) -> Rect

Stores the minimum and maximum vertices of the given Box2D into a rectangle of equivalent origin and size.

Returns

rect

the rectangle to initialize

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

Unions the two given Box2D.

b

the box to union to self

Returns

res

return location for the result

pub fn empty() -> Box2D

A degenerate Box2D that can only be expanded.

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

Returns

a Box2D

pub fn infinite() -> Box2D

A degenerate Box2D that cannot be expanded.

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

Returns

a Box2D

pub fn minus_one() -> Box2D

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

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

Returns

a Box2D

pub fn one() -> Box2D

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

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

Returns

a Box2D

pub fn one_minus_one() -> Box2D

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

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

Returns

a Box2D

pub fn zero() -> Box2D

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

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

Returns

a Box2D

impl Box2D

pub fn vertices(&self) -> &[Vec2; 4]

Computes the vertices of the given Box2D.

Returns

vertices

return location for an array of 4 Vec2

pub fn to_float(&self) -> [f32; 4]

Stores the minimum and maximum vertices of the given Box2D into an array.

The array layout is:

• min_x
• min_y
• max_x
• max_y

Returns

v

return location for an array of floating point values with at least 4 elements

pub fn new(min: Option<&Point>, max: Option<&Point>) -> Self

Initializes the given Box2D with two vertices.

min

the coordinates of the minimum vertex

max

the coordinates of the maximum vertex

Returns

the initialized Box2D

pub fn from_points(points: &[Point]) -> Self

Initializes the given Box2D with the given array of vertices.

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

points

an array of Point

Returns

the initialized Box2D

pub fn from_vec2(min: Option<&Vec2>, max: Option<&Vec2>) -> Self

Initializes the given Box2D with two vertices stored inside Vec2.

min

the coordinates of the minimum vertex

max

the coordinates of the maximum vertex

Returns

the initialized Box2D

pub fn from_vectors(vectors: &[Vec2]) -> Self

Initializes the given Box2D with the given array of vertices.

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

vectors

an array of Vec2

Returns

the initialized Box2D

pub fn from_rect(src: &Rect) -> Self

Initializes the given Box2D with the origin and size of a Rect.

src

a Rect

Returns

the initialized Box2D

Trait Implementations

impl Clone for Box2D

fn clone(&self) -> Self

Copies the inline boxed type by value with the type-specific copy function.

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

Performs copy-assignment from source.

impl Debug for Box2D

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

Formats the value using the given formatter.

impl Default for Box2D

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for Box2D

type ParamSpec = ParamSpecBoxed

type SetValue = Box2D

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(&str) -> ParamSpecBoxedBuilder<'_, Box2D>

fn param_spec_builder() -> Self::BuilderFn

impl PartialEq for Box2D

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StaticType for Box2D

fn static_type() -> Type

Returns the type identifier of Self.

impl Copy for Box2D

impl Eq for Box2D