Rework Fixture Name to be not dependent on PropertyGroup

Author: vanous

dmx.py

@@ -480,7 +480,7 @@ def reset_live_dmx_data(self, context):
 
     data_version: IntProperty(
             name = "BlenderDMX data version, bump when changing RNA structure and provide migration script",
-            default = 12,
+            default = 13,
             )
 
     def get_fixture_by_index(self, index):
@@ -957,6 +957,14 @@ def findGroupUuidDuplicates(uuid):
                 del fixture_["address"]
                 del fixture_["universe"]
 
+        if file_data_version < 13:
+            DMX_Log.log.info("Running migration 12→13")
+            dmx = bpy.context.scene.dmx
+
+            # we added proper fixture name
+            for fixture_ in dmx.fixtures:
+                fixture_.user_fixture_name = fixture_.name
+
         # add here another if statement for next migration condition... like:
         # if file_data_version < 6:
         # ...
@@ -991,7 +999,7 @@ def onDisplayLabel(self, context):
                     if self.display_device_label == "NONE":
                         obj.show_name = False
                     elif self.display_device_label == "NAME":
-                        obj.name = f"{fixture_.name}"
+                        obj.name = f"{fixture_.user_fixture_name}"
                         obj.show_name = self.enable_device_label
                     elif self.display_device_label == "DMX":
                         obj.name = f"{fixture_.dmx_breaks[0].universe}.{fixture_.dmx_breaks[0].address}"
@@ -1044,7 +1052,7 @@ def onDisplay2D(self, context):
                     if self.display_device_label == "NONE":
                         obj.show_name = False
                     elif self.display_device_label == "NAME":
-                        obj.name = f"{fixture_.name}"
+                        obj.name = f"{fixture_.user_fixture_name}"
                         obj.show_name = True
                     elif self.display_device_label == "DMX":
                         obj.name = f"{fixture_.dmx_breaks[0].universe}.{fixture_.dmx_breaks[0].address}"
