Merge pull request #58 from BlockResearchGroup/viewer_objects

Adding Group and viewer objects

Author: Licini

CHANGELOG.md

@@ -9,8 +9,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+* Added back `Group` Element.
+* Added `ElementObject` and `ModelElement` for `compas_viewer`.
+
 ### Changed
 
+* Updated existing `ElementObject` and `ModelElement` for renewed `SceneObject` APIs. 
+
 ### Removed
 
 

docs/examples/elements/group.py

@@ -0,0 +1,40 @@
+from compas.geometry import Polygon
+from compas.geometry import Translation
+from compas_model.elements import BeamElement
+from compas_model.elements import PlateElement
+from compas_model.models import Model
+from compas_viewer import Viewer
+
+beam1 = BeamElement(0.2, 0.3, 3)
+beam2 = BeamElement(0.2, 0.3, 3)
+beam3 = BeamElement(0.2, 0.3, 3)
+beam4 = BeamElement(0.2, 0.3, 3)
+
+beam1.transformation = Translation.from_vector([3, 3, 0])
+beam2.transformation = Translation.from_vector([-3, 3, 0])
+beam3.transformation = Translation.from_vector([-3, -3, 0])
+beam4.transformation = Translation.from_vector([3, -3, 0])
+
+
+points: list[list[float]] = [
+    [-3, -3, 0],
+    [-3, 3, 0],
+    [3, 3, 0],
+    [3, -3, 0],
+]
+polygon: Polygon = Polygon(points)
+plate = PlateElement(polygon=polygon, thickness=0.2)
+plate.transformation = Translation.from_vector([0, 0, 3])
+
+model = Model()
+group = model.add_group(name="Beams")
+model.add_element(beam1, parent=group)
+model.add_element(beam2, parent=group)
+model.add_element(beam3, parent=group)
+model.add_element(beam4, parent=group)
+model.add_element(plate)
+
+# Vizualize.
+viewer = Viewer()
+viewer.scene.add(model)
+viewer.show()

requirements-dev.txt

@@ -8,3 +8,4 @@ ruff
 sphinx_compas2_theme
 twine
 wheel
+compas_viewer # For building documentation

src/compas_model/__init__.py

@@ -20,4 +20,5 @@
     "compas_model.rhino",
     "compas_model.rhino.scene",
     "compas_model.notebook.scene",
+    "compas_model.viewer",
 ]

src/compas_model/elements/__init__.py

@@ -7,7 +7,7 @@
 from .column import ColumnFeature
 from .plate import PlateElement
 from .plate import PlateFeature
-
+from .group import Group
 
 __all__ = [
     "reset_computed",
@@ -19,4 +19,5 @@
     "ColumnFeature",
     "PlateElement",
     "PlateFeature",
+    "Group",
 ]

src/compas_model/elements/element.py

@@ -164,9 +164,21 @@ def material(self) -> Union[Material, None]:
         return self._material
 
     @property
-    def parent(self) -> "ElementNode":
+    def parentnode(self) -> "ElementNode":
         return self.treenode.parent
 
+    @property
+    def parent(self) -> "Element":
+        return self.parentnode.element
+
+    @property
+    def childnodes(self) -> "list[ElementNode]":
+        return self.treenode.children
+
+    @property
+    def children(self) -> "list[Element]":
+        return [child.element for child in self.childnodes]
+
     @property
     def features(self) -> list[Feature]:
         return self._features
@@ -285,9 +297,8 @@ def compute_modeltransformation(self) -> Transformation:
         parent = self.parent
 
         while parent:
-            if parent.element:
-                if parent.element.transformation:
-                    stack.append(parent.element.transformation)
+            if parent.transformation:
+                stack.append(parent.transformation)
             parent = parent.parent
 
         if self.model.transformation:

src/compas_model/elements/group.py

@@ -0,0 +1,5 @@
+from .element import Element
+
+
+class Group(Element):
+    pass

src/compas_model/models/elementtree.py

@@ -47,6 +47,12 @@ def __init__(self, element: Optional[Element] = None, **kwargs) -> None:
     def __getitem__(self, index: int) -> "ElementNode":
         return self.children[index]
 
+    def __repr__(self):
+        if self.parent:
+            return f"{self.element.__class__.__name__}(name={self.element.name})"
+        else:
+            return "ROOT"
+
 
 class ElementTree(Tree):
     """Class representing the hierarchy of elements in a model through a tree.
@@ -88,6 +94,10 @@ def __init__(self, name: Optional[str] = None) -> None:
     def elements(self) -> list[Element]:
         return [node.element for node in self.nodes if isinstance(node, ElementNode) if node.element]
 
+    @property
+    def rootelements(self) -> list[Element]:
+        return [node.element for node in self.root.children if isinstance(node, ElementNode) if node.element]
+
     def find_element_node(self, element: Element) -> ElementNode:
         """Find the node containing the element.
 

src/compas_model/models/model.py

