Struct pix_engine::shape::Quad

#[repr(transparent)]
pub struct Quad<T = i32, const N: usize = 2_usize>(_);

A Quad or quadrilateral, a four-sided polygon.

Quad is similar to Rect but the angles between edges are not constrained to 90 degrees.

Please see the module-level documentation for examples.

Implementations

impl<T, const N: usize> Quad<T, N>

pub fn new<P1, P2, P3, P4>(p1: P1, p2: P2, p3: P3, p4: P4) -> Self where
    P1: Into<Point<T, N>>,
    P2: Into<Point<T, N>>,
    P3: Into<Point<T, N>>,
    P4: Into<Point<T, N>>, 

Constructs a Quad with the given Points.

use pix_engine::prelude::*;
let quad = Quad::new([10, 20], [30, 10], [20, 25], [15, 15]);
assert_eq!(quad.p1().coords(), [10, 20]);
assert_eq!(quad.p2().coords(), [30, 10]);
assert_eq!(quad.p3().coords(), [20, 25]);
assert_eq!(quad.p4().coords(), [15, 15]);

impl<T> Quad<T>

pub const fn from_xy(
    x1: T,
    y1: T,
    x2: T,
    y2: T,
    x3: T,
    y3: T,
    x4: T,
    y4: T
) -> Self

Constructs a Quad from individual x/y coordinates.

impl<T: Copy> Quad<T>

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

Returns Quad coordinates as [x1, y1, x2, y2, x3, y3, x4, y4].

Example

let quad = Quad::new([10, 20], [30, 10], [20, 25], [15, 15]);
assert_eq!(quad.coords(), [10, 20, 30, 10, 20, 25, 15, 15]);

impl<T> Quad<T, 3>

pub const fn from_xyz(
    x1: T,
    y1: T,
    z1: T,
    x2: T,
    y2: T,
    z2: T,
    x3: T,
    y3: T,
    z3: T,
    x4: T,
    y4: T,
    z4: T
) -> Self

Constructs a Quad from individual x/y/z coordinates.

impl<T: Copy> Quad<T, 3>

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

Returns Quad coordinates as [x1, y1, z1, x2, y2, z2, x3, y3, z3, x4, y4, z4].

Example

let quad = Quad::new([10, 20, 5], [30, 10, 5], [20, 25, 5], [15, 15, 5]);
assert_eq!(quad.coords(), [10, 20, 5, 30, 10, 5, 20, 25, 5, 15, 15, 5]);

impl<T: Copy, const N: usize> Quad<T, N>

pub fn p1(&self) -> Point<T, N>

Returns the first point of the quad.

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

Sets the first point of the quad.

pub fn p2(&self) -> Point<T, N>

Returns the second point of the quad.

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

Sets the second point of the quad.

pub fn p3(&self) -> Point<T, N>

Returns the third point of the quad.

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

Sets the third point of the quad.

pub fn p4(&self) -> Point<T, N>

Returns the fourth point of the quad.

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

Sets the fourth point of the quad.

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

Returns Quad points as [Point<T, N>; 4].

Example

let quad = Quad::new([10, 20], [30, 10], [20, 25], [15, 15]);
assert_eq!(quad.points(), [
    point!(10, 20),
    point!(30, 10),
    point!(20, 25),
    point!(15, 15)
]);

pub fn points_mut(&mut self) -> &mut [Point<T, N>; 4]

Returns Quad points as a mutable slice &mut [Point<T, N>; 4].

Example

let mut quad = Quad::new([10, 20], [30, 10], [20, 25], [15, 15]);
for p in quad.points_mut() {
    *p += 5;
}
assert_eq!(quad.points(), [
    point!(15, 25),
    point!(35, 15),
    point!(25, 30),
    point!(20, 20)
]);

pub fn to_vec(self) -> Vec<Point<T, N>>

Returns Quad points as a Vec.

Example

let quad = Quad::new([10, 20], [30, 10], [20, 25], [15, 15]);
assert_eq!(quad.to_vec(), vec![
    point!(10, 20),
    point!(30, 10),
    point!(20, 25),
    point!(15, 15)
]);

impl<T, const N: usize> Quad<T, N>

pub fn as_<U>(&self) -> Quad<U, N> where
    U: 'static + Copy,
    T: AsPrimitive<U>, 

Returns Self with the numbers cast using as operator. Converts Quad < T, N > to Quad < U, N >.

impl<T: Float, const N: usize> Quad<T, N>

pub fn round(&self) -> Self

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

pub fn floor(&self) -> Self

Returns Quad < T, N >with the largest integers less than or equal to the numbers.

pub fn ceil(&self) -> Self

Returns Quad < T, N > with the smallest integers greater than or equal to the numbers.

Methods from Deref<Target = [Point<T, N>; 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]);

