rita 0.2.1

2D and 3D Randomized Incremental Triangulation Algorithms
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
106
107

use core::cmp::Ordering;
use core::fmt;
#[cfg(feature = "logging")]
use log::error;

use super::{tri_data_structure::TriDataStructure, tri_iterator::TriIterator};
use crate::{VertexNode, utils::types::HedgeIteratorIdx};

/// An iterator over the half-edges of a triangulation data structure.
#[derive(Clone)]
pub struct HedgeIterator<'a> {
    pub tds: &'a TriDataStructure,
    /// The hedge idx of this iterator
    pub idx: HedgeIteratorIdx,
}

impl<'a> HedgeIterator<'a> {
    pub const fn new(tds: &'a TriDataStructure, idx: HedgeIteratorIdx) -> Self {
        Self { tds, idx }
    }

    /// Retrieve the node this hedge originates from.
    pub fn starting_node(&self) -> VertexNode {
        self.tds.hedge_starting_nodes[self.idx]
    }

    /// Check if the hedge is conceptual, i.e. one of the nodes is the infinite node
    pub fn is_conceptual(&self) -> bool {
        self.starting_node().is_conceptual() || self.end_node().is_conceptual()
    }

    /// Check if the hedge is sound, i.e. `next`, `prev` and `twin` are pointing to correct nodes.
    pub fn is_sound(&self) -> bool {
        let mut sound = true;

        let starting_node = self.starting_node();
        let end_node = self.end_node();

        #[allow(unused)]
        let mut check = |condition: bool, error_msg: &str| {
            if !condition {
                #[cfg(feature = "logging")]
                error!("{self}: {error_msg}");
                sound = false;
            }
        };

        check(self.next().starting_node() == end_node, "Wrong next hedge");
        check(self.prev().end_node() == starting_node, "Wrong prev hedge");
        check(
            self.twin().starting_node() == end_node && self.twin().end_node() == starting_node,
            "Wrong twin hedge",
        );

        sound
    }

    /// Retrieve the node this hedge ends at.
    pub fn end_node(&self) -> VertexNode {
        match (self.idx % 3).cmp(&2) {
            Ordering::Equal => self.tds.hedge_starting_nodes[self.idx - 2],
            Ordering::Greater | Ordering::Less => self.tds.hedge_starting_nodes[self.idx + 1], // TODO: can this be greater, x % 3 is always 0, 1 or 2
        }
    }

    /// Retrieve the `next` half-edge belonging to the same triangle.
    pub fn next(&self) -> HedgeIterator<'a> {
        match (self.idx % 3).cmp(&2) {
            Ordering::Equal => Self::new(self.tds, self.idx - 2),
            Ordering::Greater | Ordering::Less => Self::new(self.tds, self.idx + 1),
        }
    }

    /// Retrieve the `twin` (aka opposite) half-edge belonging to the same triangle.
    ///
    /// This is the hedge that goes in the opposite direction,
    ///
    /// i.e. `self.starting_node() == self.twin().end_node()` and the other way around.
    pub fn twin(&self) -> HedgeIterator<'a> {
        Self::new(self.tds, self.tds.hedge_twins[self.idx])
    }

    /// Retrieve the `previous` half-edge belonging to the same triangle.
    pub fn prev(&self) -> HedgeIterator<'a> {
        match (self.idx % 3).cmp(&0) {
            Ordering::Equal => Self::new(self.tds, self.idx + 2),
            Ordering::Greater | Ordering::Less => Self::new(self.tds, self.idx - 1),
        }
    }

    /// Retrieve the triangle this half-edge belongs to.
    pub const fn tri(&self) -> TriIterator<'a> {
        TriIterator::new(self.tds, self.idx / 3)
    }
}

impl fmt::Display for HedgeIterator<'_> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(
            f,
            "Edge {}: {} -> {}",
            self.idx,
            self.starting_node(),
            self.end_node()
        )
    }
}