Struct nannou::prelude::geom::quad::Quad

pub struct Quad<V = Vec3>(pub [V; 4]);

A quad represented by its four vertices.

Tuple Fields

0: [V; 4]

Implementations

impl<V> Quad<V>

where V: Vertex,

pub fn vertices(self) -> Vertices<V>

Produce an iterator yielding each vertex in the Quad.

pub fn centroid(&self) -> V

where V: Average,

Produce the centroid of the quad, aka the “mean”/“average” vertex.

pub fn triangles(&self) -> (Tri<V>, Tri<V>)

Triangulates the given quad, represented by four points that describe its edges in either clockwise or anti-clockwise order.

Example

The following rectangle

 a        b
  --------
  |      |
  |      |
  |      |
  --------
 d        c

given as

triangles([a, b, c, d])

returns

(Tri([a, b, c]), Tri([a, c, d]))

Here’s a basic code example:

use nannou::geom::{self, pt2, Quad, Tri};

fn main() {
    let a = pt2(0.0, 1.0);
    let b = pt2(1.0, 1.0);
    let c = pt2(1.0, 0.0);
    let d = pt2(0.0, 0.0);
    let quad = Quad([a, b, c, d]);
    let triangles = geom::quad::triangles(&quad);
    assert_eq!(triangles, (Tri([a, b, c]), Tri([a, c, d])));
}

pub fn triangles_iter(&self) -> Triangles<V>

The same as triangles but provided as an Iterator.

pub fn bounding_rect(self) -> Rect<<V as Vertex>::Scalar>

where V: Vertex2d,

The bounding Rect of the quad.

pub fn bounding_cuboid(self) -> Cuboid<<V as Vertex>::Scalar>

where V: Vertex3d,

The bounding Rect of the triangle.

pub fn map_vertices<F, V2>(self, map: F) -> Quad<V2>

where F: FnMut(V) -> V2,

Map the Quad’s vertices to a new type.

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

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.

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

Returns a slice containing the entire array. Equivalent to &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 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 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]);
}

Trait Implementations

impl<V> AsRef<[V; 4]> for Quad<V>

where V: Vertex,

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

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

impl<V> AsRef<Quad<V>> for Quad<V>

where V: Vertex,

fn as_ref(&self) -> &Quad<V>

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

impl<V> Clone for Quad<V>

where V: Clone,

fn clone(&self) -> Quad<V>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<V> Debug for Quad<V>

where V: Debug,

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

Formats the value using the given formatter.

impl<V> Deref for Quad<V>

type Target = [V; 4]

The resulting type after dereferencing.

fn deref(&self) -> &<Quad<V> as Deref>::Target

Dereferences the value.

impl<V> From<[V; 4]> for Quad<V>

where V: Vertex,

fn from(points: [V; 4]) -> Quad<V>

Converts to this type from the input type.

impl<V> From<(V, V, V, V)> for Quad<V>

where V: Vertex,

fn from(_: (V, V, V, V)) -> Quad<V>

Converts to this type from the input type.

impl From<Quad<Vec2>> for Quad

fn from(quad: Quad<Point2>) -> Self

Converts to this type from the input type.

impl<V> Hash for Quad<V>

where V: Hash,

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

where __H: Hasher,

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<V> Index<usize> for Quad<V>

where V: Vertex,

type Output = V

The returned type after indexing.

fn index(&self, index: usize) -> &<Quad<V> as Index<usize>>::Output

Performs the indexing (container[index]) operation.

impl<V> Into<[V; 4]> for Quad<V>

where V: Vertex,

fn into(self) -> [V; 4]

Converts this type into the (usually inferred) input type.

impl<V> Into<(V, V, V, V)> for Quad<V>

where V: Vertex,

fn into(self) -> (V, V, V, V)

Converts this type into the (usually inferred) input type.

impl<V> PartialEq for Quad<V>

where V: PartialEq,

fn eq(&self, other: &Quad<V>) -> 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<V> Copy for Quad<V>

where V: Copy,

impl<V> Eq for Quad<V>

where V: Eq,

impl<V> StructuralEq for Quad<V>

impl<V> StructuralPartialEq for Quad<V>