Struct truck_polymesh::Faces

pub struct Faces<V = StandardVertex> { /* private fields */ }

Faces of polygon mesh

To optimize for the case where the polygon mesh consists only triangles and quadrangle, there are vectors which consist by each triangles and quadrilaterals, internally.

Implementations

impl<V: Copy> Faces<V>

pub fn extend<U: Copy + Into<V>, T: AsRef<[U]>, I: IntoIterator<Item = T>>( &mut self, iter: I, )

Extends faces by an iterator.

pub const fn from_tri_and_quad_faces( tri_faces: Vec<[V; 3]>, quad_faces: Vec<[V; 4]>, ) -> Self

Creates faces of a polygon mesh by the vectors of triangle and quadrangle.

Examples

// Creates faces consisis only triangles.
use truck_polymesh::*;
let tri_faces: Vec<[StandardVertex; 3]> = vec![
    [[0, 0, 0].into(), [1, 1, 1].into(), [2, 2, 2].into()],
    [[0, 0, 0].into(), [2, 2, 2].into(), [3, 3, 3].into()],
];
let faces = Faces::from_tri_and_quad_faces(tri_faces, Vec::new());

pub fn push<U: Copy + Into<V>, T: AsRef<[U]>>(&mut self, face: T)

Push a face to the faces.

If face.len() < 3, the face is ignored with warning.

Examples

use truck_polymesh::*;
let mut faces = Faces::<StandardVertex>::default(); // empty faces
faces.push(&[[0, 0, 0], [1, 1, 1], [2, 2, 2]]);
faces.push(&[[3, 3, 3], [0, 0, 0], [2, 2, 2]]);
faces.push(&[[0, 0, 0], [4, 4, 4], [5, 5, 5], [1, 1, 1]]);
faces.push(&[[100, 1000, 10]]); // Wargning: ignored one vertex "face"

pub const fn tri_faces(&self) -> &Vec<[V; 3]>

Returns the vector of triangles.

pub fn tri_faces_mut(&mut self) -> &mut [[V; 3]]

Returns the mutable slice of triangles.

pub const fn quad_faces(&self) -> &Vec<[V; 4]>

Returns the vector of quadrangles.

pub fn quad_faces_mut(&mut self) -> &mut [[V; 4]]

Returns the mutable slice of quadrangles.

pub const fn other_faces(&self) -> &Vec<Vec<V>>

Returns the vector of n-gons (n > 4).

pub fn other_faces_mut(&mut self) -> impl Iterator<Item = &mut [V]>

Returns the mutable iterator of n-gons (n > 4).

pub fn face_iter(&self) -> impl Iterator<Item = &[V]>

Returns the iterator of the slice.

By the internal optimization, this iterator does not runs in the simple order in which they are registered, but runs order: triangle, square, and the others.

Examples

use truck_polymesh::*;
let slice: &[&[usize]] = &[
    &[0, 1, 2],
    &[0, 4, 5, 1],
    &[1, 2, 6, 7, 8, 9],
    &[0, 2, 3],
];
let faces = Faces::<usize>::from_iter(slice);
let mut iter = faces.face_iter();
assert_eq!(iter.next(), Some([0, 1, 2].as_ref()));
assert_eq!(iter.next(), Some([0, 2, 3].as_ref()));
assert_eq!(iter.next(), Some([0, 4, 5, 1].as_ref()));
assert_eq!(iter.next(), Some([1, 2, 6, 7, 8, 9].as_ref()));
assert_eq!(iter.next(), None);

pub fn face_iter_mut(&mut self) -> impl Iterator<Item = &mut [V]>

Returns the iterator of the slice.

By the internal optimization, this iterator does not runs in the simple order in which they are registered, but runs order: triangle, square, and the others. cf: Faces:face_iter

pub fn is_empty(&self) -> bool

Returns true if the faces is empty.

pub fn len(&self) -> usize

Returns the number of faces.

pub fn naive_concat(&mut self, other: Self)

Merges other into self.

pub fn triangle_iter(&self) -> TriangleIterator<'_, V>

Returns iterator with triangulation faces

Examples

use truck_polymesh::*;
let slice: &[&[usize]] = &[
    &[0, 1, 2],
    &[0, 4, 5, 1],
    &[1, 2, 6, 7, 8, 9],
    &[1, 2, 4, 3],
    &[0, 2, 3],
];
let faces = Faces::<usize>::from_iter(slice);
let mut iter = faces.triangle_iter();
assert_eq!(iter.len(), 10);
assert_eq!(iter.next(), Some([0, 1, 2]));
assert_eq!(iter.next(), Some([0, 2, 3]));
assert_eq!(iter.next(), Some([0, 4, 5]));
assert_eq!(iter.next(), Some([0, 5, 1]));
assert_eq!(iter.next(), Some([1, 2, 4]));
assert_eq!(iter.next(), Some([1, 4, 3]));
assert_eq!(iter.next(), Some([1, 2, 6]));
assert_eq!(iter.next(), Some([1, 6, 7]));
assert_eq!(iter.next(), Some([1, 7, 8]));
assert_eq!(iter.next(), Some([1, 8, 9]));
assert_eq!(iter.len(), 0);
assert_eq!(iter.next(), None);

Trait Implementations

impl<V: Clone> Clone for Faces<V>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<V: Debug> Debug for Faces<V>

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

Formats the value using the given formatter.

impl<V> Default for Faces<V>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, V> Deserialize<'de> for Faces<V>

where V: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<S: AsRef<[usize]>> FromIterator<S> for Faces<usize>

fn from_iter<I: IntoIterator<Item = S>>(iter: I) -> Faces<usize>

Creates a value from an iterator.

impl<T: AsVertexSlice> FromIterator<T> for Faces

fn from_iter<I: IntoIterator<Item = T>>(iter: I) -> Faces

Creates a value from an iterator.

impl<V> Index<usize> for Faces<V>

type Output = [V]

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for Faces

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

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

impl<V: Copy> Invertible for Faces<V>

fn invert(&mut self)

Inverts self

fn inverse(&self) -> Self

Returns the inverse.

impl<V: PartialEq> PartialEq for Faces<V>

fn eq(&self, other: &Faces<V>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<V> Serialize for Faces<V>

where V: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<V: Eq> Eq for Faces<V>

impl<V> StructuralPartialEq for Faces<V>