Merge branch 'update/group'

Author: Licini

scripts/arrows.py

@@ -1,5 +1,3 @@
-
-import compas
 from compas.colors import Color
 from compas.geometry import Vector
 from compas_viewer.viewer import Viewer

scripts/group.py

@@ -1,26 +1,17 @@
-from compas.colors import Color
 from compas.geometry import Box
-from compas.geometry import Translation
 from compas_viewer import Viewer
 from compas_viewer.scene import Tag
 
 box1 = Box.from_width_height_depth(5, 1, 1)
 box2 = Box.from_width_height_depth(1, 5, 1)
-t = Tag("EN", (0, 0, 0), height=50)
-viewer = Viewer()
-
-# Simple list of objects
-group1 = viewer.scene.add([box1, box2, t])
+t = Tag("EN", (5, 0, 0), height=50)
 
 
-# with kwargs for each object
-box1 = box1.transformed(Translation.from_vector([0, 5, 0]))
-box2 = box2.transformed(Translation.from_vector([0, 5, 0]))
-group2 = viewer.scene.add([(box1, {"name": "box1", "facecolor": Color.red()}), (box2, {"name": "box2", "facecolor": Color.green()})], linecolor=Color.blue())
+viewer = Viewer()
 
-# with nested groups
-box1 = box1.transformed(Translation.from_vector([0, 5, 0]))
-box2 = box2.transformed(Translation.from_vector([0, 5, 0]))
-group3 = viewer.scene.add([[box1], box2])
-group3.transformation = Translation.from_vector([0, 0, 5])
+# Just fix API for groups
+group1 = viewer.scene.add_group(name="group1")
+group1.add(box1, name="box1")
+group1.add(box2, name="box2")
+group1.add(t, name="tag")
 viewer.show()

scripts/tag.py

@@ -7,5 +7,8 @@
 t4 = Tag("Absolute height", (5, 0, 0), absolute_height=True, height=100)
 
 viewer = Viewer()
-viewer.scene.add([t1, t2, t3, t4])
+viewer.scene.add(t1)
+viewer.scene.add(t2)
+viewer.scene.add(t3)
+viewer.scene.add(t4)
 viewer.show()

src/compas_viewer/components/layout.py

@@ -95,10 +95,10 @@ def __init__(
 
     @property
     def exclude_type_list(self) -> tuple[type, ...]:
-        from compas_viewer.scene import GroupObject
+        from compas_viewer.scene import Group
         from compas_viewer.scene import TagObject
 
-        return (GroupObject, TagObject)
+        return (Group, TagObject)
 
     def generate_layout(self) -> None:
         self.layout = QVBoxLayout()

src/compas_viewer/renderer/renderer.py

@@ -13,6 +13,7 @@
 
 from compas.geometry import Frame
 from compas.geometry import transform_points_numpy
+from compas.scene import Group
 from compas_viewer.scene import TagObject
 from compas_viewer.scene.buffermanager import BufferManager
 from compas_viewer.scene.gridobject import GridObject
@@ -405,7 +406,8 @@ def init(self):
         self.grid.init()
 
         for obj in self.viewer.scene.objects:
-            obj.init()
+            if not isinstance(obj, Group):
+                obj.init()
 
         for obj in self.viewer.scene.objects:
             if not isinstance(obj, TagObject):

src/compas_viewer/scene/__init__.py

@@ -44,8 +44,7 @@
 from .polyhedronobject import PolyhedronObject
 from .geometryobject import GeometryObject
 from .shapeobject import ShapeObject
-from .groupobject import Group
-from .groupobject import GroupObject
+from .group import Group
 from .collectionobject import Collection
 from .collectionobject import CollectionObject
 from .bufferobject import BufferGeometry
@@ -86,7 +85,6 @@ def register_scene_objects():
     register(Cone, ShapeObject, context="Viewer")
     register(Capsule, ShapeObject, context="Viewer")
     register(Polyhedron, PolyhedronObject, context="Viewer")
-    register(list, GroupObject, context="Viewer")
     register(Collection, CollectionObject, context="Viewer")
     register(BufferGeometry, BufferObject, context="Viewer")
 
@@ -141,7 +139,6 @@ def register_scene_objects():
     "GeometryObject",
     "ShapeObject",
     "Group",
-    "GroupObject",
     "Collection",
     "CollectionObject",
     "BufferGeometry",

src/compas_viewer/scene/group.py

@@ -0,0 +1,9 @@
+from compas.scene import Group as BaseGroup
+
+from .sceneobject import ViewerSceneObject
+
+
+class Group(ViewerSceneObject, BaseGroup):
+    """A group of scene objects."""
+
+    pass

src/compas_viewer/scene/groupobject.py

@@ -10,6 +10,7 @@
 from compas.geometry import Geometry
 from compas.scene import Scene
 
+from .group import Group
 from .sceneobject import ViewerSceneObject
 
 
@@ -70,16 +71,6 @@ def __init__(self, name: str = "ViewerScene", context: str = "Viewer"):
         self.instance_colors: dict[tuple[int, int, int], ViewerSceneObject] = {}
         self._instance_colors_generator = instance_colors_generator()
 
-    @property
-    def visiable_objects(self) -> list[ViewerSceneObject]:
-        def traverse(obj):
-            for child in obj.children:
-                if child.show:
-                    yield child
-                    yield from traverse(child)
-
-        return traverse(self.root)
-
     @property
     def viewer(self):
         from compas_viewer import Viewer
@@ -186,3 +177,25 @@ def add(
             **kwargs,
         )
         return sceneobject
+
+    def add_group(self, name: str = None, parent: Optional[ViewerSceneObject] = None, **kwargs) -> Group:
+        """
+        Add a group to the scene.
+
+        Parameters
+        ----------
+        name : str, optional
+            The name of the group.
+        parent : :class:`compas_viewer.scene.ViewerSceneObject`, optional
+            The parent of the group.
+        **kwargs : dict, optional
+            The other possible parameters to be passed to the group.
+
+        Returns
+        -------
+        :class:`compas_viewer.scene.Group`
+            The group.
+        """
+        group = Group(name=name, **kwargs)
+        self.add(group, parent=parent)
+        return group

src/compas_viewer/scene/scene.py

@@ -120,6 +120,7 @@ def __init__(
         self._backfaces_buffer: [dict[str, Any]] = None  # type: ignore
 
         self._inited = False
+        self.context = "Viewer"
 
     @property
     def bounding_box(self):
@@ -135,19 +136,19 @@ def bounding_box_center(self):
 
     def _read_points_data(self) -> Optional[ShaderDataType]:
         """Read points data from the object."""
-        raise NotImplementedError
+        pass
 
     def _read_lines_data(self) -> Optional[ShaderDataType]:
         """Read lines data from the object."""
-        raise NotImplementedError
+        pass
 
     def _read_frontfaces_data(self) -> Optional[ShaderDataType]:
         """Read frontfaces data from the object."""
-        raise NotImplementedError
+        pass
 
     def _read_backfaces_data(self) -> Optional[ShaderDataType]:
         """Read backfaces data from the object."""
-        raise NotImplementedError
+        pass
 
     # ==========================================================================
     # general