Merge pull request #1223 from compas-dev/scene-object

Track guids in drawn objects

Author: Licini

CHANGELOG.md

@@ -1575,6 +1575,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 
 * Fixed bug in `compas.geometry.Box.vertices`.
+* `compas.scene.SceneObject` will now track a list of drawn Objects/GUIDs.
 
 ### Removed
 

src/compas/scene/context.py

@@ -10,7 +10,7 @@
 
 
 @pluggable(category="drawing-utils")
-def clear():
+def clear(guids=None):
     raise NotImplementedError
 
 

src/compas/scene/scene.py

@@ -47,22 +47,18 @@ def _get_node(self, sceneobject):
         raise Exception("Scene object not in scene")
 
     def clear(self):
-        clear()
+        guids = []
+        for sceneobject in self.sceneobjects:
+            guids += sceneobject.guids
+            sceneobject._guids = None
+        clear(guids=guids)
 
     def redraw(self):
+        self.clear()
+
         drawn_objects = []
         for sceneobject in self.sceneobjects:
-            drawn_object = sceneobject.draw()
-
-            # TODO: unify output of draw(), so we don't have to do this
-            if isinstance(drawn_object, (list, tuple)):
-                for item in drawn_object:
-                    if isinstance(item, (list, tuple)):
-                        drawn_objects.extend(item)
-                    else:
-                        drawn_objects.append(item)
-            else:
-                drawn_objects.append(drawn_object)
+            drawn_objects += sceneobject.draw()
 
         if drawn_objects:
             redraw()

src/compas/scene/sceneobject.py

@@ -4,6 +4,7 @@
 
 from abc import abstractmethod
 from .descriptors.protocol import DescriptorProtocol
+from .context import clear
 
 
 class SceneObject(object):
@@ -13,14 +14,12 @@ class SceneObject(object):
     ----------
     item : Any
         The item which should be visualized using the created SceneObject.
-    context : str, optional
-        Explicit context to pick the SceneObject from.
-        If not specified, an attempt will be made to automatically detect the appropriate context.
+
 
     Attributes
     ----------
-    ITEM_SCENEOBJECT : dict[str, dict[Type[:class:`~compas.data.Data`], Type[:class:`~compas.scene.SceneObject`]]]
-        Dictionary mapping data types to the corresponding scene objects types per visualization context.
+    guids : list[object]
+        The GUIDs of the items drawn in the visualization context.
 
     """
 
@@ -30,6 +29,11 @@ class SceneObject(object):
     def __init__(self, item, **kwargs):
         self._item = item
         self._transformation = None
+        self._guids = None
+
+    @property
+    def guids(self):
+        return self._guids or []
 
     @property
     def transformation(self):
@@ -52,7 +56,7 @@ def draw(self):
         """The main drawing method."""
         raise NotImplementedError
 
-    @staticmethod
-    def draw_collection(collection):
-        """Drawing method for drawing an entire collection of objects."""
-        raise NotImplementedError
+    def clear(self):
+        """The main clearing method."""
+        clear(guids=self.guids)
+        self._guids = None

src/compas_blender/__init__.py

@@ -10,24 +10,28 @@
     from .utilities import *  # noqa: F401 F403
 
 
-def clear():
+def clear(guids=None):
     """Clear all scene objects."""
-    # delete all objects
-    bpy.ops.object.select_all(action="SELECT")
-    bpy.ops.object.delete(use_global=True, confirm=False)
-    # delete data
-    delete_unused_data()  # noqa: F405
-    # delete collections
-    for collection in bpy.context.scene.collection.children:
-        bpy.context.scene.collection.children.unlink(collection)
-    for block in bpy.data.collections:
-        objects = [o for o in block.objects if o.users]
-        while objects:
-            bpy.data.objects.remove(objects.pop())
-        for collection in block.children:
-            block.children.unlink(collection)
-        if block.users == 0:
-            bpy.data.collections.remove(block)
+    if guids is None:
+        # delete all objects
+        bpy.ops.object.select_all(action="SELECT")
+        bpy.ops.object.delete(use_global=True, confirm=False)
+        # delete data
+        delete_unused_data()  # noqa: F405
+        # delete collections
+        for collection in bpy.context.scene.collection.children:
+            bpy.context.scene.collection.children.unlink(collection)
+        for block in bpy.data.collections:
+            objects = [o for o in block.objects if o.users]
+            while objects:
+                bpy.data.objects.remove(objects.pop())
+            for collection in block.children:
+                block.children.unlink(collection)
+            if block.users == 0:
+                bpy.data.collections.remove(block)
+    else:
+        for obj in guids:
+            bpy.data.objects.remove(obj, do_unlink=True)
 
 
 def redraw():

src/compas_blender/scene/__init__.py

@@ -16,6 +16,7 @@
 from compas.geometry import Cylinder
 from compas.geometry import Frame
 from compas.geometry import Line
+from compas.geometry import Plane
 from compas.geometry import Point
 from compas.geometry import Pointcloud
 from compas.geometry import Polygon
@@ -40,6 +41,7 @@
 from .lineobject import LineObject
 from .meshobject import MeshObject
 from .networkobject import NetworkObject
+from .planeobject import PlaneObject
 from .pointobject import PointObject
 from .pointcloudobject import PointcloudObject
 from .polygonobject import PolygonObject
@@ -53,8 +55,8 @@
 
 
 @plugin(category="drawing-utils", pluggable_name="clear", requires=["bpy"])
-def clear_blender():
-    compas_blender.clear()
+def clear_blender(guids=None):
+    compas_blender.clear(guids=guids)
 
 
 @plugin(category="drawing-utils", pluggable_name="redraw", requires=["bpy"])
@@ -74,6 +76,7 @@ def register_scene_objects():
     register(Line, LineObject, context="Blender")
     register(Mesh, MeshObject, context="Blender")
     register(Network, NetworkObject, context="Blender")
+    register(Plane, PlaneObject, context="Blender")
     register(Point, PointObject, context="Blender")
     register(Pointcloud, PointcloudObject, context="Blender")
     register(Polygon, PolygonObject, context="Blender")
@@ -99,6 +102,7 @@ def register_scene_objects():
     "LineObject",
     "MeshObject",
     "NetworkObject",
+    "PlaneObject",
     "PointObject",
     "PointcloudObject",
     "PolygonObject",

src/compas_blender/scene/boxobject.py

@@ -33,7 +33,7 @@ def draw(
         color: Optional[Color] = None,
         collection: Optional[Union[str, bpy.types.Collection]] = None,
         show_wire: bool = True,
-    ) -> bpy.types.Object:
+    ) -> list[bpy.types.Object]:
         """Draw the box associated with the scene object.
 
         Parameters
