Struct gut::mesh::polymesh::PolyMesh

pub struct PolyMesh<T: Real> {
    pub vertex_positions: IntrinsicAttribute<[T; 3], VertexIndex>,
    pub indices: Vec<usize>,
    pub offsets: Vec<usize>,
    pub vertex_attributes: AttribDict<VertexIndex>,
    pub face_attributes: AttribDict<FaceIndex>,
    pub face_vertex_attributes: AttribDict<FaceVertexIndex>,
    pub face_edge_attributes: AttribDict<FaceEdgeIndex>,
}

Mesh with arbitrarily shaped faces. It could have polygons with any number of sides. All faces are assumed to be closed polygons.

Fields

vertex_positions: IntrinsicAttribute<[T; 3], VertexIndex>

Vertex positions intrinsic attribute.

indices: Vec<usize>

Indices into vertices representing face vertices.

offsets: Vec<usize>

Offsets into indices representing individual faces. The last element in this Vec is always the length of indices for convenience.

vertex_attributes: AttribDict<VertexIndex>

Vertex attributes.

face_attributes: AttribDict<FaceIndex>

Polygon attributes.

face_vertex_attributes: AttribDict<FaceVertexIndex>

Polygon vertex attributes.

face_edge_attributes: AttribDict<FaceEdgeIndex>

Polygon edge attributes.

Methods

impl<T: Real> PolyMesh<T>

pub fn new(verts: Vec<[T; 3]>, faces: &[usize]) -> PolyMesh<T>

Construct a PolyMesh from an array of vertices and an array of indices marking the vertex indices into the vertex array for each face preceeded by the number of vertices in the corresponding face. I.e. faces is expected to be structured as a contiguous array of a number (corresponding to the number of vertices in the face) followed by the vertex indices (in the same face): n i_1 i_2 ... i_n m j_1 j_2 ... j_m ...

Examples

    use gut::mesh::PolyMesh;
    let points = vec![
        [0.0, 0.0, 0.0],
        [1.0, 0.0, 0.0],
        [0.0, 1.0, 0.0],
        [1.0, 1.0, 0.0],
        [0.0, 0.0, 1.0],
        [1.0, 0.0, 1.0]];
    let faces = vec![3, 0, 1, 2, // first triangle
                     3, 1, 3, 2, // second triangle
                     4, 0, 1, 5, 4]; // quadrilateral

    let polymesh = PolyMesh::new(points, &faces);

    assert_eq!(polymesh.indices, [0, 1, 2, 1, 3, 2, 0, 1, 5, 4]);
    assert_eq!(polymesh.offsets, [0, 3, 6, 10]);

Important traits for DynamicIndexSliceIter<'a>

impl<'a> Iterator for DynamicIndexSliceIter<'a> type Item = &'a [usize];

pub fn face_iter(&self) -> DynamicIndexSliceIter

Important traits for DynamicIndexSliceIterMut<'a>

impl<'a> Iterator for DynamicIndexSliceIterMut<'a> type Item = &'a mut [usize];

pub fn face_iter_mut(&mut self) -> DynamicIndexSliceIterMut

pub fn reverse(&mut self)

Reverse the order of each polygon in this mesh.

pub fn reversed(self) -> PolyMesh<T>

Reverse the order of each polygon in this mesh. This is the consuming version of the reverse method.

Trait Implementations

impl<T: Real> SplitIntoConnectedComponents<VertexFaceIndex> for PolyMesh<T>

fn split_into_connected_components(self) -> Vec<Self>

impl<T: Real> Merge for PolyMesh<T>

fn merge(&mut self, other: Self) -> &mut Self

Attributes with the same name but different types won't be merged.

fn merge_vec(vec: Vec<Self>) -> Self where
    Self: Default, 

Merge a Vec of objecs into one of the same type.

fn merge_slice(slice: &[Self]) -> Self where
    Self: Clone + Default, 

In contrast to merge_vec, this function takes an immutable reference to a collection of meshes, and creates a brand new mesh that is a union of all the given meshes.

impl<T: Real> NumVertices for PolyMesh<T>

