Skip to content

Commit 0158be3

Browse files
KeavonKeavon
authored
Instance tables refactor part 4: replace ArtboardGroups with multi-row Instances<Artboard> (#2265)
* Clean up dyn_any usages * Migrate ArtboardGroup to ArtboardGroupTable (not yet flattened) * Reorder graphical data imports * Flatten and remove ArtboardGroup in favor of ArtboardGroupTable * Fix test
1 parent 9ae6562 commit 0158be3

File tree

32 files changed

+233
-156
lines changed

32 files changed

+233
-156
lines changed

‎editor/src/messages/portfolio/document/document_message_handler.rs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2408,7 +2408,7 @@ impl DocumentMessageHandler {
24082408
/// Create a network interface with a single export
24092409
fn default_document_network_interface() -> NodeNetworkInterface {
24102410
let mut network_interface = NodeNetworkInterface::default();
2411-
network_interface.add_export(TaggedValue::ArtboardGroup(graphene_core::ArtboardGroup::default()), -1, "", &[]);
2411+
network_interface.add_export(TaggedValue::ArtboardGroup(graphene_core::ArtboardGroupTable::default()), -1, "", &[]);
24122412
network_interface
24132413
}
24142414

‎editor/src/messages/portfolio/document/graph_operation/utility_types.rs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ impl<'a> ModifyInputsContext<'a> {
126126
/// Creates an artboard as the primary export for the document network
127127
pub fn create_artboard(&mut self, new_id: NodeId, artboard: Artboard) -> LayerNodeIdentifier {
128128
let artboard_node_template = resolve_document_node_type("Artboard").expect("Node").node_template_input_override([
129-
Some(NodeInput::value(TaggedValue::ArtboardGroup(graphene_std::ArtboardGroup::default()), true)),
129+
Some(NodeInput::value(TaggedValue::ArtboardGroup(graphene_std::ArtboardGroupTable::default()), true)),
130130
Some(NodeInput::value(TaggedValue::GraphicGroup(graphene_core::GraphicGroupTable::default()), true)),
131131
Some(NodeInput::value(TaggedValue::IVec2(artboard.location), false)),
132132
Some(NodeInput::value(TaggedValue::IVec2(artboard.dimensions), false)),

‎editor/src/messages/portfolio/document/node_graph/document_node_definitions.rs‎

Lines changed: 25 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -295,7 +295,7 @@ fn static_nodes() -> Vec<DocumentNodeDefinition> {
295295
DocumentNode {
296296
manual_composition: Some(concrete!(Context)),
297297
inputs: vec![
298-
NodeInput::network(graphene_core::Type::Fn(Box::new(concrete!(Context)), Box::new(concrete!(ArtboardGroup))), 0),
298+
NodeInput::network(graphene_core::Type::Fn(Box::new(concrete!(Context)), Box::new(concrete!(ArtboardGroupTable))), 0),
299299
NodeInput::node(NodeId(1), 0),
300300
NodeInput::Reflection(graph_craft::document::DocumentNodeMetadata::DocumentNodePath),
301301
],
@@ -310,7 +310,7 @@ fn static_nodes() -> Vec<DocumentNodeDefinition> {
310310
..Default::default()
311311
}),
312312
inputs: vec![
313-
NodeInput::value(TaggedValue::ArtboardGroup(ArtboardGroup::default()), true),
313+
NodeInput::value(TaggedValue::ArtboardGroup(ArtboardGroupTable::default()), true),
314314
NodeInput::value(TaggedValue::GraphicGroup(GraphicGroupTable::default()), true),
315315
NodeInput::value(TaggedValue::IVec2(glam::IVec2::ZERO), false),
316316
NodeInput::value(TaggedValue::IVec2(glam::IVec2::new(1920, 1080)), false),
@@ -544,7 +544,7 @@ fn static_nodes() -> Vec<DocumentNodeDefinition> {
544544
nodes: [
545545
DocumentNode {
546546
inputs: vec![NodeInput::network(concrete!(ImageFrameTable<Color>), 0)],
547-
implementation: DocumentNodeImplementation::ProtoNode(ProtoNodeIdentifier::new("graphene_core::ops::IntoNode<_, ImageFrame>")), // TODO: Possibly change `ImageFrame` to something else
547+
implementation: DocumentNodeImplementation::ProtoNode(ProtoNodeIdentifier::new("graphene_core::ops::IntoNode<_, ImageFrameTable>")),
548548
..Default::default()
549549
},
550550
DocumentNode {
@@ -571,7 +571,7 @@ fn static_nodes() -> Vec<DocumentNodeDefinition> {
571571
.collect(),
572572
..Default::default()
573573
}),
574-
inputs: vec![NodeInput::value(TaggedValue::ImageFrame(ImageFrameTable::empty()), true)],
574+
inputs: vec![NodeInput::value(TaggedValue::ImageFrame(ImageFrameTable::one_empty_image()), true)],
575575
..Default::default()
576576
},
577577
persistent_node_metadata: DocumentNodePersistentMetadata {
@@ -809,8 +809,8 @@ fn static_nodes() -> Vec<DocumentNodeDefinition> {
809809
document_node: DocumentNode {
810810
implementation: DocumentNodeImplementation::proto("graphene_std::raster::MaskImageNode"),
811811
inputs: vec![
812-
NodeInput::value(TaggedValue::ImageFrame(ImageFrameTable::empty()), true),
813-
NodeInput::value(TaggedValue::ImageFrame(ImageFrameTable::empty()), true),
812+
NodeInput::value(TaggedValue::ImageFrame(ImageFrameTable::one_empty_image()), true),
813+
NodeInput::value(TaggedValue::ImageFrame(ImageFrameTable::one_empty_image()), true),
814814
],
815815
..Default::default()
816816
},
@@ -832,8 +832,8 @@ fn static_nodes() -> Vec<DocumentNodeDefinition> {
832832
document_node: DocumentNode {
833833
implementation: DocumentNodeImplementation::proto("graphene_std::raster::InsertChannelNode"),
834834
inputs: vec![
835-
NodeInput::value(TaggedValue::ImageFrame(ImageFrameTable::empty()), true),
836-
NodeInput::value(TaggedValue::ImageFrame(ImageFrameTable::empty()), true),
835+
NodeInput::value(TaggedValue::ImageFrame(ImageFrameTable::one_empty_image()), true),
836+
NodeInput::value(TaggedValue::ImageFrame(ImageFrameTable::one_empty_image()), true),
837837
NodeInput::value(TaggedValue::RedGreenBlue(RedGreenBlue::default()), false),
838838
],
839839
..Default::default()
@@ -856,10 +856,10 @@ fn static_nodes() -> Vec<DocumentNodeDefinition> {
856856
implementation: DocumentNodeImplementation::proto("graphene_std::raster::CombineChannelsNode"),
857857
inputs: vec![
858858
NodeInput::value(TaggedValue::None, false),
859-
NodeInput::value(TaggedValue::ImageFrame(ImageFrameTable::empty()), true),
860-
NodeInput::value(TaggedValue::ImageFrame(ImageFrameTable::empty()), true),
861-
NodeInput::value(TaggedValue::ImageFrame(ImageFrameTable::empty()), true),
862-
NodeInput::value(TaggedValue::ImageFrame(ImageFrameTable::empty()), true),
859+
NodeInput::value(TaggedValue::ImageFrame(ImageFrameTable::one_empty_image()), true),
860+
NodeInput::value(TaggedValue::ImageFrame(ImageFrameTable::one_empty_image()), true),
861+
NodeInput::value(TaggedValue::ImageFrame(ImageFrameTable::one_empty_image()), true),
862+
NodeInput::value(TaggedValue::ImageFrame(ImageFrameTable::one_empty_image()), true),
863863
],
864864
..Default::default()
865865
},
@@ -929,7 +929,7 @@ fn static_nodes() -> Vec<DocumentNodeDefinition> {
929929

930930
..Default::default()
931931
}),
932-
inputs: vec![NodeInput::value(TaggedValue::ImageFrame(ImageFrameTable::empty()), true)],
932+
inputs: vec![NodeInput::value(TaggedValue::ImageFrame(ImageFrameTable::one_empty_image()), true)],
933933
..Default::default()
934934
},
935935
persistent_node_metadata: DocumentNodePersistentMetadata {
@@ -1011,8 +1011,8 @@ fn static_nodes() -> Vec<DocumentNodeDefinition> {
10111011
..Default::default()
10121012
}),
10131013
inputs: vec![
1014-
NodeInput::value(TaggedValue::ImageFrame(ImageFrameTable::empty()), true),
1015-
NodeInput::value(TaggedValue::ImageFrame(ImageFrameTable::empty()), true),
1014+
NodeInput::value(TaggedValue::ImageFrame(ImageFrameTable::one_empty_image()), true),
1015+
NodeInput::value(TaggedValue::ImageFrame(ImageFrameTable::one_empty_image()), true),
10161016
NodeInput::value(TaggedValue::BrushStrokes(Vec::new()), false),
10171017
NodeInput::value(TaggedValue::BrushCache(BrushCache::new_proto()), false),
10181018
],
@@ -1061,7 +1061,7 @@ fn static_nodes() -> Vec<DocumentNodeDefinition> {
10611061
node_template: NodeTemplate {
10621062
document_node: DocumentNode {
10631063
implementation: DocumentNodeImplementation::proto("graphene_core::memo::MemoNode"),
1064-
inputs: vec![NodeInput::value(TaggedValue::ImageFrame(ImageFrameTable::empty()), true)],
1064+
inputs: vec![NodeInput::value(TaggedValue::ImageFrame(ImageFrameTable::one_empty_image()), true)],
10651065
manual_composition: Some(concrete!(Context)),
10661066
..Default::default()
10671067
},
@@ -1080,7 +1080,7 @@ fn static_nodes() -> Vec<DocumentNodeDefinition> {
10801080
node_template: NodeTemplate {
10811081
document_node: DocumentNode {
10821082
implementation: DocumentNodeImplementation::proto("graphene_core::memo::ImpureMemoNode"),
1083-
inputs: vec![NodeInput::value(TaggedValue::ImageFrame(ImageFrameTable::empty()), true)],
1083+
inputs: vec![NodeInput::value(TaggedValue::ImageFrame(ImageFrameTable::one_empty_image()), true)],
10841084
manual_composition: Some(concrete!(Context)),
10851085
..Default::default()
10861086
},
@@ -1112,7 +1112,10 @@ fn static_nodes() -> Vec<DocumentNodeDefinition> {
11121112
.collect(),
11131113
..Default::default()
11141114
}),
1115-
inputs: vec![NodeInput::value(TaggedValue::None, false), NodeInput::value(TaggedValue::ImageFrame(ImageFrameTable::empty()), false)],
1115+
inputs: vec![
1116+
NodeInput::value(TaggedValue::None, false),
1117+
NodeInput::value(TaggedValue::ImageFrame(ImageFrameTable::one_empty_image()), false),
1118+
],
11161119
..Default::default()
11171120
},
11181121
persistent_node_metadata: DocumentNodePersistentMetadata {
@@ -1825,7 +1828,7 @@ fn static_nodes() -> Vec<DocumentNodeDefinition> {
18251828
.collect(),
18261829
..Default::default()
18271830
}),
1828-
inputs: vec![NodeInput::value(TaggedValue::ImageFrame(ImageFrameTable::empty()), true)],
1831+
inputs: vec![NodeInput::value(TaggedValue::ImageFrame(ImageFrameTable::one_empty_image()), true)],
18291832
..Default::default()
18301833
},
18311834
persistent_node_metadata: DocumentNodePersistentMetadata {
@@ -1881,7 +1884,7 @@ fn static_nodes() -> Vec<DocumentNodeDefinition> {
18811884
document_node: DocumentNode {
18821885
implementation: DocumentNodeImplementation::proto("graphene_std::executor::MapGpuSingleImageNode"),
18831886
inputs: vec![
1884-
NodeInput::value(TaggedValue::ImageFrame(ImageFrameTable::empty()), true),
1887+
NodeInput::value(TaggedValue::ImageFrame(ImageFrameTable::one_empty_image()), true),
18851888
NodeInput::value(TaggedValue::DocumentNode(DocumentNode::default()), true),
18861889
],
18871890
..Default::default()
@@ -1923,7 +1926,7 @@ fn static_nodes() -> Vec<DocumentNodeDefinition> {
19231926
document_node: DocumentNode {
19241927
implementation: DocumentNodeImplementation::proto("graphene_core::raster::BrightnessContrastNode"),
19251928
inputs: vec![
1926-
NodeInput::value(TaggedValue::ImageFrame(ImageFrameTable::empty()), true),
1929+
NodeInput::value(TaggedValue::ImageFrame(ImageFrameTable::one_empty_image()), true),
19271930
NodeInput::value(TaggedValue::F64(0.), false),
19281931
NodeInput::value(TaggedValue::F64(0.), false),
19291932
NodeInput::value(TaggedValue::Bool(false), false),
@@ -2799,7 +2802,7 @@ pub static IMAGINATE_NODE: Lazy<DocumentNodeDefinition> = Lazy::new(|| DocumentN
27992802
..Default::default()
28002803
}),
28012804
inputs: vec![
2802-
NodeInput::value(TaggedValue::ImageFrame(ImageFrameTable::empty()), true),
2805+
NodeInput::value(TaggedValue::ImageFrame(ImageFrameTable::one_empty_image()), true),
28032806
NodeInput::scope("editor-api"),
28042807
NodeInput::value(TaggedValue::ImaginateController(Default::default()), false),
28052808
NodeInput::value(TaggedValue::F64(0.), false), // Remember to keep index used in `ImaginateRandom` updated with this entry's index

‎editor/src/messages/portfolio/document/utility_types/network_interface.rs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -468,8 +468,8 @@ impl NodeNetworkInterface {
468468
InputConnector::Node { node_id, input_index } => (node_id, input_index),
469469
InputConnector::Export(export_index) => {
470470
let Some((encapsulating_node_id, encapsulating_node_id_path)) = network_path.split_last() else {
471-
// The outermost network export defaults to an ArtboardGroup.
472-
return Some((concrete!(graphene_core::ArtboardGroup), TypeSource::OuterMostExportDefault));
471+
// The outermost network export defaults to an ArtboardGroupTable.
472+
return Some((concrete!(graphene_core::ArtboardGroupTable), TypeSource::OuterMostExportDefault));
473473
};
474474

475475
let output_type = self.output_types(encapsulating_node_id, encapsulating_node_id_path).into_iter().nth(export_index).flatten();

‎node-graph/gcore/src/application_io.rs‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ impl TransformMut for SurfaceFrame {
4949
}
5050
}
5151

52+
#[cfg(feature = "dyn-any")]
5253
unsafe impl StaticType for SurfaceFrame {
5354
type Static = SurfaceFrame;
5455
}
@@ -90,6 +91,7 @@ impl PartialEq for ImageTexture {
9091
}
9192
}
9293

94+
#[cfg(feature = "dyn-any")]
9395
unsafe impl StaticType for ImageTexture {
9496
type Static = ImageTexture;
9597
}
@@ -128,6 +130,7 @@ impl<S: Size> Size for SurfaceHandle<S> {
128130
}
129131
}
130132

133+
#[cfg(feature = "dyn-any")]
131134
unsafe impl<T: 'static> StaticType for SurfaceHandle<T> {
132135
type Static = SurfaceHandle<T>;
133136
}
@@ -138,6 +141,7 @@ pub struct SurfaceHandleFrame<Surface> {
138141
pub transform: DAffine2,
139142
}
140143

144+
#[cfg(feature = "dyn-any")]
141145
unsafe impl<T: 'static> StaticType for SurfaceHandleFrame<T> {
142146
type Static = SurfaceHandleFrame<T>;
143147
}
@@ -317,6 +321,7 @@ impl<T> Debug for EditorApi<T> {
317321
}
318322
}
319323

324+
#[cfg(feature = "dyn-any")]
320325
unsafe impl<T: StaticTypeSized> StaticType for EditorApi<T> {
321326
type Static = EditorApi<T::Static>;
322327
}

‎node-graph/gcore/src/graphic_element.rs‎

Lines changed: 36 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -238,6 +238,12 @@ pub struct Artboard {
238238
pub clip: bool,
239239
}
240240

241+
impl Default for Artboard {
242+
fn default() -> Self {
243+
Self::new(IVec2::ZERO, IVec2::new(1920, 1080))
244+
}
245+
}
246+
241247
impl Artboard {
242248
pub fn new(location: IVec2, dimensions: IVec2) -> Self {
243249
Self {
@@ -251,23 +257,38 @@ impl Artboard {
251257
}
252258
}
253259

254-
/// Contains multiple artboards.
255-
#[derive(Clone, Default, Debug, Hash, PartialEq, DynAny)]
256-
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
257-
pub struct ArtboardGroup {
258-
pub artboards: Vec<(Artboard, Option<NodeId>)>,
259-
}
260+
// TODO: Eventually remove this migration document upgrade code
261+
pub fn migrate_artboard_group<'de, D: serde::Deserializer<'de>>(deserializer: D) -> Result<ArtboardGroupTable, D::Error> {
262+
use serde::Deserialize;
260263

261-
impl ArtboardGroup {
262-
pub fn new() -> Self {
263-
Default::default()
264+
#[derive(Clone, Default, Debug, Hash, PartialEq, DynAny)]
265+
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
266+
pub struct ArtboardGroup {
267+
pub artboards: Vec<(Artboard, Option<NodeId>)>,
264268
}
265269

266-
fn append_artboard(&mut self, artboard: Artboard, node_id: Option<NodeId>) {
267-
self.artboards.push((artboard, node_id));
270+
#[derive(serde::Serialize, serde::Deserialize)]
271+
#[serde(untagged)]
272+
enum EitherFormat {
273+
ArtboardGroup(ArtboardGroup),
274+
ArtboardGroupTable(ArtboardGroupTable),
268275
}
276+
277+
Ok(match EitherFormat::deserialize(deserializer)? {
278+
EitherFormat::ArtboardGroup(artboard_group) => {
279+
let mut table = ArtboardGroupTable::empty();
280+
for (artboard, source_node_id) in artboard_group.artboards {
281+
table.push(artboard);
282+
*table.instances_mut().last().unwrap().source_node_id = source_node_id;
283+
}
284+
table
285+
}
286+
EitherFormat::ArtboardGroupTable(artboard_group_table) => artboard_group_table,
287+
})
269288
}
270289

290+
pub type ArtboardGroupTable = Instances<Artboard>;
291+
271292
#[node_macro::node(category(""))]
272293
async fn layer(_: impl Ctx, stack: GraphicGroupTable, mut element: GraphicElement, node_path: Vec<NodeId>) -> GraphicGroupTable {
273294
let mut stack = stack;
@@ -385,15 +406,13 @@ async fn to_artboard<Data: Into<GraphicGroupTable> + 'n>(
385406
}
386407

387408
#[node_macro::node(category(""))]
388-
async fn append_artboard(_ctx: impl Ctx, mut artboards: ArtboardGroup, artboard: Artboard, node_path: Vec<NodeId>) -> ArtboardGroup {
389-
// let mut artboards = artboards.eval(ctx.clone()).await;
390-
// let artboard = artboard.eval(ctx).await;
391-
// let foot = ctx.footprint();
392-
// log::debug!("{:?}", foot);
409+
async fn append_artboard(_ctx: impl Ctx, mut artboards: ArtboardGroupTable, artboard: Artboard, node_path: Vec<NodeId>) -> ArtboardGroupTable {
393410
// Get the penultimate element of the node path, or None if the path is too short.
394411
// This is used to get the ID of the user-facing "Artboard" node (which encapsulates this internal "Append Artboard" node).
395412
let encapsulating_node_id = node_path.get(node_path.len().wrapping_sub(2)).copied();
396-
artboards.append_artboard(artboard, encapsulating_node_id);
413+
414+
artboards.push(artboard);
415+
*artboards.instances_mut().last().unwrap().source_node_id = encapsulating_node_id;
397416

398417
artboards
399418
}

‎node-graph/gcore/src/graphic_element/renderer.rs‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ use crate::transform::{Footprint, Transform};
99
use crate::uuid::{generate_uuid, NodeId};
1010
use crate::vector::style::{Fill, Stroke, ViewMode};
1111
use crate::vector::{PointId, VectorDataTable};
12-
use crate::{Artboard, ArtboardGroup, Color, GraphicElement, GraphicGroupTable, RasterFrame};
12+
use crate::{Artboard, ArtboardGroupTable, Color, GraphicElement, GraphicGroupTable, RasterFrame};
1313

1414
use bezier_rs::Subpath;
1515
use dyn_any::DynAny;
@@ -790,38 +790,38 @@ impl GraphicElementRendered for Artboard {
790790
}
791791
}
792792

793-
impl GraphicElementRendered for ArtboardGroup {
793+
impl GraphicElementRendered for ArtboardGroupTable {
794794
fn render_svg(&self, render: &mut SvgRender, render_params: &RenderParams) {
795-
for (artboard, _) in &self.artboards {
796-
artboard.render_svg(render, render_params);
795+
for artboard in self.instances() {
796+
artboard.instance.render_svg(render, render_params);
797797
}
798798
}
799799

800800
fn bounding_box(&self, transform: DAffine2) -> Option<[DVec2; 2]> {
801-
self.artboards.iter().filter_map(|(element, _)| element.bounding_box(transform)).reduce(Quad::combine_bounds)
801+
self.instances().filter_map(|instance| instance.instance.bounding_box(transform)).reduce(Quad::combine_bounds)
802802
}
803803

804804
fn collect_metadata(&self, metadata: &mut RenderMetadata, footprint: Footprint, _element_id: Option<NodeId>) {
805-
for (artboard, element_id) in &self.artboards {
806-
artboard.collect_metadata(metadata, footprint, *element_id);
805+
for instance in self.instances() {
806+
instance.instance.collect_metadata(metadata, footprint, *instance.source_node_id);
807807
}
808808
}
809809

810810
fn add_upstream_click_targets(&self, click_targets: &mut Vec<ClickTarget>) {
811-
for (artboard, _) in &self.artboards {
812-
artboard.add_upstream_click_targets(click_targets);
811+
for instance in self.instances() {
812+
instance.instance.add_upstream_click_targets(click_targets);
813813
}
814814
}
815815

816816
#[cfg(feature = "vello")]
817817
fn render_to_vello(&self, scene: &mut Scene, transform: DAffine2, context: &mut RenderContext) {
818-
for (artboard, _) in &self.artboards {
819-
artboard.render_to_vello(scene, transform, context)
818+
for instance in self.instances() {
819+
instance.instance.render_to_vello(scene, transform, context)
820820
}
821821
}
822822

823823
fn contains_artboard(&self) -> bool {
824-
!self.artboards.is_empty()
824+
self.instances().count() > 0
825825
}
826826
}
827827

0 commit comments

Comments
 (0)