Struct pix_engine::shape::Rect

pub struct Rect<T = i32>(/* private fields */);

A Rectangle positioned at (x, y) with width and height. A square is a Rectangle where width and height are equal.

Please see the module-level documentation for examples.

Implementations

impl<T> Rect<T>

pub const fn new(x: T, y: T, width: T, height: T) -> Self

Constructs a Rect at position (x, y) with width and height.

pub fn square(x: T, y: T, size: T) -> Self

where T: Copy,

Constructs a square Rect at position (x, y) with size.

impl<T: Copy> Rect<T>

pub fn coords(&self) -> [T; 4]

Returns Rect coordinates as [x, y, width, height].

Example

let r = rect!(5, 10, 100, 100);
assert_eq!(r.coords(), [5, 10, 100, 100]);

pub fn coords_mut(&mut self) -> &mut [T; 4]

Returns Rect coordinates as a mutable slice &mut [x, y, width, height].

Example

let mut r = rect!(5, 10, 100, 100);
for p in r.coords_mut() {
    *p += 5;
}
assert_eq!(r.coords(), [10, 15, 105, 105]);

pub fn x(&self) -> T

Returns the x-coordinate of the rectangle.

pub fn set_x(&mut self, x: T)

Sets the x-coordinate of the rectangle.

pub fn y(&self) -> T

Returns the y-coordinate of the rectangle.

pub fn set_y(&mut self, y: T)

Sets the y-coordinate of the rectangle.

pub fn width(&self) -> T

Returns the width of the rectangle.

pub fn set_width(&mut self, width: T)

Sets the width of the rectangle.

pub fn height(&self) -> T

Returns the height of the rectangle.

pub fn set_height(&mut self, height: T)

Sets the height of the rectangle.

impl<T: Num> Rect<T>

pub fn with_position<P: Into<Point<T>>>(p: P, width: T, height: T) -> Self

Constructs a Rect at position Point with width and height.

pub fn square_with_position<P: Into<Point<T>>>(p: P, size: T) -> Self

Constructs a square Rect at position Point with size.

pub fn with_points<P: Into<Point<T>>>(p1: P, p2: P) -> Self

Constructs a Rect by providing top-left and bottom-right Points.

Panics

Panics if p2 <= p1.

Example

let r = Rect::with_points([50, 50], [150, 150]);
assert_eq!(r.coords(), [50, 50, 100, 100]);

pub fn from_center<P: Into<Point<T>>>(p: P, width: T, height: T) -> Self

Constructs a Rect centered at position (x, y) with width and height.

Example

let r = Rect::from_center([50, 50], 100, 100);
assert_eq!(r.coords(), [0, 0, 100, 100]);

pub fn square_from_center<P: Into<Point<T>>>(p: P, size: T) -> Self

Constructs a square Rect centered at position (x, y) with size.

Example

let s = Rect::square_from_center([50, 50], 100);
assert_eq!(s.coords(), [0, 0, 100, 100]);

pub fn size(&self) -> Point<T>

Returns the size of the rectangle as a Point.

pub fn reposition(&self, x: T, y: T) -> Self

Reposition the the rectangle.

pub fn resize(&self, width: T, height: T) -> Self

Resize the the rectangle.

pub fn offset<P>(&self, offsets: P) -> Self

where P: Into<Point<T>>,

Offsets a rectangle by shifting coordinates by given amount.

pub fn offset_size<P>(&self, offsets: P) -> Self

where P: Into<Point<T>>,

Offsets a rectangle’s size by shifting coordinates by given amount.

pub fn grow<P>(&self, offsets: P) -> Self

where P: Into<Point<T>>,

Grows a rectangle by a given size.

pub fn shrink<P>(&self, offsets: P) -> Self

where P: Into<Point<T>>,

Shrinks a rectangle by a given size.

pub fn to_vec(self) -> Vec<T>

Returns Rect as a Vec.

Example

let r = rect!(5, 10, 100, 100);
assert_eq!(r.to_vec(), vec![5, 10, 100, 100]);

pub fn left(&self) -> T

Returns the horizontal position of the left edge.