fn num_vertices(&self) -> usize

impl<T: Real> NumFaces for PolyMesh<T>

fn num_faces(&self) -> usize

impl<T: Real> Attrib for PolyMesh<T>

fn attrib_size<I: AttribIndex<Self>>(&self) -> usize

Get the size of the attribute at the appropriate mesh location determined by I.

fn attrib_dict<I: AttribIndex<Self>>(&self) -> &AttribDict<I>

Read only access to the attribute dictionary.

fn attrib_dict_mut<I: AttribIndex<Self>>(&mut self) -> &mut AttribDict<I>

Read and write access to the attribute dictionary.

fn add_attrib<'a, T, I: AttribIndex<Self>>(
    &mut self,
    name: &'a str,
    def: T
) -> Result<&mut Attribute<I>, Error> where
    T: Any + Clone, 

Add an attribute at the appropriate location with a given default.

fn add_attrib_data<'a, T, I: AttribIndex<Self>>(
    &mut self,
    name: &'a str,
    data: Vec<T>
) -> Result<&mut Attribute<I>, Error> where
    T: Any + Clone + Default, 

Construct an attribute from a given data Vec<T>. data must have exactly the right size for the attribute to be added successfully.

fn set_attrib<'a, T, I: AttribIndex<Self>>(
    &mut self,
    name: &'a str,
    def: T
) -> Result<&mut Attribute<I>, Error> where
    T: Any + Clone, 

Sets the attribute to the specified default value whether or not it already exists.

fn set_attrib_data<'a, T, I: AttribIndex<Self>>(
    &mut self,
    name: &'a str,
    data: &[T]
) -> Result<&mut Attribute<I>, Error> where
    T: Any + Clone + Default, 

Set an attribute to the given data slice. data must have exactly the right size for the attribute to be set successfully.

fn duplicate_attrib<'a, 'b, T, I: AttribIndex<Self>>(
    &mut self,
    name: &'a str,
    new_name: &'b str
) -> Result<&mut Attribute<I>, Error> where
    T: Any + Clone, 

Makes a copy of an existing attribute. Return a mutable reference to the new attribute if successful.

fn remove_attrib<'a, I: AttribIndex<Self>>(
    &mut self,
    name: &'a str
) -> Result<Attribute<I>, Error>

Remove an attribute from the attribute dictionary. From there you can use methods defined on the returned attribute, and if desired return it back to the dictionary with insert_attrib.

fn insert_attrib<'a, I: AttribIndex<Self>>(
    &mut self,
    name: &'a str,
    attrib: Attribute<I>
) -> Result<Option<Attribute<I>>, Error>

Inserts an attribute into the dictionary with the usual HashMap semantics. This means that if an attribute with the same name exists, it will be returned and the current table entry is updated with the new value. If it doesn't already exist, None is returned.

fn attrib_or_add<'a, T, I: AttribIndex<Self>>(
    &mut self,
    name: &'a str,
    def: T
) -> Result<&mut Attribute<I>, Error> where
    T: Any + Clone, 

Retrieve the attribute with the given name and if it doesn't exist, add a new one and set it to a given default value. In either case the mutable reference to the attribute is returned.

fn attrib_or_add_data<'a, T, I: AttribIndex<Self>>(
    &mut self,
    name: &'a str,
    data: &[T]
) -> Result<&mut Attribute<I>, Error> where
    T: Any + Clone + Default, 

Retrieve the attribute with the given name and if it doesn't exist, set its data to what's in the given slice. In either case the mutable reference to the attribute is returned.

fn attrib_iter<'a, 'b, T, I: 'b + AttribIndex<Self>>(
    &'b self,
    name: &'a str
) -> Result<Iter<T>, Error> where
    T: 'static + Clone, 

Get the attribute iterator. This is essentially a safe version of attrib(loc, name).unwrap().iter::<T>().

fn attrib_iter_mut<'a, 'b, T, I: 'b + AttribIndex<Self>>(
    &'b mut self,
    name: &'a str
) -> Result<IterMut<T>, Error> where
    T: 'static + Clone, 

