Struct HalfEdgeMesh 

pub struct HalfEdgeMesh<C: Config = PolyConfig> { /* private fields */ }

Implementation of the half edge mesh. This data structure is widely used in geometry processing due to its many capabilities paired with fairly good speed and memory consumption.

This data structure allows you to represent polygon meshes where each face can have differently many vertices. (However, you can restrict this mesh to triangle meshes via the configuration.) Furthermore, it can answer all adjacency queries and exposes full edges.

The half edge mesh is a half-edge based data structure, with most of the connectivity stored per half edge. Each face and vertex just store one arbitrary half edge handle. This diagram illustrates the fields stored per half edge. (Not shown in the diagram: each half edge also stores the handle of its face.)

References

Introduced in: Mäntylä, Martti. An introduction to solid modeling. Computer science press, 1988.

Trait Implementations

impl<C: Config> BasicAdj for HalfEdgeMesh<C>

type VerticesAroundFaceIter<'s> = FaceToVertexIter<'s, C>

fn vertices_around_triangle(&self, face: FaceHandle) -> [VertexHandle; 3]

where Self: TriMesh,

Returns the vertices of the given triangular face in front-face CCW order.

fn vertices_around_face( &self, face: FaceHandle, ) -> Self::VerticesAroundFaceIter<'_>

Returns the vertices around the given face in front-face CCW order.

fn is_vertex_around_face(&self, vertex: VertexHandle, face: FaceHandle) -> bool

Checks whether the given vertex is adjacent to the given face.

impl<C: Config> Clone for HalfEdgeMesh<C>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<C: Config> Debug for HalfEdgeMesh<C>

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

Formats the value using the given formatter.

impl<C: Config> EdgeAdj for HalfEdgeMesh<C>

type EdgesAroundVertexIter<'s> = VertexToEdgeIter<'s, C>

Iterator for Self::edges_around_vertex.

type EdgesAroundFaceIter<'s> = FaceToEdgeIter<'s, C>

Iterator for Self::edges_around_vertex.

fn endpoints_of_edge(&self, edge: EdgeHandle) -> [VertexHandle; 2]

Returns the (up to) two endpoints of a given edge.

fn faces_of_edge(&self, edge: EdgeHandle) -> DiList<FaceHandle>

Returns the (up to) two faces of the given edge.

fn edges_around_vertex( &self, vertex: VertexHandle, ) -> Self::EdgesAroundVertexIter<'_>

Returns all edges around the given vertex.

fn edges_around_face(&self, face: FaceHandle) -> Self::EdgesAroundFaceIter<'_>

Returns all edges around/of the given face.

fn edges_around_triangle(&self, face: FaceHandle) -> [EdgeHandle; 3]

where Self: TriMesh,

Returns all three edges around/of the given triangular face.

fn is_boundary_edge(&self, edge: EdgeHandle) -> bool

Returns true iff the edge is a boundary edge, i.e. if it has fewer than 2 adjacent faces.

fn edge_between_vertices( &self, a: VertexHandle, b: VertexHandle, ) -> Option<EdgeHandle>

Returns the edge connecting the two given vertices, or None if the two vertices are not connected.

impl<C: Config> Empty for HalfEdgeMesh<C>

fn empty() -> Self

Returns an empty value of this type.

impl<C: Config> FullAdj for HalfEdgeMesh<C>

type FacesAroundFaceIter<'s> = FaceToFaceIter<'s, C>

type FacesAroundVertexIter<'s> = VertexToFaceIter<'s, C>

Iterator for Self::faces_around_vertex.

type VerticesAroundVertexIter<'s> = VertexToVertexIter<'s, C>

Iterator for Self::vertices_around_vertex.

fn faces_around_triangle(&self, face: FaceHandle) -> TriList<FaceHandle>

where Self: TriMesh,

Returns the faces around the given triangular face in front-face CCW order.

fn faces_around_face(&self, face: FaceHandle) -> Self::FacesAroundFaceIter<'_>

Returns the faces around the given face in front-face CCW order.

fn faces_around_vertex( &self, vh: VertexHandle, ) -> Self::FacesAroundVertexIter<'_>

Returns a list of all faces adjacent to the given vertex.

fn vertices_around_vertex( &self, vh: VertexHandle, ) -> Self::VerticesAroundVertexIter<'_>

Returns a list of all faces adjacent to the given vertex.

fn is_boundary_face(&self, face: FaceHandle) -> bool

Checks if the given face lies on a boundary. A face is a boundary face if the number of adjacent faces does not match the number of adjacent vertices.

fn is_boundary_vertex(&self, vertex: VertexHandle) -> bool

Checks if the given vertex lies on a boundary. A vertex is a boundary vertex if the number of adjacent faces does not match the number of adjacent vertices or if it is an isolated vertex.

fn is_isolated_vertex(&self, vertex: VertexHandle) -> bool

Checks if the given vertex is isolated, meaning that it has no adjacent faces, edges or vertices.

fn are_faces_adjacent(&self, a: FaceHandle, b: FaceHandle) -> bool

Checks whether the two given faces share an edge (are “adjacent” to one another).

fn are_vertices_adjacent(&self, a: VertexHandle, b: VertexHandle) -> bool

Checks whether the two given faces share an edge (are “adjacent” to one another).

impl<C: Config> Mesh for HalfEdgeMesh<C>

type FaceKind = <C as Config>::FaceKind

The kind of faces this mesh type can store. Either TriFaces or PolyFaces.

type Orientable = True

Denotes whether this mesh is always orientable or potentially non-orientable.

fn num_vertices(&self) -> hsize

Returns the number of vertices in this mesh.

fn next_vertex_handle_from(&self, start: VertexHandle) -> Option<VertexHandle>

