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 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331
//! Thick line join.
use crate::{
geometry::{Point, PointExt},
primitives::{
common::{LineSide, LinearEquation, StrokeOffset},
line::intersection_params::{Intersection, IntersectionParams},
Line,
},
};
/// Join kind
#[derive(Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug)]
#[cfg_attr(feature = "defmt", derive(::defmt::Format))]
pub enum JoinKind {
/// Mitered (sharp point)
Miter,
/// Bevelled (flattened point)
Bevel {
/// Left side or right side?
outer_side: LineSide,
},
/// Degenerate (angle between lines is too small to properly render stroke).
///
/// Degenerate corners are rendered with a bevel.
Degenerate {
/// Left side or right side?
outer_side: LineSide,
},
/// Lines are colinear.
///
/// Start and end points for this join will be equal.
Colinear,
/// The starting cap of a line.
Start,
/// The ending cap of a line.
End,
}
/// The left/right corners that make up the start or end edge of a thick line.
#[derive(Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug)]
#[cfg_attr(feature = "defmt", derive(::defmt::Format))]
pub struct EdgeCorners {
/// Left side point.
pub left: Point,
/// Right side point.
pub right: Point,
}
/// A join between two lines.
#[derive(Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug)]
#[cfg_attr(feature = "defmt", derive(::defmt::Format))]
pub struct LineJoin {
/// Join kind.
pub kind: JoinKind,
/// Corners comprising the ending edge of the line that ends at this join.
pub first_edge_end: EdgeCorners,
/// Corners comprising the start edge of the line that begins at this join.
pub second_edge_start: EdgeCorners,
}
impl LineJoin {
/// Create a starting join.
///
/// `first_edge_end` and `second_edge_start` are set to the same points.
pub fn start(start: Point, mid: Point, width: u32, stroke_offset: StrokeOffset) -> Self {
let line = Line::new(start, mid);
let (l, r) = line.extents(width, stroke_offset);
let points = EdgeCorners {
left: l.start,
right: r.start,
};
Self {
kind: JoinKind::Start,
first_edge_end: points,
second_edge_start: points,
}
}
/// Create an ending join.
///
/// `first_edge_end` and `second_edge_start` are set to the same points.
pub fn end(mid: Point, end: Point, width: u32, stroke_offset: StrokeOffset) -> Self {
let line = Line::new(mid, end);
let (l, r) = line.extents(width, stroke_offset);
let points = EdgeCorners {
left: l.end,
right: r.end,
};
Self {
kind: JoinKind::End,
first_edge_end: points,
second_edge_start: points,
}
}
/// Empty join
pub const fn empty() -> Self {
Self {
kind: JoinKind::End,
first_edge_end: EdgeCorners {
left: Point::zero(),
right: Point::zero(),
},
second_edge_start: EdgeCorners {
left: Point::zero(),
right: Point::zero(),
},
}
}
/// Compute a join.
pub fn from_points(
start: Point,
mid: Point,
end: Point,
width: u32,
stroke_offset: StrokeOffset,
) -> Self {
let first_line = Line::new(start, mid);
let second_line = Line::new(mid, end);
// Left and right edges of thick first segment
let (first_edge_left, first_edge_right) = first_line.extents(width, stroke_offset);
// Left and right edges of thick second segment
let (second_edge_left, second_edge_right) = second_line.extents(width, stroke_offset);
if let Some((l_intersection, outer_side, r_intersection)) = intersections(
&first_edge_left,
&first_edge_right,
&second_edge_left,
&second_edge_right,
) {
// Check if the inside end point of the second line lies inside the first segment.
let self_intersection = match outer_side {
LineSide::Right => LinearEquation::from_line(&first_edge_left)
.check_side(second_edge_left.end, LineSide::Right),
LineSide::Left => LinearEquation::from_line(&first_edge_right)
.check_side(second_edge_right.end, LineSide::Left),
};
// Normal line: non-overlapping line end caps
if !self_intersection {
// Distance from midpoint to miter outside end point.
let miter_length_squared = Line::new(
mid,
match outer_side {
LineSide::Left => l_intersection,
LineSide::Right => r_intersection,
},
)
.delta()
.length_squared() as u32;
// Miter length limit is double the line width (but squared to avoid sqrt() costs)
let miter_limit = (width * 2).pow(2);
// Intersection is within limit at which it will be chopped off into a bevel, so
// return a miter.
if miter_length_squared <= miter_limit {
let corners = EdgeCorners {
left: l_intersection,
right: r_intersection,
};
Self {
kind: JoinKind::Miter,
first_edge_end: corners,
second_edge_start: corners,
}
}
// Miter is too long, chop it into bevel-style corner
else {
match outer_side {
LineSide::Right => Self {
kind: JoinKind::Bevel { outer_side },
first_edge_end: EdgeCorners {
left: l_intersection,
right: first_edge_right.end,
},
second_edge_start: EdgeCorners {
left: l_intersection,
right: second_edge_right.start,
},
},
LineSide::Left => Self {
kind: JoinKind::Bevel { outer_side },
first_edge_end: EdgeCorners {
left: first_edge_left.end,
right: r_intersection,
},
second_edge_start: EdgeCorners {
left: second_edge_left.start,
right: r_intersection,
},
},
}
}
}
// Line segments overlap (degenerate)
else {
Self {
kind: JoinKind::Degenerate { outer_side },
first_edge_end: EdgeCorners {
left: first_edge_left.end,
right: first_edge_right.end,
},
second_edge_start: EdgeCorners {
left: second_edge_left.start,
right: second_edge_right.start,
},
}
}
}
// Lines are colinear
else {
Self {
kind: JoinKind::Colinear,
first_edge_end: EdgeCorners {
left: first_edge_left.end,
right: first_edge_right.end,
},
second_edge_start: EdgeCorners {
left: second_edge_left.start,
right: second_edge_right.start,
},
}
}
}
/// The filler line (if any) for bevel and degenerate joints.
const fn filler_line(&self) -> Option<Line> {
match self.kind {
JoinKind::Bevel { outer_side, .. } | JoinKind::Degenerate { outer_side, .. } => {
let line = match outer_side {
LineSide::Left => {
Line::new(self.first_edge_end.left, self.second_edge_start.left)
}
LineSide::Right => {
Line::new(self.first_edge_end.right, self.second_edge_start.right)
}
};
Some(line)
}
_ => None,
}
}
fn cap(&self, cap: &EdgeCorners) -> (Line, Option<Line>) {
if let Some(filler) = self.filler_line() {
let midpoint = filler.midpoint();
let l1 = Line::new(cap.left, midpoint);
let l2 = Line::new(midpoint, cap.right);
(l1, l2.into())
} else {
(Line::new(cap.left, cap.right), None)
}
}
/// Start node bevel line(s).
///
/// If the join is a bevel join, this will return two lines, otherwise one.
pub fn start_cap_lines(&self) -> (Line, Option<Line>) {
self.cap(&self.second_edge_start)
}
/// End node bevel line(s).
///
/// If the join is a bevel join, this will return two lines, otherwise one.
pub fn end_cap_lines(&self) -> (Line, Option<Line>) {
self.cap(&self.first_edge_end)
}
/// Whether the join is degenerate (segments self-intersect) or not.
pub const fn is_degenerate(&self) -> bool {
matches!(self.kind, JoinKind::Degenerate { .. })
}
}
fn intersections(
first_edge_left: &Line,
first_edge_right: &Line,
second_edge_left: &Line,
second_edge_right: &Line,
) -> Option<(Point, LineSide, Point)> {
let params = IntersectionParams::from_lines(second_edge_left, first_edge_left);
let (l_intersection, outer_side) = if let Intersection::Point {
point, outer_side, ..
} = params.intersection()
{
if !params.nearly_colinear_has_error() {
(point, outer_side)
} else {
(first_edge_left.end, outer_side)
}
} else {
return None;
};
let params = IntersectionParams::from_lines(second_edge_right, first_edge_right);
let r_intersection = if let Intersection::Point { point, .. } = params.intersection() {
if !params.nearly_colinear_has_error() {
point
} else {
first_edge_right.end
}
} else {
return None;
};
Some((l_intersection, outer_side, r_intersection))
}