Struct Quad

Source
pub struct Quad<T = i32, const N: usize = 2>(/* private fields */);
Expand description

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§

Source§

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

Source

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]);
Source§

impl<T> Quad<T>

Source

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.

Source§

impl<T: Copy> Quad<T>

Source

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]);
Source§

impl<T> Quad<T, 3>

Source

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.

Source§

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

Source

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]);
Source§

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

Source

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

Returns the first point of the quad.

Source

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

Sets the first point of the quad.

Source

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

Returns the second point of the quad.

Source

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

Sets the second point of the quad.

Source

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

Returns the third point of the quad.

Source

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

Sets the third point of the quad.

Source

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

Returns the fourth point of the quad.

Source

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

Sets the fourth point of the quad.

Source

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)
]);
Source

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)
]);
Source

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)
]);
Source§

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

Source

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 >.

Source§

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

Source

pub fn round(&self) -> Self

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

Source

pub fn floor(&self) -> Self

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

Source

pub fn ceil(&self) -> Self

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

Trait Implementations§

Source§

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

Source§

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

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

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

Source§

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

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

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

Source§

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

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

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

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

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

The resulting type after dereferencing.
Source§

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

Dereferences the value.
Source§

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

Source§

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

Mutably dereferences the value.
Source§

impl<'de, T, const N: usize> Deserialize<'de> for Quad<T, N>

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Draw for Quad<i32>

Source§

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

Draw Quad to the current PixState canvas.

Source§

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

Source§

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

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

Source§

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

Source§

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

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

Source§

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

Source§

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

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

Source§

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

Source§

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>.

Source§

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

Source§

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

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

Source§

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

Source§

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

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

Source§

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

Source§

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

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

Source§

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

Source§

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

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

Source§

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

Source§

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

Creates a value from an iterator. Read more
Source§

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

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

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

Source§

type Output = Point<T, N>

The returned type after indexing.
Source§

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

Performs the indexing (container[index]) operation. Read more
Source§

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

Source§

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

Performs the mutable indexing (container[index]) operation. Read more
Source§

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

Source§

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

The type of the elements being iterated over.
Source§

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

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
Source§

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

Source§

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

The type of the elements being iterated over.
Source§

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

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
Source§

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

Source§

type Item = Point<T, N>

The type of the elements being iterated over.
Source§

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

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
Source§

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

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

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

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

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

Source§

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

Source§

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

Auto Trait Implementations§

§

impl<T, const N: usize> Freeze for Quad<T, N>
where T: Freeze,

§

impl<T, const N: usize> RefUnwindSafe for Quad<T, N>
where T: RefUnwindSafe,

§

impl<T, const N: usize> Send for Quad<T, N>
where T: Send,

§

impl<T, const N: usize> Sync for Quad<T, N>
where T: Sync,

§

impl<T, const N: usize> Unpin for Quad<T, N>
where T: Unpin,

§

impl<T, const N: usize> UnwindSafe for Quad<T, N>
where T: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,