Skip to content

Commit 9ae6562

Browse files
KeavonKeavon
authored
Instance tables refactor part 3: flatten ImageFrame<P> in lieu of Image<P> (#2256)
* Remove ImageFrame<T> by flattening it into Image<T> * Rename TextureFrame to ImageTexture * Fix tests
1 parent 1b5b590 commit 9ae6562

File tree

19 files changed

+233
-267
lines changed

19 files changed

+233
-267
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ use crate::node_graph_executor::NodeGraphExecutor;
2828
use bezier_rs::Subpath;
2929
use graph_craft::document::value::TaggedValue;
3030
use graph_craft::document::{NodeId, NodeInput, NodeNetwork, OldNodeNetwork};
31-
use graphene_core::raster::image::{ImageFrame, ImageFrameTable};
31+
use graphene_core::raster::image::ImageFrameTable;
3232
use graphene_core::raster::BlendMode;
3333
use graphene_core::vector::style::ViewMode;
3434
use graphene_std::renderer::{ClickTarget, Quad};
@@ -818,7 +818,7 @@ impl MessageHandler<DocumentMessage, DocumentMessageData<'_>> for DocumentMessag
818818

819819
responses.add(DocumentMessage::AddTransaction);
820820

821-
let layer = graph_modification_utils::new_image_layer(ImageFrameTable::new(ImageFrame { image }), layer_node_id, self.new_layer_parent(true), responses);
821+
let layer = graph_modification_utils::new_image_layer(ImageFrameTable::new(image), layer_node_id, self.new_layer_parent(true), responses);
822822

823823
if let Some(name) = name {
824824
responses.add(NodeGraphMessage::SetDisplayName {

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ use graphene_core::raster::{
2020
use graphene_core::text::Font;
2121
use graphene_core::vector::misc::CentroidType;
2222
use graphene_core::vector::style::{GradientType, LineCap, LineJoin};
23-
use graphene_std::application_io::TextureFrame;
23+
use graphene_std::application_io::TextureFrameTable;
2424
use graphene_std::transform::Footprint;
2525
use graphene_std::vector::misc::BooleanOperation;
2626
use graphene_std::vector::style::{Fill, FillChoice, FillType, GradientStops};
@@ -159,7 +159,7 @@ pub(crate) fn property_from_type(
159159
Some(x) if x == TypeId::of::<Curve>() => curves_widget(document_node, node_id, index, name, true),
160160
Some(x) if x == TypeId::of::<GradientStops>() => color_widget(document_node, node_id, index, name, ColorInput::default().allow_none(false), true),
161161
Some(x) if x == TypeId::of::<VectorDataTable>() => vector_widget(document_node, node_id, index, name, true).into(),
162-
Some(x) if x == TypeId::of::<RasterFrame>() || x == TypeId::of::<ImageFrameTable<Color>>() || x == TypeId::of::<TextureFrame>() => {
162+
Some(x) if x == TypeId::of::<RasterFrame>() || x == TypeId::of::<ImageFrameTable<Color>>() || x == TypeId::of::<TextureFrameTable>() => {
163163
raster_widget(document_node, node_id, index, name, true).into()
164164
}
165165
Some(x) if x == TypeId::of::<GraphicGroupTable>() => group_widget(document_node, node_id, index, name, true).into(),

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6222,10 +6222,11 @@ impl PropertiesRow {
62226222
fn migrate_output_names<'de, D: serde::Deserializer<'de>>(deserializer: D) -> Result<Vec<String>, D::Error> {
62236223
use serde::Deserialize;
62246224

6225-
const REPLACEMENTS: [(&str, &str); 3] = [
6225+
const REPLACEMENTS: [(&str, &str); 4] = [
62266226
("VectorData", "Instances<VectorData>"),
62276227
("GraphicGroup", "Instances<GraphicGroup>"),
6228-
("ImageFrame", "Instances<ImageFrame>"),
6228+
("ImageFrame", "Instances<Image>"),
6229+
("Instances<ImageFrame>", "Instances<Image>"),
62296230
];
62306231

62316232
let mut names = Vec::<String>::deserialize(deserializer)?;

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

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -64,17 +64,18 @@ impl Size for web_sys::HtmlCanvasElement {
6464
}
6565
}
6666

67-
pub type TextureFrameTable = Instances<TextureFrame>;
67+
// TODO: Rename to ImageTextureTable
68+
pub type TextureFrameTable = Instances<ImageTexture>;
6869

6970
#[derive(Debug, Clone)]
70-
pub struct TextureFrame {
71+
pub struct ImageTexture {
7172
#[cfg(feature = "wgpu")]
7273
pub texture: Arc<wgpu::Texture>,
7374
#[cfg(not(feature = "wgpu"))]
7475
pub texture: (),
7576
}
7677

77-
impl Hash for TextureFrame {
78+
impl Hash for ImageTexture {
7879
#[cfg(feature = "wgpu")]
7980
fn hash<H: Hasher>(&self, state: &mut H) {
8081
self.texture.hash(state);
@@ -83,18 +84,18 @@ impl Hash for TextureFrame {
8384
fn hash<H: Hasher>(&self, _state: &mut H) {}
8485
}
8586

86-
impl PartialEq for TextureFrame {
87+
impl PartialEq for ImageTexture {
8788
fn eq(&self, other: &Self) -> bool {
8889
self.texture == other.texture
8990
}
9091
}
9192

92-
unsafe impl StaticType for TextureFrame {
93-
type Static = TextureFrame;
93+
unsafe impl StaticType for ImageTexture {
94+
type Static = ImageTexture;
9495
}
9596

9697
#[cfg(feature = "wgpu")]
97-
impl Size for TextureFrame {
98+
impl Size for ImageTexture {
9899
fn size(&self) -> UVec2 {
99100
UVec2::new(self.texture.width(), self.texture.height())
100101
}

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

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
use crate::application_io::{TextureFrame, TextureFrameTable};
1+
use crate::application_io::{ImageTexture, TextureFrameTable};
22
use crate::instances::Instances;
3-
use crate::raster::image::{ImageFrame, ImageFrameTable};
3+
use crate::raster::image::{Image, ImageFrameTable};
44
use crate::raster::BlendMode;
55
use crate::transform::{Transform, TransformMut};
66
use crate::uuid::NodeId;
@@ -111,19 +111,19 @@ impl From<VectorDataTable> for GraphicGroupTable {
111111
Self::new(GraphicGroup::new(vec![GraphicElement::VectorData(vector_data)]))
112112
}
113113
}
114-
impl From<ImageFrame<Color>> for GraphicGroupTable {
115-
fn from(image_frame: ImageFrame<Color>) -> Self {
116-
Self::new(GraphicGroup::new(vec![GraphicElement::RasterFrame(RasterFrame::ImageFrame(ImageFrameTable::new(image_frame)))]))
114+
impl From<Image<Color>> for GraphicGroupTable {
115+
fn from(image: Image<Color>) -> Self {
116+
Self::new(GraphicGroup::new(vec![GraphicElement::RasterFrame(RasterFrame::ImageFrame(ImageFrameTable::new(image)))]))
117117
}
118118
}
119119
impl From<ImageFrameTable<Color>> for GraphicGroupTable {
120120
fn from(image_frame: ImageFrameTable<Color>) -> Self {
121121
Self::new(GraphicGroup::new(vec![GraphicElement::RasterFrame(RasterFrame::ImageFrame(image_frame))]))
122122
}
123123
}
124-
impl From<TextureFrame> for GraphicGroupTable {
125-
fn from(texture_frame: TextureFrame) -> Self {
126-
Self::new(GraphicGroup::new(vec![GraphicElement::RasterFrame(RasterFrame::TextureFrame(TextureFrameTable::new(texture_frame)))]))
124+
impl From<ImageTexture> for GraphicGroupTable {
125+
fn from(image_texture: ImageTexture) -> Self {
126+
Self::new(GraphicGroup::new(vec![GraphicElement::RasterFrame(RasterFrame::TextureFrame(TextureFrameTable::new(image_texture)))]))
127127
}
128128
}
129129
impl From<TextureFrameTable> for GraphicGroupTable {
@@ -194,11 +194,14 @@ impl GraphicElement {
194194
}
195195
}
196196

197+
// TODO: Rename to Raster
197198
#[derive(Clone, Debug, Hash, PartialEq, DynAny)]
198199
pub enum RasterFrame {
199200
/// A CPU-based bitmap image with a finite position and extent, equivalent to the SVG <image> tag: https://developer.mozilla.org/en-US/docs/Web/SVG/Element/image
201+
// TODO: Rename to ImageTable
200202
ImageFrame(ImageFrameTable<Color>),
201203
/// A GPU texture with a finite position and extent
204+
// TODO: Rename to ImageTextureTable
202205
TextureFrame(TextureFrameTable),
203206
}
204207

@@ -207,7 +210,7 @@ impl<'de> serde::Deserialize<'de> for RasterFrame {
207210
where
208211
D: serde::Deserializer<'de>,
209212
{
210-
Ok(RasterFrame::ImageFrame(ImageFrameTable::new(ImageFrame::deserialize(deserializer)?)))
213+
Ok(RasterFrame::ImageFrame(ImageFrameTable::new(Image::deserialize(deserializer)?)))
211214
}
212215
}
213216

@@ -239,7 +242,7 @@ impl Artboard {
239242
pub fn new(location: IVec2, dimensions: IVec2) -> Self {
240243
Self {
241244
graphic_group: GraphicGroupTable::default(),
242-
label: String::from("Artboard"),
245+
label: "Artboard".to_string(),
243246
location: location.min(location + dimensions),
244247
dimensions: dimensions.abs(),
245248
background: Color::WHITE,
@@ -382,25 +385,22 @@ async fn to_artboard<Data: Into<GraphicGroupTable> + 'n>(
382385
}
383386

384387
#[node_macro::node(category(""))]
385-
async fn append_artboard(ctx: impl Ctx, mut artboards: ArtboardGroup, artboard: Artboard, node_path: Vec<NodeId>) -> ArtboardGroup {
388+
async fn append_artboard(_ctx: impl Ctx, mut artboards: ArtboardGroup, artboard: Artboard, node_path: Vec<NodeId>) -> ArtboardGroup {
386389
// let mut artboards = artboards.eval(ctx.clone()).await;
387390
// let artboard = artboard.eval(ctx).await;
388391
// let foot = ctx.footprint();
389392
// log::debug!("{:?}", foot);
390-
// Get the penultimate element of the node path, or None if the path is too short
391-
392-
// TODO: Delete this line
393-
let _ctx = ctx;
394-
393+
// Get the penultimate element of the node path, or None if the path is too short.
394+
// This is used to get the ID of the user-facing "Artboard" node (which encapsulates this internal "Append Artboard" node).
395395
let encapsulating_node_id = node_path.get(node_path.len().wrapping_sub(2)).copied();
396396
artboards.append_artboard(artboard, encapsulating_node_id);
397397

398398
artboards
399399
}
400400

401401
// TODO: Remove this one
402-
impl From<ImageFrame<Color>> for GraphicElement {
403-
fn from(image_frame: ImageFrame<Color>) -> Self {
402+
impl From<Image<Color>> for GraphicElement {
403+
fn from(image_frame: Image<Color>) -> Self {
404404
GraphicElement::RasterFrame(RasterFrame::ImageFrame(ImageFrameTable::new(image_frame)))
405405
}
406406
}
@@ -410,8 +410,8 @@ impl From<ImageFrameTable<Color>> for GraphicElement {
410410
}
411411
}
412412
// TODO: Remove this one
413-
impl From<TextureFrame> for GraphicElement {
414-
fn from(texture: TextureFrame) -> Self {
413+
impl From<ImageTexture> for GraphicElement {
414+
fn from(texture: ImageTexture) -> Self {
415415
GraphicElement::RasterFrame(RasterFrame::TextureFrame(TextureFrameTable::new(texture)))
416416
}
417417
}
@@ -462,7 +462,7 @@ trait ToGraphicElement: Into<GraphicElement> {}
462462

463463
impl ToGraphicElement for VectorDataTable {}
464464
impl ToGraphicElement for ImageFrameTable<Color> {}
465-
impl ToGraphicElement for TextureFrame {}
465+
impl ToGraphicElement for ImageTexture {}
466466

467467
impl<T> From<T> for GraphicGroup
468468
where

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

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -276,6 +276,7 @@ pub struct RenderMetadata {
276276
pub clip_targets: HashSet<NodeId>,
277277
}
278278

279+
// TODO: Rename to "Graphical"
279280
pub trait GraphicElementRendered {
280281
fn render_svg(&self, render: &mut SvgRender, render_params: &RenderParams);
281282

@@ -831,7 +832,7 @@ impl GraphicElementRendered for ImageFrameTable<Color> {
831832

832833
match render_params.image_render_mode {
833834
ImageRenderMode::Base64 => {
834-
let image = &instance.instance.image;
835+
let image = &instance.instance;
835836
if image.data.is_empty() {
836837
return;
837838
}
@@ -894,7 +895,7 @@ impl GraphicElementRendered for ImageFrameTable<Color> {
894895
use vello::peniko;
895896

896897
for instance in self.instances() {
897-
let image = &instance.instance.image;
898+
let image = &instance.instance;
898899
if image.data.is_empty() {
899900
return;
900901
}
@@ -918,7 +919,7 @@ impl GraphicElementRendered for RasterFrame {
918919
};
919920

920921
for instance in image.instances() {
921-
let (image, blending) = (&instance.instance.image, instance.alpha_blending);
922+
let (image, blending) = (&instance.instance, instance.alpha_blending);
922923
if image.data.is_empty() {
923924
return;
924925
}
@@ -992,9 +993,9 @@ impl GraphicElementRendered for RasterFrame {
992993
};
993994

994995
match self {
995-
RasterFrame::ImageFrame(image_frame) => {
996-
for instance in image_frame.instances() {
997-
let image = &instance.instance.image;
996+
RasterFrame::ImageFrame(image) => {
997+
for instance in image.instances() {
998+
let image = &instance.instance;
998999
if image.data.is_empty() {
9991000
return;
10001001
}
@@ -1004,8 +1005,8 @@ impl GraphicElementRendered for RasterFrame {
10041005
render_stuff(image, *instance.alpha_blending);
10051006
}
10061007
}
1007-
RasterFrame::TextureFrame(texture) => {
1008-
for instance in texture.instances() {
1008+
RasterFrame::TextureFrame(image_texture) => {
1009+
for instance in image_texture.instances() {
10091010
let image =
10101011
vello::peniko::Image::new(vec![].into(), peniko::Format::Rgba8, instance.instance.texture.width(), instance.instance.texture.height()).with_extend(peniko::Extend::Repeat);
10111012

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

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
use crate::application_io::{TextureFrame, TextureFrameTable};
2-
use crate::raster::image::{ImageFrame, ImageFrameTable};
1+
use crate::application_io::{ImageTexture, TextureFrameTable};
2+
use crate::raster::image::{Image, ImageFrameTable};
33
use crate::raster::Pixel;
44
use crate::transform::{Transform, TransformMut};
55
use crate::vector::{InstanceId, VectorData, VectorDataTable};
@@ -180,18 +180,18 @@ impl TransformMut for GraphicGroupTable {
180180
}
181181
}
182182

183-
// TEXTURE FRAME
184-
impl Transform for Instance<'_, TextureFrame> {
183+
// IMAGE TEXTURE
184+
impl Transform for Instance<'_, ImageTexture> {
185185
fn transform(&self) -> DAffine2 {
186186
*self.transform
187187
}
188188
}
189-
impl Transform for InstanceMut<'_, TextureFrame> {
189+
impl Transform for InstanceMut<'_, ImageTexture> {
190190
fn transform(&self) -> DAffine2 {
191191
*self.transform
192192
}
193193
}
194-
impl TransformMut for InstanceMut<'_, TextureFrame> {
194+
impl TransformMut for InstanceMut<'_, ImageTexture> {
195195
fn transform_mut(&mut self) -> &mut DAffine2 {
196196
self.transform
197197
}
@@ -209,24 +209,24 @@ impl TransformMut for TextureFrameTable {
209209
}
210210
}
211211

212-
// IMAGE FRAME
213-
impl<P: Pixel> Transform for Instance<'_, ImageFrame<P>> {
212+
// IMAGE
213+
impl<P: Pixel> Transform for Instance<'_, Image<P>> {
214214
fn transform(&self) -> DAffine2 {
215215
*self.transform
216216
}
217217
fn local_pivot(&self, pivot: DVec2) -> DVec2 {
218218
self.transform.transform_point2(pivot)
219219
}
220220
}
221-
impl<P: Pixel> Transform for InstanceMut<'_, ImageFrame<P>> {
221+
impl<P: Pixel> Transform for InstanceMut<'_, Image<P>> {
222222
fn transform(&self) -> DAffine2 {
223223
*self.transform
224224
}
225225
fn local_pivot(&self, pivot: DVec2) -> DVec2 {
226226
self.transform.transform_point2(pivot)
227227
}
228228
}
229-
impl<P: Pixel> TransformMut for InstanceMut<'_, ImageFrame<P>> {
229+
impl<P: Pixel> TransformMut for InstanceMut<'_, Image<P>> {
230230
fn transform_mut(&mut self) -> &mut DAffine2 {
231231
self.transform
232232
}
@@ -237,7 +237,7 @@ impl<P: Pixel> Transform for ImageFrameTable<P>
237237
where
238238
P: dyn_any::StaticType,
239239
P::Static: Pixel,
240-
GraphicElement: From<ImageFrame<P>>,
240+
GraphicElement: From<Image<P>>,
241241
{
242242
fn transform(&self) -> DAffine2 {
243243
self.one_instance().transform()
@@ -247,7 +247,7 @@ impl<P: Pixel> TransformMut for ImageFrameTable<P>
247247
where
248248
P: dyn_any::StaticType,
249249
P::Static: Pixel,
250-
GraphicElement: From<ImageFrame<P>>,
250+
GraphicElement: From<Image<P>>,
251251
{
252252
fn transform_mut(&mut self) -> &mut DAffine2 {
253253
self.transform.first_mut().unwrap_or_else(|| panic!("ONE INSTANCE EXPECTED"))

0 commit comments

Comments
 (0)