use crate::consts::GRAPHENE_DOCUMENT_VERSION; use std::{ cmp::max, collections::hash_map::DefaultHasher, hash::{Hash, Hasher}, }; use glam::{DAffine2, DVec2}; use serde::{Deserialize, Serialize}; use crate::{ layers::{self, style::ViewMode, Folder, Layer, LayerData, LayerDataType, Shape}, DocumentError, DocumentResponse, LayerId, Operation, Quad, }; #[derive(Debug, Clone, Deserialize, Serialize)] pub struct Document { pub root: Layer, /// The state_identifier serves to provide a way to uniquely identify a particular state that the document is in. /// This identifier is not a hash and is not guaranteed to be equal for equivalent documents. #[serde(skip)] pub state_identifier: DefaultHasher, pub graphene_document_version: String, } impl Default for Document { fn default() -> Self { Self { root: Layer::new(LayerDataType::Folder(Folder::default()), DAffine2::IDENTITY.to_cols_array()), state_identifier: DefaultHasher::new(), graphene_document_version: GRAPHENE_DOCUMENT_VERSION.to_string(), } } } impl Document { /// Wrapper around render, that returns the whole document as a Response. pub fn render_root(&mut self, mode: ViewMode) -> String { self.root.render(&mut vec![], mode); self.root.cache.clone() } pub fn current_state_identifier(&self) -> u64 { self.state_identifier.finish() } /// Checks whether each layer under `path` intersects with the provided `quad` and adds all intersection layers as paths to `intersections`. pub fn intersects_quad(&self, quad: Quad, path: &mut Vec, intersections: &mut Vec>) { self.layer(path).unwrap().intersects_quad(quad, path, intersections); } /// Checks whether each layer under the root path intersects with the provided `quad` and returns the paths to all intersecting layers. pub fn intersects_quad_root(&self, quad: Quad) -> Vec> { let mut intersections = Vec::new(); self.intersects_quad(quad, &mut vec![], &mut intersections); intersections } /// Returns a reference to the requested folder. Fails if the path does not exist, /// or if the requested layer is not of type folder. pub fn folder(&self, path: &[LayerId]) -> Result<&Folder, DocumentError> { let mut root = &self.root; for id in path { root = root.as_folder()?.layer(*id).ok_or(DocumentError::LayerNotFound)?; } root.as_folder() } /// Returns a mutable reference to the requested folder. Fails if the path does not exist, /// or if the requested layer is not of type folder. /// If you manually edit the folder you have to set the cache_dirty flag yourself. fn folder_mut(&mut self, path: &[LayerId]) -> Result<&mut Folder, DocumentError> { let mut root = &mut self.root; for id in path { root = root.as_folder_mut()?.layer_mut(*id).ok_or(DocumentError::LayerNotFound)?; } root.as_folder_mut() } /// Returns a reference to the layer or folder at the path. pub fn layer(&self, path: &[LayerId]) -> Result<&Layer, DocumentError> { if path.is_empty() { return Ok(&self.root); } let (path, id) = split_path(path)?; self.folder(path)?.layer(id).ok_or(DocumentError::LayerNotFound) } /// Returns a mutable reference to the layer or folder at the path. fn layer_mut(&mut self, path: &[LayerId]) -> Result<&mut Layer, DocumentError> { if path.is_empty() { return Ok(&mut self.root); } let (path, id) = split_path(path)?; self.folder_mut(path)?.layer_mut(id).ok_or(DocumentError::LayerNotFound) } pub fn deepest_common_folder<'a>(&self, layers: impl Iterator) -> Result<&'a [LayerId], DocumentError> { let common_prefix_of_path = self.common_layer_path_prefix(layers); Ok(match self.layer(common_prefix_of_path)?.data { LayerDataType::Folder(_) => common_prefix_of_path, LayerDataType::Shape(_) => &common_prefix_of_path[..common_prefix_of_path.len() - 1], }) } pub fn common_layer_path_prefix<'a>(&self, layers: impl Iterator) -> &'a [LayerId] { layers .reduce(|a, b| { let number_of_uncommon_ids_in_a = (0..a.len()).position(|i| b.starts_with(&a[..a.len() - i])).unwrap_or_default(); &a[..(a.len() - number_of_uncommon_ids_in_a)] }) .unwrap_or_default() } // Determines which layer is closer to the root, if path_a return true, if path_b return false // Answers the question: Is A closer to the root than B? pub fn layer_closer_to_root(&self, path_a: &Vec, path_b: &Vec) -> bool { // Convert UUIDs to indices let indices_for_path_a = self.indices_for_path(path_a).unwrap(); let indices_for_path_b = self.indices_for_path(path_b).unwrap(); let longest = max(indices_for_path_a.len(), indices_for_path_b.len()); for i in 0..longest { // usize::MAX becomes negative one here, sneaky. So folders are compared as [X, -1]. This is intentional. let index_a = *indices_for_path_a.get(i).unwrap_or(&usize::MAX) as i32; let index_b = *indices_for_path_b.get(i).unwrap_or(&usize::MAX) as i32; // index_a == index_b -> true, this means the "2" indices being compared are within the same folder // eg -> [2, X] == [2, X] since we are only comparing the "2" in this iteration // Continue onto comparing the X indices. if index_a == index_b { continue; } // If index_a is smaller, index_a is closer to the root return index_a < index_b; } return false; } // Is the target layer between a <-> b layers, inclusive pub fn layer_is_between(&self, target: &Vec, path_a: &Vec, path_b: &Vec) -> bool { // If the target is a nonsense path, it isn't between if target.len() < 1 { return false; } // This function is inclusive, so we consider path_a, path_b to be between themselves if target == path_a || target == path_b { return true; }; // These can't both be true and be between two values let layer_vs_a = self.layer_closer_to_root(target, path_a); let layer_vs_b = self.layer_closer_to_root(target, path_b); // To be inbetween you need to be above A and below B or vice versa return layer_vs_a != layer_vs_b; } /// Given a path to a layer, returns a vector of the indices in the layer tree /// These indices can be used to order a list of layers pub fn indices_for_path(&self, path: &[LayerId]) -> Result, DocumentError> { let mut root = self.root.as_folder()?; let mut indices = vec![]; let (path, layer_id) = split_path(path)?; // TODO: appears to be n^2? should we maintain a lookup table? for id in path { let pos = root.layer_ids.iter().position(|x| *x == *id).ok_or(DocumentError::LayerNotFound)?; indices.push(pos); root = root.folder(*id).ok_or(DocumentError::LayerNotFound)?; } indices.push(root.layer_ids.iter().position(|x| *x == layer_id).ok_or(DocumentError::LayerNotFound)?); Ok(indices) } /// Replaces the layer at the specified `path` with `layer`. pub fn set_layer(&mut self, path: &[LayerId], layer: Layer, insert_index: isize) -> Result<(), DocumentError> { let mut folder = self.root.as_folder_mut()?; let mut layer_id = None; if let Ok((path, id)) = split_path(path) { layer_id = Some(id); self.mark_as_dirty(path)?; folder = self.folder_mut(path)?; if let Some(folder_layer) = folder.layer_mut(id) { *folder_layer = layer; return Ok(()); } } folder.add_layer(layer, layer_id, insert_index).ok_or(DocumentError::IndexOutOfBounds)?; Ok(()) } /// Visit each layer recursively, applies modify_shape to each non-overlay Shape pub fn visit_all_shapes(layer: &mut Layer, modify_shape: &mut F) -> bool { match layer.data { LayerDataType::Shape(ref mut shape) => { if !layer.overlay { modify_shape(shape); // This layer should be updated on next render pass layer.cache_dirty = true; } } LayerDataType::Folder(ref mut folder) => { for sub_layer in folder.layers_mut() { if Document::visit_all_shapes(sub_layer, modify_shape) { layer.cache_dirty = true; } } } } layer.cache_dirty } /// Adds a new layer to the folder specified by `path`. /// Passing a negative `insert_index` indexes relative to the end. /// -1 is equivalent to adding the layer to the top. pub fn add_layer(&mut self, path: &[LayerId], layer: Layer, insert_index: isize) -> Result { let folder = self.folder_mut(path)?; folder.add_layer(layer, None, insert_index).ok_or(DocumentError::IndexOutOfBounds) } /// Deletes the layer specified by `path`. pub fn delete(&mut self, path: &[LayerId]) -> Result<(), DocumentError> { let (path, id) = split_path(path)?; self.mark_as_dirty(path)?; self.folder_mut(path)?.remove_layer(id) } pub fn visible_layers(&self, path: &mut Vec, paths: &mut Vec>) -> Result<(), DocumentError> { if !self.layer(path)?.visible { return Ok(()); } if let Ok(folder) = self.folder(path) { for layer in folder.layer_ids.iter() { path.push(*layer); self.visible_layers(path, paths)?; path.pop(); } } else { paths.push(path.clone()); } Ok(()) } pub fn viewport_bounding_box(&self, path: &[LayerId]) -> Result, DocumentError> { let layer = self.layer(path)?; let transform = self.multiply_transforms(path)?; Ok(layer.data.bounding_box(transform)) } pub fn visible_layers_bounding_box(&self) -> Option<[DVec2; 2]> { let mut paths = vec![]; self.visible_layers(&mut vec![], &mut paths).ok()?; self.combined_viewport_bounding_box(paths.iter().map(|x| x.as_slice())) } pub fn combined_viewport_bounding_box<'a>(&self, paths: impl Iterator) -> Option<[DVec2; 2]> { let boxes = paths.filter_map(|path| self.viewport_bounding_box(path).ok()?); boxes.reduce(|a, b| [a[0].min(b[0]), a[1].max(b[1])]) } pub fn mark_upstream_as_dirty(&mut self, path: &[LayerId]) -> Result<(), DocumentError> { let mut root = &mut self.root; root.cache_dirty = true; for id in path { root = root.as_folder_mut()?.layer_mut(*id).ok_or(DocumentError::LayerNotFound)?; root.cache_dirty = true; } Ok(()) } pub fn mark_downstream_as_dirty(&mut self, path: &[LayerId]) -> Result<(), DocumentError> { let mut layer = self.layer_mut(path)?; layer.cache_dirty = true; let mut path = path.to_vec(); let len = path.len(); path.push(0); if let Some(ids) = layer.as_folder().ok().map(|f| f.layer_ids.clone()) { for id in ids { path[len] = id; self.mark_downstream_as_dirty(&path)? } } Ok(()) } pub fn mark_as_dirty(&mut self, path: &[LayerId]) -> Result<(), DocumentError> { self.mark_upstream_as_dirty(path)?; Ok(()) } pub fn transforms(&self, path: &[LayerId]) -> Result, DocumentError> { let mut root = &self.root; let mut transforms = vec![self.root.transform]; for id in path { if let Ok(folder) = root.as_folder() { root = folder.layer(*id).ok_or(DocumentError::LayerNotFound)?; } transforms.push(root.transform); } Ok(transforms) } pub fn multiply_transforms(&self, path: &[LayerId]) -> Result { let mut root = &self.root; let mut trans = self.root.transform; for id in path { if let Ok(folder) = root.as_folder() { root = folder.layer(*id).ok_or(DocumentError::LayerNotFound)?; } trans = trans * root.transform; } Ok(trans) } pub fn generate_transform_across_scope(&self, from: &[LayerId], to: Option) -> Result { let from_rev = self.multiply_transforms(from)?; let scope = to.unwrap_or(DAffine2::IDENTITY); Ok(scope * from_rev) } pub fn transform_relative_to_scope(&mut self, layer: &[LayerId], scope: Option, transform: DAffine2) -> Result<(), DocumentError> { let to = self.generate_transform_across_scope(&layer[..layer.len() - 1], scope)?; let layer = self.layer_mut(layer)?; layer.transform = to.inverse() * transform * to * layer.transform; Ok(()) } pub fn set_transform_relative_to_scope(&mut self, layer: &[LayerId], scope: Option, transform: DAffine2) -> Result<(), DocumentError> { let to = self.generate_transform_across_scope(&layer[..layer.len() - 1], scope)?; let layer = self.layer_mut(layer)?; layer.transform = to.inverse() * transform; Ok(()) } pub fn generate_transform_relative_to_viewport(&self, from: &[LayerId]) -> Result { self.generate_transform_across_scope(from, None) } pub fn apply_transform_relative_to_viewport(&mut self, layer: &[LayerId], transform: DAffine2) -> Result<(), DocumentError> { self.transform_relative_to_scope(layer, None, transform) } pub fn set_transform_relative_to_viewport(&mut self, layer: &[LayerId], transform: DAffine2) -> Result<(), DocumentError> { self.set_transform_relative_to_scope(layer, None, transform) } fn remove_overlays(&mut self, path: &mut Vec) { if self.layer(path).unwrap().overlay { self.delete(path).unwrap() } let ids = self.folder(path).map(|folder| folder.layer_ids.clone()).unwrap_or_default(); for id in ids { path.push(id); self.remove_overlays(path); path.pop(); } } pub fn clone_without_overlays(&self) -> Self { let mut document = self.clone(); document.remove_overlays(&mut vec![]); document } /// Mutate the document by applying the `operation` to it. If the operation necessitates a /// reaction from the frontend, responses may be returned. pub fn handle_operation(&mut self, operation: &Operation) -> Result>, DocumentError> { operation.pseudo_hash().hash(&mut self.state_identifier); use DocumentResponse::*; let responses = match &operation { Operation::AddEllipse { path, insert_index, transform, style } => { let layer = Layer::new(LayerDataType::Shape(Shape::ellipse(*style)), *transform); self.set_layer(path, layer, *insert_index)?; Some([vec![DocumentChanged, CreatedLayer { path: path.clone() }], update_thumbnails_upstream(path)].concat()) } Operation::AddOverlayEllipse { path, transform, style } => { let mut ellipse = Shape::ellipse(*style); ellipse.render_index = -1; let mut layer = Layer::new(LayerDataType::Shape(ellipse), *transform); layer.overlay = true; self.set_layer(path, layer, -1)?; Some([vec![DocumentChanged, CreatedLayer { path: path.clone() }]].concat()) } Operation::AddRect { path, insert_index, transform, style } => { let layer = Layer::new(LayerDataType::Shape(Shape::rectangle(*style)), *transform); self.set_layer(path, layer, *insert_index)?; Some([vec![DocumentChanged, CreatedLayer { path: path.clone() }], update_thumbnails_upstream(path)].concat()) } Operation::AddOverlayRect { path, transform, style } => { let mut rect = Shape::rectangle(*style); rect.render_index = -1; let mut layer = Layer::new(LayerDataType::Shape(rect), *transform); layer.overlay = true; self.set_layer(path, layer, -1)?; Some([vec![DocumentChanged, CreatedLayer { path: path.clone() }]].concat()) } Operation::AddLine { path, insert_index, transform, style } => { let layer = Layer::new(LayerDataType::Shape(Shape::line(*style)), *transform); self.set_layer(path, layer, *insert_index)?; Some([vec![DocumentChanged, CreatedLayer { path: path.clone() }], update_thumbnails_upstream(path)].concat()) } Operation::AddOverlayLine { path, transform, style } => { let mut line = Shape::line(*style); line.render_index = -1; let mut layer = Layer::new(LayerDataType::Shape(line), *transform); layer.overlay = true; self.set_layer(path, layer, -1)?; Some([vec![DocumentChanged, CreatedLayer { path: path.clone() }]].concat()) } Operation::AddNgon { path, insert_index, transform, style, sides, } => { let layer = Layer::new(LayerDataType::Shape(Shape::ngon(*sides, *style)), *transform); self.set_layer(path, layer, *insert_index)?; Some([vec![DocumentChanged, CreatedLayer { path: path.clone() }], update_thumbnails_upstream(path)].concat()) } Operation::AddOverlayShape { path, style, bez_path } => { let mut shape = Shape::from_bez_path(bez_path.clone(), *style, false); shape.render_index = -1; let mut layer = Layer::new(LayerDataType::Shape(shape), DAffine2::IDENTITY.to_cols_array()); layer.overlay = true; self.set_layer(path, layer, -1)?; Some([vec![DocumentChanged, CreatedLayer { path: path.clone() }]].concat()) } Operation::AddPen { path, insert_index, points, transform, style, } => { let points: Vec = points.iter().map(|&it| it.into()).collect(); self.set_layer(path, Layer::new(LayerDataType::Shape(Shape::poly_line(points, *style)), *transform), *insert_index)?; Some([vec![DocumentChanged, CreatedLayer { path: path.clone() }], update_thumbnails_upstream(path)].concat()) } Operation::DeleteLayer { path } => { fn aggregate_deletions(folder: &Folder, path: &mut Vec, responses: &mut Vec) { for (id, layer) in folder.layer_ids.iter().zip(folder.layers()) { path.push(*id); responses.push(DocumentResponse::DeletedLayer { path: path.clone() }); if let LayerDataType::Folder(f) = &layer.data { aggregate_deletions(f, path, responses); } path.pop(); } } let mut responses = Vec::new(); if let Ok(folder) = self.folder(path) { aggregate_deletions(folder, &mut path.clone(), &mut responses) }; self.delete(path)?; let (folder, _) = split_path(path.as_slice()).unwrap_or_else(|_| (&[], 0)); responses.extend([DocumentChanged, DeletedLayer { path: path.clone() }, FolderChanged { path: folder.to_vec() }]); responses.extend(update_thumbnails_upstream(folder)); Some(responses) } Operation::PasteLayer { path, layer, insert_index } => { let folder = self.folder_mut(path)?; let id = folder.add_layer(layer.clone(), None, *insert_index).ok_or(DocumentError::IndexOutOfBounds)?; let full_path = [path.clone(), vec![id]].concat(); self.mark_as_dirty(&full_path)?; fn aggregate_insertions(folder: &Folder, path: &mut Vec, responses: &mut Vec) { for (id, layer) in folder.layer_ids.iter().zip(folder.layers()) { path.push(*id); responses.push(DocumentResponse::CreatedLayer { path: path.clone() }); if let LayerDataType::Folder(f) = &layer.data { aggregate_insertions(f, path, responses); } path.pop(); } } let mut responses = Vec::new(); if let Ok(folder) = self.folder(&full_path) { aggregate_insertions(folder, &mut full_path.clone(), &mut responses) }; responses.extend([DocumentChanged, CreatedLayer { path: full_path }, FolderChanged { path: path.clone() }]); responses.extend(update_thumbnails_upstream(path)); Some(responses) } Operation::DuplicateLayer { path } => { let layer = self.layer(path)?.clone(); let (folder_path, _) = split_path(path.as_slice()).unwrap_or_else(|_| (&[], 0)); let folder = self.folder_mut(folder_path)?; if let Some(new_layer_id) = folder.add_layer(layer, None, -1) { let new_path = [folder_path, &[new_layer_id]].concat(); self.mark_as_dirty(folder_path)?; Some( [ vec![DocumentChanged, CreatedLayer { path: new_path }, FolderChanged { path: folder_path.to_vec() }], update_thumbnails_upstream(path.as_slice()), ] .concat(), ) } else { return Err(DocumentError::IndexOutOfBounds); } } Operation::RenameLayer { path, name } => { self.layer_mut(path)?.name = Some(name.clone()); Some(vec![LayerChanged { path: path.clone() }]) } Operation::CreateFolder { path } => { self.set_layer(path, Layer::new(LayerDataType::Folder(Folder::default()), DAffine2::IDENTITY.to_cols_array()), -1)?; self.mark_as_dirty(path)?; Some(vec![DocumentChanged, CreatedLayer { path: path.clone() }]) } Operation::TransformLayer { path, transform } => { let layer = self.layer_mut(path).unwrap(); let transform = DAffine2::from_cols_array(transform) * layer.transform; layer.transform = transform; self.mark_as_dirty(path)?; Some(vec![DocumentChanged]) } Operation::TransformLayerInViewport { path, transform } => { let transform = DAffine2::from_cols_array(transform); self.apply_transform_relative_to_viewport(path, transform)?; self.mark_as_dirty(path)?; Some([vec![DocumentChanged], update_thumbnails_upstream(path)].concat()) } Operation::SetLayerTransformInViewport { path, transform } => { let transform = DAffine2::from_cols_array(transform); self.set_transform_relative_to_viewport(path, transform)?; self.mark_as_dirty(path)?; Some([vec![DocumentChanged], update_thumbnails_upstream(path)].concat()) } Operation::SetShapePathInViewport { path, bez_path, transform } => { let transform = DAffine2::from_cols_array(transform); self.set_transform_relative_to_viewport(path, transform)?; self.mark_as_dirty(path)?; match &mut self.layer_mut(path)?.data { LayerDataType::Shape(shape) => { shape.path = bez_path.clone(); } LayerDataType::Folder(_) => (), } Some(vec![DocumentChanged, LayerChanged { path: path.clone() }]) } Operation::TransformLayerInScope { path, transform, scope } => { let transform = DAffine2::from_cols_array(transform); let scope = DAffine2::from_cols_array(scope); self.transform_relative_to_scope(path, Some(scope), transform)?; self.mark_as_dirty(path)?; Some([vec![DocumentChanged], update_thumbnails_upstream(path)].concat()) } Operation::SetLayerTransformInScope { path, transform, scope } => { let transform = DAffine2::from_cols_array(transform); let scope = DAffine2::from_cols_array(scope); self.set_transform_relative_to_scope(path, Some(scope), transform)?; self.mark_as_dirty(path)?; Some([vec![DocumentChanged], update_thumbnails_upstream(path)].concat()) } Operation::SetLayerTransform { path, transform } => { let transform = DAffine2::from_cols_array(transform); let layer = self.layer_mut(path)?; layer.transform = transform; self.mark_as_dirty(path)?; Some([vec![DocumentChanged], update_thumbnails_upstream(path)].concat()) } Operation::ToggleLayerVisibility { path } => { self.mark_as_dirty(path)?; let layer = self.layer_mut(path)?; layer.visible = !layer.visible; Some([vec![DocumentChanged], update_thumbnails_upstream(path)].concat()) } Operation::SetLayerVisibility { path, visible } => { self.mark_as_dirty(path)?; let layer = self.layer_mut(path)?; layer.visible = *visible; Some([vec![DocumentChanged], update_thumbnails_upstream(path)].concat()) } Operation::SetLayerBlendMode { path, blend_mode } => { self.mark_as_dirty(path)?; self.layer_mut(path)?.blend_mode = *blend_mode; Some([vec![DocumentChanged], update_thumbnails_upstream(path)].concat()) } Operation::SetLayerOpacity { path, opacity } => { self.mark_as_dirty(path)?; self.layer_mut(path)?.opacity = *opacity; Some([vec![DocumentChanged], update_thumbnails_upstream(path)].concat()) } Operation::SetLayerStyle { path, style } => { let layer = self.layer_mut(path)?; match &mut layer.data { LayerDataType::Shape(s) => s.style = *style, _ => return Err(DocumentError::NotAShape), } self.mark_as_dirty(path)?; Some(vec![DocumentChanged, LayerChanged { path: path.clone() }]) } Operation::SetLayerFill { path, color } => { let layer = self.layer_mut(path)?; match &mut layer.data { LayerDataType::Shape(s) => s.style.set_fill(layers::style::Fill::new(*color)), _ => return Err(DocumentError::NotAShape), } self.mark_as_dirty(path)?; Some([vec![DocumentChanged], update_thumbnails_upstream(path)].concat()) } }; Ok(responses) } } fn split_path(path: &[LayerId]) -> Result<(&[LayerId], LayerId), DocumentError> { let (id, path) = path.split_last().ok_or(DocumentError::InvalidPath)?; Ok((path, *id)) } fn update_thumbnails_upstream(path: &[LayerId]) -> Vec { let length = path.len(); let mut responses = Vec::with_capacity(length); for i in 0..length { responses.push(DocumentResponse::LayerChanged { path: path[0..(length - i)].to_vec() }); } responses }