Get the attribute mutable iterator. This is essentially a safe version of attrib_mut(name).unwrap().iter_mut::<T>().

fn attrib_exists<'a, I: AttribIndex<Self>>(&self, name: &'a str) -> bool

Return true if the given attribute exists at the given location, and false otherwise, even if the specified attribute location is invalid for the mesh.

fn attrib_check<'a, T: Any, I: AttribIndex<Self>>(
    &self,
    name: &'a str
) -> Result<(), Error>

Determine if the given attribute is valid and exists at the given location.

fn attrib_as_slice<'a, 'b, T: 'static, I: 'b + AttribIndex<Self>>(
    &'b self,
    name: &'a str
) -> Result<&'b [T], Error>

Expose the underlying attribute as a slice.

fn attrib_as_mut_slice<'a, 'b, T: 'static, I: 'b + AttribIndex<Self>>(
    &'b mut self,
    name: &'a str
) -> Result<&'b mut [T], Error>

Expose the underlying attribute as a mutable slice.

fn attrib_clone_into_vec<'a, 'b, T, I: 'b + AttribIndex<Self>>(
    &'b self,
    name: &'a str
) -> Result<Vec<T>, Error> where
    T: 'static + Clone, 

Clone attribute data into a Vec<T>.

fn attrib<'a, I: AttribIndex<Self>>(
    &self,
    name: &'a str
) -> Result<&Attribute<I>, Error>

Borrow the raw attribute from the attribute dictionary. From there you can use methods defined on the attribute itself.

fn attrib_mut<'a, I: AttribIndex<Self>>(
    &mut self,
    name: &'a str
) -> Result<&mut Attribute<I>, Error>

Get the raw mutable attribute from the attribute dictionary. From there you can use methods defined on the attribute itself.

impl<T: Real> VertexPositions for PolyMesh<T>

type Element = [T; 3]

fn vertex_positions(&self) -> &[Self::Element]

Vertex positions as a slice of triplets.

fn vertex_positions_mut(&mut self) -> &mut [Self::Element]

Vertex positions as a mutable slice of triplets.

fn vertex_position_iter(&self) -> Iter<Self::Element>

Vertex iterator.

fn vertex_position_iter_mut(&mut self) -> IterMut<Self::Element>

Mutable vertex iterator.

fn vertex_position<VI>(&self, vidx: VI) -> Self::Element where
    VI: Into<VertexIndex>, 

Vertex accessor.

impl<T: Real> FaceVertex for PolyMesh<T>

fn face_to_vertex<FI>(&self, fidx: FI, which: usize) -> Option<VertexIndex> where
    FI: Copy + Into<FaceIndex>, 

Given the index of a polygonal face fidx, return the index of the vertex the whichth vertex within the face.

fn face_vertex<FI>(&self, fidx: FI, which: usize) -> Option<FaceVertexIndex> where
    FI: Copy + Into<FaceIndex>, 

Toplogy index: where the data lives in an attribute array.

fn num_face_vertices(&self) -> usize

Topology quantifier. Number of connectors in total.

fn num_vertices_at_face<FI>(&self, fidx: FI) -> usize where
    FI: Copy + Into<FaceIndex>, 

Topology quantifier. Number of connectors at a particular element.

fn reverse_topo(&self) -> (Vec<usize>, Vec<usize>) where
    Self: NumFaces + NumVertices, 

Generate the reverse topology structure.

impl<T: Real> FaceEdge for PolyMesh<T>

fn face_to_edge<FI>(&self, fidx: FI, which: usize) -> Option<EdgeIndex> where
    FI: Copy + Into<FaceIndex>, 

Index of the destination element.

fn face_edge<FI>(&self, fidx: FI, which: usize) -> Option<FaceEdgeIndex> where
    FI: Copy + Into<FaceIndex>, 

Toplogy index: where the data lives in an attribute array.

fn num_face_edges(&self) -> usize

Topology quantifier. Number of connectors in total.

fn num_edges_at_face<FI>(&self, fidx: FI) -> usize where
    FI: Copy + Into<FaceIndex>, 

