Merge pull request #1471 from compas-dev/group

Group

Author: tomvanmele

CHANGELOG.md

@@ -9,10 +9,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+* Added `compas.scene.Scene.add_group()` for adding group.
+* Added `compas.scene.Group.add_from_list()` for adding a list of items to a group.
+
 ### Changed
 
 * Fixed error in `circle_to_compas` from Rhino.
 * Fixed Rhino to Rhino brep serialization.
+* Upated `compas.scene.Group.add()` to pass on group kwargs as default for child items.
 
 ### Removed
 

src/compas/scene/group.py

@@ -1,4 +1,6 @@
 # -*- coding: utf-8 -*-
+import compas.data  # noqa: F401
+
 from .sceneobject import SceneObject
 
 
@@ -9,6 +11,13 @@ class Group(SceneObject):
     ----------
     name : str, optional
         The name of the group.
+    **kwargs : dict, optional
+        Additional keyword arguments to pass on to the child sceneobjects as default values.
+
+    Attributes
+    ----------
+    kwargs : dict
+        The keyword arguments to pass on to the child sceneobjects as default values.
 
     Examples
     --------
@@ -32,6 +41,10 @@ def __new__(cls, *args, **kwargs):
         # overwriting __new__ to revert to the default behavior of normal object, So an instance can be created directly without providing a registered item.
         return object.__new__(cls)
 
+    def __init__(self, name, **kwargs):
+        super(Group, self).__init__(name=name, **kwargs)
+        self.kwargs = kwargs
+
     @property
     def __data__(self):
         # type: () -> dict
@@ -40,3 +53,52 @@ def __data__(self):
             "children": [child.__data__ for child in self.children],
         }
         return data
+
+    def add(self, item, **kwargs):
+        # type: (compas.data.Data, dict) -> SceneObject
+        """Add a child item to the group, using the group's kwargs as default values for the child sceneobject.
+
+        Parameters
+        ----------
+        item : :class:`compas.data.Data`
+            The item to add.
+        **kwargs : dict
+            Additional keyword arguments to create the scene object for the item.
+
+        Returns
+        -------
+        :class:`compas.scene.SceneObject`
+            The scene object associated with the added item.
+
+        Raises
+        ------
+        ValueError
+            If the scene object does not have an associated scene node.
+        """
+        group_kwargs = self.kwargs.copy()
+        group_kwargs.update(kwargs)
+        kwargs = group_kwargs
+        return super(Group, self).add(item, **kwargs)
+
+    def add_from_list(self, items, **kwargs):
+        # type: (list[compas.data.Data], dict) -> list[SceneObject]
+        """Add a list of items to the group, using the group's kwargs as default values for the child sceneobject.
+
+        Parameters
+        ----------
+        items : list[:class:`compas.data.Data`]
+            The items to add.
+        **kwargs : dict
+            Additional keyword arguments to create the scene object for the items.
+
+        Returns
+        -------
+        list[SceneObject]
+            The scene objects associated with the added items.
+
+        """
+        sceneobjects = []
+        for item in items:
+            sceneobject = self.add(item, **kwargs)
+            sceneobjects.append(sceneobject)
+        return sceneobjects

src/compas/scene/scene.py

@@ -61,12 +61,12 @@ def add(node, parent, items):
                 settings = child_node["settings"]
                 if "item" in child_node:
                     guid = child_node["item"]
-                    sceneobject = parent.add(items[guid], **settings)
+                    sceneobject = scene.add(items[guid], parent=parent, **settings)
                 else:
-                    sceneobject = parent.add(Group(**settings))
+                    sceneobject = scene.add_group(parent=parent, **settings)
                 add(child_node, sceneobject, items)
 
-        add(data["root"], scene, items)
+        add(data["root"], scene.root, items)
 
         return scene
 
@@ -117,10 +117,21 @@ def add(self, item, parent=None, **kwargs):
                 if kwargs["context"] != self.context:
                     raise Exception("Object context should be the same as scene context: {} != {}".format(kwargs["context"], self.context))
                 del kwargs["context"]  # otherwist the SceneObject receives "context" twice, which results in an error
+            if isinstance(parent, Group):
+                # Use the kwargs of the parent group as default values for the child sceneobject
+                group_kwargs = parent.kwargs.copy()
+                group_kwargs.update(kwargs)
+                kwargs = group_kwargs
             sceneobject = SceneObject(item=item, context=self.context, **kwargs)  # type: ignore
         super(Scene, self).add(sceneobject, parent=parent)
         return sceneobject
 
