Struct pixel_game_lib::Aabr

pub struct Aabr<T> {
    pub min: Vec2<T>,
    pub max: Vec2<T>,
}

Re-export vek types. Axis-aligned Bounding Rectangle (2D), represented by min and max points.

N.B: You are responsible for ensuring that all respective elements of min are indeed less than or equal to those of max. The is_valid(), make_valid() and made_valid() methods are designed to help you with this.

Fields

min: Vec2<T>

Minimum coordinates of bounds.

max: Vec2<T>

Maximum coordinates of bounds.

Implementations

impl<T> Aabr<T>

pub fn is_valid(&self) -> bool

where T: PartialOrd,

Is this bounding shape valid ? True only if all elements of self.min are less than or equal to those of self.max.

pub fn make_valid(&mut self)

where T: PartialOrd,

Makes this bounding shape valid by swapping elements of self.min with self.max as needed.

pub fn made_valid(self) -> Aabr<T>

where T: PartialOrd,

Returns this bounding shape made valid by swapping elements of self.min with self.max as needed.

pub fn new_empty(p: Vec2<T>) -> Aabr<T>

where T: Copy,

Creates a new bounding shape from a single point.

pub fn into_rect(self) -> Rect<T, T>

where T: Copy + Sub<Output = T>,

Converts this bounding shape to the matching rectangle representation.

pub fn center(self) -> Vec2<T>

where T: Copy + One + Add<Output = T> + Div<Output = T>,

Gets this bounding shape’s center.

pub fn size(self) -> Extent2<T>

where T: Copy + Sub<Output = T>,

Gets this bounding shape’s total size.

pub fn half_size(self) -> Extent2<T>

where T: Copy + Sub<Output = T> + One + Div<Output = T> + Add<Output = T>,

Gets this bounding shape’s half size.

pub fn union(self, other: Aabr<T>) -> Aabr<T>

where T: PartialOrd,

Gets the smallest bounding shape that contains both this one and another.

pub fn intersection(self, other: Aabr<T>) -> Aabr<T>

where T: PartialOrd,

Gets the largest bounding shape contained by both this one and another.

pub fn expand_to_contain(&mut self, other: Aabr<T>)

where T: Copy + PartialOrd,

Sets this bounding shape to the union of itself with another.

pub fn intersect(&mut self, other: Aabr<T>)

where T: Copy + PartialOrd,

Sets this bounding shape to the intersection of itself with another.

pub fn expanded_to_contain_point(self, p: Vec2<T>) -> Aabr<T>

where T: Copy + PartialOrd,

Gets a copy of this shape so that it contains the given point.

pub fn expand_to_contain_point(&mut self, p: Vec2<T>)

where T: Copy + PartialOrd,

Expands this shape so that it contains the given point.

pub fn contains_point(self, p: Vec2<T>) -> bool

where T: PartialOrd,

Does this bounding shape contain the given point ?

pub fn contains_aabr(self, other: Aabr<T>) -> bool

where T: PartialOrd,

Does this bounding shape fully contain another ?

pub fn collides_with_aabr(self, other: Aabr<T>) -> bool

where T: PartialOrd,

Does this bounding shape collide with another ?

pub fn collision_vector_with_aabr(self, other: Aabr<T>) -> Vec2<T>

where T: Copy + PartialOrd + Sub<Output = T> + One + Add<Output = T> + Div<Output = T>,

Gets a vector that tells how much self penetrates other.

pub fn projected_point(self, p: Vec2<T>) -> Vec2<T>

where T: Clamp,

Project the given point into the bounding shape (equivalent to ‘snapping’ the point to the closest point in the bounding shape).

pub fn distance_to_point(self, p: Vec2<T>) -> T

where T: Clamp + Real<Output = T> + Add + RelativeEq,

Get the smallest distance between the bounding shape and a point.

pub fn split_at_x(self, sp: T) -> [Aabr<T>; 2]

where T: Copy + PartialOrd,

Splits this shape in two, by a straight plane along the x axis. The returned tuple is (low, high).

Panics

sp is assumed to be a position along the x axis that is within this shape’s bounds.

pub fn split_at_y(self, sp: T) -> [Aabr<T>; 2]

where T: Copy + PartialOrd,

Splits this shape in two, by a straight plane along the y axis. The returned tuple is (low, high).

Panics

sp is assumed to be a position along the y axis that is within this shape’s bounds.

pub fn map<D, F>(self, f: F) -> Aabr<D>

where F: FnMut(T) -> D,

Returns this bounding shape, converted element-wise using the given closure.

pub fn as_<D>(self) -> Aabr<D>

where T: AsPrimitive<D>, D: 'static + Copy,

Converts this rectangle to a rectangle of another type, using the as conversion.

Trait Implementations

impl<T> Clone for Aabr<T>

where T: Clone,

fn clone(&self) -> Aabr<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Aabr<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T> Default for Aabr<T>

where T: Default,

fn default() -> Aabr<T>

Returns the “default value” for a type.

impl<'de, T> Deserialize<'de> for Aabr<T>

where T: Deserialize<'de>,

fn deserialize<__D>( __deserializer: __D ) -> Result<Aabr<T>, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> From<Aabb<T>> for Aabr<T>

fn from(aabb: Aabb<T>) -> Aabr<T>

Converts to this type from the input type.

impl<T> From<Aabr<T>> for Rect<T, T>

where T: Copy + Sub<Output = T>,

fn from(aab: Aabr<T>) -> Rect<T, T>

Converts to this type from the input type.

impl<T> From<Rect<T, T>> for Aabr<T>

where T: Copy + Add<Output = T>,

fn from(rect: Rect<T, T>) -> Aabr<T>

Converts to this type from the input type.

impl<T> Hash for Aabr<T>

where T: Hash,

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

where __H: Hasher,

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<T> PartialEq for Aabr<T>

where T: PartialEq,

fn eq(&self, other: &Aabr<T>) -> 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<T> Serialize for Aabr<T>

where T: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> Copy for Aabr<T>

where T: Copy,

impl<T> Eq for Aabr<T>

where T: Eq,

impl<T> StructuralEq for Aabr<T>

impl<T> StructuralPartialEq for Aabr<T>