Topology quantifier. Number of connectors at a particular element.

impl<T: Real> VertexAttrib for PolyMesh<T>

fn impl_attrib_size(&self) -> usize

Mesh implementation of the attribute size getter.

fn impl_attrib_dict(&self) -> &AttribDict<VertexIndex>

Mesh implementation of the attribute dictionary getter.

fn impl_attrib_dict_mut(&mut self) -> &mut AttribDict<VertexIndex>

Mesh implementation of the attribute dictionary mutable getter.

impl<T: Real> FaceAttrib for PolyMesh<T>

fn impl_attrib_size(&self) -> usize

Mesh implementation of the attribute size getter.

fn impl_attrib_dict(&self) -> &AttribDict<FaceIndex>

Mesh implementation of the attribute dictionary getter.

fn impl_attrib_dict_mut(&mut self) -> &mut AttribDict<FaceIndex>

Mesh implementation of the attribute dictionary mutable getter.

impl<T: Real> FaceVertexAttrib for PolyMesh<T>

fn impl_attrib_size(&self) -> usize

Mesh implementation of the attribute size getter.

fn impl_attrib_dict(&self) -> &AttribDict<FaceVertexIndex>

Mesh implementation of the attribute dictionary getter.

fn impl_attrib_dict_mut(&mut self) -> &mut AttribDict<FaceVertexIndex>

Mesh implementation of the attribute dictionary mutable getter.

impl<T: Real> FaceEdgeAttrib for PolyMesh<T>

fn impl_attrib_size(&self) -> usize

Mesh implementation of the attribute size getter.

fn impl_attrib_dict(&self) -> &AttribDict<FaceEdgeIndex>

Mesh implementation of the attribute dictionary getter.

fn impl_attrib_dict_mut(&mut self) -> &mut AttribDict<FaceEdgeIndex>

Mesh implementation of the attribute dictionary mutable getter.

impl<T: Real> From<PolyMesh<T>> for PointCloud<T>

Convert a polygon mesh to a point cloud by erasing all polygon data.

fn from(polymesh: PolyMesh<T>) -> PointCloud<T>

Performs the conversion.

impl<T: Real> From<TriMesh<T>> for PolyMesh<T>

Convert a triangle mesh into a polygon mesh.

fn from(mesh: TriMesh<T>) -> PolyMesh<T>

Performs the conversion.

impl<T: Real> From<QuadMesh<T>> for PolyMesh<T>

Convert a quad mesh into a polygon mesh.

fn from(mesh: QuadMesh<T>) -> PolyMesh<T>

Performs the conversion.

impl<T: Real> From<PointCloud<T>> for PolyMesh<T>

Convert a point cloud into a polygon mesh.

fn from(mesh: PointCloud<T>) -> PolyMesh<T>

Performs the conversion.

impl<T: Real> From<TetMesh<T>> for PolyMesh<T>

fn from(tetmesh: TetMesh<T>) -> PolyMesh<T>

Performs the conversion.

impl<T: Real> From<PolyMesh<T>> for TriMeshExt<T>

Convert a triangle mesh to a polygon mesh.

fn from(mesh: PolyMesh<T>) -> TriMeshExt<T>

Performs the conversion.

impl<T: Real> From<PolyMesh<T>> for TriMesh<T>

Convert a triangle mesh to a polygon mesh.

fn from(mesh: PolyMesh<T>) -> TriMesh<T>

Performs the conversion.

impl<T: Clone + Real> Clone for PolyMesh<T>

fn clone(&self) -> PolyMesh<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Real> Default for PolyMesh<T>

fn default() -> Self

Produce an empty mesh. This is not particularly useful on its own, however it can be used as a null case for various mesh algorithms.

impl<T: PartialEq + Real> PartialEq<PolyMesh<T>> for PolyMesh<T>

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

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

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

This method tests for !=.

impl<T: Debug + Real> Debug for PolyMesh<T>

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

Formats the value using the given formatter.

impl<T: Real> StructuralPartialEq for PolyMesh<T>