@@ -2020,7 +2028,6 @@ def syncProgrammer(self):
     # # Fixtures
     def addFixture(
         self,
-        name,
         profile,
         mode,
         dmx_breaks,
@@ -2035,14 +2042,14 @@ def addFixture(
         fixture_id_numeric=0,
         unit_number=0,
         classing=None,
+        user_fixture_name="",
     ):
         # TODO: fix order of attributes to match fixture.build()
         dmx = bpy.context.scene.dmx
         new_fixture = dmx.fixtures.add()
         new_fixture.uuid = str(py_uuid.uuid4())  # ensure clean uuid
         try:
             new_fixture.build(
-                name,
                 profile,
                 mode,
                 dmx_breaks,
@@ -2057,6 +2064,7 @@ def addFixture(
                 fixture_id_numeric,
                 unit_number,
                 classing=classing,
+                user_fixture_name=user_fixture_name,
             )
         except Exception as e:
             DMX_Log.log.error(f"Error while adding fixture {e}")

fixture.py

@@ -57,6 +57,7 @@
     getGeometryNodes,
     set_light_nodes,
 )
+from .util import generate_fixture_name
 from .model import DMX_Model
 from .osc_utils import DMX_OSC_Handlers
 from .color_utils import (
@@ -413,6 +414,18 @@ class DMX_Fixture(PropertyGroup):
         type = DMX_Fixture_Channel
     )
 
+    user_fixture_name: StringProperty(
+        name = "Fixture name",
+        description="User definable fixture name, can be non-unique, is for MVR export and all UI",
+        default = "")
+
+    name: StringProperty(
+        name = "Collection name",
+        description="Not for the user",
+        default = "")
+    # this used to be the fixture name, we now only use it for the collection and we rename it
+    # if the gdtf_profile changes
+
     gdtf_long_name: StringProperty(
         name = "Fixture > Name",
         default = "")
@@ -515,7 +528,6 @@ def on_use_target(self, context):
 
     def build(
         self,
-        name,
         profile,
         mode,
         dmx_breaks,
@@ -530,6 +542,7 @@ def build(
         fixture_id_numeric=0,
         unit_number=0,
         classing="",
+        user_fixture_name="",
     ):
         bpy.ops.object.select_all(action="DESELECT")
         for obj in bpy.data.objects:
@@ -548,8 +561,7 @@ def build(
             bpy.data.collections.remove(bpy.data.collections[self.name])
 
         # Data Properties
-        self.name = name
-        self.profile = profile
+
         self.mode = mode
         if fixture_id is not None:
             self.fixture_id = fixture_id
@@ -588,13 +600,24 @@ def build(
         self["blender_control_playmode"] = None
         self["blender_control_recording"] = None
 
-        # Create clean Collection
-        self.collection = bpy.data.collections.new(name)
-
         # Import and deep copy Fixture Model Collection
         gdtf_profile = DMX_GDTF_File.load_gdtf_profile(profile)
         self.gdtf_long_name = gdtf_profile.long_name
         self.gdtf_manufacturer = gdtf_profile.manufacturer
+        if user_fixture_name is None:
+            user_fixture_name = gdtf_profile.name
+
+        self.user_fixture_name = user_fixture_name
+
+        regenerate_name = self.profile is not None and self.profile != profile
+
+        self.profile = profile
+
+        if self.name is None or regenerate_name:
+            self.name = generate_fixture_name(gdtf_profile.name)
+
+        # Create clean Collection
+        self.collection = bpy.data.collections.new(self.name)
 
         # Handle if dmx mode doesn't exist (maybe this is MVR import and GDTF files were replaced)
         # use mode[0] as default
@@ -2750,7 +2773,7 @@ def to_mvr_fixture(self, universe_add=False):
         ]
 
         return pymvr.Fixture(
-            name=self.name,
+            name=self.user_fixture_name,
             uuid=self.uuid,
             gdtf_spec=self.profile,
             gdtf_mode=self.mode,
@@ -2775,7 +2798,7 @@ def focus_to_mvr_focus_point(self):
                 return pymvr.FocusPoint(
                     matrix=pymvr.Matrix(matrix),
                     uuid=uuid_,
-                    name=f"Target for {self.name}",
+                    name=f"Target for {self.user_fixture_name}",
                 )
 
     def follow_target_constraint_enable(self, enabled):

in_gdtf.py

@@ -36,7 +36,6 @@
 
 from .i18n import DMX_Lang
 from .panels import profiles as Profiles
-from .util import create_unique_fixture_name
 from .gdtf_file import DMX_GDTF_File
 from .logging_setup import DMX_Log
 
@@ -232,17 +231,15 @@ def execute(self, context):
                         new_break.channels_count = 0
 
                     for count in range(1, 1 + self.units):
-                        new_name = f"{profile.name} {count}"
-                        new_name = create_unique_fixture_name(new_name)
                         dmx.addFixture(
-                            new_name,
                             file.name,
                             dmx_mode.name,
                             self.dmx_breaks,
                             self.gel_color,
                             self.display_beams,
                             self.add_target,
                             fixture_id=fixture_id,
+                            user_fixture_name=None,
                         )
                         fixture = dmx.fixtures[-1]
                         DMX_Log.log.debug(f"Added fixture {fixture}")

mvr.py

@@ -31,7 +31,6 @@
 
 from .group import FixtureGroup
 from .logging_setup import DMX_Log
-from .util import create_unique_fixture_name
 from .color_utils import xyY2rgbaa
 
 auxData = {}
@@ -784,16 +783,12 @@ def add_mvr_fixture(
     fixture_matrix = get_matrix(fixture, mscale)
 
     if existing_fixture is not None:
-        # TODO: we should not rename the fixture on import unless if the user wants it
-        # but we must ensure that the name is unique in the collection
-        unique_name = create_unique_fixture_name(fixture.name)
         if isinstance(fixture.color, str):
             fixture.color = pymvr.Color(str_repr=fixture.color)
 
         color_rgb = xyY2rgbaa(fixture.color)
         gel_color = [c / 255 for c in color_rgb] + [1]
         existing_fixture.build(
-            unique_name,
             fixture.gdtf_spec,
             fixture.gdtf_mode or "",
             addresses,
@@ -808,16 +803,14 @@ def add_mvr_fixture(
             fixture_id_numeric=fixture.fixture_id_numeric,
             unit_number=fixture.unit_number,
             classing=fixture.classing,
+            user_fixture_name=fixture.name,
         )
     else:
-        unique_name = f"{fixture.name} {layer_idx}-{fixture_idx}"
-        unique_name = create_unique_fixture_name(unique_name)
         if isinstance(fixture.color, str):
             fixture.color = pymvr.Color(str_repr=fixture.color)
         color_rgb = xyY2rgbaa(fixture.color)
         gel_color = [c / 255 for c in color_rgb] + [1]
         dmx.addFixture(
-            unique_name,
             fixture.gdtf_spec,
             fixture.gdtf_mode or "",
             addresses,
@@ -832,6 +825,7 @@ def add_mvr_fixture(
             fixture_id_numeric=fixture.fixture_id_numeric,
             unit_number=fixture.unit_number,
             classing=fixture.classing,
+            user_fixture_name=fixture.name,
         )
 
     if parent_object is not None: