Repository navigation
Tracking Issue: Instances tables #1834
Description
- 1. Write the
Instances<T>struct. WrapVectorDatato becomeInstances<VectorData>,ImageFrameto becomeInstances<ImageFrame>,GraphicGroupto becomeInstances<GraphicGroup>, which lets us leavetransform/alpha_blendingalone for now. Places that read the single piece of data now read from a "getter" function that calls.next().expect("...")and write to a "setter" function that loops through each row (but there's just 1 presently).
(Instance tables refactor part 1: wrap graphical data in the new Instances<T> struct #2230) - 2. Move the
transform/alpha_blendingup a level, which removes those fields fromVectorData,ImageFrame, andGraphicGroup.
(Instance tables refactor part 2: move the transform and alpha_blending fields up a level #2249) - 3. Since the
ImageFrame<P>struct now has only one field left (pub image: Image<P>), delete this redundant struct and replace its usage inInstances<ImageFrame<P>>withInstances<Image<P>>.
(Instance tables refactor part 3: flatten ImageFrame<P> in lieu of Image<P> #2256) - 4. Wrap
ArtboardGroupto becomeInstances<ArtboardGroup>. Since theArtboardGroupstruct now has only one field (artboards: Vec<(Artboard, Option<NodeId>)>), delete this redundant struct and replace its usage withInstances<Artboard>. Move theOption<NodeId>to be an attribute calledsource_node_idinInstances<T>.
(Instance tables refactor part 4: replace ArtboardGroups with multi-row Instances<Artboard> #2265) - 5. Since the
GraphicGroupstruct now has only one field left (elements: Vec<(GraphicElement, Option<NodeId>)>), delete this redundant struct and replace its usage inInstances<GraphicGroup>withInstances<GraphicElement>. Move theOption<NodeId>to thesource_node_idattribute inInstances<T>. At this point, we have multi-row tables for group data but single-row image and vector data tables.
(Instance tables refactor part 5: unwrap GraphicGroup as multi-row Instance<GraphicElement> tables and move up transforms #2363) - 6. Remove all usages of
.one_instance_ref()and.one_instance_mut()by replacing their usages with loops or fold/reduce as needed in the nodes that currently expect one value but now need to work on multiple rows of values. Once this is done, nodes won't panic when we have a zero-row table. So we can replace usages of the formVectorDataTable::new(VectorData::empty())with an actual empty table. Now, we have nodes that can accept table data of any row counts, and will often map N rows to N rows, but we don't have any nodes that actually produce more than 1 row as output yet unless given more than 1 row. But the repeat style nodes all currently output groups, not multi-rows of vector or raster, which we change in the next step. (db34ac3, 2cee9e2, Instance tables refactor part 6: remove usage ofone_instance_*functions #2672, Instance tables refactor part 6: unwrap VectorData and ImageFrame from single-row to multi-row tables #2684, Replace Instances<T>::empty() with Instances<T>::default() and make it return an empty table for vector data instead of one empty row #2689) - 7. Change
RasterFrame(an enum ofImageFrameTable<Color> = Instances<Image<Color>>andTextureFrameTable = Instances<ImageTexture>variants) toRasterTable = Instances<Raster>, whereRasteris an enum ofImage<Color>andImageTexturevariants. (Instance tables refactor part 7: reorganize raster data to remove TextureFrameTable #2693, 5cacab2, 6111440) - 8. Change the Repeat/Circular Repeat/Copy to Points node to no longer create a level of grouping, so they map from
Instances<T>toInstances<T>, not fromInstances<T>toInstances<GraphicElement>, now that we have (in the previous step) ensured all other nodes are able to work correctly with multiple instances instead of assuming a single instance. Investigate also doing this for the Merge node, making it generic over its input types, so we can have homogenous layer stacks to keep the data entropy down. (Instance tables refactor part 8: Make repeater nodes use pivot not bbox and output instance type not group; rename 'Flatten Vector Elements' to 'Flatten Path' and add 'Flatten Vector' #2697, Instance tables refactor part 8: Output the type of the input data with the Mirror node as well #2699) - 9. Clean up all terminology and naming. (Rename Instances<T> to Table<T> and the "instance" terminology to "TableRow" and "element" #2981)
Initial
type GraphicElement = VectorData | GraphicGroup;
struct VectorData {
transform: DAffine2,
}
struct GraphicGroup {
transform: DAffine2,
elements: Vec<GraphicElement>,
}Wrapped in table
type GraphicElement = VectorDataTable | GraphicGroupTable;
struct VectorData {
// transform has been moved to the table
}
type VectorDataTable = struct Instances<VectorData> {
transform: Vec<DAffine2>, // count = 1
instance: Vec<VectorData>, // count = 1
}
struct GraphicGroup {
// transform has been moved to the table, but not up to the parent group
elements: Vec<GraphicElement>,
}
type GraphicGroupTable = struct Instances<GraphicGroup> {
transform: Vec<DAffine2>, // count = 1, parent to all in self.instance[0].elements
instance: Vec<GraphicGroup>, // count = 1
}(Inlined GraphicGroup)
type GraphicElement = VectorDataTable | GraphicGroupTable;
struct VectorData {
// transform has been moved to the table
}
type VectorDataTable = struct Instances<VectorData> {
transform: Vec<DAffine2>, // count = 1
instance: Vec<VectorData>, // count = 1
}
type GraphicGroupTable = struct Instances<Vec<GraphicElement>> {
transform: Vec<DAffine2>, // count = 1, parent to all in self.instance[0]
instance: Vec<Vec<GraphicElement>>, // count = 1
}// Document root
// ├─ Top folder
// │ ├─ Inner vector 1
// │ └─ Inner vector 2
// └─ Top vector
// Document root
GraphicGroupTable {
transform: vec![ // count = 1
DAffine2::IDENTITY,
],
instance: vec![ // count = 1
vec![
// Top folder
GraphicGroupTable {
transform: vec![ // count = 1
DAffine2::TOP_FOLDER,
],
instance: vec![ // count = 1
vec![
// Inner vector 1
VectorDataTable {
transform: vec![ // count = 1
DAffine2::INNER_VECTOR_1,
],
instance: vec![ // count = 1
VectorData {},
],
},
// Inner vector 2
VectorDataTable {
transform: vec![ // count = 1
DAffine2::INNER_VECTOR_2,
],
instance: vec![ // count = 1
VectorData {},
],
},
],
],
},
// Top vector
VectorDataTable {
transform: vec![ // count = 1
DAffine2::TOP_VECTOR,
],
instance: vec![ // count = 1
VectorData {},
],
},
],
],
}Flattened GraphicGroup with transform moved to parent
type GraphicElement = VectorDataTable | GraphicGroupTable;
struct VectorData {
// transform has been moved to the table
}
type VectorDataTable = struct Instances<VectorData> {
transform: Vec<DAffine2>, // count = 1
instance: Vec<VectorData>, // count = 1
}
type GraphicGroupTable = struct Instances<GraphicElement> {
transform: Vec<DAffine2>, // parent to its corresponding element in self.instance
instance: Vec<GraphicElement>,
}// Document root
// ├─ Top folder
// │ ├─ Inner vector 1
// │ └─ Inner vector 2
// └─ Top vector
// Document root
GraphicGroupTable {
transform: vec![
DAffine2::TOP_FOLDER,
DAffine2::TOP_VECTOR,
],
instance: vec![
// Top folder
GraphicGroupTable {
transform: vec![
DAffine2::IDENTITY, // from the Merge layer node
DAffine2::IDENTITY, // from the Merge layer node
],
instance: vec![
// Inner vector 1
VectorDataTable {
transform: vec![ // count = 1
DAffine2::INNER_VECTOR_1,
],
instance: vec![ // count = 1
VectorData {},
],
},
// Inner vector 2
VectorDataTable {
transform: vec![ // count = 1
DAffine2::INNER_VECTOR_2,
],
instance: vec![ // count = 1
VectorData {},
],
},
],
},
// Top vector
VectorDataTable {
transform: vec![ // count = 1
DAffine2::IDENTITY,
],
instance: vec![ // count = 1
VectorData {},
],
},
],
}Metadata
Metadata
Assignees
Type
Projects
- Status
Activity
[-]Refactor GraphicGroup to become the Element domain[/-][+]Refactor GraphicGroup to become the Element table[/+][-]Refactor GraphicGroup to become the Element table[/-][+]Refactor graphical data to use the Instances table[/+][-]Refactor graphical data to use the Instances table[/-][+]Refactor graphical data to use the Instances table and move transforms/alpha_blending up a scope[/+][-]Refactor graphical data to use the Instances table and move transforms/alpha_blending up a scope[/-][+]Tracking Issue: Refactor graphical data to use the Instances table and move transforms/alpha_blending up a scope[/+][-]Tracking Issue: Refactor graphical data to use the Instances table and move transforms/alpha_blending up a scope[/-][+]Tracking Issue: Instances table and moving transforms/alpha_blending up a scope[/+]6 remaining items
0HyperCube commentedon Aug 3, 2025
This is by no means done as it doesn't really work e.g. selecting or modifying rows other than the first one or all of them are impossible. It also breaks the tooling.
Keavon commentedon Aug 3, 2025
Those are larger features tracked in this issue's parent. This is the MVP and its step-by-step plan is completed. The follow-on work that you mentioned is tracked in the parent.