Returns the next handle of an existing vertex with an index ≥ start’s index, or None if there is no such handle.

fn next_face_handle_from(&self, start: FaceHandle) -> Option<FaceHandle>

Returns the next handle of an existing face with an index ≥ start’s index, or None if there is no such handle.

fn last_vertex_handle(&self) -> Option<VertexHandle>

Returns the vertex handle for an existing vertex with the highest index, or None if there are no vertices in the mesh.

fn last_face_handle(&self) -> Option<FaceHandle>

Returns the face handle for an existing face with the highest index, or None if there are no vertices in the mesh.

fn contains_vertex(&self, vertex: VertexHandle) -> bool

Checks if the given vertex handle refers to a valid vertex of this mesh.

fn num_faces(&self) -> hsize

Returns the number of faces in this mesh.

fn contains_face(&self, face: FaceHandle) -> bool

Checks if the given face handle refers to a valid face of this mesh.

fn num_edges(&self) -> hsize

where Self: EdgeMesh,

Returns the number of edges in this mesh.

fn next_edge_handle_from(&self, start: EdgeHandle) -> Option<EdgeHandle>

where Self: EdgeMesh,

Returns the next handle of an existing edge with an index ≥ start’s index, or None if there is no such handle.

fn last_edge_handle(&self) -> Option<EdgeHandle>

where Self: EdgeMesh,

Returns the edge handle for an existing edge with the highest index, or None if there are no vertices in the mesh.

fn contains_edge(&self, edge: EdgeHandle) -> bool

where Self: EdgeMesh,

Checks if the given edge handle refers to a valid edge of this mesh.

fn check_integrity(&self)

Performs a number of integrity checks on internal data and panics if something is broken.

fn get_ref<H: Handle>(&self, handle: H) -> ElementRef<'_, H, Self>

Returns an ElementRef with the given handle referencing this mesh.

fn vertex_handles(&self) -> HandleIter<'_, Self, VertexHandle>

Returns an iterator over the handles of all vertices in this mesh.

fn vertex_handles_mut(&mut self) -> HandleIterMut<'_, Self, VertexHandle>

Returns an iterator over the handles of all vertices which can return a mutable reference to the mesh. This is useful when it is necessary to mutate the mesh while iterating.

fn vertices(&self) -> ElementRefIter<'_, Self, VertexHandle>

Returns an iterator over all vertices in this mesh.

fn face_handles(&self) -> HandleIter<'_, Self, FaceHandle>

Returns an iterator over the handles of all faces in this mesh.

fn face_handles_mut(&mut self) -> HandleIterMut<'_, Self, FaceHandle>

Returns an iterator over the handles of all faces which can return a mutable reference to the mesh. This is useful when it is necessary to mutate the mesh while iterating.

fn faces(&self) -> ElementRefIter<'_, Self, FaceHandle>

Returns an iterator over all faces in this mesh.

fn edge_handles(&self) -> HandleIter<'_, Self, EdgeHandle>

where Self: EdgeMesh,

Returns an iterator over the handles of all edges in this mesh.

fn edge_handles_mut(&mut self) -> HandleIterMut<'_, Self, EdgeHandle>

where Self: EdgeMesh,

Returns an iterator over the handles of all edges which can return a mutable reference to the mesh. This is useful when it is necessary to mutate the mesh while iterating.

fn edges(&self) -> ElementRefIter<'_, Self, EdgeHandle>

where Self: EdgeMesh,

Returns an iterator over all edges in this mesh.

fn is_tri_mesh(&self) -> bool

Returns true if Self is a TriMesh, meaning that all faces are triangles. If false is returned, that means that you can’t assume all faces are triangles, but it could still be the case.

impl<C: Config> MeshMut for HalfEdgeMesh<C>

fn add_vertex(&mut self) -> VertexHandle

Adds a new, unconnected vertex to the mesh and returns the handle representing that vertex.

fn add_triangle(&mut self, [a, b, c]: [VertexHandle; 3]) -> FaceHandle

Adds a new triangular face (defined by the three vertices in CCW order) to this mesh and returns the handle representing that face.

fn add_face(&mut self, vertices: &[VertexHandle]) -> FaceHandle

where Self: PolyMesh,

Adds a new face to this mesh and returns the handle representing that face.

fn remove_isolated_vertex(&mut self, v: VertexHandle)

Removes the given isolated vertex from the mesh. You have to make sure that the given vertex is indeed isolated!

fn remove_face(&mut self, f: FaceHandle)

Removes the given face and all of its boundary edges. Will not remove any vertices.

fn reserve_for_vertices(&mut self, count: hsize)

Reserves memory for count additional vertices.

fn reserve_for_faces(&mut self, count: hsize)

Reserves memory for count additional faces.

fn remove_all_vertices(&mut self)

Removes all vertices of this mesh.

fn remove_all_faces(&mut self)

Removes all faces of this mesh. This can be more efficient than calling remove_face for each face individually. Also removes all edges.

fn split_face(&mut self, f: FaceHandle) -> VertexHandle

Splits the face f into k new faces (where k is the valence of f) by inserting a center vertex. This new vertex is returned. This operation is sometimes called “1-to-n split”.

fn flip_edge(&mut self, edge: EdgeHandle)

where Self: TriMesh + EdgeMesh,

Performs the “edge flip” operation on e. Requires e to be an interior edge (i.e. being adjacent to two faces).

fn split_edge_with_faces( &mut self, edge: EdgeHandle, ) -> SplitEdgeWithFacesResult

where Self: TriMesh + EdgeMesh,

Splits the given edge and its neighboring faces into two, each.

impl<C: Config> EdgeMesh for HalfEdgeMesh<C>

impl<C: Config> SupportsMultiBlade for HalfEdgeMesh<C>