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 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193
use std::fmt;
use pretty_assertions::{assert_eq, assert_ne};
use crate::stores::{Handle, HandleWrapper};
use super::{Curve, GlobalCurve, GlobalVertex, Vertex};
/// A half-edge
#[derive(Clone, Debug, Eq, PartialEq, Hash, Ord, PartialOrd)]
pub struct HalfEdge {
curve: Curve,
vertices: [Vertex; 2],
global_form: GlobalEdge,
}
impl HalfEdge {
/// Create a new instance of `HalfEdge`
///
/// # Panics
///
/// Panics, if the provided `vertices` are not defined on the same curve as
/// `curve`.
///
/// Panics, if the provided [`GlobalEdge`] instance doesn't refer to the
/// same [`GlobalCurve`] and [`GlobalVertex`] instances that the other
/// objects that are passed refer to.
///
/// Panics, if the provided vertices are coincident on the curve. If they
/// were, the edge would have no length, and thus not be valid. (It is
/// perfectly fine for global forms of the the vertices to be coincident.
/// That would just mean, that ends of the edge connect to each other.)
pub fn new(
curve: Curve,
vertices: [Vertex; 2],
global_form: GlobalEdge,
) -> Self {
// Make sure `curve` and `vertices` match.
for vertex in &vertices {
assert_eq!(
&curve,
vertex.curve(),
"An edge and its vertices must be defined on the same curve"
);
}
// Make sure `curve` and `vertices` match `global_form`.
assert_eq!(
curve.global_form().id(),
global_form.curve().id(),
"The global form of a half-edge's curve must match the curve of \
the half-edge's global form"
);
assert_eq!(
&normalize_vertex_order(
vertices.clone().map(|vertex| *vertex.global_form())
),
global_form.vertices_in_normalized_order(),
"The global forms of a half-edge's vertices must match the \
vertices of the half-edge's global form"
);
// Make sure that the edge vertices are not coincident on the curve.
let [a, b] = &vertices;
assert_ne!(
a.position(),
b.position(),
"Vertices of an edge must not be coincident on curve"
);
Self {
curve,
vertices,
global_form,
}
}
/// Access the curve that defines the half-edge's geometry
///
/// The edge can be a segment of the curve that is bounded by two vertices,
/// or if the curve is continuous (i.e. connects to itself), the edge could
/// be defined by the whole curve, and have no bounding vertices.
pub fn curve(&self) -> &Curve {
&self.curve
}
/// Access the vertices that bound the half-edge on the curve
///
/// An edge has either two bounding vertices or none. The latter is possible
/// if the edge's curve is continuous (i.e. connects to itself), and defines
/// the whole edge.
pub fn vertices(&self) -> &[Vertex; 2] {
&self.vertices
}
/// Access the global form of this half-edge
pub fn global_form(&self) -> &GlobalEdge {
&self.global_form
}
}
impl fmt::Display for HalfEdge {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
let [a, b] = self.vertices().clone().map(|vertex| vertex.position());
write!(f, "edge from {:?} to {:?}", a, b)?;
write!(f, " on {:?}", self.curve().global_form())?;
Ok(())
}
}
/// An edge, defined in global (3D) coordinates
///
/// In contract to [`HalfEdge`], `GlobalEdge` is undirected, meaning it has no
/// defined direction, and its vertices have no defined order. This means it can
/// be used to determine whether two [`HalfEdge`]s map to the same `GlobalEdge`,
/// regardless of their direction.
#[derive(Clone, Debug, Eq, PartialEq, Hash, Ord, PartialOrd)]
pub struct GlobalEdge {
curve: HandleWrapper<GlobalCurve>,
vertices: [GlobalVertex; 2],
}
impl GlobalEdge {
/// Create a new instance
///
/// The order of `vertices` is irrelevant. Two `GlobalEdge`s with the same
/// `curve` and `vertices` will end up being equal, regardless of the order
/// of `vertices` here.
pub fn new(
curve: impl Into<HandleWrapper<GlobalCurve>>,
vertices: [GlobalVertex; 2],
) -> Self {
let curve = curve.into();
let vertices = normalize_vertex_order(vertices);
Self { curve, vertices }
}
/// Access the curve that defines the edge's geometry
///
/// The edge can be a segment of the curve that is bounded by two vertices,
/// or if the curve is continuous (i.e. connects to itself), the edge could
/// be defined by the whole curve, and have no bounding vertices.
pub fn curve(&self) -> &Handle<GlobalCurve> {
&self.curve
}
/// Access the vertices that bound the edge on the curve
///
/// As the name indicates, the order of the returned vertices is normalized
/// and might not match the order of the vertices that were passed to
/// [`GlobalEdge::new`]. You must not rely on the vertices being in any
/// specific order.
pub fn vertices_in_normalized_order(&self) -> &[GlobalVertex; 2] {
&self.vertices
}
}
fn normalize_vertex_order([a, b]: [GlobalVertex; 2]) -> [GlobalVertex; 2] {
if a < b {
[a, b]
} else {
[b, a]
}
}
#[cfg(test)]
mod tests {
use pretty_assertions::assert_eq;
use crate::{objects::Surface, partial::HasPartial, stores::Stores};
use super::HalfEdge;
#[test]
fn global_edge_equality() {
let stores = Stores::new();
let surface = stores.surfaces.insert(Surface::xy_plane());
let a = [0., 0.];
let b = [1., 0.];
let a_to_b = HalfEdge::partial()
.as_line_segment_from_points(surface.clone(), [a, b])
.build(&stores);
let b_to_a = HalfEdge::partial()
.as_line_segment_from_points(surface, [b, a])
.build(&stores);
assert_eq!(a_to_b.global_form(), b_to_a.global_form());
}
}