Struct pix_engine::shape::Tri

#[repr(transparent)]
pub struct Tri<T, const N: usize>(_);

A Triangle with three Points.

Please see the module-level documentation for examples.

Implementations

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

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

Constructs a Triangle with the given Points.

Example

let tri = Tri::new([10, 20], [30, 10], [20, 25]);
assert_eq!(tri.p1().as_array(), [10, 20]);
assert_eq!(tri.p2().as_array(), [30, 10]);
assert_eq!(tri.p3().as_array(), [20, 25]);

impl<T> Tri<T, 2>

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

Constructs a Triangle from individual x/y coordinates.

impl<T> Tri<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
) -> Self

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

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

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

Returns the first point of the triangle.

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

Sets the first point of the triangle.

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

Returns the second point of the triangle.

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

Sets the second point of the triangle.

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

Returns the third point of the triangle.

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

Sets the third point of the triangle.

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

Returns Triangle points as [Point<T, N>; 3].

Example

let tri = Tri::new([10, 20], [30, 10], [20, 25]);
assert_eq!(tri.as_array(), [
    point!(10, 20),
    point!(30, 10),
    point!(20, 25),
]);

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

Returns Triangle points as a byte slice &[Point<T, N>; 3].

Example

let tri = Tri::new([10, 20], [30, 10], [20, 25]);
assert_eq!(tri.as_bytes(), &[
    point!(10, 20),
    point!(30, 10),
    point!(20, 25),
]);

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

Returns Triangle points as a mutable byte slice &mut [Point<T, N>; 3].

Example

let mut tri = Tri::new([10, 20], [30, 10], [20, 25]);
for p in tri.as_bytes_mut() {
    *p += 5;
}
assert_eq!(tri.as_bytes(), &[
    point!(15, 25),
    point!(35, 15),
    point!(25, 30),
]);

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

Returns Triangle as a Vec.

Example

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

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

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

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

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

pub fn round(&self) -> Self

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

pub fn floor(&self) -> Self

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

pub fn ceil(&self) -> Self

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

Trait Implementations

impl<T, const N: usize> AsMut<[Point<T, N>; 3]> for Tri<T, N>

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

Performs the conversion.

impl<T, const N: usize> AsRef<[Point<T, N>; 3]> for Tri<T, N>

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

Performs the conversion.

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

fn clone(&self) -> Tri<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 Tri<T, N>

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

Formats the value using the given formatter.

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

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

The resulting type after dereferencing.

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

Dereferences the value.

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

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

Mutably dereferences the value.

impl<'de, T, const N: usize> Deserialize<'de> for Tri<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<T: Copy, const N: usize> From<&'_ [Point<T, N>; 3]> for Tri<T, N>

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

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

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

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

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

impl<T: Copy> From<[[T; 2]; 3]> for Tri<T, 2>

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

Converts [[T; 2]; 3] into Tri<T, 2>.

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

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

Converts [[T; 3]; 3] into Tri<T, 3>.

impl<T, const N: usize> From<[Point<T, N>; 3]> for Tri<T, N>

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

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

impl<T: Copy> From<[T; 6]> for Tri<T, 2>

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

Converts [T; 6] into Tri<T, 2>.

impl<T: Copy> From<[T; 9]> for Tri<T, 3>

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

Converts [T; 9] into Tri<T, 3>.

impl<T, const N: usize> From<Tri<T, N>> for [Point<T, N>; 3]

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

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

impl<T: Default, const N: usize> FromIterator<Point<T, N>> for Tri<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 Tri<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 Tri<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 Tri<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 Tri<T, N>

type Item = Point<T, N>

The type of the elements being iterated over.

type IntoIter = IntoIter<Self::Item, 3>

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 Tri<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 Tri<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<Tri<T, N>> for Tri<T, N>

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

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

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

This method tests for !=.

impl<T, const N: usize> Serialize for Tri<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 Tri<T, N>

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

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

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