@@ -6,6 +6,7 @@
 from compas.geometry import Transformation
 from compas_model.datastructures import KDTree
 from compas_model.elements import Element
+from compas_model.elements import Group
 from compas_model.interactions import Modifier
 from compas_model.materials import Material
 
@@ -252,26 +253,26 @@ def has_material(self, material: Material) -> bool:
     def add_element(
         self,
         element: Element,
-        parent: Optional[ElementNode] = None,
+        parent: Optional[Element] = None,
         material: Optional[Material] = None,
-    ) -> ElementNode:
+    ) -> Element:
         """Add an element to the model.
 
         Parameters
         ----------
         element : :class:`Element`
             The element to add.
-        parent : :class:`ElementNode`, optional
-            The parent group node of the element.
-            If ``None``, the element will be added directly under the root node.
+        parent : :class:`Element`, optional
+            The parent element of the element.
+            If ``None``, the element will be added directly under the root element.
         material : :class:`Material`, optional
             A material to assign to the element.
             Note that the material should have already been added to the model before it can be assigned.
 
         Returns
         -------
-        :class:`Elementnode`
-            The tree node containing the element in the hierarchy.
+        :class:`Element`
+            The element added to the model.
 
         Raises
         ------
@@ -289,23 +290,20 @@ def add_element(
 
         element.graphnode = self.graph.add_node(element=element)
 
-        if not parent:
-            parent = self._tree.root
-
-        if isinstance(parent, Element):
-            if parent.treenode is None:
+        if parent is None:
+            parent_node = self._tree.root
+        elif isinstance(parent, Element):
+            parent_node = parent.treenode
+            if parent_node is None:
                 raise ValueError("The parent element is not part of this model.")
-
-            parent = parent.treenode
-
-        if not isinstance(parent, ElementNode):
-            raise ValueError("Parent should be an Element or ElementNode of the current model.")
+        else:
+            raise ValueError("Parent should be an Element or None")
 
         if material and not self.has_material(material):
             raise ValueError("The material is not part of the model: {}".format(material))
 
         element_node = ElementNode(element=element)
-        parent.add(element_node)
+        parent_node.add(element_node)
 
         if material:
             self.assign_material(material=material, element=element)
@@ -317,28 +315,45 @@ def add_element(
         # and perhaps all resets should be collected in a reset decorator
         self._bvh = None
 
-        return element_node
+        return element
+
+    def add_group(self, name: str = None) -> Group:
+        """Add a group to the model.
+
+        Parameters
+        ----------
+        name : str
+            The name of the group.
+
+        Returns
+        -------
+        :class:`Group`
+            The group added to the model.
+
+        """
+        group = Group(name=name)
+        return self.add_element(group)
 
-    def add_elements(self, elements: list[Element], parent: Optional[ElementNode] = None) -> list[ElementNode]:
+    def add_elements(self, elements: list[Element], parent: Optional[Element] = None) -> list[Element]:
         """Add multiple elements to the model.
 
         Parameters
         ----------
         elements : list[:class:`Element`]
             The model elements.
-        parent : :class:`GroupNode`, optional
-            The parent group node of the elements.
-            If ``None``, the elements will be added directly under the root node.
+        parent : :class:`Group`, optional
+            The parent group of the elements.
+            If ``None``, the elements will be added directly under the root element.
 
         Returns
         -------
-        list[:class:`ElementNode`]
+        list[:class:`Element`]
 
         """
-        nodes = []
+        added_elements = []
         for element in elements:
-            nodes.append(self.add_element(element, parent=parent))
-        return nodes
+            added_elements.append(self.add_element(element, parent=parent))
+        return added_elements
 
     def add_material(self, material: Material) -> None:
         """Add a material to the model.

src/compas_model/scene/elementobject.py

@@ -54,7 +54,6 @@ class ElementObject(SceneObject):
 
     def __init__(
         self,
-        element: Element,
         vertexcolor: Optional[Color] = Color.black(),
         edgecolor: Optional[Color] = Color.black(),
         facecolor: Optional[Color] = Color.white(),
@@ -65,9 +64,7 @@ def __init__(
         show_faces: Optional[bool] = True,
         **kwargs,
     ) -> None:
-        super().__init__(item=element, **kwargs)
-
-        self._element = element
+        super().__init__(**kwargs)
 
         self.vertexcolor = vertexcolor
         self.edgecolor = edgecolor
@@ -80,14 +77,14 @@ def __init__(
         self.show_edges = show_edges
         self.show_faces = show_faces
 
+        for child in self.element.children:
+            child_kwargs = kwargs.copy()
+            child_kwargs["item"] = child
+            self.add(**child_kwargs)
+
     @property
     def element(self) -> Element:
-        return self._element
-
-    @element.setter
-    def element(self, element: Element) -> None:
-        self._element = element
-        self._transformation = None
+        return self.item
 
     @property
     def transformation(self) -> Transformation: