update draw and class name of rhino scene objects

Author: tomvanmele

docs/api/compas_rhino.scene.rst

@@ -19,29 +19,29 @@ Classes
     :toctree: generated/
     :nosignatures:
 
-    BoxObject
-    BrepObject
-    CapsuleObject
-    CircleObject
-    ConeObject
-    CurveObject
-    CylinderObject
-    EllipseObject
-    FrameObject
-    LineObject
-    MeshObject
-    GraphObject
-    PlaneObject
-    PointObject
-    PolygonObject
-    PolyhedronObject
-    PolylineObject
+    RhinoBoxObject
+    RhinoBrepObject
+    RhinoCapsuleObject
+    RhinoCircleObject
+    RhinoConeObject
+    RhinoCurveObject
+    RhinoCylinderObject
+    RhinoEllipseObject
+    RhinoFrameObject
+    RhinoLineObject
+    RhinoMeshObject
+    RhinoGraphObject
+    RhinoPlaneObject
+    RhinoPointObject
+    RhinoPolygonObject
+    RhinoPolyhedronObject
+    RhinoPolylineObject
     RhinoSceneObject
-    SphereObject
-    SurfaceObject
-    TorusObject
-    VectorObject
-    VolMeshObject
+    RhinoSphereObject
+    RhinoSurfaceObject
+    RhinoTorusObject
+    RhinoVectorObject
+    RhinoVolMeshObject
 
 
 

src/compas/scene/sceneobject.py

@@ -45,6 +45,9 @@ class SceneObject(object):
         The transformation of the scene object in world coordinates.
     color : :class:`compas.colors.Color`
         The color of the object.
+    contrastcolor : :class:`compas.colors.Color`, readon-only
+        The contrastcolor wrt to the color.
+        This is a 50% darket or lighter version of the color, depending on whether the color is light or dark.
     opacity : float
         The opacity of the object.
     show : bool

src/compas_rhino/scene/__init__.py

@@ -17,15 +17,13 @@
 from compas.geometry import Polygon
 from compas.geometry import Polyline
 from compas.geometry import Vector
-
 from compas.geometry import Box
 from compas.geometry import Capsule
 from compas.geometry import Cone
 from compas.geometry import Cylinder
 from compas.geometry import Polyhedron
 from compas.geometry import Sphere
 from compas.geometry import Torus
-
 from compas.geometry import Curve
 from compas.geometry import Surface
 from compas.geometry import Brep
@@ -37,31 +35,28 @@
 import compas_rhino
 
 from .sceneobject import RhinoSceneObject
-from .circleobject import CircleObject
-from .ellipseobject import EllipseObject
-from .frameobject import FrameObject
-from .lineobject import LineObject
-from .planeobject import PlaneObject
-from .pointobject import PointObject
-from .polygonobject import PolygonObject
-from .polylineobject import PolylineObject
-from .vectorobject import VectorObject
-
-from .boxobject import BoxObject
-from .capsuleobject import CapsuleObject
-from .coneobject import ConeObject
-from .cylinderobject import CylinderObject
-from .polyhedronobject import PolyhedronObject
-from .sphereobject import SphereObject
-from .torusobject import TorusObject
-
-from .meshobject import MeshObject
-from .graphobject import GraphObject
-from .volmeshobject import VolMeshObject
-
-from .curveobject import CurveObject
-from .surfaceobject import SurfaceObject
-from .brepobject import BrepObject
+from .circleobject import RhinoCircleObject
+from .ellipseobject import RhinoEllipseObject
+from .frameobject import RhinoFrameObject
+from .lineobject import RhinoLineObject
+from .planeobject import RhinoPlaneObject
+from .pointobject import RhinoPointObject
+from .polygonobject import RhinoPolygonObject
+from .polylineobject import RhinoPolylineObject
+from .vectorobject import RhinoVectorObject
+from .boxobject import RhinoBoxObject
+from .brepobject import RhinoBrepObject
+from .capsuleobject import RhinoCapsuleObject
+from .coneobject import RhinoConeObject
+from .cylinderobject import RhinoCylinderObject
+from .polyhedronobject import RhinoPolyhedronObject
+from .sphereobject import RhinoSphereObject
+from .torusobject import RhinoTorusObject
+from .meshobject import RhinoMeshObject
+from .graphobject import RhinoGraphObject
+from .volmeshobject import RhinoVolMeshObject
+from .curveobject import RhinoCurveObject
+from .surfaceobject import RhinoSurfaceObject
 
 
 @plugin(category="drawing-utils", pluggable_name="clear", requires=["Rhino"])
