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 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435
// Copyright (c) 2018-2021 Thomas Kramer.
// SPDX-FileCopyrightText: 2022 Thomas Kramer
// SPDX-FileCopyrightText: 2020 Fabian Keller <github.100.fkeller@spamgourmet.com> (contributions under MIT licence)
// SPDX-FileCopyrightText: 2020 Bodo Junglas <junglas@objectcode.de> (contributions under MIT licence)
//
// SPDX-License-Identifier: AGPL-3.0-or-later
//! Connect the resulting edges of the sweep line algorithm into polygons.
use super::sweep_line::sweep_event::SweepEvent;
use super::Operation;
use crate::PolygonSemantics;
use iron_shapes::point::Point;
use iron_shapes::polygon::Polygon;
use iron_shapes::simple_polygon::SimplePolygon;
use iron_shapes::CoordinateType;
use std::fmt::Debug;
use std::rc::Rc;
/// Given the processed and sorted events, connect the edges to polygons.
///
/// This uses the property events at the same point lie next to each other in the list
/// of sorted events. This way it is easy to follow the contour: 1) Start at some left event,
/// 2) go to its right event, 3) from there find a event with the same location.
pub fn connect_edges<T, Ctr, P, ContributesToResultFn>(
sorted_events: &[Rc<SweepEvent<T, Ctr, P>>],
operation: Operation,
polygon_semantics: PolygonSemantics,
contributes_to_result: ContributesToResultFn,
) -> Vec<Polygon<T>>
where
T: CoordinateType + Debug,
ContributesToResultFn: Fn(&SweepEvent<T, Ctr, P>) -> bool,
{
let mut relevant_events = filter_events(sorted_events, contributes_to_result);
if operation == Operation::Xor || polygon_semantics == PolygonSemantics::XOR {
relevant_events = xor_cancel_double_edges(relevant_events);
}
let mut events = order_events(&mut relevant_events);
debug_assert!(events.len() % 2 == 0, "Expect an even number of events.");
// Store found contours.
let mut polygons: Vec<Polygon<T>> = Vec::new();
// Remember which events have been processed.
let mut processed: Vec<bool> = vec![false; events.len()];
for i in 0..events.len() {
// Find the next unprocessed event from the left.
if processed[i] {
continue;
}
// Sanity check: There must be an even number of unprocessed events,
// because events always come in pairs.
debug_assert!(
processed.iter().filter(|&&b| !b).count() % 2 == 0,
"Expect to have an even number of non-processed events."
);
// Sanity check: There must be as many right events as left events among the unprocessed events.
debug_assert!(
(0..events.len())
.into_iter()
.filter_map(|i| if processed[i] {
None
} else {
if events[i].is_left_event {
Some(1)
} else {
Some(-1)
}
})
.fold(0, |a, b| a + b)
== 0,
"Expect to have the same amount of left and right events."
);
// Buffer for polygon.
let mut contour = Vec::new();
let mut pointer = i;
let initial_event = &events[i];
// Find contour index if this is a hole.
let is_hull = initial_event
.prev_index
.map(|prev| {
let prev_event = &events[prev];
if prev_event.is_upper_boundary {
!prev_event.is_hole
} else {
// A hole inside a hole is a hull.
prev_event.is_hole
}
})
.unwrap_or(true);
let is_hole = !is_hull;
let polygon_id = if is_hull {
polygons.len()
} else {
initial_event
.prev_index
.map(|prev| events[prev].contour_id)
// If there is no previous segment, this is a contour and not a hole.
// Create a new polygon id.
.unwrap_or(polygons.len())
};
let initial_point = initial_event.p;
debug_assert!(
initial_event.is_left_event,
"Initial event is expected to be a left event."
);
// Follow the lines until the contour is closed.
loop {
let other_pointer = {
// Propagate fields to the right event.
let e = &mut events[pointer];
e.contour_id = polygon_id;
e.is_hole = is_hole;
e.other_index
};
{
let other = &mut events[other_pointer];
other.contour_id = polygon_id;
other.is_hole = is_hole;
}
if events[pointer].p.x > events[other_pointer].p.x {
// This is an upper boundary of the contour.
events[pointer].is_upper_boundary = true;
events[other_pointer].is_upper_boundary = true;
}
let event = &events[pointer];
let other_event = &events[other_pointer];
contour.push(event.p);
processed[pointer] = true;
processed[other_pointer] = true;
debug_assert!(
event.is_left_event ^ other_event.is_left_event,
"Need to get exactly one left event and one right event."
);
if other_event.p == initial_point {
// Contour is closed.
break;
}
// Get the start of an adjacent edge.
if let Some(next_index) = next_index(&events, other_pointer, &processed) {
pointer = next_index;
} else {
break;
}
}
if polygon_id < polygons.len() {
// Add hole to existing polygon.
let hole = SimplePolygon::new(contour).normalized_orientation::<T>();
polygons[polygon_id].interiors.push(hole);
} else {
let p = Polygon::new(contour);
polygons.push(p);
}
}
polygons
}
#[derive(Debug, Clone, PartialEq)]
struct Event<T: CoordinateType> {
/// Index of this event in the vector where it is stored.
index: usize,
/// Index of the other event of this pair.
other_index: usize,
/// The index of the segment just below.
prev_index: Option<usize>,
/// The endpoint of the edge which is represented by this event.
p: Point<T>,
/// Is this part of a hole? Used to distinguish between holes and hulls.
is_hole: bool,
/// Is this an upper boundary of the contour? Used to distinguish between holes and hulls.
is_upper_boundary: bool,
/// Tells if this is the left or right event of the segment.
is_left_event: bool,
contour_id: usize,
}
/// Take all the events that contribute to the result.
/// This depends on the boolean operation to be performed.
/// Also adjusts the `prev` pointers for hole attribution.
fn filter_events<T, Ctr, P, ContributesToResultFn>(
sorted_events: &[Rc<SweepEvent<T, Ctr, P>>],
contributes_to_result: ContributesToResultFn,
) -> Vec<Rc<SweepEvent<T, Ctr, P>>>
where
T: CoordinateType + Debug,
ContributesToResultFn: Fn(&SweepEvent<T, Ctr, P>) -> bool,
{
// Flags that tell whether the event contributes to the result or not.
let mut contributes = vec![false; sorted_events.len()];
for (i, event) in sorted_events.iter().enumerate() {
event.set_pos(i);
let contributes_to_result = if event.is_left_event() {
contributes_to_result(event)
} else {
event
.get_other_event()
.map(|other| contributes_to_result(other.as_ref()))
.unwrap_or(false)
};
contributes[i] = contributes_to_result;
// Update the prev field for hole attribution.
if let Some(prev) = event.get_prev().upgrade() {
if !contributes[prev.get_pos()] {
// The previous event is not contributing to the result, so take the previous
// of the previous.
event.set_prev(prev.get_prev());
debug_assert!({
// If the `prev` is set now, it must be a contributing edge.
if let Some(prevprev) = event.get_prev().upgrade() {
contributes[prevprev.get_pos()]
} else {
true
}
});
}
}
}
// Filter relevant events.
let result_events: Vec<_> = sorted_events
.iter()
.zip(contributes)
.filter(|(_e, contributes)| *contributes)
.map(|(e, _)| e)
.cloned()
.collect();
result_events
}
/// Remove duplicate edges which would form empty polygons.
fn xor_cancel_double_edges<T, Ctr, P>(
sorted_events: Vec<Rc<SweepEvent<T, Ctr, P>>>,
) -> Vec<Rc<SweepEvent<T, Ctr, P>>>
where
T: CoordinateType + Debug,
{
// Flags that tell whether the event contributes to the result or not.
let mut contributes = vec![false; sorted_events.len()];
// Store positions.
for (i, event) in sorted_events.iter().enumerate() {
event.set_pos(i);
}
let mut prev_edge = None;
let mut prev_idx = 0;
for (i, event) in sorted_events.iter().enumerate() {
let other_idx = event.get_other_event().unwrap().get_pos();
if event.is_left_event() {
let edge = event.get_edge();
if Some(edge) == prev_edge {
// Duplicate edges cancel eachother.
prev_edge = None;
contributes[i] = false;
contributes[other_idx] = false; // Cancel the right event.
// Also cancel the first edge.
contributes[prev_idx] = false;
let prev_other_idx = sorted_events[prev_idx].get_other_event().unwrap().get_pos();
contributes[prev_other_idx] = false; // Cancel the right event.
} else {
prev_edge = Some(edge);
prev_idx = i;
contributes[i] = true;
contributes[other_idx] = true;
};
}
}
// Update the prev field for hole attribution.
for event in sorted_events.iter() {
if let Some(prev) = event.get_prev().upgrade() {
if !contributes[prev.get_pos()] {
// The previous event is not contributing to the result, so take the previous
// of the previous.
event.set_prev(prev.get_prev());
debug_assert!({
// If the `prev` is set now, it must be a contributing edge.
if let Some(prevprev) = event.get_prev().upgrade() {
contributes[prevprev.get_pos()]
} else {
true
}
});
}
}
}
// Filter relevant events.
sorted_events
.into_iter()
.zip(contributes)
.filter(|(_e, contributes)| *contributes)
.map(|(e, _)| e)
.collect()
}
/// Sort the events and insert indices.
/// Input events must already be filtered such that they only contain relevant events.
fn order_events<T, Ctr, P>(events: &mut Vec<Rc<SweepEvent<T, Ctr, P>>>) -> Vec<Event<T>>
where
T: CoordinateType,
{
// Sort the events.
// The events are probably almost sorted.
let mut sorted = false;
while !sorted {
sorted = true;
for i in 1..events.len() {
if events[i - 1] < events[i] {
events.swap(i - 1, i);
sorted = false;
}
}
}
// Check if events are sorted.
debug_assert!(events.windows(2).all(|e| e[0] >= e[1]), "Must be sorted.");
// And check if events are sorted by coordinates too.
debug_assert!(
events.windows(2).all(|e| e[0].p <= e[1].p),
"Must be sorted by coordinates."
);
// Sorted by coordinates implies that end-point and start-point of two connected edges are close together in the list.
// Further, the start-point of the second edge will come after the end-point of the first edge.
// Tell the events what index they have.
for (pos, event) in events.iter().enumerate() {
event.set_pos(pos)
}
// Swap positions of all event pairs.
// This way we know for each event index of the other event.
for event in events.iter() {
if !event.is_left_event() {
if let Some(other) = event.get_other_event() {
let tmp = event.get_pos();
event.set_pos(other.get_pos());
other.set_pos(tmp);
}
}
}
// Convert the events into a simpler data structure.
let result = events
.iter()
.enumerate()
.map(|(index, event)| {
Event {
index,
other_index: event.get_pos(),
prev_index: event.get_prev().upgrade().map(|p| p.get_pos()),
p: event.p,
is_left_event: event.is_left_event(),
is_hole: false,
is_upper_boundary: false, // TODO: Is this used?
contour_id: usize::MAX,
}
})
.collect();
result
}
/// Given an index of an event get the index of another event with the same coordinates that is not yet
/// marked as used.
fn next_index<T: CoordinateType>(
events: &[Event<T>],
start_index: usize,
used: &[bool],
) -> Option<usize> {
debug_assert!(start_index < events.len());
debug_assert!(events.len() == used.len());
let event = &events[start_index];
// Find the next event by linear search in both directions.
let point = event.p;
// Search to the right.
let next_to_the_right = events[start_index + 1..]
.iter()
.take_while(|e| e.p == point)
.find(|e| !used[e.index])
.map(|e|
// Return the index of this event.
e.index);
if next_to_the_right.is_some() {
next_to_the_right
} else {
// Search to the left.
let next_to_the_left = events[0..start_index]
.iter()
.rev()
.take_while(|e| e.p == point)
.find(|e| !used[e.index])
.map(|e|
// Return the index of this event.
e.index);
next_to_the_left
}
}