redges 0.3.0

A radial edge is a data structure for topological operations.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105

//! Topology handle around a vertex.
use crate::container_trait::{RedgeContainers, VertData};
use crate::edge_handle::EdgeHandle;

use crate::iterators::{
    VertIncidentFacesIterator, VertManifoldIncidentFacesIterator, VertexLinkEdgesIter,
    VertexStarEdgesIter, VertexStarVerticesIter,
};
use crate::EdgeId;
use crate::{container_trait::PrimitiveContainer, Redge, VertId, VertMetaData};
/// Topology handle around a vertex.
pub struct VertHandle<'r, R: RedgeContainers> {
    id: VertId,
    redge: &'r Redge<R>,
}

impl<'r, R: RedgeContainers> VertHandle<'r, R> {
    pub(crate) fn new(id: VertId, redge: &'r Redge<R>) -> Self {
        debug_assert!(!id.is_absent());
        Self { id, redge }
    }

    /// Id.
    pub fn id(&self) -> VertId {
        self.id
    }

    /// Does this vertex point to an edge?
    pub fn has_edge(&self) -> bool {
        self.redge.verts_meta[self.id.to_index()].edge_id != EdgeId::ABSENT
    }
    /// Get the edge. WARNING: Check it exists with `has_edge` if necessary, bad things can happen
    /// otherwise.
    pub fn edge(&self) -> EdgeHandle<'r, R> {
        EdgeHandle::new(
            self.redge.verts_meta[self.id.to_index()].edge_id,
            self.redge,
        )
    }
    /// Get the underlying vertex data.
    pub fn data(&self) -> &VertData<R> {
        self.redge.vert_data.get(self.id.to_index() as u64)
    }
    /// Is this vertex active/valid?
    pub fn is_active(&self) -> bool {
        self.metadata().is_active
    }

    fn metadata(&self) -> &VertMetaData {
        &self.redge.verts_meta[self.id.to_index()]
    }
    /// Iterator around all vertices sharing an edge with this vertex.
    pub fn neighbours(&self) -> VertexStarVerticesIter<'r, R> {
        VertexStarVerticesIter::new(self.id, self.redge)
    }
    /// Iterator around all edges incident on the vertex *in no particular order*. Do *NOT* assume
    /// this has a winding order.
    pub fn star_edges(&self) -> VertexStarEdgesIter<'r, R> {
        VertexStarEdgesIter::new(self.id, self.redge)
    }
    /// Like `star_edges` but starts the iteration at the specified edge.
    /// Assumes the edge is in the star.
    pub fn star_edges_from(&self, edge_id: EdgeId) -> VertexStarEdgesIter<'r, R> {
        debug_assert!(
            self.redge.edge_handle(edge_id).v1().id() == self.id
                || self.redge.edge_handle(edge_id).v2().id() == self.id
        );
        VertexStarEdgesIter {
            start_edge: edge_id,
            current_edge: edge_id,
            focused_vertex: self.id,
            start: true,
            redge: self.redge,
        }
    }
    /// Iterator around the edges of the link of the vertex.
    pub fn link_edges(&self) -> VertexLinkEdgesIter<'r, R> {
        VertexLinkEdgesIter::new(self.id, self.redge)
    }
    /// Iterator over the faces incident on the vertex.
    pub fn incident_faces(&self) -> VertIncidentFacesIterator<'r, R> {
        VertIncidentFacesIterator::new(self.id, self.redge)
    }

    /// WARNING: Call only if you know that the vertex is locally manifold.
    /// Otherwise, there are no guarantees as to what this method will do.
    pub fn incident_faces_manifold(&self) -> VertManifoldIncidentFacesIterator<'r, R> {
        VertManifoldIncidentFacesIterator::new(self.id, self.redge)
    }

    /// Is this vertex pointed to by a boundary edge?
    pub fn is_in_boundary(&self) -> bool {
        self.star_edges().any(|e| e.is_boundary())
    }

    /// Pick an edge in the star other than the specified one, if possible.
    pub fn pick_different(&self, eid: EdgeId) -> Option<EdgeHandle<'r, R>> {
        self.star_edges().find(|e| e.id() != eid)
    }

    /// Count the number of edges in the boundary that share this vertex.
    pub fn count_incident_boundary_edges(&self) -> usize {
        self.star_edges().filter(|e| e.is_boundary()).count()
    }
}