@@ -76,53 +71,53 @@ def after_draw_rhino(drawn_objects):
 
 @plugin(category="factories", requires=["Rhino"])
 def register_scene_objects():
-    register(Circle, CircleObject, context="Rhino")
-    register(Ellipse, EllipseObject, context="Rhino")
-    register(Frame, FrameObject, context="Rhino")
-    register(Line, LineObject, context="Rhino")
-    register(Plane, PlaneObject, context="Rhino")
-    register(Point, PointObject, context="Rhino")
-    register(Polygon, PolygonObject, context="Rhino")
-    register(Polyline, PolylineObject, context="Rhino")
-    register(Vector, VectorObject, context="Rhino")
-    register(Box, BoxObject, context="Rhino")
-    register(Capsule, CapsuleObject, context="Rhino")
-    register(Cone, ConeObject, context="Rhino")
-    register(Cylinder, CylinderObject, context="Rhino")
-    register(Polyhedron, PolyhedronObject, context="Rhino")
-    register(Sphere, SphereObject, context="Rhino")
-    register(Torus, TorusObject, context="Rhino")
-    register(Mesh, MeshObject, context="Rhino")
-    register(Graph, GraphObject, context="Rhino")
-    register(VolMesh, VolMeshObject, context="Rhino")
-    register(Curve, CurveObject, context="Rhino")
-    register(Surface, SurfaceObject, context="Rhino")
-    register(Brep, BrepObject, context="Rhino")
+    register(Circle, RhinoCircleObject, context="Rhino")
+    register(Ellipse, RhinoEllipseObject, context="Rhino")
+    register(Frame, RhinoFrameObject, context="Rhino")
+    register(Line, RhinoLineObject, context="Rhino")
+    register(Plane, RhinoPlaneObject, context="Rhino")
+    register(Point, RhinoPointObject, context="Rhino")
+    register(Polygon, RhinoPolygonObject, context="Rhino")
+    register(Polyline, RhinoPolylineObject, context="Rhino")
+    register(Vector, RhinoVectorObject, context="Rhino")
+    register(Box, RhinoBoxObject, context="Rhino")
+    register(Capsule, RhinoCapsuleObject, context="Rhino")
+    register(Cone, RhinoConeObject, context="Rhino")
+    register(Cylinder, RhinoCylinderObject, context="Rhino")
+    register(Polyhedron, RhinoPolyhedronObject, context="Rhino")
+    register(Sphere, RhinoSphereObject, context="Rhino")
+    register(Torus, RhinoTorusObject, context="Rhino")
+    register(Mesh, RhinoMeshObject, context="Rhino")
+    register(Graph, RhinoGraphObject, context="Rhino")
+    register(VolMesh, RhinoVolMeshObject, context="Rhino")
+    register(Curve, RhinoCurveObject, context="Rhino")
+    register(Surface, RhinoSurfaceObject, context="Rhino")
+    register(Brep, RhinoBrepObject, context="Rhino")
     print("Rhino SceneObjects registered.")
 
 
 __all__ = [
     "RhinoSceneObject",
-    "CircleObject",
-    "EllipseObject",
-    "FrameObject",
-    "LineObject",
-    "PlaneObject",
-    "PointObject",
-    "PolygonObject",
-    "PolylineObject",
-    "VectorObject",
-    "BoxObject",
-    "CapsuleObject",
-    "ConeObject",
-    "CylinderObject",
-    "PolyhedronObject",
-    "SphereObject",
-    "TorusObject",
-    "MeshObject",
-    "GraphObject",
-    "VolMeshObject",
-    "CurveObject",
-    "SurfaceObject",
-    "BrepObject",
+    "RhinoCircleObject",
+    "RhinoEllipseObject",
+    "RhinoFrameObject",
+    "RhinoLineObject",
+    "RhinoPlaneObject",
+    "RhinoPointObject",
+    "RhinoPolygonObject",
+    "RhinoPolylineObject",
+    "RhinoVectorObject",
+    "RhinoBoxObject",
+    "RhinoCapsuleObject",
+    "RhinoConeObject",
+    "RhinoCylinderObject",
+    "RhinoPolyhedronObject",
+    "RhinoSphereObject",
+    "RhinoTorusObject",
+    "RhinoMeshObject",
+    "RhinoGraphObject",
+    "RhinoVolMeshObject",
+    "RhinoCurveObject",
+    "RhinoSurfaceObject",
+    "RhinoBrepObject",
 ]