@@ -47,7 +47,7 @@ def draw(
 
         Returns
         -------
-        :blender:`bpy.types.Object`
+        list[:blender:`bpy.types.Object`]
             The object(s) created in Blender to represent the box.
 
         """
@@ -61,4 +61,5 @@ def draw(
         obj = self.create_object(mesh, name=name)
         self.update_object(obj, color=color, collection=collection, show_wire=show_wire)
 
-        return obj
+        self._guids = [obj]
+        return self.guids

src/compas_blender/scene/capsuleobject.py

@@ -35,7 +35,7 @@ def draw(
         v: int = 16,
         show_wire: bool = False,
         shade_smooth: bool = True,
-    ) -> bpy.types.Object:
+    ) -> list[bpy.types.Object]:
         """Draw the capsule associated with the scene object.
 
         Parameters
@@ -55,7 +55,7 @@ def draw(
 
         Returns
         -------
-        :blender:`bpy.types.Object`
+        list[:blender:`bpy.types.Object`]
             The objects created in Blender.
 
         """
@@ -71,4 +71,5 @@ def draw(
         obj = self.create_object(mesh, name=name)
         self.update_object(obj, color=color, collection=collection, show_wire=show_wire)
 
-        return obj
+        self._guids = [obj]
+        return self.guids

src/compas_blender/scene/circleobject.py

@@ -25,7 +25,7 @@ class CircleObject(BlenderSceneObject, GeometryObject):
     def __init__(self, circle: Circle, **kwargs: Any):
         super().__init__(geometry=circle, **kwargs)
 
-    def draw(self, color: Optional[Color] = None, collection: Optional[str] = None) -> bpy.types.Object:
+    def draw(self, color: Optional[Color] = None, collection: Optional[str] = None) -> list[bpy.types.Object]:
         """Draw the circle.
 
         Parameters
@@ -37,7 +37,7 @@ def draw(self, color: Optional[Color] = None, collection: Optional[str] = None)
 
         Returns
         -------
-        :blender:`bpy.types.Object`
+        list[:blender:`bpy.types.Object`]
             The object created in Blender.
 
         """
@@ -49,4 +49,5 @@ def draw(self, color: Optional[Color] = None, collection: Optional[str] = None)
         self.objects.append(obj)
         self.update_object(obj, color=color, collection=collection, transformation=self.geometry.transformation)
 
-        return obj
+        self._guids = [obj]
+        return self.guids

src/compas_blender/scene/coneobject.py

@@ -33,8 +33,8 @@ def draw(
         collection: Optional[str] = None,
         u: int = 16,
         show_wire: bool = False,
-        shade_smooth: bool = True,
-    ) -> bpy.types.Object:
+        shade_smooth: bool = False,
+    ) -> list[bpy.types.Object]:
         """Draw the cone associated with the scene object.
 
         Parameters
@@ -52,7 +52,7 @@ def draw(
 
         Returns
         -------
-        :blender:`bpy.types.Object`
+        list[:blender:`bpy.types.Object`]
             The objects created in Blender.
 
         """
@@ -67,4 +67,5 @@ def draw(
         obj = self.create_object(mesh, name=name)
         self.update_object(obj, color=color, collection=collection, show_wire=show_wire)
 
-        return obj
+        self._guids = [obj]
+        return self.guids