GPv3: Add layers RNA

This adds `layers` as a collection to the new grease pencil RNA.

Additionally, layers have 3 properties:
 - `name`
 - `hide`
 - `lock`

Pull Request: https://projects.blender.org/blender/blender/pulls/109235

source/blender/makesrna/intern/CMakeLists.txt

@@ -94,7 +94,7 @@ if(WITH_EXPERIMENTAL_FEATURES)
   add_definitions(-DWITH_GREASE_PENCIL_V3)
   list(APPEND DEFSRC
     rna_simulation.c
-    rna_grease_pencil.c
+    rna_grease_pencil.cc
   )
 endif()
 

source/blender/makesrna/intern/makesrna.c

@@ -4568,7 +4568,7 @@ static RNAProcessItem PROCESS_ITEMS[] = {
     {"rna_dynamicpaint.c", NULL, RNA_def_dynamic_paint},
     {"rna_fcurve.c", "rna_fcurve_api.c", RNA_def_fcurve},
     {"rna_gpencil_legacy.c", NULL, RNA_def_gpencil},
-    {"rna_grease_pencil.c", NULL, RNA_def_grease_pencil},
+    {"rna_grease_pencil.cc", NULL, RNA_def_grease_pencil},
     {"rna_curves.cc", NULL, RNA_def_curves},
     {"rna_image.c", "rna_image_api.c", RNA_def_image},
     {"rna_key.c", NULL, RNA_def_key},

source/blender/makesrna/intern/rna_grease_pencil.c

@@ -1,39 +0,0 @@
-/* SPDX-FileCopyrightText: 2023 Blender Foundation
- *
- * SPDX-License-Identifier: GPL-2.0-or-later */
-
-/** \file
- * \ingroup RNA
- */
-
-#include "DNA_grease_pencil_types.h"
-
-#include "RNA_access.h"
-#include "RNA_define.h"
-#include "RNA_enum_types.h"
-
-#include "rna_internal.h"
-
-#ifdef RNA_RUNTIME
-
-#else
-
-static void rna_def_grease_pencil_data(BlenderRNA *brna)
-{
-  StructRNA *srna;
-
-  srna = RNA_def_struct(brna, "GreasePencilv3", "ID");
-  RNA_def_struct_sdna(srna, "GreasePencil");
-  RNA_def_struct_ui_text(srna, "Grease Pencil", "Grease Pencil data-block");
-  RNA_def_struct_ui_icon(srna, ICON_OUTLINER_DATA_GREASEPENCIL);
-
-  /* Animation Data */
-  rna_def_animdata_common(srna);
-}
-
-void RNA_def_grease_pencil(BlenderRNA *brna)
-{
-  rna_def_grease_pencil_data(brna);
-}
-
-#endif

source/blender/makesrna/intern/rna_grease_pencil.cc

@@ -0,0 +1,169 @@
+/* SPDX-FileCopyrightText: 2023 Blender Foundation
+ *
+ * SPDX-License-Identifier: GPL-2.0-or-later */
+
+/** \file
+ * \ingroup RNA
+ */
+
+#include "BLI_string.h"
+
+#include "DNA_grease_pencil_types.h"
+
+#include "RNA_access.h"
+#include "RNA_define.h"
+#include "RNA_enum_types.h"
+
+#include "rna_internal.h"
+
+#include "WM_api.h"
+
+#ifdef RNA_RUNTIME
+
+#  include "BKE_grease_pencil.hh"
+
+#  include "BLI_span.hh"
+
+#  include "DEG_depsgraph.h"
+
+static GreasePencil *rna_grease_pencil(const PointerRNA *ptr)
+{
+  return reinterpret_cast<GreasePencil *>(ptr->owner_id);
+}
+
+static void rna_grease_pencil_update(Main * /*bmain*/, Scene * /*scene*/, PointerRNA *ptr)
+{
+  DEG_id_tag_update(&rna_grease_pencil(ptr)->id, ID_RECALC_GEOMETRY);
+  WM_main_add_notifier(NC_GPENCIL | NA_EDITED, NULL);
+}
+
+static void rna_iterator_grease_pencil_layers_begin(CollectionPropertyIterator *iter,
+                                                    PointerRNA *ptr)
+{
+  using namespace blender::bke::greasepencil;
+  GreasePencil *grease_pencil = rna_grease_pencil(ptr);
+  blender::Span<Layer *> layers = grease_pencil->layers_for_write();
+
+  rna_iterator_array_begin(
+      iter, (void *)layers.data(), sizeof(Layer *), layers.size(), 0, nullptr);
+}
+
+static int rna_iterator_grease_pencil_layers_length(PointerRNA *ptr)
+{
+  GreasePencil *grease_pencil = rna_grease_pencil(ptr);
+  return grease_pencil->layers().size();
+}
+
+static char *rna_GreasePencilLayer_path(const PointerRNA *ptr)
+{
+  GreasePencilLayer *layer = static_cast<GreasePencilLayer *>(ptr->data);
+
+  BLI_assert(layer->base.name);
+  const size_t name_length = strlen(layer->base.name);
+
+  std::string name_esc(name_length * 2, '\0');
+  BLI_str_escape(name_esc.data(), layer->base.name, name_length * 2);
+
+  return BLI_sprintfN("layers[\"%s\"]", name_esc.c_str());
+}
+
+static void rna_GreasePencilLayer_name_get(PointerRNA *ptr, char *value)
+{
+  GreasePencilLayer *layer = static_cast<GreasePencilLayer *>(ptr->data);
+
+  if (layer->base.name) {
+    strcpy(value, layer->base.name);
+  }
+  else {
+    value[0] = '\0';
+  }
+}
+
+static int rna_GreasePencilLayer_name_length(PointerRNA *ptr)
+{
+  GreasePencilLayer *layer = static_cast<GreasePencilLayer *>(ptr->data);
+  return layer->base.name ? strlen(layer->base.name) : 0;
+}
+
+static void rna_GreasePencilLayer_name_set(PointerRNA *ptr, const char *value)
+{
+  GreasePencil *grease_pencil = rna_grease_pencil(ptr);
+  GreasePencilLayer *layer = static_cast<GreasePencilLayer *>(ptr->data);
+
+  grease_pencil->rename_layer(layer->wrap(), value);
+}
+
+#else
+
+static void rna_def_grease_pencil_data(BlenderRNA *brna)
+{
+  StructRNA *srna;
+  PropertyRNA *prop;
+
+  srna = RNA_def_struct(brna, "GreasePencilv3", "ID");
+  RNA_def_struct_sdna(srna, "GreasePencil");
+  RNA_def_struct_ui_text(srna, "Grease Pencil", "Grease Pencil data-block");
+  RNA_def_struct_ui_icon(srna, ICON_OUTLINER_DATA_GREASEPENCIL);
+
+  /* Animation Data */
+  rna_def_animdata_common(srna);
+
+  /* Layers */
+  prop = RNA_def_property(srna, "layers", PROP_COLLECTION, PROP_NONE);
+  RNA_def_property_struct_type(prop, "GreasePencilLayer");
+  RNA_def_property_collection_funcs(prop,
+                                    "rna_iterator_grease_pencil_layers_begin",
+                                    "rna_iterator_array_next",
+                                    "rna_iterator_array_end",
+                                    "rna_iterator_array_dereference_get",
+                                    "rna_iterator_grease_pencil_layers_length",
+                                    nullptr, /* TODO */
+                                    nullptr, /* TODO */
+                                    nullptr);
+  RNA_def_property_ui_text(prop, "Layers", "Grease Pencil layers");
+}
+
+static void rna_def_grease_pencil_layer(BlenderRNA *brna)
+{
+  StructRNA *srna;
+  PropertyRNA *prop;
+
+  srna = RNA_def_struct(brna, "GreasePencilLayer", nullptr);
+  RNA_def_struct_sdna(srna, "GreasePencilLayer");
+  RNA_def_struct_ui_text(srna, "Grease Pencil Layer", "Collection of related drawings");
+  RNA_def_struct_path_func(srna, "rna_GreasePencilLayer_path");
+
+  /* Name */
+  prop = RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
+  RNA_def_property_ui_text(prop, "Name", "Layer name");
+  RNA_def_property_string_funcs(prop,
+                                "rna_GreasePencilLayer_name_get",
+                                "rna_GreasePencilLayer_name_length",
+                                "rna_GreasePencilLayer_name_set");
+  RNA_def_struct_name_property(srna, prop);
+
+  /* Visibility */
+  prop = RNA_def_property(srna, "hide", PROP_BOOLEAN, PROP_NONE);
+  RNA_def_property_boolean_sdna(
+      prop, "GreasePencilLayerTreeNode", "flag", GP_LAYER_TREE_NODE_HIDE);
+  RNA_def_property_ui_icon(prop, ICON_HIDE_OFF, -1);
+  RNA_def_property_ui_text(prop, "Hide", "Set layer Visibility");
+  RNA_def_property_update(prop, NC_GPENCIL | ND_DATA, "rna_grease_pencil_update");
+
+  /* Lock */
+  prop = RNA_def_property(srna, "lock", PROP_BOOLEAN, PROP_NONE);
+  RNA_def_property_boolean_sdna(
+      prop, "GreasePencilLayerTreeNode", "flag", GP_LAYER_TREE_NODE_LOCKED);
+  RNA_def_property_ui_icon(prop, ICON_UNLOCKED, 1);
+  RNA_def_property_ui_text(
+      prop, "Locked", "Protect layer from further editing and/or frame changes");
+  RNA_def_property_update(prop, NC_GPENCIL | ND_DATA, "rna_grease_pencil_update");
+}
+
+void RNA_def_grease_pencil(BlenderRNA *brna)
+{
+  rna_def_grease_pencil_data(brna);
+  rna_def_grease_pencil_layer(brna);
+}
+
+#endif