Allow groups to work with the node graph (#1452)

* Initial groups

* Improve graph arangement

* Fix selecting nested layers

* Code review pass

* Change log

---------

Co-authored-by: Keavon Chambers <[email protected]>

Author: 0HyperCube

document-legacy/src/document_metadata.rs

@@ -77,6 +77,7 @@ impl DocumentMetadata {
 		self.structure.entry(node_identifier).or_default()
 	}
 
+	/// Layers excluding ones that are children of other layers in the list.
 	pub fn shallowest_unique_layers(&self, layers: impl Iterator<Item = LayerNodeIdentifier>) -> Vec<Vec<LayerNodeIdentifier>> {
 		let mut sorted_layers = layers
 			.map(|layer| {
@@ -90,6 +91,34 @@ impl DocumentMetadata {
 		sorted_layers.dedup_by(|a, b| a.starts_with(b));
 		sorted_layers
 	}
+
+	/// Ancestor that is shared by all layers and that is deepest (more nested). May be the root layer.
+	pub fn deepest_common_ancestor(&self, layers: impl Iterator<Item = LayerNodeIdentifier>) -> LayerNodeIdentifier {
+		layers
+			.map(|layer| {
+				let mut layer_path = layer.ancestors(self).skip(1).collect::<Vec<_>>();
+				layer_path.reverse();
+				layer_path
+			})
+			.reduce(|mut a, b| {
+				a.truncate(a.iter().zip(b.iter()).position(|(&a, &b)| a != b).unwrap_or_else(|| a.len().min(b.len())));
+				a
+			})
+			.and_then(|path| path.last().copied())
+			.unwrap_or(LayerNodeIdentifier::ROOT)
+	}
+
+	/// Filter out non folder layers
+	pub fn folders<'a>(&'a self, layers: impl Iterator<Item = LayerNodeIdentifier> + 'a) -> impl Iterator<Item = LayerNodeIdentifier> + 'a {
+		layers.filter(|layer| layer.has_children(self))
+	}
+
+	/// Folders sorted from most nested to least nested
+	pub fn folders_sorted_by_most_nested(&self, layers: impl Iterator<Item = LayerNodeIdentifier>) -> Vec<LayerNodeIdentifier> {
+		let mut folders: Vec<_> = self.folders(layers).collect();
+		folders.sort_by_cached_key(|a| std::cmp::Reverse(a.ancestors(self).count()));
+		folders
+	}
 }
 
 // selected layer modifications
@@ -146,7 +175,7 @@ impl DocumentMetadata {
 }
 
 fn first_child_layer<'a>(graph: &'a NodeNetwork, node: &DocumentNode) -> Option<(&'a DocumentNode, NodeId)> {
-	graph.primary_flow_from_opt(Some(node.inputs[0].as_node()?)).find(|(node, _)| node.name == "Layer")
+	graph.primary_flow_from_node(Some(node.inputs[0].as_node()?)).find(|(node, _)| node.name == "Layer")
 }
 fn sibling_below<'a>(graph: &'a NodeNetwork, node: &DocumentNode) -> Option<(&'a DocumentNode, NodeId)> {
 	node.inputs[7].as_node().and_then(|id| graph.nodes.get(&id).filter(|node| node.name == "Layer").map(|node| (node, id)))
@@ -178,7 +207,7 @@ impl DocumentMetadata {
 }
 
 fn is_artboard(layer: LayerNodeIdentifier, network: &NodeNetwork) -> bool {
-	network.primary_flow_from_opt(Some(layer.to_node())).any(|(node, _)| node.name == "Artboard")
+	network.primary_flow_from_node(Some(layer.to_node())).any(|(node, _)| node.name == "Artboard")
 }
 
 // click targets
@@ -299,6 +328,7 @@ impl LayerNodeIdentifier {
 	}
 
 	/// Construct a [`LayerNodeIdentifier`], debug asserting that it is a layer node
+	#[track_caller]
 	pub fn new(node_id: NodeId, network: &NodeNetwork) -> Self {
 		debug_assert!(
 			is_layer_node(node_id, network),

document-legacy/src/response.rs

@@ -22,11 +22,6 @@ pub enum DocumentResponse {
 	LayerChanged {
 		path: Vec<LayerId>,
 	},
-	MoveSelectedLayersTo {
-		folder_path: Vec<LayerId>,
-		insert_index: isize,
-		reverse_index: bool,
-	},
 	DeletedSelectedManipulatorPoints,
 }
 
@@ -39,7 +34,6 @@ impl fmt::Display for DocumentResponse {
 			DocumentResponse::LayerChanged { .. } => write!(f, "LayerChanged"),
 			DocumentResponse::DeletedLayer { .. } => write!(f, "DeleteLayer"),
 			DocumentResponse::DeletedSelectedManipulatorPoints { .. } => write!(f, "DeletedSelectedManipulatorPoints"),
-			DocumentResponse::MoveSelectedLayersTo { .. } => write!(f, "MoveSelectedLayersTo"),
 		}
 	}
 }

editor/src/dispatcher.rs

@@ -302,7 +302,7 @@ mod test {
 		editor.handle_message(PortfolioMessage::Copy { clipboard: Clipboard::Internal });
 		editor.handle_message(PortfolioMessage::PasteIntoFolder {
 			clipboard: Clipboard::Internal,
-			folder_path: vec![],
+			parent: LayerNodeIdentifier::ROOT,
 			insert_index: -1,
 		});
 		let document_after_copy = editor.dispatcher.message_handlers.portfolio_message_handler.active_document().unwrap().document_legacy.clone();
@@ -341,7 +341,7 @@ mod test {
 		editor.handle_message(PortfolioMessage::Copy { clipboard: Clipboard::Internal });
 		editor.handle_message(PortfolioMessage::PasteIntoFolder {
 			clipboard: Clipboard::Internal,
-			folder_path: vec![],
+			parent: LayerNodeIdentifier::ROOT,
 			insert_index: -1,
 		});
 
@@ -407,12 +407,12 @@ mod test {
 		editor.handle_message(DocumentMessage::DeleteSelectedLayers);
 		editor.handle_message(PortfolioMessage::PasteIntoFolder {
 			clipboard: Clipboard::Internal,
-			folder_path: vec![],
+			parent: LayerNodeIdentifier::ROOT,
 			insert_index: -1,
 		});
 		editor.handle_message(PortfolioMessage::PasteIntoFolder {
 			clipboard: Clipboard::Internal,
-			folder_path: vec![],
+			parent: LayerNodeIdentifier::ROOT,
 			insert_index: -1,
 		});
 
@@ -479,12 +479,12 @@ mod test {
 		editor.draw_rect(0., 800., 12., 200.);
 		editor.handle_message(PortfolioMessage::PasteIntoFolder {
 			clipboard: Clipboard::Internal,
-			folder_path: vec![],
+			parent: LayerNodeIdentifier::ROOT,
 			insert_index: -1,
 		});
 		editor.handle_message(PortfolioMessage::PasteIntoFolder {
 			clipboard: Clipboard::Internal,
-			folder_path: vec![],
+			parent: LayerNodeIdentifier::ROOT,
 			insert_index: -1,
 		});
 

editor/src/messages/portfolio/document/document_message.rs

@@ -5,6 +5,7 @@ use crate::messages::portfolio::document::utility_types::misc::{AlignAggregate,
 use crate::messages::prelude::*;
 
 use document_legacy::document::Document as DocumentLegacy;
+use document_legacy::document_metadata::LayerNodeIdentifier;
 use document_legacy::layers::blend_mode::BlendMode;
 use document_legacy::layers::style::ViewMode;
 use document_legacy::LayerId;
@@ -106,9 +107,8 @@ pub enum DocumentMessage {
 		affected_layer_path: Vec<LayerId>,
 	},
 	MoveSelectedLayersTo {
-		folder_path: Vec<LayerId>,
+		parent: LayerNodeIdentifier,
 		insert_index: isize,
-		reverse_index: bool,
 	},
 	NudgeSelectedLayers {
 		delta_x: f64,
@@ -169,6 +169,9 @@ pub enum DocumentMessage {
 	SetOverlaysVisibility {
 		visible: bool,
 	},
+	SetRangeSelectionLayer {
+		new_layer: Option<LayerNodeIdentifier>,
+	},
 	SetSelectedLayers {
 		replacement_selected_layers: Vec<Vec<LayerId>>,
 	},
@@ -189,9 +192,6 @@ pub enum DocumentMessage {
 	},
 	Undo,
 	UndoFinished,
-	UngroupLayers {
-		folder_path: Vec<LayerId>,
-	},
 	UngroupSelectedLayers,
 	UpdateDocumentTransform {
 		transform: glam::DAffine2,