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>,
    pub attribute_value_cache: AttribValueCache,
}

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.

attribute_value_cache: AttribValueCache

Indirect attribute value cache

Implementations

impl<T: Real> PolyMesh<T>

pub fn vertex_connectivity(&self) -> (Vec<usize>, usize)

impl<T: Real> PolyMesh<T>

pub fn merge_with_vertex_source<'a, I>(
    meshes: I,
    source_attrib: &str
) -> Result<Self, Error> where
    I: IntoIterator<Item = &'a Self>, 

Merge a iterator of meshes into a single distinct mesh.

This version of merge accepts an attribute name for the source index on vertices.

The mesh vertices will be merged in the order given by the source attribute. This is useful when merging previously split up meshes. The source attribute needs to have type usize.

If the source attribute does not exist in at least one of the given meshes, then None is returned and the merge is aborted.

This is a non-destructive merge --- both original meshes remain intact. This also means that this way of merging is somewhat more expensive than a merge without any source indices.

impl<T: Real> PolyMesh<T>

pub fn split_vertices_by_face_vertex_attrib<U: PartialOrd + PartialEq + Copy + 'static>(
    &mut self,
    attrib: &str
)

Split vertices by a given face-vertex attribute.

If a pair of face-vertices have different values for the same vertex, then they will be split into distinct vertices. New vertex positions are appended at the end of the vertex position array.

If the given attribute doesn't exist, then nothing is changed.

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 sizes and indices.

The faces array contains the 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]);

pub fn face_iter(&self) -> DynamicIndexSliceIter<'_>

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(mut self: 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> 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 attrib_dict_and_cache_mut<I: AttribIndex<Self>>(
    &mut self
) -> (&mut AttribDict<I>, Option<&mut AttribValueCache>)

Read and write access to the attribute dictionary along with a cache for indirect attribute values.

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

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: AttributeValue + 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: AttributeValue, 

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: AttributeValue + Default, 

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

fn add_indirect_attrib<'a, T, I: AttribIndex<Self>>(
    &mut self,
    name: &'a str,
    def: T
) -> Result<(&mut Attribute<I>, &mut AttribValueCache), Error> where
    T: AttributeValueHash, 

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

fn set_indirect_attrib<'a, T, I: AttribIndex<Self>>(
    &mut self,
    name: &'a str,
    def: T
) -> Result<(&mut Attribute<I>, &mut AttribValueCache), Error> where
    T: AttributeValueHash, 

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

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

Construct an indirect attribute from a given IndirectData. data must have exactly the right size for the attribute to be added successfully.

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

Set an indirect attribute to the given IndirectData instance. 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.

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

Remove an attribute from the attribute dictionary.

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.

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

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: AttributeValue + 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_or_add_indirect<'a, T, I: AttribIndex<Self>>(
    &mut self,
    name: &'a str,
    def: T
) -> Result<(&mut Attribute<I>, &mut AttribValueCache), Error> where
    T: AttributeValueHash, 

Retrieve the indirect 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 direct_attrib_iter<'a, 'b, T, I: 'b + AttribIndex<Self>>(
    &'b self,
    name: &'a str
) -> Result<Iter<'_, T>, Error> where
    T: Any + Clone, 

Get the attribute iterator for a direct attribute.

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

Get the attribute mutable iterator for a direct attribute.

fn attrib_iter<'b, T, I: 'b + AttribIndex<Self>>(
    &'b self,
    name: &str
) -> Result<Box<dyn Iterator<Item = &'b T> + 'b>, Error> where
    T: Any + Clone, 

Get the iterator for an attribute no matter what kind.

fn indirect_attrib_update_with<'a, 'b, T, I, F>(
    &'b mut self,
    name: &'a str,
    f: F
) -> Result<(&'b mut Attribute<I>, &'b mut AttribValueCache), Error> where
    T: AttributeValueHash,
    I: 'b + AttribIndex<Self>,
    F: FnMut(usize, &Irc<T>) -> Option<Irc<T>>, 