src/compas_rhino/scene/boxobject.py

@@ -8,10 +8,9 @@
 from compas_rhino.conversions import box_to_rhino
 from compas_rhino.conversions import transformation_to_rhino
 from .sceneobject import RhinoSceneObject
-from .helpers import attributes
 
 
-class BoxObject(RhinoSceneObject, GeometryObject):
+class RhinoBoxObject(RhinoSceneObject, GeometryObject):
     """Scene object for drawing box shapes.
 
     Parameters
@@ -24,7 +23,7 @@ class BoxObject(RhinoSceneObject, GeometryObject):
     """
 
     def __init__(self, box, **kwargs):
-        super(BoxObject, self).__init__(geometry=box, **kwargs)
+        super(RhinoBoxObject, self).__init__(geometry=box, **kwargs)
         self.box = box
 
     def draw(self):
@@ -36,10 +35,9 @@ def draw(self):
             List of GUIDs of the objects created in Rhino.
 
         """
-        attr = attributes(name=self.geometry.name, color=self.color, layer=self.layer)
+        attr = self.compile_attributes()
         geometry = box_to_rhino(self.geometry)
-        transformation = transformation_to_rhino(self.worldtransformation)
-        geometry.Transform(transformation)
+        geometry.Transform(transformation_to_rhino(self.worldtransformation))
 
         self._guids = [sc.doc.Objects.AddBox(geometry, attr)]
         return self.guids

src/compas_rhino/scene/brepobject.py

@@ -8,10 +8,9 @@
 from compas_rhino.conversions import transformation_to_rhino
 from compas.scene import GeometryObject
 from .sceneobject import RhinoSceneObject
-from .helpers import attributes
 
 
-class BrepObject(RhinoSceneObject, GeometryObject):
+class RhinoBrepObject(RhinoSceneObject, GeometryObject):
     """A scene object for drawing a RhinoBrep.
 
     Parameters
@@ -22,7 +21,7 @@ class BrepObject(RhinoSceneObject, GeometryObject):
     """
 
     def __init__(self, brep, **kwargs):
-        super(BrepObject, self).__init__(geometry=brep, **kwargs)
+        super(RhinoBrepObject, self).__init__(geometry=brep, **kwargs)
 
     def draw(self):
         """Bakes the Brep into the current document
