Item as kwarg

CHANGELOG.md

@@ -34,6 +34,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * Fixed `load_scene` action bug.
 * Changed base of shapes to `compas_viewer.scene.ShapeObject`.
 * Changed `FrameObject` to something with just 3 axes.
+* Restructured `SceneObjects` to accepct `item` as kwargs.
 * Fixed `compas_viewer.components.slider` step attribute.
 
 ### Removed

src/compas_viewer/commands.py

@@ -1,3 +1,4 @@
+import pathlib
 from typing import TYPE_CHECKING
 from typing import Any
 from typing import Callable
@@ -9,7 +10,6 @@
 from numpy import array
 from numpy import unique
 from numpy.linalg import norm
-import pathlib
 from PySide6.QtCore import QEvent
 from PySide6.QtCore import Qt
 from PySide6.QtGui import QMouseEvent

src/compas_viewer/scene/__init__.py

@@ -37,16 +37,10 @@
 from .tagobject import TagObject, Tag
 from .frameobject import FrameObject
 from .circleobject import CircleObject
-from .boxobject import BoxObject
-from .torusobject import TorusObject
 from .polylineobject import PolylineObject
 from .polygonobject import PolygonObject
-from .sphereobject import SphereObject
 from .planeobject import PlaneObject
-from .cylinderobject import CylinderObject
 from .ellipseobject import EllipseObject
-from .coneobject import ConeObject
-from .capsuleobject import CapsuleObject
 from .polyhedronobject import PolyhedronObject
 from .geometryobject import GeometryObject
 from .shapeobject import ShapeObject
@@ -81,16 +75,16 @@ def register_scene_objects():
     register(Frame, FrameObject, context="Viewer")
     register(Vector, VectorObject, context="Viewer")
     register(Circle, CircleObject, context="Viewer")
-    register(Box, BoxObject, context="Viewer")
+    register(Box, ShapeObject, context="Viewer")
     register(Polyline, PolylineObject, context="Viewer")
-    register(Torus, TorusObject, context="Viewer")
+    register(Torus, ShapeObject, context="Viewer")
     register(Polygon, PolygonObject, context="Viewer")
-    register(Sphere, SphereObject, context="Viewer")
+    register(Sphere, ShapeObject, context="Viewer")
     register(Plane, PlaneObject, context="Viewer")
-    register(Cylinder, CylinderObject, context="Viewer")
+    register(Cylinder, ShapeObject, context="Viewer")
     register(Ellipse, EllipseObject, context="Viewer")
-    register(Cone, ConeObject, context="Viewer")
-    register(Capsule, CapsuleObject, context="Viewer")
+    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")
@@ -130,23 +124,17 @@ def register_scene_objects():
     "Polyline",
     "PolylineObject",
     "Box",
-    "BoxObject",
     "Torus",
-    "TorusObject",
     "Polygon",
     "PolygonObject",
     "Sphere",
-    "SphereObject",
     "Plane",
     "PlaneObject",
     "Cylinder",
-    "CylinderObject",
     "Ellipse",
     "EllipseObject",
     "Cone",
-    "ConeObject",
     "Capsule",
-    "CapsuleObject",
     "NurbsSurface",
     "NurbsSurfaceObject",
     "GeometryObject",

src/compas_viewer/scene/brepobject.py

@@ -1,7 +1,5 @@
 from typing import Optional
 
-from compas_occ.brep import OCCBrep
-
 from compas.datastructures import Mesh
 from compas.geometry import Line
 from compas.geometry import Point
@@ -26,9 +24,8 @@ class BRepObject(ViewerGeometryObject, GeometryObject):
     :class:`compas_occ.brep.Brep`
     """
 
-    def __init__(self, brep: OCCBrep, **kwargs):
-        super().__init__(geometry=brep, **kwargs)
-        self.geometry: OCCBrep
+    def __init__(self, **kwargs):
+        super().__init__(**kwargs)
         self._viewmesh, self._boundaries = self.geometry.to_tesselation(TOL.lineardeflection)
 
     @property

src/compas_viewer/scene/bufferobject.py

@@ -187,7 +187,6 @@ class BufferObject(SceneObject, Base):
 
     def __init__(
         self,
-        buffergeometry: BufferGeometry,
         show_points: Optional[bool] = None,
         show_lines: Optional[bool] = None,
         show_faces: Optional[bool] = None,
@@ -198,8 +197,7 @@ def __init__(
         is_visiable: Optional[bool] = None,
         **kwargs,
     ):
-        super().__init__(item=buffergeometry, **kwargs)
-        self.buffergeometry = buffergeometry
+        super().__init__(**kwargs)
 
         self.show_points = True if show_points is None else show_points
         self.show_lines = True if show_lines is None else show_lines
@@ -214,6 +212,10 @@ def __init__(
         self.background = False
         self._matrix_buffer = None
 
+    @property
+    def buffergeometry(self) -> BufferGeometry:
+        return self.item
+
     def init(self):
         """Initialize the object"""
         self.instance_color = Color.from_rgb255(*next(self.scene._instance_colors_generator))

src/compas_viewer/scene/circleobject.py

@@ -9,16 +9,12 @@
 
 
 class CircleObject(ViewerGeometryObject, GeometryObject):
-    """Viewer scene object for displaying COMPAS Circle geometry.
+    """Viewer scene object for displaying COMPAS Circle geometry."""
 
