Struct bevy_math::URect

#[repr(C)]
pub struct URect {
    pub min: UVec2,
    pub max: UVec2,
}

A rectangle defined by two opposite corners.

The rectangle is axis aligned, and defined by its minimum and maximum coordinates, stored in URect::min and URect::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: UVec2

The minimum corner point of the rect.

max: UVec2

The maximum corner point of the rect.

Implementations

impl URect

pub const EMPTY: Self = _

An empty URect, represented by maximum and minimum corner points with max == UVec2::MIN and min == UVec2::MAX, so the rect has an extremely large negative size. This is useful, because when taking a union B of a non-empty URect A and this empty URect, B will simply equal A.

pub fn new(x0: u32, y0: u32, x1: u32, y1: u32) -> 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 = URect::new(0, 4, 10, 6); // w=10 h=2
let r = URect::new(2, 4, 5, 0); // w=3 h=4

pub fn from_corners(p0: UVec2, p1: UVec2) -> 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 = URect::from_corners(UVec2::ZERO, UVec2::ONE); // w=1 h=1
// Same; the points do not need to be ordered
let r = URect::from_corners(UVec2::ONE, UVec2::ZERO); // w=1 h=1

pub fn from_center_size(origin: UVec2, size: UVec2) -> 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 or if origin - (size / 2) results in any negatives.

Examples

let r = URect::from_center_size(UVec2::ONE, UVec2::splat(2)); // w=2 h=2
assert_eq!(r.min, UVec2::splat(0));
assert_eq!(r.max, UVec2::splat(2));

pub fn from_center_half_size(origin: UVec2, half_size: UVec2) -> 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 or if origin - half_size results in any negatives.

Examples

let r = URect::from_center_half_size(UVec2::ONE, UVec2::ONE); // w=2 h=2
assert_eq!(r.min, UVec2::splat(0));
assert_eq!(r.max, UVec2::splat(2));

pub fn is_empty(&self) -> bool

Check if the rectangle is empty.

Examples

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

pub const fn width(&self) -> u32

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

Examples

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

pub const fn height(&self) -> u32

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

Examples

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

pub fn size(&self) -> UVec2

Rectangle size.

Examples

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

pub fn half_size(&self) -> UVec2

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 = URect::new(0, 0, 4, 2); // w=4 h=2
assert_eq!(r.half_size(), UVec2::new(2, 1));

pub fn center(&self) -> UVec2

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 = URect::new(0, 0, 4, 2); // w=4 h=2
assert_eq!(r.center(), UVec2::new(2, 1));

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

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

Examples

let r = URect::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 = URect::new(0, 0, 5, 1); // w=5 h=1
let r2 = URect::new(1, 0, 3, 8); // w=2 h=4
let r = r1.union(r2);
assert_eq!(r.min, UVec2::new(0, 0));
assert_eq!(r.max, UVec2::new(5, 8));

pub fn union_point(&self, other: UVec2) -> 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 = URect::new(0, 0, 5, 1); // w=5 h=1
let u = r.union_point(UVec2::new(3, 6));
assert_eq!(u.min, UVec2::ZERO);
assert_eq!(u.max, UVec2::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 (URect::is_empty() returns true), but the actual values of URect::min and URect::max are implementation-dependent.

Examples

let r1 = URect::new(0, 0, 2, 2); // w=2 h=2
let r2 = URect::new(1, 1, 3, 3); // w=2 h=2
let r = r1.intersect(r2);
assert_eq!(r.min, UVec2::new(1, 1));
assert_eq!(r.max, UVec2::new(2, 2));

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

Create a new rectangle by expanding it evenly on all sides.

A positive expansion value produces a larger rectangle, while a negative expansion value produces a smaller rectangle. If this would result in zero width or height, URect::EMPTY is returned instead.

Examples

let r = URect::new(4, 4, 6, 6); // w=2 h=2
let r2 = r.inflate(1); // w=4 h=4
assert_eq!(r2.min, UVec2::splat(3));
assert_eq!(r2.max, UVec2::splat(7));

let r = URect::new(4, 4, 8, 8); // w=4 h=4
let r2 = r.inflate(-1); // w=2 h=2
assert_eq!(r2.min, UVec2::splat(5));
assert_eq!(r2.max, UVec2::splat(7));

pub fn as_rect(&self) -> Rect

Returns self as Rect (f32)

pub fn as_irect(&self) -> IRect

Returns self as IRect (i32)

Trait Implementations

impl Clone for URect

fn clone(&self) -> URect

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for URect

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

Formats the value using the given formatter.

impl Default for URect

fn default() -> URect

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for URect

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromReflect for URect

where Self: Any + Send + Sync, UVec2: FromReflect + TypePath + RegisterForReflection,

fn from_reflect(reflect: &dyn Reflect) -> Option<Self>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn Reflect> ) -> Result<Self, Box<dyn Reflect>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl GetTypeRegistration for URect

