Minor improvement to ergonomics of checking if a DfsObject is instanced

Author: cmbasnett

bdk_addon/bsp/operators.py

@@ -778,15 +778,12 @@ def _get_or_add_material(material: Material | None) -> int:
         level_object.bdk.level.brushes.clear()
 
         for brush_index, dfs_object in enumerate(brush_objects):
-            brush_object = dfs_object.obj
-            instance_objects = dfs_object.instance_objects
-            is_instanced_brush = len(instance_objects) > 0
-            if is_instanced_brush:
+            if dfs_object.is_instanced:
                 # Skip brushes that are instanced, as we cannot change their texturing.
                 continue
             level_brush = level_object.bdk.level.brushes.add()
             level_brush.index = brush_index
-            level_brush.brush_object = brush_object
+            level_brush.brush_object = dfs_object.obj
 
         timer = time.time()
 
@@ -797,8 +794,7 @@ def _get_or_add_material(material: Material | None) -> int:
 
         brushes: list[Brush] = []
         for brush_index, dfs_object in enumerate(brush_objects):
-
-            if dfs_object.instance_objects:
+            if dfs_object.is_instanced:
                 instanced_brush_indices.append(brush_index)
 
             brush_object = dfs_object.obj

bdk_addon/dfs.py

@@ -23,9 +23,7 @@ def __init__(self, obj: Object, instance_objects: List[Object], matrix_world: Ma
     @property
     def is_visible(self) -> bool:
         """
-        Check if the object is visible.
-
-        @return: True if the object is visible, False otherwise.
+        Return whether the object is visible.
         """
         if self.instance_objects:
             return self.instance_objects[-1].visible_get()
@@ -34,13 +32,19 @@ def is_visible(self) -> bool:
     @property
     def is_selected(self) -> bool:
         """
-        Check if the object is selected.
-        @return: True if the object is selected, False otherwise.
+        Return whether the object is selected.
         """
         if self.instance_objects:
             return self.instance_objects[-1].select_get()
         return self.obj.select_get()
 
+    @property
+    def is_instanced(self) -> bool:
+        """
+        Return whether the object is part of an instance.
+        """
+        return len(self.instance_objects) > 0
+
 
 def _dfs_object_children(obj: Object, collection: Collection) -> Iterable[Object]:
     """
@@ -85,9 +89,9 @@ def dfs_collection_objects(collection: Collection) -> Iterable[DfsObject]:
 
 def _dfs_collection_objects_recursive(
         collection: Collection,
-        instance_objects: Optional[List[Object]] = None,
+        instance_objects: list[Object] | None = None,
         matrix_world: Matrix = Matrix.Identity(4),
-        visited: Optional[Set[Object]]=None
+        visited: set[Object] | None = None
 ) -> Iterable[DfsObject]:
     """
     Depth-first search of objects in a collection, including recursing into instances.