Graphite/editor/src/viewport_tools/snapping.rs

use crate::consts::{COLOR_ACCENT, SNAP_OVERLAY_FADE_DISTANCE, SNAP_OVERLAY_UNSNAPPED_OPACITY, SNAP_TOLERANCE};
use crate::document::DocumentMessageHandler;
use crate::message_prelude::*;

use graphene::layers::style::{self, Stroke};
use graphene::{LayerId, Operation};

use glam::{DAffine2, DVec2};
use std::f64::consts::PI;

#[derive(Debug, Clone, Default)]
pub struct SnapHandler {
	snap_targets: Option<(Vec<f64>, Vec<f64>)>,
	overlay_paths: Vec<Vec<LayerId>>,
}

impl SnapHandler {
	/// Updates the snapping overlays with the specified distances.
	/// `positions_and_distances` is a tuple of `position` and `distance` iterators, respectively, each with `(x, y)` values.
	fn update_overlays(
		overlay_paths: &mut Vec<Vec<LayerId>>,
		responses: &mut VecDeque<Message>,
		viewport_bounds: DVec2,
		positions_and_distances: (impl Iterator<Item = (f64, f64)>, impl Iterator<Item = (f64, f64)>),
		closest_distance: DVec2,
	) {
		/// Draws an alignment line overlay with the correct transform and fade opacity, reusing lines from the pool if available.
		fn add_overlay_line(responses: &mut VecDeque<Message>, transform: [f64; 6], opacity: f64, index: usize, overlay_paths: &mut Vec<Vec<LayerId>>) {
			// If there isn't one in the pool to ruse, add a new alignment line to the pool with the intended transform
			let layer_path = if index >= overlay_paths.len() {
				let layer_path = vec![generate_uuid()];
				responses.push_back(
					DocumentMessage::Overlays(
						Operation::AddOverlayLine {
							path: layer_path.clone(),
							transform,
							style: style::PathStyle::new(Some(Stroke::new(COLOR_ACCENT, 1.0)), style::Fill::None),
						}
						.into(),
					)
					.into(),
				);
				overlay_paths.push(layer_path.clone());
				layer_path
			}
			// Otherwise, reuse an overlay line from the pool and update its new transform
			else {
				let layer_path = overlay_paths[index].clone();
				responses.push_back(DocumentMessage::Overlays(Operation::SetLayerTransform { path: layer_path.clone(), transform }.into()).into());
				layer_path
			};

			// Then set its opacity to the fade amount
			responses.push_back(DocumentMessage::Overlays(Operation::SetLayerOpacity { path: layer_path, opacity }.into()).into());
		}

		let (positions, distances) = positions_and_distances;
		let mut index = 0;

		// Draw the vertical alignment lines
		for (x_target, distance) in positions.filter(|(_pos, dist)| dist.abs() < SNAP_OVERLAY_FADE_DISTANCE) {
			let transform = DAffine2::from_scale_angle_translation(DVec2::new(viewport_bounds.y, 1.), PI / 2., DVec2::new((x_target).round() - 0.5, 0.)).to_cols_array();

			let opacity = if closest_distance.x == distance {
				1.
			} else {
				SNAP_OVERLAY_UNSNAPPED_OPACITY - distance.abs() / (SNAP_OVERLAY_FADE_DISTANCE / SNAP_OVERLAY_UNSNAPPED_OPACITY)
			};

			add_overlay_line(responses, transform, opacity, index, overlay_paths);
			index += 1;
		}
		// Draw the horizontal alignment lines
		for (y_target, distance) in distances.filter(|(_pos, dist)| dist.abs() < SNAP_OVERLAY_FADE_DISTANCE) {
			let transform = DAffine2::from_scale_angle_translation(DVec2::new(viewport_bounds.x, 1.), 0., DVec2::new(0., (y_target).round() - 0.5)).to_cols_array();

			let opacity = if closest_distance.y == distance {
				1.
			} else {
				SNAP_OVERLAY_UNSNAPPED_OPACITY - distance.abs() / (SNAP_OVERLAY_FADE_DISTANCE / SNAP_OVERLAY_UNSNAPPED_OPACITY)
			};

			add_overlay_line(responses, transform, opacity, index, overlay_paths);
			index += 1;
		}
		Self::remove_unused_overlays(overlay_paths, responses, index);
	}

	/// Remove overlays from the pool beyond a given index. Pool entries up through that index will be kept.
	fn remove_unused_overlays(overlay_paths: &mut Vec<Vec<LayerId>>, responses: &mut VecDeque<Message>, remove_after_index: usize) {
		while overlay_paths.len() > remove_after_index {
			responses.push_back(DocumentMessage::Overlays(Operation::DeleteLayer { path: overlay_paths.pop().unwrap() }.into()).into());
		}
	}