Trait Implementations

impl<T, const N: usize> AsMut<[Point<T, N>; 4]> for Quad<T, N>

fn as_mut(&mut self) -> &mut [Point<T, N>; 4]

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

impl<T, const N: usize> AsRef<[Point<T, N>; 4]> for Quad<T, N>

fn as_ref(&self) -> &[Point<T, N>; 4]

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

impl<T: Clone, const N: usize> Clone for Quad<T, N>

fn clone(&self) -> Quad<T, N>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug, const N: usize> Debug for Quad<T, N>

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

Formats the value using the given formatter.

impl<T, const N: usize> Deref for Quad<T, N>

type Target = [Point<T, N>; 4]

The resulting type after dereferencing.

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

Dereferences the value.

impl<T, const N: usize> DerefMut for Quad<T, N>

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

Mutably dereferences the value.

impl<'de, T, const N: usize> Deserialize<'de> for Quad<T, N> where
    T: Serialize + DeserializeOwned, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Draw for Quad<i32>

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

Draw Quad to the current PixState canvas.

impl<T: Copy, const N: usize> From<&'_ [Point<T, N>; 4]> for Quad<T, N>

fn from(arr: &[Point<T, N>; 4]) -> Self

Converts &[T; M] to Quad < T, N >.

impl<T: Copy, const N: usize> From<&'_ Quad<T, N>> for [Point<T, N>; 4]

fn from(t: &Quad<T, N>) -> Self

Converts Quad < T, N > to &[T; M].

impl<T: Copy> From<[[T; 2]; 4]> for Quad<T>

fn from([[x1, y1], [x2, y2], [x3, y3], [x4, y4]]: [[T; 2]; 4]) -> Self

Converts [[T; 2]; 4] into Quad<T>.

impl<T: Copy> From<[[T; 3]; 4]> for Quad<T, 3>

fn from(
    [[x1, y1, z1], [x2, y2, z2], [x3, y3, z3], [x4, y4, z4]]: [[T; 3]; 4]
) -> Self

Converts [[T; 3]; 4] into Quad<T, 3>.

impl<T, const N: usize> From<[Point<T, N>; 4]> for Quad<T, N>

fn from(arr: [Point<T, N>; 4]) -> Self

Converts [T; M] to Quad < T, N >.

impl<T: Copy> From<[T; 12]> for Quad<T, 3>

fn from([x1, y1, z1, x2, y2, z2, x3, y3, z3, x4, y4, z4]: [T; 12]) -> Self

Converts [T; 12] into Quad<T, 3>.

impl<T: Copy> From<[T; 8]> for Quad<T>

fn from([x1, y1, x2, y2, x3, y3, x4, y4]: [T; 8]) -> Self

Converts [T; 8] into Quad<T>.

impl<T, const N: usize> From<Quad<T, N>> for [Point<T, N>; 4]

fn from(t: Quad<T, N>) -> Self

Converts Quad < T, N > to [T; M].

impl<T: Default, const N: usize> FromIterator<Point<T, N>> for Quad<T, N>

fn from_iter<I>(iter: I) -> Self where
    I: IntoIterator<Item = Point<T, N>>, 

Creates a value from an iterator.

impl<T: Hash, const N: usize> Hash for Quad<T, N>

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, 

Feeds a slice of this type into the given Hasher.

impl<T, const N: usize> Index<usize> for Quad<T, N>

type Output = Point<T, N>

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<T, const N: usize> IndexMut<usize> for Quad<T, N>

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

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

impl<T, const N: usize> IntoIterator for Quad<T, N>

type Item = Point<T, N>

The type of the elements being iterated over.

type IntoIter = IntoIter<<Quad<T, N> as IntoIterator>::Item, 4_usize>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, T, const N: usize> IntoIterator for &'a Quad<T, N>

type Item = &'a Point<T, N>

The type of the elements being iterated over.

type IntoIter = Iter<'a, Point<T, N>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, T, const N: usize> IntoIterator for &'a mut Quad<T, N>

type Item = &'a mut Point<T, N>

The type of the elements being iterated over.

type IntoIter = IterMut<'a, Point<T, N>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T: PartialEq, const N: usize> PartialEq<Quad<T, N>> for Quad<T, N>

fn eq(&self, other: &Quad<T, N>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Quad<T, N>) -> bool

This method tests for !=.

impl<T, const N: usize> Serialize for Quad<T, N> where
    T: Serialize + DeserializeOwned, 

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

Serialize this value into the given Serde serializer.

impl<T: Copy, const N: usize> Copy for Quad<T, N>

impl<T: Eq, const N: usize> Eq for Quad<T, N>

impl<T, const N: usize> StructuralEq for Quad<T, N>

impl<T, const N: usize> StructuralPartialEq for Quad<T, N>