Fix T97251: Store generated type information for each UDIM tile

Various situations can lead to un-saved UDIM tiles potentially losing
their contents. The most notable situation is a save and re-load of a
.blend file that has "generated" UDIM tiles that haven't been written to
disk yet. Normal "generated" images are reconstructed on demand in these
circumstances but UDIM tiles do not retain the information required for
reconstruction and empty tiles are presented to the user.

This patch stores the generated type information for each tile to solve
this particular issue. It also shifts the Image generation info into the
1st tile. The existing DNA fields are deprecated but RNA was modified as
to not break API compat.

There's two broad changes here that merit special callout:
- How to distinguish between a tile that should be reconstructed vs.
a tile that should remain empty because loading failed for the UDIMs
- How to better handle Image Source changes

The first issue is addressed as follows:
- Each time a tile is filled with generated content we set a new
IMA_GEN_TILE flag
- Each time a tile is saved to disk we remove the IMA_GEN_TILE flag
- When requesting an ibuf: If the ibuf is null, we check to see if
IMA_GEN_TILE is set. If it is set, go ahead and re-create the tile.
Otherwise, do nothing.

The second set of changes have to do with ensuring that information is
carried along as far as possible when the, sometimes destructive, act of
changing an Image Source is performed. Behavior should be a bit more
natural and expected now; though users will rarely, or should rarely, be
modifying this property. The full table describing the behavior is in
the differential.

Differential Revision: https://developer.blender.org/D14885

1 files changed, 141 insertions, 0 deletions

diff --git a/source/blender/makesrna/intern/rna_image.c b/source/blender/makesrna/intern/rna_image.c
index 7f134c5055f..8f6aa55b9ac 100644
--- a/source/blender/makesrna/intern/rna_image.c
+++ b/source/blender/makesrna/intern/rna_image.c
@@ -52,6 +52,7 @@ static const EnumPropertyItem image_source_items[] = {
 #ifdef RNA_RUNTIME
 
 #  include "BLI_math_base.h"
+#  include "BLI_math_vector.h"
 
 #  include "BKE_global.h"
 
@@ -85,6 +86,10 @@ static void rna_Image_source_set(PointerRNA *ptr, int value)
     ima->source = value;
     BLI_assert(BKE_id_is_in_global_main(&ima->id));
     BKE_image_signal(G_MAIN, ima, NULL, IMA_SIGNAL_SRC_CHANGE);
+    if (ima->source == IMA_SRC_TILED) {
+      BKE_image_signal(G_MAIN, ima, NULL, IMA_SIGNAL_RELOAD);
+    }
+
     DEG_id_tag_update(&ima->id, 0);
     DEG_id_tag_update(&ima->id, ID_RECALC_EDITORS);
     DEG_relations_tag_update(G_MAIN);
@@ -100,6 +105,83 @@ static void rna_Image_reload_update(Main *bmain, Scene *UNUSED(scene), PointerRN
   DEG_id_tag_update(&ima->id, ID_RECALC_EDITORS);
 }
 
+static int rna_Image_generated_type_get(PointerRNA *ptr)
+{
+  Image *ima = (Image *)ptr->data;
+  ImageTile *base_tile = BKE_image_get_tile(ima, 0);
+  return base_tile->gen_type;
+}
+
+static void rna_Image_generated_type_set(PointerRNA *ptr, int value)
+{
+  Image *ima = (Image *)ptr->data;
+  ImageTile *base_tile = BKE_image_get_tile(ima, 0);
+  base_tile->gen_type = value;
+}
+
+static int rna_Image_generated_width_get(PointerRNA *ptr)
+{
+  Image *ima = (Image *)ptr->data;
+  ImageTile *base_tile = BKE_image_get_tile(ima, 0);
+  return base_tile->gen_x;
+}
+
+static void rna_Image_generated_width_set(PointerRNA *ptr, int value)
+{
+  Image *ima = (Image *)ptr->data;
+  ImageTile *base_tile = BKE_image_get_tile(ima, 0);
+  base_tile->gen_x = CLAMPIS(value, 1, 65536);
+}
+
+static int rna_Image_generated_height_get(PointerRNA *ptr)
+{
+  Image *ima = (Image *)ptr->data;
+  ImageTile *base_tile = BKE_image_get_tile(ima, 0);
+  return base_tile->gen_y;
+}
+
+static void rna_Image_generated_height_set(PointerRNA *ptr, int value)
+{
+  Image *ima = (Image *)ptr->data;
+  ImageTile *base_tile = BKE_image_get_tile(ima, 0);
+  base_tile->gen_y = CLAMPIS(value, 1, 65536);
+}
+
+static bool rna_Image_generated_float_get(PointerRNA *ptr)
+{
+  Image *ima = (Image *)ptr->data;
+  ImageTile *base_tile = BKE_image_get_tile(ima, 0);
+  return (base_tile->gen_flag & IMA_GEN_FLOAT) != 0;
+}
+
+static void rna_Image_generated_float_set(PointerRNA *ptr, bool value)
+{
+  Image *ima = (Image *)ptr->data;
+  ImageTile *base_tile = BKE_image_get_tile(ima, 0);
+  if (value) {
+    base_tile->gen_flag |= IMA_GEN_FLOAT;
+  }
+  else {
+    base_tile->gen_flag &= ~IMA_GEN_FLOAT;
+  }
+}
+
+void rna_Image_generated_color_get(PointerRNA *ptr, float values[4])
+{
+  Image *ima = (Image *)(ptr->data);
+  ImageTile *base_tile = BKE_image_get_tile(ima, 0);
+  copy_v4_v4(values, base_tile->gen_color);
+}
+
+void rna_Image_generated_color_set(PointerRNA *ptr, const float values[4])
+{
+  Image *ima = (Image *)(ptr->data);
+  ImageTile *base_tile = BKE_image_get_tile(ima, 0);
+  for (unsigned int i = 0; i < 4; i++) {
+    base_tile->gen_color[i] = CLAMPIS(values[i], 0.0f, FLT_MAX);
+  }
+}
+
 static void rna_Image_generated_update(Main *bmain, Scene *UNUSED(scene), PointerRNA *ptr)
 {
   Image *ima = (Image *)ptr->owner_id;
@@ -335,6 +417,18 @@ static void rna_UDIMTile_tile_number_set(PointerRNA *ptr, int value)
   }
 }
 