	/// Gets a list of snap targets for the X and Y axes (if specified) in Viewport coords for the target layers (usually all layers or all non-selected layers.)
	/// This should be called at the start of a drag.
	pub fn start_snap(&mut self, document_message_handler: &DocumentMessageHandler, bounding_boxes: impl Iterator<Item = [DVec2; 2]>, snap_x: bool, snap_y: bool) {
		if document_message_handler.snapping_enabled {
			let (x_targets, y_targets) = bounding_boxes.flat_map(|[bound1, bound2]| [bound1, bound2, ((bound1 + bound2) / 2.)]).map(|vec| vec.into()).unzip();

			// Could be made into sorted Vec or a HashSet for more performant lookups.
			self.snap_targets = Some((if snap_x { x_targets } else { Vec::new() }, if snap_y { y_targets } else { Vec::new() }));
		}
	}

	/// Add arbitrary snapping points
	/// This should be called after start_snap
	pub fn add_snap_points(&mut self, document_message_handler: &DocumentMessageHandler, snap_points: Vec<DVec2>) {
		if document_message_handler.snapping_enabled {
			let (mut x_targets, mut y_targets): (Vec<f64>, Vec<f64>) = snap_points.into_iter().map(|vec| vec.into()).unzip();
			if let Some((new_x_targets, new_y_targets)) = &mut self.snap_targets {
				x_targets.append(new_x_targets);
				y_targets.append(new_y_targets);
				self.snap_targets = Some((x_targets, y_targets));
			}
		}
	}

	/// Finds the closest snap from an array of layers to the specified snap targets in viewport coords.
	/// Returns 0 for each axis that there is no snap less than the snap tolerance.
	pub fn snap_layers(
		&mut self,
		responses: &mut VecDeque<Message>,
		document_message_handler: &DocumentMessageHandler,
		(snap_x, snap_y): (Vec<f64>, Vec<f64>),
		viewport_bounds: DVec2,
		mouse_delta: DVec2,
	) -> DVec2 {
		if document_message_handler.snapping_enabled {
			if let Some((targets_x, targets_y)) = &self.snap_targets {
				let positions = targets_x.iter().flat_map(|&target| snap_x.iter().map(move |&snap| (target, target - mouse_delta.x - snap)));
				let distances = targets_y.iter().flat_map(|&target| snap_y.iter().map(move |&snap| (target, target - mouse_delta.y - snap)));

				let min_positions = positions.clone().min_by(|a, b| a.1.abs().partial_cmp(&b.1.abs()).expect("Could not compare position."));
				let min_distances = distances.clone().min_by(|a, b| a.1.abs().partial_cmp(&b.1.abs()).expect("Could not compare position."));

				let closest_distance = DVec2::new(min_positions.map_or(0., |(_pos, dist)| dist), min_distances.map_or(0., |(_pos, dist)| dist));

				// Clamp, do not move, if above snap tolerance
				let clamped_closest_distance = DVec2::new(
					if closest_distance.x.abs() > SNAP_TOLERANCE { 0. } else { closest_distance.x },
					if closest_distance.y.abs() > SNAP_TOLERANCE { 0. } else { closest_distance.y },
				);

				Self::update_overlays(&mut self.overlay_paths, responses, viewport_bounds, (positions, distances), clamped_closest_distance);

				clamped_closest_distance
			} else {
				DVec2::ZERO
			}
		} else {
			DVec2::ZERO
		}
	}

	/// Handles snapping of a viewport position, returning another viewport position.
	pub fn snap_position(&mut self, responses: &mut VecDeque<Message>, viewport_bounds: DVec2, document_message_handler: &DocumentMessageHandler, position_viewport: DVec2) -> DVec2 {
		if document_message_handler.snapping_enabled {
			if let Some((targets_x, targets_y)) = &self.snap_targets {
				let positions = targets_x.iter().map(|&x| (x, x - position_viewport.x));
				let distances = targets_y.iter().map(|&y| (y, y - position_viewport.y));

				let min_positions = positions.clone().min_by(|a, b| a.1.abs().partial_cmp(&b.1.abs()).expect("Could not compare position."));
				let min_distances = distances.clone().min_by(|a, b| a.1.abs().partial_cmp(&b.1.abs()).expect("Could not compare position."));

				let closest_distance = DVec2::new(min_positions.map_or(0., |(_pos, dist)| dist), min_distances.map_or(0., |(_pos, dist)| dist));

				// Do not move if over snap tolerance
				let clamped_closest_distance = DVec2::new(
					if closest_distance.x.abs() > SNAP_TOLERANCE { 0. } else { closest_distance.x },
					if closest_distance.y.abs() > SNAP_TOLERANCE { 0. } else { closest_distance.y },
				);

				Self::update_overlays(&mut self.overlay_paths, responses, viewport_bounds, (positions, distances), clamped_closest_distance);

				position_viewport + clamped_closest_distance
			} else {
				position_viewport
			}
		} else {
			position_viewport
		}
	}

	/// Removes snap target data and overlays. Call this when snapping is done.
	pub fn cleanup(&mut self, responses: &mut VecDeque<Message>) {
		Self::remove_unused_overlays(&mut self.overlay_paths, responses, 0);
		self.snap_targets = None;
	}
}