where Self: Any + Send + Sync, UVec2: FromReflect + TypePath + RegisterForReflection,

fn get_type_registration() -> TypeRegistration

Returns the default TypeRegistration for this type.

fn register_type_dependencies(registry: &mut TypeRegistry)

Registers other types needed by this type.

impl Hash for URect

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 URect

fn eq(&self, other: &URect) -> 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 Reflect for URect

where Self: Any + Send + Sync, UVec2: FromReflect + TypePath + RegisterForReflection,

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the TypeInfo of the type represented by this value.

fn into_any(self: Box<Self>) -> Box<dyn Any>

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &dyn Any

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut dyn Any

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>

Casts this type to a boxed reflected value.

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a reflected value.

fn as_reflect_mut(&mut self) -> &mut dyn Reflect

Casts this type to a mutable reflected value.

fn clone_value(&self) -> Box<dyn Reflect>

Clones the value as a Reflect trait object.

fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>

Performs a type-checked assignment of a reflected value to this value.

fn try_apply(&mut self, value: &dyn Reflect) -> Result<(), ApplyError>

Tries to apply a reflected value to this value.

fn reflect_kind(&self) -> ReflectKind

Returns a zero-sized enumeration of “kinds” of type.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an immutable enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<Self>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

fn reflect_partial_eq(&self, value: &dyn Reflect) -> Option<bool>

Returns a “partial equality” comparison result.

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

Debug formatter for the value.

fn apply(&mut self, value: &(dyn Reflect + 'static))

Applies a reflected value to this value.

fn serializable(&self) -> Option<Serializable<'_>>

Returns a serializable version of the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Serialize for URect

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Struct for URect

where Self: Any + Send + Sync, UVec2: FromReflect + TypePath + RegisterForReflection,

fn field(&self, name: &str) -> Option<&dyn Reflect>

Returns a reference to the value of the field named name as a &dyn Reflect.

fn field_mut(&mut self, name: &str) -> Option<&mut dyn Reflect>

Returns a mutable reference to the value of the field named name as a &mut dyn Reflect.

fn field_at(&self, index: usize) -> Option<&dyn Reflect>

Returns a reference to the value of the field with index index as a &dyn Reflect.

fn field_at_mut(&mut self, index: usize) -> Option<&mut dyn Reflect>

Returns a mutable reference to the value of the field with index index as a &mut dyn Reflect.

fn name_at(&self, index: usize) -> Option<&str>

Returns the name of the field with index index.

fn field_len(&self) -> usize

Returns the number of fields in the struct.

fn iter_fields(&self) -> FieldIter<'_>

Returns an iterator over the values of the reflectable fields for this struct.

fn clone_dynamic(&self) -> DynamicStruct

Clones the struct into a DynamicStruct.

impl TypePath for URect

where Self: Any + Send + Sync,

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl Typed for URect

where Self: Any + Send + Sync, UVec2: FromReflect + TypePath + RegisterForReflection,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Copy for URect

impl Eq for URect

impl StructuralPartialEq for URect