-    See Also
-    --------
-    :class:`compas.geometry.Circle`
-    """
+    geometry: Circle
 
-    def __init__(self, circle: Circle, **kwargs):
-        super().__init__(geometry=circle, **kwargs)
-        self.geometry: Circle
+    def __init__(self, **kwargs):
+        super().__init__(**kwargs)
         self.show_lines = True
 
     @property

src/compas_viewer/scene/collectionobject.py

@@ -27,10 +27,14 @@ def __data__(self):
 class CollectionObject(ViewerSceneObject, GeometryObject):
     """Viewer scene object for displaying a collection of COMPAS geometries."""
 
-    def __init__(self, collection: Collection, **kwargs):
-        self.collection = collection
-        super().__init__(geometry=self.collection, **kwargs)
-        self.objects = [ViewerSceneObject(item, **kwargs) for item in self.collection.items]
+    def __init__(self, **kwargs):
+        super().__init__(**kwargs)
+        kwargs.pop("item")
+        self.objects = [ViewerSceneObject(item=item, **kwargs) for item in self.collection.items]
+
+    @property
+    def collection(self) -> Collection:
+        return self.item
 
     def _read_points_data(self) -> ShaderDataType:
         positions = []

src/compas_viewer/scene/ellipseobject.py

@@ -9,24 +9,12 @@
 
 
 class EllipseObject(ViewerGeometryObject, GeometryObject):
-    """Viewer scene object for displaying COMPAS Ellipse geometry.
-
-    Parameters
-    ----------
-    ellipse : :class:`compas.geometry.Ellipse`
-        A COMPAS ellipse geometry.
-    **kwargs : dict, optional
-        Additional options for the :class:`compas_viewer.scene.ViewerSceneObject`
-        and :class:`compas.scene.GeometryObject`.
-
-    See Also
-    --------
-    :class:`compas.geometry.Ellipse`
-    """
-
-    def __init__(self, ellipse: Ellipse, **kwargs):
-        super().__init__(geometry=ellipse, **kwargs)
-        self.geometry: Ellipse
+    """Viewer scene object for displaying COMPAS Ellipse geometry."""
+
+    geometry: Ellipse
+
+    def __init__(self, **kwargs):
+        super().__init__(**kwargs)
         self.show_lines = True
 
     @property

src/compas_viewer/scene/frameobject.py

@@ -48,12 +48,10 @@ class FrameObject(ViewerSceneObject):
 
     def __init__(
         self,
-        frame: Frame,
         size: Optional[float] = 1,
         **kwargs,
     ):
-        super().__init__(item=frame, **kwargs)
-        self.frame = frame
+        super().__init__(**kwargs)
         self.size = size
 
     def _read_lines_data(self) -> ShaderDataType:

src/compas_viewer/scene/geometryobject.py

@@ -2,7 +2,6 @@
 
 from compas.colors import Color
 from compas.datastructures import Mesh
-from compas.geometry import Geometry
 from compas.geometry import Line
 from compas.geometry import Point
 from compas.itertools import flatten
@@ -60,13 +59,11 @@ class GeometryObject(ViewerSceneObject, BaseGeometryObject):
 
     def __init__(
         self,
-        geometry: Geometry,
         u: Optional[int] = 16,
         v: Optional[int] = 16,
         **kwargs,
     ):
-        super().__init__(geometry=geometry, **kwargs)
-        self.geometry: Geometry
+        super().__init__(**kwargs)
         self.u = u
         self.v = v
 

src/compas_viewer/scene/graphobject.py

@@ -6,25 +6,9 @@
 
 
 class GraphObject(ViewerSceneObject, BaseGraphObject):
-    """Viewer scene object for displaying COMPAS Graph data.
+    """Viewer scene object for displaying COMPAS Graph data."""
 
-
-    Parameters
-    ----------
-    graph : :class:`compas.datastructures.Graph`
-        The graph data structure.
-    **kwargs : dict, optional
-        Additional options for the :class:`compas_viewer.scene.ViewerSceneObject`.
-
-    See Also
-    --------
-    :class:`compas.datastructures.Graph`
-
-    """
-
-    def __init__(self, graph: Graph, **kwargs):
-        super(GraphObject, self).__init__(graph=graph, **kwargs)
-        self.graph: Graph
+    graph: Graph
 
     def _read_points_data(self) -> ShaderDataType:
         positions = []

src/compas_viewer/scene/groupobject.py

@@ -18,15 +18,15 @@ def __data__(self):
 class GroupObject(SceneObject):
     """A group of scene objects."""
 
-    def __init__(self, items, **kwargs):
-        super().__init__(Group(items), **kwargs)
+    def __init__(self, item=None, **kwargs):
+        super().__init__(item=Group(item), **kwargs)
         self.show = True
         self.is_selected = False
         self.is_locked = False
         self.opacity = 1.0
         self.bounding_box = None
 
-        for item in items:
+        for item in self.items:
             if isinstance(item, (Data, list)):
                 self.add(item, **kwargs)
             elif isinstance(item, tuple) and len(item) == 2 and isinstance(item[0], (Data, list)):
@@ -37,6 +37,10 @@ def __init__(self, items, **kwargs):
                 print(item)
                 raise TypeError("Group items must be of type `Data` or a tuple of (`Data`, kwargs).")
 
+    @property
+    def items(self):
+        return self.item.items
+
     def init(self, *args, **kwargs):
         pass
 

src/compas_viewer/scene/lineobject.py

@@ -8,16 +8,12 @@
 
 
 class LineObject(ViewerGeometryObject, GeometryObject):
-    """Viewer scene object for displaying COMPAS Line geometry.
+    """Viewer scene object for displaying COMPAS Line geometry."""
 
-    See Also
-    --------
-    :class:`compas.geometry.Line`
-    """
+    geometry: Line
 
-    def __init__(self, line: Line, **kwargs):
-        super().__init__(geometry=line, **kwargs)
-        self.geometry: Line
+    def __init__(self, **kwargs):
+        super().__init__(**kwargs)
         self.show_lines = True
 
     @property