+static void rna_UDIMTile_generated_update(Main *bmain, Scene *UNUSED(scene), PointerRNA *ptr)
+{
+  Image *ima = (Image *)ptr->owner_id;
+  ImageTile *tile = (ImageTile *)ptr->data;
+
+  /* If the tile is still marked as generated, then update the tile as requested. */
+  if ((tile->gen_flag & IMA_GEN_TILE) != 0) {
+    BKE_image_fill_tile(ima, tile);
+    BKE_image_partial_update_mark_full_update(ima);
+  }
+}
+
 static int rna_Image_active_tile_index_get(PointerRNA *ptr)
 {
   Image *image = (Image *)ptr->data;
@@ -896,6 +990,43 @@ static void rna_def_udim_tile(BlenderRNA *brna)
   RNA_def_property_int_funcs(prop, "rna_UDIMTile_channels_get", NULL, NULL);
   RNA_def_property_ui_text(prop, "Channels", "Number of channels in the tile pixels buffer");
   RNA_def_property_clear_flag(prop, PROP_EDITABLE);
+
+  /* Generated tile information. */
+  prop = RNA_def_property(srna, "generated_type", PROP_ENUM, PROP_NONE);
+  RNA_def_property_enum_sdna(prop, NULL, "gen_type");
+  RNA_def_property_enum_items(prop, rna_enum_image_generated_type_items);
+  RNA_def_property_ui_text(prop, "Generated Type", "Generated image type");
+  RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_UDIMTile_generated_update");
+  RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
+
+  prop = RNA_def_property(srna, "generated_width", PROP_INT, PROP_PIXEL);
+  RNA_def_property_int_sdna(prop, NULL, "gen_x");
+  RNA_def_property_flag(prop, PROP_PROPORTIONAL);
+  RNA_def_property_range(prop, 1, 65536);
+  RNA_def_property_ui_text(prop, "Generated Width", "Generated image width");
+  RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_UDIMTile_generated_update");
+  RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
+
+  prop = RNA_def_property(srna, "generated_height", PROP_INT, PROP_PIXEL);
+  RNA_def_property_int_sdna(prop, NULL, "gen_y");
+  RNA_def_property_flag(prop, PROP_PROPORTIONAL);
+  RNA_def_property_range(prop, 1, 65536);
+  RNA_def_property_ui_text(prop, "Generated Height", "Generated image height");
+  RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_UDIMTile_generated_update");
+  RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
+
+  prop = RNA_def_property(srna, "use_generated_float", PROP_BOOLEAN, PROP_NONE);
+  RNA_def_property_boolean_sdna(prop, NULL, "gen_flag", IMA_GEN_FLOAT);
+  RNA_def_property_ui_text(prop, "Float Buffer", "Generate floating-point buffer");
+  RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_UDIMTile_generated_update");
+  RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
+
+  prop = RNA_def_property(srna, "generated_color", PROP_FLOAT, PROP_COLOR_GAMMA);
+  RNA_def_property_float_sdna(prop, NULL, "gen_color");
+  RNA_def_property_array(prop, 4);
+  RNA_def_property_ui_text(prop, "Color", "Fill color for the generated image");
+  RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_UDIMTile_generated_update");
+  RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
 }
 
 static void rna_def_udim_tiles(BlenderRNA *brna, PropertyRNA *cprop)
