Remove the Frame tool

document-legacy/src/document.rs

@@ -590,6 +590,7 @@ impl Document {
 
 				Some(responses)
 			}
+			// TODO: Remove
 			Operation::AddFrame {
 				path,
 				insert_index,

document-legacy/src/operation.rs

@@ -14,6 +14,7 @@ use std::hash::{Hash, Hasher};
 // TODO: Rename all instances of `path` to `layer_path`
 /// Operations that can be performed to mutate the document.
 pub enum Operation {
+	// TODO: Remove
 	AddFrame {
 		path: Vec<LayerId>,
 		insert_index: isize,

editor/src/messages/input_mapper/default_mapping.rs

@@ -150,13 +150,6 @@ pub fn default_mapping() -> Mapping {
 		entry!(KeyDown(Escape); action_dispatch=ImaginateToolMessage::Abort),
 		entry!(PointerMove; refresh_keys=[Alt, Shift], action_dispatch=ImaginateToolMessage::Resize { center: Alt, lock_ratio: Shift }),
 		//
-		// FrameToolMessage
-		entry!(KeyDown(Lmb); action_dispatch=FrameToolMessage::DragStart),
-		entry!(KeyUp(Lmb); action_dispatch=FrameToolMessage::DragStop),
-		entry!(KeyDown(Rmb); action_dispatch=FrameToolMessage::Abort),
-		entry!(KeyDown(Escape); action_dispatch=FrameToolMessage::Abort),
-		entry!(PointerMove; refresh_keys=[Alt, Shift], action_dispatch=FrameToolMessage::Resize { center: Alt, lock_ratio: Shift }),
-		//
 		// EllipseToolMessage
 		entry!(KeyDown(Lmb); action_dispatch=EllipseToolMessage::DragStart),
 		entry!(KeyUp(Lmb); action_dispatch=EllipseToolMessage::DragStop),

editor/src/messages/prelude.rs

@@ -35,7 +35,6 @@ pub use crate::messages::tool::tool_messages::brush_tool::{BrushToolMessage, Bru
 pub use crate::messages::tool::tool_messages::ellipse_tool::{EllipseToolMessage, EllipseToolMessageDiscriminant};
 pub use crate::messages::tool::tool_messages::eyedropper_tool::{EyedropperToolMessage, EyedropperToolMessageDiscriminant};
 pub use crate::messages::tool::tool_messages::fill_tool::{FillToolMessage, FillToolMessageDiscriminant};
-pub use crate::messages::tool::tool_messages::frame_tool::{FrameToolMessage, FrameToolMessageDiscriminant};
 pub use crate::messages::tool::tool_messages::freehand_tool::{FreehandToolMessage, FreehandToolMessageDiscriminant};
 pub use crate::messages::tool::tool_messages::gradient_tool::{GradientToolMessage, GradientToolMessageDiscriminant};
 pub use crate::messages::tool::tool_messages::imaginate_tool::{ImaginateToolMessage, ImaginateToolMessageDiscriminant};

editor/src/messages/tool/tool_message.rs

@@ -82,9 +82,6 @@ pub enum ToolMessage {
 	#[remain::unsorted]
 	#[child]
 	Imaginate(ImaginateToolMessage),
-	#[remain::unsorted]
-	#[child]
-	Frame(FrameToolMessage),
 
 	// Messages
 	#[remain::unsorted]
@@ -123,8 +120,6 @@ pub enum ToolMessage {
 	ActivateToolBrush,
 	#[remain::unsorted]
 	ActivateToolImaginate,
-	#[remain::unsorted]
-	ActivateToolFrame,
 
 	ActivateTool {
 		tool_type: ToolType,

editor/src/messages/tool/tool_messages/frame_tool.rs

@@ -1,185 +0,0 @@
-use super::tool_prelude::*;
-use crate::messages::portfolio::document::node_graph;
-use crate::messages::tool::common_functionality::path_outline::PathOutline;
-use crate::messages::tool::common_functionality::resize::Resize;
-
-use document_legacy::Operation;
-
-#[derive(Default)]
-pub struct FrameTool {
-	fsm_state: NodeGraphToolFsmState,
-	tool_data: NodeGraphToolData,
-}
-
-#[remain::sorted]
-#[impl_message(Message, ToolMessage, Frame)]
-#[derive(PartialEq, Eq, Clone, Debug, Hash, Serialize, Deserialize, specta::Type)]
-pub enum FrameToolMessage {
-	// Standard messages
-	#[remain::unsorted]
-	Abort,
-	#[remain::unsorted]
-	DocumentIsDirty,
-	#[remain::unsorted]
-	SelectionChanged,
-
-	// Tool-specific messages
-	DragStart,
-	DragStop,
-	Resize {
-		center: Key,
-		lock_ratio: Key,
-	},
-}
-
-impl LayoutHolder for FrameTool {
-	fn layout(&self) -> Layout {
-		Layout::WidgetLayout(WidgetLayout::default())
-	}
-}
-
-impl<'a> MessageHandler<ToolMessage, &mut ToolActionHandlerData<'a>> for FrameTool {
-	fn process_message(&mut self, message: ToolMessage, responses: &mut VecDeque<Message>, tool_data: &mut ToolActionHandlerData<'a>) {
-		self.fsm_state.process_event(message, &mut self.tool_data, tool_data, &(), responses, true);
-	}
-
-	fn actions(&self) -> ActionList {
-		use NodeGraphToolFsmState::*;
-
-		match self.fsm_state {
-			Ready => actions!(FrameToolMessageDiscriminant;
-				DragStart,
-			),
-			Drawing => actions!(FrameToolMessageDiscriminant;
-				DragStop,
-				Abort,
-				Resize,
-			),
-		}
-	}
-}
-
-impl ToolMetadata for FrameTool {
-	fn icon_name(&self) -> String {
-		"RasterFrameTool".into()
-	}
-	fn tooltip(&self) -> String {
-		"Frame Tool".into()
-	}
-	fn tool_type(&self) -> crate::messages::tool::utility_types::ToolType {
-		ToolType::Frame
-	}
-}
-
-impl ToolTransition for FrameTool {
-	fn event_to_message_map(&self) -> EventToMessageMap {
-		EventToMessageMap {
-			document_dirty: Some(FrameToolMessage::DocumentIsDirty.into()),
-			tool_abort: Some(FrameToolMessage::Abort.into()),
-			selection_changed: Some(FrameToolMessage::SelectionChanged.into()),
-			..Default::default()
-		}
-	}
-}
-
-#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
-enum NodeGraphToolFsmState {
-	#[default]
-	Ready,
-	Drawing,
-}
-
-#[derive(Clone, Debug, Default)]
-struct NodeGraphToolData {
-	data: Resize,
-	path_outlines: PathOutline,
-}
-
-impl Fsm for NodeGraphToolFsmState {
-	type ToolData = NodeGraphToolData;
-	type ToolOptions = ();
-
-	fn transition(self, event: ToolMessage, tool_data: &mut Self::ToolData, tool_action_data: &mut ToolActionHandlerData, _tool_options: &(), responses: &mut VecDeque<Message>) -> Self {
-		let ToolActionHandlerData { document, input, render_data, .. } = tool_action_data;
-
-		let shape_data = &mut tool_data.data;
-
-		let ToolMessage::Frame(event) = event else {
-			return self;
-		};
-		match (self, event) {
-			(_, FrameToolMessage::DocumentIsDirty | FrameToolMessage::SelectionChanged) => {
-				tool_data.path_outlines.clear_selected(responses);
-				//tool_data.path_outlines.update_selected(document.selected_visible_layers(), document, responses, render_data);
-
-				self
-			}
-			(NodeGraphToolFsmState::Ready, FrameToolMessage::DragStart) => {
-				tool_data.path_outlines.clear_selected(responses);
-
-				shape_data.start(responses, document, input, render_data);
-				responses.add(DocumentMessage::StartTransaction);
-				shape_data.path = Some(document.get_path_for_new_layer());
-				responses.add(DocumentMessage::DeselectAllLayers);
-
-				let network = node_graph::new_image_network(8, 0);
-
-				responses.add(Operation::AddFrame {
-					path: shape_data.path.clone().unwrap(),
-					insert_index: -1,
-					transform: DAffine2::ZERO.to_cols_array(),
-					network,
-				});
-
-				NodeGraphToolFsmState::Drawing
-			}
-			(state, FrameToolMessage::Resize { center, lock_ratio }) => {
-				let message = shape_data.calculate_transform(responses, document, input, center, lock_ratio, true);
-				responses.try_add(message);
-
-				state
-			}
-			(NodeGraphToolFsmState::Drawing, FrameToolMessage::DragStop) => {
-				if let Some(layer_path) = &shape_data.path {
-					responses.add(DocumentMessage::InputFrameRasterizeRegionBelowLayer { layer_path: layer_path.to_vec() });
-				}
-
-				input.mouse.finish_transaction(shape_data.viewport_drag_start(document), responses);
-				shape_data.cleanup(responses);
-
-				NodeGraphToolFsmState::Ready
-			}
-			(NodeGraphToolFsmState::Drawing, FrameToolMessage::Abort) => {
-				responses.add(DocumentMessage::AbortTransaction);
-
-				shape_data.cleanup(responses);
-				tool_data.path_outlines.clear_selected(responses);
-
-				NodeGraphToolFsmState::Ready
-			}
-			(_, FrameToolMessage::Abort) => {
-				tool_data.path_outlines.clear_selected(responses);
-
-				NodeGraphToolFsmState::Ready
-			}
-			_ => self,
-		}
-	}
-
-	fn update_hints(&self, responses: &mut VecDeque<Message>) {
-		let hint_data = match self {
-			NodeGraphToolFsmState::Ready => HintData(vec![HintGroup(vec![
-				HintInfo::mouse(MouseMotion::LmbDrag, "Draw Repaint Frame"),
-				HintInfo::keys([Key::Shift], "Constrain Square").prepend_plus(),
-				HintInfo::keys([Key::Alt], "From Center").prepend_plus(),
-			])]),
-			NodeGraphToolFsmState::Drawing => HintData(vec![HintGroup(vec![HintInfo::keys([Key::Shift], "Constrain Square"), HintInfo::keys([Key::Alt], "From Center")])]),
-		};
-
-		responses.add(FrontendMessage::UpdateInputHints { hint_data });
-	}
-
-	fn update_cursor(&self, responses: &mut VecDeque<Message>) {
-		responses.add(FrontendMessage::UpdateMouseCursor { cursor: MouseCursorIcon::Crosshair });
-	}
-}

editor/src/messages/tool/tool_messages/mod.rs

@@ -3,7 +3,6 @@ pub mod brush_tool;
 pub mod ellipse_tool;
 pub mod eyedropper_tool;
 pub mod fill_tool;
-pub mod frame_tool;
 pub mod freehand_tool;
 pub mod gradient_tool;
 pub mod imaginate_tool;

editor/src/messages/tool/utility_types.rs

@@ -396,7 +396,6 @@ fn list_tools_in_groups() -> Vec<Vec<ToolAvailability>> {
 		],
 		vec![
 			// Raster tool group
-			ToolAvailability::Available(Box::<frame_tool::FrameTool>::default()),
 			ToolAvailability::Available(Box::<imaginate_tool::ImaginateTool>::default()),
 			ToolAvailability::Available(Box::<brush_tool::BrushTool>::default()),
 			ToolAvailability::ComingSoon(ToolEntry::new(ToolType::Heal, "RasterHealTool").tooltip("Coming Soon: Heal Tool (J)")),
@@ -437,7 +436,6 @@ pub fn tool_message_to_tool_type(tool_message: &ToolMessage) -> ToolType {
 		// ToolMessage::Detail(_) => ToolType::Detail,
 		// ToolMessage::Relight(_) => ToolType::Relight,
 		ToolMessage::Imaginate(_) => ToolType::Imaginate,
-		ToolMessage::Frame(_) => ToolType::Frame,
 		_ => panic!("Conversion from ToolMessage to ToolType impossible because the given ToolMessage does not have a matching ToolType. Got: {tool_message:?}"),
 	}
 }
@@ -471,7 +469,6 @@ pub fn tool_type_to_activate_tool_message(tool_type: ToolType) -> ToolMessageDis
 		// ToolType::Detail => ToolMessageDiscriminant::ActivateToolDetail,
 		// ToolType::Relight => ToolMessageDiscriminant::ActivateToolRelight,
 		ToolType::Imaginate => ToolMessageDiscriminant::ActivateToolImaginate,
-		ToolType::Frame => ToolMessageDiscriminant::ActivateToolFrame,
 		_ => panic!("Conversion from ToolType to ToolMessage impossible because the given ToolType does not have a matching ToolMessage. Got: {tool_type:?}"),
 	}
 }

frontend/assets/icon-24px-two-tone/raster-frame-tool.svg

@@ -1,4 +0,0 @@
-<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
-	<path class="color-raster" d="M18,8v8H6V8H18 M19,6H5C4.5,6,4,6.4,4,7v10c0,0.5,0.5,1,1,1h14c0.5,0,1-0.5,1-1V7C20,6.4,19.5,6,19,6L19,6z" />
-	<path d="M2,8V6c0-1.1,0.9-2,2-2h2v1H4C3.4,5,3,5.4,3,6v2H2z M21,16v2c0,0.6-0.4,1-1,1h-2v1h2c1.1,0,2-0.9,2-2v-2H21z M18,5h2c0.6,0,1,0.4,1,1v2h1V6c0-1.1-0.9-2-2-2h-2V5z M6,19H4c-0.6,0-1-0.4-1-1v-2H2v2c0,1.1,0.9,2,2,2h2V19z" />
-</svg>

frontend/src/utility-functions/icons.ts

@@ -260,7 +260,6 @@ import GeneralSelectTool from "@graphite-frontend/assets/icon-24px-two-tone/gene
 import RasterBrushTool from "@graphite-frontend/assets/icon-24px-two-tone/raster-brush-tool.svg";
 import RasterCloneTool from "@graphite-frontend/assets/icon-24px-two-tone/raster-clone-tool.svg";
 import RasterDetailTool from "@graphite-frontend/assets/icon-24px-two-tone/raster-detail-tool.svg";
-import RasterFrameTool from "@graphite-frontend/assets/icon-24px-two-tone/raster-frame-tool.svg";
 import RasterHealTool from "@graphite-frontend/assets/icon-24px-two-tone/raster-heal-tool.svg";
 import RasterImaginateTool from "@graphite-frontend/assets/icon-24px-two-tone/raster-imaginate-tool.svg";
 import RasterPatchTool from "@graphite-frontend/assets/icon-24px-two-tone/raster-patch-tool.svg";
@@ -285,7 +284,6 @@ const TWO_TONE_24PX = {
 	RasterBrushTool: { svg: RasterBrushTool, size: 24 },
 	RasterCloneTool: { svg: RasterCloneTool, size: 24 },
 	RasterDetailTool: { svg: RasterDetailTool, size: 24 },
-	RasterFrameTool: { svg: RasterFrameTool, size: 24 },
 	RasterHealTool: { svg: RasterHealTool, size: 24 },
 	RasterImaginateTool: { svg: RasterImaginateTool, size: 24 },
 	RasterPatchTool: { svg: RasterPatchTool, size: 24 },