@@ -33,7 +32,7 @@ def draw(self):
             List of GUIDs of the objects created in Rhino.
 
         """
-        attr = attributes(name=self.geometry.name, color=self.color, layer=self.layer)
+        attr = self.compile_attributes()
         geometry = brep_to_rhino(self.geometry)
         geometry.Transform(transformation_to_rhino(self.worldtransformation))
 

src/compas_rhino/scene/capsuleobject.py

@@ -8,10 +8,9 @@
 from compas_rhino.conversions import capsule_to_rhino_brep
 from compas_rhino.conversions import transformation_to_rhino
 from .sceneobject import RhinoSceneObject
-from .helpers import attributes
 
 
-class CapsuleObject(RhinoSceneObject, GeometryObject):
+class RhinoCapsuleObject(RhinoSceneObject, GeometryObject):
     """Scene object for drawing capsule shapes.
 
     Parameters
@@ -24,7 +23,7 @@ class CapsuleObject(RhinoSceneObject, GeometryObject):
     """
 
     def __init__(self, capsule, **kwargs):
-        super(CapsuleObject, self).__init__(geometry=capsule, **kwargs)
+        super(RhinoCapsuleObject, self).__init__(geometry=capsule, **kwargs)
 
     def draw(self):
         """Draw the capsule associated with the scene object.
@@ -35,7 +34,7 @@ def draw(self):
             The GUIDs of the objects created in Rhino.
 
         """
-        attr = attributes(name=self.geometry.name, color=self.color, layer=self.layer)
+        attr = self.compile_attributes()
         breps = capsule_to_rhino_brep(self.geometry)
         transformation = transformation_to_rhino(self.worldtransformation)
         for geometry in breps:

src/compas_rhino/scene/circleobject.py

@@ -8,10 +8,9 @@
 from compas_rhino.conversions import circle_to_rhino
 from compas_rhino.conversions import transformation_to_rhino
 from .sceneobject import RhinoSceneObject
-from .helpers import attributes
 
 
-class CircleObject(RhinoSceneObject, GeometryObject):
+class RhinoCircleObject(RhinoSceneObject, GeometryObject):
     """Scene object for drawing circles.
 
     Parameters
@@ -24,7 +23,7 @@ class CircleObject(RhinoSceneObject, GeometryObject):
     """
 
     def __init__(self, circle, **kwargs):
-        super(CircleObject, self).__init__(geometry=circle, **kwargs)
+        super(RhinoCircleObject, self).__init__(geometry=circle, **kwargs)
 
     def draw(self):
         """Draw the circle.
@@ -35,7 +34,7 @@ def draw(self):
             List of GUIDs of the objects created in Rhino.
 
         """
-        attr = attributes(name=self.geometry.name, color=self.color, layer=self.layer)
+        attr = self.compile_attributes()
         geometry = circle_to_rhino(self.geometry)
         geometry.Transform(transformation_to_rhino(self.worldtransformation))
 

src/compas_rhino/scene/coneobject.py

@@ -8,10 +8,9 @@
 from compas_rhino.conversions import cone_to_rhino_brep
 from compas_rhino.conversions import transformation_to_rhino
 from .sceneobject import RhinoSceneObject
-from .helpers import attributes
 
 
-class ConeObject(RhinoSceneObject, GeometryObject):
+class RhinoConeObject(RhinoSceneObject, GeometryObject):
     """Scene object for drawing cone shapes.
 
     Parameters
@@ -24,7 +23,7 @@ class ConeObject(RhinoSceneObject, GeometryObject):
     """
 
     def __init__(self, cone, **kwargs):
-        super(ConeObject, self).__init__(geometry=cone, **kwargs)
+        super(RhinoConeObject, self).__init__(geometry=cone, **kwargs)
 
     def draw(self):
         """Draw the cone associated with the scene object.
@@ -35,7 +34,7 @@ def draw(self):
             The GUID of the object created in Rhino.
 
         """
-        attr = attributes(name=self.geometry.name, color=self.color, layer=self.layer)
+        attr = self.compile_attributes()
         geometry = cone_to_rhino_brep(self.geometry)
         geometry.Transform(transformation_to_rhino(self.worldtransformation))