pub fn set_left(&mut self, left: T)

Set the horizontal position of the left edge.

pub fn right(&self) -> T

Returns the horizontal position of the right edge.

pub fn set_right(&mut self, right: T)

Set the horizontal position of the right edge.

pub fn top(&self) -> T

Returns the horizontal position of the top edge.

pub fn set_top(&mut self, top: T)

Set the vertical position of the top edge.

pub fn bottom(&self) -> T

Returns the vertical position of the bottom edge.

pub fn set_bottom(&mut self, bottom: T)

Set the vertical position of the bottom edge.

pub fn center(&self) -> Point<T>

Returns the center position as Point.

pub fn top_left(&self) -> Point<T>

Returns the top-left position as Point.

pub fn top_right(&self) -> Point<T>

Returns the top-right position as Point.

pub fn bottom_left(&self) -> Point<T>

Returns the bottom-left position as Point.

pub fn bottom_right(&self) -> Point<T>

Returns the bottom-right position as Point.

pub fn points(&self) -> [Point<T>; 4]

Returns the four Points that compose this Rect as [top_left, top_right, bottom_right, bottom_left].

pub fn center_on<P: Into<Point<T>>>(&mut self, p: P)

Set position centered on a Point.

pub fn rotated(&self, angle: f64, center: Option<Point<T>>) -> Self

where T: Ord + Bounded + AsPrimitive<f64> + NumCast,

Returns the bounding box for a given rectangle rotated about a center by a given angle. Passing None for center rotates about the top-left point of the rectangle.

impl<T> Rect<T>

pub fn as_<U>(&self) -> Rect<U>

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

Converts Rect < T > to Rect < U >.

impl<T: Float> Rect<T>

pub fn round(&self) -> Self

Returns Rect < T > with the nearest integers to the numbers. Round half-way cases away from 0.0.

pub fn floor(&self) -> Self

Returns Rect < T > with the largest integers less than or equal to the numbers.

pub fn ceil(&self) -> Self

Returns Rect < T > with the smallest integers greater than or equal to the numbers.

Methods from Deref<Target = [T; 4]>

pub fn as_slice(&self) -> &[T]

Returns a slice containing the entire array. Equivalent to &s[..].

pub fn as_mut_slice(&mut self) -> &mut [T]

Returns a mutable slice containing the entire array. Equivalent to &mut s[..].

pub fn each_ref(&self) -> [&T; N]

🔬This is a nightly-only experimental API. (array_methods)

Borrows each element and returns an array of references with the same size as self.

Example

#![feature(array_methods)]

let floats = [3.1, 2.7, -1.0];
let float_refs: [&f64; 3] = floats.each_ref();
assert_eq!(float_refs, [&3.1, &2.7, &-1.0]);

This method is particularly useful if combined with other methods, like map. This way, you can avoid moving the original array if its elements are not Copy.

#![feature(array_methods)]

let strings = ["Ferris".to_string(), "♥".to_string(), "Rust".to_string()];
let is_ascii = strings.each_ref().map(|s| s.is_ascii());
assert_eq!(is_ascii, [true, false, true]);

// We can still access the original array: it has not been moved.
assert_eq!(strings.len(), 3);

pub fn each_mut(&mut self) -> [&mut T; N]

🔬This is a nightly-only experimental API. (array_methods)

Borrows each element mutably and returns an array of mutable references with the same size as self.

Example

#![feature(array_methods)]

let mut floats = [3.1, 2.7, -1.0];
let float_refs: [&mut f64; 3] = floats.each_mut();
*float_refs[0] = 0.0;
assert_eq!(float_refs, [&mut 0.0, &mut 2.7, &mut -1.0]);
assert_eq!(floats, [0.0, 2.7, -1.0]);

pub fn split_array_ref<const M: usize>(&self) -> (&[T; M], &[T])

🔬This is a nightly-only experimental API. (split_array)

Divides one array reference into two at an index.

The first will contain all indices from [0, M) (excluding the index M itself) and the second will contain all indices from [M, N) (excluding the index N itself).

Panics

Panics if M > N.

Examples

#![feature(split_array)]

