Struct bevy_math::IRect

#[repr(C)]
pub struct IRect {
    pub min: IVec2,
    pub max: IVec2,
}

A rectangle defined by two opposite corners.

The rectangle is axis aligned, and defined by its minimum and maximum coordinates, stored in IRect::min and IRect::max, respectively. The minimum/maximum invariant must be upheld by the user when directly assigning the fields, otherwise some methods produce invalid results. It is generally recommended to use one of the constructor methods instead, which will ensure this invariant is met, unless you already have the minimum and maximum corners.

Fields

min: IVec2

The minimum corner point of the rect.

max: IVec2

The maximum corner point of the rect.

Implementations

impl IRect

pub fn new(x0: i32, y0: i32, x1: i32, y1: i32) -> Self

Create a new rectangle from two corner points.

The two points do not need to be the minimum and/or maximum corners. They only need to be two opposite corners.

Examples

let r = IRect::new(0, 4, 10, 6); // w=10 h=2
let r = IRect::new(2, 3, 5, -1); // w=3 h=4

pub fn from_corners(p0: IVec2, p1: IVec2) -> Self

Create a new rectangle from two corner points.

The two points do not need to be the minimum and/or maximum corners. They only need to be two opposite corners.

Examples

// Unit rect from [0,0] to [1,1]
let r = IRect::from_corners(IVec2::ZERO, IVec2::ONE); // w=1 h=1
// Same; the points do not need to be ordered
let r = IRect::from_corners(IVec2::ONE, IVec2::ZERO); // w=1 h=1

pub fn from_center_size(origin: IVec2, size: IVec2) -> Self

Create a new rectangle from its center and size.

Rounding Behaviour

If the size contains odd numbers they will be rounded down to the nearest whole number.

Panics

This method panics if any of the components of the size is negative.

Examples

let r = IRect::from_center_size(IVec2::ZERO, IVec2::new(3, 2)); // w=2 h=2
assert_eq!(r.min, IVec2::splat(-1));
assert_eq!(r.max, IVec2::splat(1));

pub fn from_center_half_size(origin: IVec2, half_size: IVec2) -> Self

Create a new rectangle from its center and half-size.

Panics

This method panics if any of the components of the half-size is negative.

Examples

let r = IRect::from_center_half_size(IVec2::ZERO, IVec2::ONE); // w=2 h=2
assert_eq!(r.min, IVec2::splat(-1));
assert_eq!(r.max, IVec2::splat(1));

pub fn is_empty(&self) -> bool

Check if the rectangle is empty.

Examples

let r = IRect::from_corners(IVec2::ZERO, IVec2::new(0, 1)); // w=0 h=1
assert!(r.is_empty());

pub fn width(&self) -> i32

Rectangle width (max.x - min.x).

Examples

let r = IRect::new(0, 0, 5, 1); // w=5 h=1
assert_eq!(r.width(), 5);

pub fn height(&self) -> i32

Rectangle height (max.y - min.y).

Examples

let r = IRect::new(0, 0, 5, 1); // w=5 h=1
assert_eq!(r.height(), 1);

pub fn size(&self) -> IVec2

Rectangle size.

Examples

let r = IRect::new(0, 0, 5, 1); // w=5 h=1
assert_eq!(r.size(), IVec2::new(5, 1));

pub fn half_size(&self) -> IVec2

Rectangle half-size.

Rounding Behaviour

If the full size contains odd numbers they will be rounded down to the nearest whole number when calculating the half size.

Examples

let r = IRect::new(0, 0, 4, 3); // w=4 h=3
assert_eq!(r.half_size(), IVec2::new(2, 1));

pub fn center(&self) -> IVec2

The center point of the rectangle.

Rounding Behaviour

If the (min + max) contains odd numbers they will be rounded down to the nearest whole number when calculating the center.

Examples

let r = IRect::new(0, 0, 5, 2); // w=5 h=2
assert_eq!(r.center(), IVec2::new(2, 1));

pub fn contains(&self, point: IVec2) -> bool

Check if a point lies within this rectangle, inclusive of its edges.

Examples

let r = IRect::new(0, 0, 5, 1); // w=5 h=1
assert!(r.contains(r.center()));
assert!(r.contains(r.min));
assert!(r.contains(r.max));

pub fn union(&self, other: Self) -> Self

Build a new rectangle formed of the union of this rectangle and another rectangle.

The union is the smallest rectangle enclosing both rectangles.

Examples

let r1 = IRect::new(0, 0, 5, 1); // w=5 h=1
let r2 = IRect::new(1, -1, 3, 3); // w=2 h=4
let r = r1.union(r2);
assert_eq!(r.min, IVec2::new(0, -1));
assert_eq!(r.max, IVec2::new(5, 3));

pub fn union_point(&self, other: IVec2) -> Self

Build a new rectangle formed of the union of this rectangle and a point.

The union is the smallest rectangle enclosing both the rectangle and the point. If the point is already inside the rectangle, this method returns a copy of the rectangle.

Examples

let r = IRect::new(0, 0, 5, 1); // w=5 h=1
let u = r.union_point(IVec2::new(3, 6));
assert_eq!(u.min, IVec2::ZERO);
assert_eq!(u.max, IVec2::new(5, 6));

pub fn intersect(&self, other: Self) -> Self

Build a new rectangle formed of the intersection of this rectangle and another rectangle.

The intersection is the largest rectangle enclosed in both rectangles. If the intersection is empty, this method returns an empty rectangle (IRect::is_empty() returns true), but the actual values of IRect::min and IRect::max are implementation-dependent.

Examples

let r1 = IRect::new(0, 0, 5, 1); // w=5 h=1
let r2 = IRect::new(1, -1, 3, 3); // w=2 h=4
let r = r1.intersect(r2);
assert_eq!(r.min, IVec2::new(1, 0));
assert_eq!(r.max, IVec2::new(3, 1));

pub fn inset(&self, inset: i32) -> Self

Create a new rectangle with a constant inset.

The inset is the extra border on all sides. A positive inset produces a larger rectangle, while a negative inset is allowed and produces a smaller rectangle. If the inset is negative and its absolute value is larger than the rectangle half-size, the created rectangle is empty.

Examples

let r = IRect::new(0, 0, 5, 1); // w=5 h=1
let r2 = r.inset(3); // w=11 h=7
assert_eq!(r2.min, IVec2::splat(-3));
assert_eq!(r2.max, IVec2::new(8, 4));

let r = IRect::new(0, -1, 4, 3); // w=4 h=4
let r2 = r.inset(-1); // w=2 h=2
assert_eq!(r2.min, IVec2::new(1, 0));
assert_eq!(r2.max, IVec2::new(3, 2));

pub fn as_rect(&self) -> Rect

Returns self as Rect (f32)

pub fn as_urect(&self) -> URect

Returns self as URect (u32)

Trait Implementations

impl Clone for IRect

fn clone(&self) -> IRect

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IRect

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

Formats the value using the given formatter.

impl Default for IRect

fn default() -> IRect

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for IRect

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for IRect

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for IRect

fn eq(&self, other: &IRect) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for IRect

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for IRect

impl Eq for IRect

impl StructuralEq for IRect

impl StructuralPartialEq for IRect