Update indirect attribute entries with the given closure.

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<&Attribute<I>, 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 direct 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 direct 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: AttributeValueHash, 

Clone attribute data into a Vec<T>.

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

Clone direct 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: Clone + Real> Clone for PolyMesh<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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> 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: Real> FaceAttrib for PolyMesh<T>

fn topo_attrib_size(&self) -> usize

Mesh implementation of the attribute size getter.

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

Mesh implementation of the attribute dictionary getter.

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

Mesh implementation of the attribute dictionary mutable getter.

fn topo_attrib_dict_and_cache_mut(
    &mut self
) -> (&mut AttribDict<FaceIndex>, Option<&mut AttribValueCache>)

Mesh implementation of the attribute dictionary and cache mutable getter.

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

fn edge<FEI>(&self, fe_idx: FEI) -> EdgeIndex where
    FEI: Copy + Into<FaceEdgeIndex>, 

Index of the destination element given the topology index.

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.

fn face_to_edge<I>(&self, i: I, k: usize) -> Option<EdgeIndex> where
    I: Copy + Into<FaceIndex>, 

Index of the destination element from the source index.

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

fn topo_attrib_size(&self) -> usize

Mesh implementation of the attribute size getter.

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

Mesh implementation of the attribute dictionary getter.

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

Mesh implementation of the attribute dictionary mutable getter.

fn topo_attrib_dict_and_cache_mut(
    &mut self
) -> (&mut AttribDict<FaceEdgeIndex>, Option<&mut AttribValueCache>)

Mesh implementation of the attribute dictionary and cache mutable getter.

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

fn vertex<FVI>(&self, fv_idx: FVI) -> VertexIndex where
    FVI: Copy + Into<FaceVertexIndex>, 

Index of the destination element given the topology index.

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 face_to_vertex<I>(&self, i: I, k: usize) -> Option<VertexIndex> where
    I: Copy + Into<FaceIndex>, 

Index of the destination element from the source index.

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

Generate the reverse topology structure.

fn reverse_source_topo(&self) -> (Vec<usize>, Vec<usize>) where
    Self: NumVertices, 

Generate the reverse topology structure from the destination element to the source topology element.

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

fn topo_attrib_size(&self) -> usize

Mesh implementation of the attribute size getter.

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

Mesh implementation of the attribute dictionary getter.

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

Mesh implementation of the attribute dictionary mutable getter.

fn topo_attrib_dict_and_cache_mut(
    &mut self
) -> (&mut AttribDict<FaceVertexIndex>, Option<&mut AttribValueCache>)

Mesh implementation of the attribute dictionary and cache mutable getter.

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<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<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: 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<TetMesh<T>> for PolyMesh<T>

fn from(tetmesh: TetMesh<T>) -> PolyMesh<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> 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_iter(iterable: impl IntoIterator<Item = Self>) -> Self where
    Self: Default, 

Merge an iterator of objects into one of the same type.

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

Merge a Vec of objects 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> NumFaces for PolyMesh<T>

fn num_faces(&self) -> usize

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

fn num_vertices(&self) -> usize

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: Real> Split<VertexIndex> for PolyMesh<T>

fn split(self, vertex_partition: &[usize], num_parts: usize) -> Vec<Self>

impl<T: Real> SplitIntoConnectedComponents<VertexIndex, FaceIndex> for PolyMesh<T>

fn split_into_connected_components(self) -> Vec<Self>

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

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

fn topo_attrib_size(&self) -> usize

Mesh implementation of the attribute size getter.

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

Mesh implementation of the attribute dictionary getter.

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

Mesh implementation of the attribute dictionary mutable getter.

fn topo_attrib_dict_and_cache_mut(
    &mut self
) -> (&mut AttribDict<VertexIndex>, Option<&mut AttribValueCache>)

Mesh implementation of the attribute dictionary and cache mutable getter.

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.