@@ -1079,6 +1210,8 @@ static void rna_def_image(BlenderRNA *brna)
   RNA_def_property_enum_sdna(prop, NULL, "gen_type");
   RNA_def_property_enum_items(prop, rna_enum_image_generated_type_items);
   RNA_def_property_ui_text(prop, "Generated Type", "Generated image type");
+  RNA_def_property_enum_funcs(
+      prop, "rna_Image_generated_type_get", "rna_Image_generated_type_set", NULL);
   RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_Image_generated_update");
   RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
 
@@ -1087,6 +1220,8 @@ static void rna_def_image(BlenderRNA *brna)
   RNA_def_property_flag(prop, PROP_PROPORTIONAL);
   RNA_def_property_range(prop, 1, 65536);
   RNA_def_property_ui_text(prop, "Generated Width", "Generated image width");
+  RNA_def_property_int_funcs(
+      prop, "rna_Image_generated_width_get", "rna_Image_generated_width_set", NULL);
   RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_Image_generated_update");
   RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
 
@@ -1095,12 +1230,16 @@ static void rna_def_image(BlenderRNA *brna)
   RNA_def_property_flag(prop, PROP_PROPORTIONAL);
   RNA_def_property_range(prop, 1, 65536);
   RNA_def_property_ui_text(prop, "Generated Height", "Generated image height");
+  RNA_def_property_int_funcs(
+      prop, "rna_Image_generated_height_get", "rna_Image_generated_height_set", NULL);
   RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_Image_generated_update");
   RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
 
   prop = RNA_def_property(srna, "use_generated_float", PROP_BOOLEAN, PROP_NONE);
   RNA_def_property_boolean_sdna(prop, NULL, "gen_flag", IMA_GEN_FLOAT);
   RNA_def_property_ui_text(prop, "Float Buffer", "Generate floating-point buffer");
+  RNA_def_property_boolean_funcs(
+      prop, "rna_Image_generated_float_get", "rna_Image_generated_float_set");
   RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_Image_generated_update");
   RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
 
@@ -1108,6 +1247,8 @@ static void rna_def_image(BlenderRNA *brna)
   RNA_def_property_float_sdna(prop, NULL, "gen_color");
   RNA_def_property_array(prop, 4);
   RNA_def_property_ui_text(prop, "Color", "Fill color for the generated image");
+  RNA_def_property_float_funcs(
+      prop, "rna_Image_generated_color_get", "rna_Image_generated_color_set", NULL);
   RNA_def_property_update(prop, NC_IMAGE | ND_DISPLAY, "rna_Image_generated_update");
   RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);