let v = [1, 2, 3, 4, 5, 6];

{
   let (left, right) = v.split_array_ref::<0>();
   assert_eq!(left, &[]);
   assert_eq!(right, &[1, 2, 3, 4, 5, 6]);
}

{
    let (left, right) = v.split_array_ref::<2>();
    assert_eq!(left, &[1, 2]);
    assert_eq!(right, &[3, 4, 5, 6]);
}

{
    let (left, right) = v.split_array_ref::<6>();
    assert_eq!(left, &[1, 2, 3, 4, 5, 6]);
    assert_eq!(right, &[]);
}

pub fn split_array_mut<const M: usize>(&mut self) -> (&mut [T; M], &mut [T])

🔬This is a nightly-only experimental API. (split_array)

Divides one mutable array reference into two at an index.

The first will contain all indices from [0, M) (excluding the index M itself) and the second will contain all indices from [M, N) (excluding the index N itself).

Panics

Panics if M > N.

Examples

#![feature(split_array)]

let mut v = [1, 0, 3, 0, 5, 6];
let (left, right) = v.split_array_mut::<2>();
assert_eq!(left, &mut [1, 0][..]);
assert_eq!(right, &mut [3, 0, 5, 6]);
left[1] = 2;
right[1] = 4;
assert_eq!(v, [1, 2, 3, 4, 5, 6]);

pub fn rsplit_array_ref<const M: usize>(&self) -> (&[T], &[T; M])

🔬This is a nightly-only experimental API. (split_array)

Divides one array reference into two at an index from the end.

The first will contain all indices from [0, N - M) (excluding the index N - M itself) and the second will contain all indices from [N - M, N) (excluding the index N itself).

Panics

Panics if M > N.

Examples

#![feature(split_array)]

let v = [1, 2, 3, 4, 5, 6];

{
   let (left, right) = v.rsplit_array_ref::<0>();
   assert_eq!(left, &[1, 2, 3, 4, 5, 6]);
   assert_eq!(right, &[]);
}

{
    let (left, right) = v.rsplit_array_ref::<2>();
    assert_eq!(left, &[1, 2, 3, 4]);
    assert_eq!(right, &[5, 6]);
}

{
    let (left, right) = v.rsplit_array_ref::<6>();
    assert_eq!(left, &[]);
    assert_eq!(right, &[1, 2, 3, 4, 5, 6]);
}

pub fn rsplit_array_mut<const M: usize>(&mut self) -> (&mut [T], &mut [T; M])

🔬This is a nightly-only experimental API. (split_array)

Divides one mutable array reference into two at an index from the end.

The first will contain all indices from [0, N - M) (excluding the index N - M itself) and the second will contain all indices from [N - M, N) (excluding the index N itself).

Panics

Panics if M > N.

Examples

#![feature(split_array)]

let mut v = [1, 0, 3, 0, 5, 6];
let (left, right) = v.rsplit_array_mut::<4>();
assert_eq!(left, &mut [1, 0]);
assert_eq!(right, &mut [3, 0, 5, 6][..]);
left[1] = 2;
right[1] = 4;
assert_eq!(v, [1, 2, 3, 4, 5, 6]);

pub fn as_ascii(&self) -> Option<&[AsciiChar; N]>

🔬This is a nightly-only experimental API. (ascii_char)

Converts this array of bytes into a array of ASCII characters, or returns None if any of the characters is non-ASCII.

Examples

#![feature(ascii_char)]
#![feature(const_option)]

const HEX_DIGITS: [std::ascii::Char; 16] =
    *b"0123456789abcdef".as_ascii().unwrap();

assert_eq!(HEX_DIGITS[1].as_str(), "1");
assert_eq!(HEX_DIGITS[10].as_str(), "a");

pub unsafe fn as_ascii_unchecked(&self) -> &[AsciiChar; N]

🔬This is a nightly-only experimental API. (ascii_char)

Converts this array of bytes into a array of ASCII characters, without checking whether they’re valid.

Safety

Every byte in the array must be in 0..=127, or else this is UB.

Trait Implementations

impl Add<Point> for Rect

type Output = Rect

