Struct plexus::index::Flat

pub struct Flat<T, const N: usize> where
    Constant<N>: ToType,
    TypeOf<N>: NonZero,
    T: Copy + Integer + Unsigned,  { /* private fields */ }

Flat index buffer meta-grouping.

Describes a flat index buffer with a constant arity. The number of vertices in the indexed topological structures is specified using a constant parameter N, which represents the number of grouped elements in the index buffer. For example, Flat<_, 3> describes an index buffer with indices in implicit and contiguous groups of three. Note that this constant may be distinct from the arity of the indexed topological structures (i.e., if N is less than three, then arity is N - 1 and may be zero.).

Unlike structured groupings, this meta-grouping is needed to associate an index type with an implicit grouping and arity. For example, Vec<usize> implements both IndexBuffer<Flat<usize, 3>> (a triangular buffer) and IndexBuffer<Flat<usize, 4>> (a quadrilateral buffer).

See the index module documention for more information about index buffers.

Examples

Creating a MeshBuffer with a flat and triangular index buffer:

use plexus::buffer::MeshBuffer;
use plexus::index::Flat;
use plexus::prelude::*;

let mut buffer = MeshBuffer::<Flat<usize, 3>, (f64, f64, f64)>::default();

Trait Implementations

impl<T: Debug, const N: usize> Debug for Flat<T, N> where
    Constant<N>: ToType,
    TypeOf<N>: NonZero,
    T: Copy + Integer + Unsigned, 

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

Formats the value using the given formatter.

impl<T, const N: usize> Grouping for Flat<T, N> where
    Constant<N>: ToType,
    TypeOf<N>: NonZero,
    T: Copy + Integer + Unsigned, 

type Group = T

The elements of flat index buffers are indices. These indices are implicitly grouped by the arity of the buffer (N).

impl<T, const N: usize> IndexBuffer<Flat<T, N>> for Vec<T> where
    Constant<N>: ToType,
    TypeOf<N>: NonZero,
    T: Copy + Integer + Unsigned, 

type Index = T

The type of individual indices in the buffer.

impl<T, P, const N: usize> Push<Flat<T, N>, P> for Vec<T> where
    Constant<N>: ToType,
    TypeOf<N>: NonZero,
    T: Copy + Integer + Unsigned,
    P: Monomorphic + IntoVertices + Topological<Vertex = T>, 

fn push(&mut self, index: P)

impl<T, const N: usize> StaticArity for Flat<T, N> where
    Constant<N>: ToType,
    TypeOf<N>: NonZero,
    T: Copy + Integer + Unsigned, 

type Static = usize

const ARITY: Self::Static = crate::n_arity(N)

impl<T, const N: usize> Monomorphic for Flat<T, N> where
    Constant<N>: ToType,
    TypeOf<N>: NonZero,
    T: Copy + Integer + Unsigned,