+    def add_group(self, name, parent=None, **kwargs):
+        # type: (str, SceneObject | TreeNode | None, dict) -> SceneObject
+        group = Group(name=name, **kwargs)
+        self.add(group, parent=parent)
+        return group
+
     def clear_context(self, guids=None):
         # type: (list | None) -> None
         """Clear the visualisation context.

tests/compas/scene/test_scene.py

@@ -11,6 +11,7 @@
     from compas.geometry import Box
     from compas.geometry import Frame
     from compas.geometry import Translation
+    from compas.scene import Group
 
     @pytest.fixture(autouse=True)
     def reset_sceneobjects_registration():
@@ -114,3 +115,47 @@ def test_scene_clear():
         scene.clear(clear_context=False, clear_scene=True)
 
         assert len(scene.objects) == 0
+
+    def test_group_creation():
+        scene = Scene()
+        group = scene.add_group("TestGroup")
+        assert isinstance(group, Group)
+        assert group.name == "TestGroup"
+        assert group.parent == scene.root
+
+    def test_group_add_item():
+        scene = Scene()
+        group = scene.add_group("TestGroup")
+        box = Box()
+        box_obj = group.add(box)
+        assert isinstance(box_obj, SceneObject)
+        assert box_obj.parent is group
+        assert box_obj.item is box
+
+    def test_group_add_from_list():
+        scene = Scene()
+        group = scene.add_group("TestGroup")
+        boxes = [Box() for _ in range(3)]
+        box_objs = group.add_from_list(boxes)
+        assert len(box_objs) == 3
+        for box_obj in box_objs:
+            assert isinstance(box_obj, SceneObject)
+            assert box_obj.parent is group
+
+    def test_group_kwargs_inheritance():
+        scene = Scene()
+        group = scene.add_group("TestGroup", show=False)
+        box = Box()
+        box_obj = group.add(box)
+        assert not box_obj.show  # Should inherit show=False from group
+
+    def test_group_hierarchy():
+        scene = Scene()
+        parent_group = scene.add_group("ParentGroup")
+        child_group = parent_group.add(Group("ChildGroup"))
+        box = Box()
+        box_obj = child_group.add(box)
+
+        assert box_obj.parent is child_group
+        assert child_group.parent is parent_group
+        assert parent_group.parent is scene.root

tests/compas/scene/test_scene_serialisation.py

@@ -124,3 +124,66 @@ def test_scene_serialisation_empty():
         scene = compas.json_loads(compas.json_dumps(scene))
 
         assert isinstance(scene, Scene)
+
+    def test_group_serialisation():
+        scene1 = Scene()
+        group = scene1.add_group("TestGroup", show=False)
+        box = Box.from_width_height_depth(1, 1, 1)
+        group.add(box)
+
+        scene2 = Scene.from_jsonstring(scene1.to_jsonstring())
+
+        # Check if group was serialized correctly
+        group2 = scene2.find_by_name("TestGroup")
+        assert isinstance(group2, Group)
+        assert group2.name == "TestGroup"
+        assert not group2.show
+
+        # Check if box was serialized correctly
+        box2 = group2.children[0]
+        assert isinstance(box2.item, Box)
+        assert box2.parent is group2
+
+    def test_nested_group_serialisation():
+        scene1 = Scene()
+        parent_group = scene1.add_group("ParentGroup", show=False)
+        child_group = parent_group.add(Group("ChildGroup", show=True))
+        box = Box.from_width_height_depth(1, 1, 1)
+        child_group.add(box)
+
+        scene2 = Scene.from_jsonstring(scene1.to_jsonstring())
+
+        # Check parent group
+        parent2 = scene2.find_by_name("ParentGroup")
+        assert isinstance(parent2, Group)
+        assert not parent2.show
+
+        # Check child group
+        child2 = parent2.children[0]
+        assert isinstance(child2, Group)
+        assert child2.name == "ChildGroup"
+        assert child2.show
+        assert child2.parent is parent2
+
+        # Check box
+        box2 = child2.children[0]
+        assert isinstance(box2.item, Box)
+        assert box2.parent is child2
+
+    def test_group_kwargs_serialisation():
+        scene1 = Scene()
+        group = scene1.add_group("TestGroup", show=False, opacity=0.5)
+        box = Box.from_width_height_depth(1, 1, 1)
+        group.add(box)
+
+        scene2 = Scene.from_jsonstring(scene1.to_jsonstring())
+
+        # Check if group kwargs were serialized correctly
+        group2 = scene2.find_by_name("TestGroup")
+        assert not group2.show
+        assert group2.opacity == 0.5
+
+        # Check if box inherited kwargs correctly
+        box2 = group2.children[0]
+        assert not box2.show
+        assert box2.opacity == 0.5