The resulting type after applying the + operator.

fn add(self, p: Point<i32>) -> Self::Output

Performs the + operation.

impl<T> AsMut<[T; 4]> for Rect<T>

fn as_mut(&mut self) -> &mut [T; 4]

Converts this type into a mutable reference of the (usually inferred) input type.

impl<T> AsRef<[T; 4]> for Rect<T>

fn as_ref(&self) -> &[T; 4]

Converts this type into a shared reference of the (usually inferred) input type.

impl<T: Clone> Clone for Rect<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Num> Contains<Point<T>> for Rect<T>

fn contains(&self, p: Point<T>) -> bool

Returns whether this rectangle contains a given Point.

impl<T: Num> Contains<Rect<T>> for Rect<T>

fn contains(&self, rect: Rect<T>) -> bool

Returns whether this rectangle completely contains another rectangle.

impl<T: Debug> Debug for Rect<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for Rect<T>

fn default() -> Rect<T>

Returns the “default value” for a type.

impl<T> Deref for Rect<T>

type Target = [T; 4]

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T> DerefMut for Rect<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

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

where T: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Draw for Rect<i32>

fn draw(&self, s: &mut PixState) -> Result<()>

Draw Rect to the current PixState canvas.

impl<T: Copy> From<&[T; 3]> for Rect<T>

fn from([x, y, s]: &[T; 3]) -> Self

Converts &[T; 3] into Rect<T>.

impl<T: Copy> From<&[T; 4]> for Rect<T>

fn from(arr: &[T; 4]) -> Self

Converts &[T; M] to Rect < T >.

impl<T: Copy> From<&Rect<T>> for [T; 4]

fn from(t: &Rect<T>) -> Self

Converts Rect < T > to &[T; M].

impl<T: Copy> From<[T; 3]> for Rect<T>

fn from([x, y, s]: [T; 3]) -> Self

Converts [T; 3] into Rect<T>.

impl<T> From<[T; 4]> for Rect<T>

fn from(arr: [T; 4]) -> Self

Converts [T; M] to Rect < T >.

impl<T> From<Rect<T>> for [T; 4]

fn from(t: Rect<T>) -> Self

Converts Rect < T > to [T; M].

impl<T: Default> FromIterator<T> for Rect<T>

fn from_iter<I>(iter: I) -> Self

where I: IntoIterator<Item = T>,

Creates a value from an iterator.

impl<T: Hash> Hash for Rect<T>

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<T> Index<usize> for Rect<T>

type Output = T

The returned type after indexing.

fn index(&self, idx: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T> IndexMut<usize> for Rect<T>

fn index_mut(&mut self, idx: usize) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<T: Float> Intersects<Line<T>> for Rect<T>

fn intersects(&self, line: Line<T>) -> Option<Self::Result>

Returns the closest intersection point with a given line and distance along the line or None if there is no intersection.

type Result = (Point<T>, T)

The result of the intersection.

impl<T: Num> Intersects<Rect<T>> for Rect<T>

fn intersects(&self, rect: Rect<T>) -> Option<Self::Result>

Returns whether this rectangle intersects with another rectangle.

type Result = ()

The result of the intersection.

impl<'a, T> IntoIterator for &'a Rect<T>

type Item = &'a T

The type of the elements being iterated over.

type IntoIter = Iter<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, T> IntoIterator for &'a mut Rect<T>

type Item = &'a mut T

The type of the elements being iterated over.

type IntoIter = IterMut<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T> IntoIterator for Rect<T>

type Item = T

The type of the elements being iterated over.

type IntoIter = IntoIter<<Rect<T> as IntoIterator>::Item, 4>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T: PartialEq> PartialEq for Rect<T>

fn eq(&self, other: &Rect<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 Rect<T>

where T: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub<Point> for Rect

type Output = Rect

The resulting type after applying the - operator.

fn sub(self, p: Point<i32>) -> Self::Output

Performs the - operation.

impl<T: Copy> Copy for Rect<T>

impl<T: Eq> Eq for Rect<T>

impl<T> StructuralEq for Rect<T>

impl<T> StructuralPartialEq for Rect<T>