Struct mathie::Rect

source · [−]

#[repr(C)]
pub struct Rect<T: Number> { /* private fields */ }

Implementations

source

pub fn one() -> Rect<N>

Returns a rectangle that is size of one and has an origin on 0

source

pub fn cast<NO: Number>(self) -> Rect<NO>

Casts the rectangle to another primitive unit, panicking if the unit cannot be represented.

source

pub fn try_cast<NO: Number>(self) -> Option<Rect<NO>>

Same as Self::cast but returns None if the cast failed.

source

pub fn intersects_rect(&self, other: Rect<N>) -> bool

Checks if self intersects other. In other words it check if any of these rectangles touch each other. This is very useful in cull testing.

Arguments

other: The other rectangle to check intersection with.

returns: bool

Examples

use mathie::Rect;
let rect = Rect::one();
assert!(rect.intersects_rect(Rect::new([0.0, 0.0], [1.0, 1.0])));
assert!(rect.intersects_rect(Rect::new([0.4, 0.4], [0.2, 0.2])));
assert!(rect.intersects_rect(Rect::new([1.0, 1.0], [1.0, 1.0])));
assert!(rect.intersects_rect(Rect::new([0.0, 0.5], [0.5, 1.0])));
assert!(!rect.intersects_rect(Rect::new([1.1, 1.1], [1.0, 1.0])));
assert!(!rect.intersects_rect(Rect::new([-0.1, -0.1], [0.09, 0.09])));

source

pub fn contains_rect(&self, rect: Rect<N>) -> bool

Checks if self contains other, in other words, it checks if self fully contains other.

Arguments

other: The other rectangle to check if it is inside self.

returns: bool

Examples

use mathie::Rect;
let rect = Rect::one();
assert!(rect.contains_rect(Rect::new([0.0, 0.0], [1.0, 1.0])));
assert!(rect.contains_rect(Rect::new([0.4, 0.4], [0.2, 0.2])));
assert!(!rect.contains_rect(Rect::new([1.0, 1.0], [1.0, 1.0])));
assert!(!rect.contains_rect(Rect::new([0.0, 0.5], [0.5, 1.0])));
assert!(!rect.contains_rect(Rect::new([1.1, 1.1], [1.0, 1.0])));
assert!(!rect.contains_rect(Rect::new([-0.1, -0.1], [0.09, 0.09])));

source

pub fn contains_pos(&self, pos: Vec2<N>) -> bool

Checks if this position is inside this rectangle

Examples

use mathie::{Rect, Vec2};
let rect = Rect::one();
assert!(rect.contains_pos(Vec2::new(0.5, 0.5)));
assert!(rect.contains_pos(Vec2::new(0.0, 0.0)));
assert!(rect.contains_pos(Vec2::new(1.0, 1.0)));
assert!(rect.contains_pos(Vec2::new(0.0, 1.0)));
assert!(rect.contains_pos(Vec2::new(1.0, 0.0)));
assert!(!rect.contains_pos(Vec2::new(0.0, -0.1)));
assert!(!rect.contains_pos(Vec2::new(-0.1, 0.0)));

source

pub fn is_negative(&self) -> bool

Checks if the rectangle has a negative area

Examples

use mathie::{Rect, Vec2};
assert!(!Rect::new([0.0, 0.0], [1.0, 1.0]).is_negative());
assert!(!Rect::new([0.0, 0.0], [0.0, 0.0]).is_negative());
assert!(Rect::new([0.0, 0.0], [-1.0, -1.0]).is_negative());

source

pub fn is_empty(&self) -> bool

Checks if the rectangle area is zero, negative or NaN.

Examples

use mathie::{Rect, Vec2};
assert!(!Rect::new([0.0, 0.0], [1.0, 1.0]).is_empty());
assert!(Rect::new([0.0, 0.0], [0.0, 0.0]).is_empty());
assert!(Rect::new([0.0, 0.0], [-1.0, -1.0]).is_empty());

source

pub fn shrink(&self, value: Vec2<N>) -> Self

Makes the rectangle smaller in the x and y directions keeping its center.

Examples

use mathie::{Rect, Vec2};
let rect = Rect::one();
assert_eq!(rect.shrink(Vec2::one()), Rect::new([0.5, 0.5], [0.0, 0.0]));
assert_eq!(rect.shrink(Vec2::one() / 2.0), Rect::new([0.25, 0.25], [0.5, 0.5]));

source

pub fn expand(&self, value: Vec2<N>) -> Self

Makes the rectangle bigger in the x and y directions keeping its center.

Examples

use mathie::{Rect, Vec2};
let rect = Rect::one();
assert_eq!(rect.expand(Vec2::one()), Rect::new([-0.5, -0.5], [2.0, 2.0]));
assert_eq!(rect.expand(Vec2::one() / 2.0), Rect::new([-0.25, -0.25], [1.5, 1.5]));