Merge pull request #928 from compas-dev/prim_blndr_art

Primitive Blender Artists

Author: beverlylytle

CHANGELOG.md

@@ -9,8 +9,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+* Added `CircleArtist`, `LineArtist`, `PointArtist`, `PolygonArtist`, `PolylineArtist`, and `VectorArtist` to `compas_blender`.
+* Added `draw_circles` and `draw_planes` to `compas_blender`.
+
 ### Changed
 
+* Replaced implementation of `RGBColour` and `Float` with deprecation warning in `compas.utilities.descriptors`.
+
 ### Removed
 
 

src/compas/utilities/colors.py

@@ -55,7 +55,6 @@
 
 BASE16 = '0123456789abcdef'
 
-
 try:
     HEX_DEC = {v: int(v, base=16) for v in [x + y for x in BASE16 for y in BASE16]}
 except Exception:

src/compas/utilities/descriptors.py

@@ -2,97 +2,22 @@
 from __future__ import absolute_import
 from __future__ import division
 
-from compas.utilities import color_to_rgb
-
-try:
-    basestring
-except NameError:
-    basestring = str
+import warnings
 
 
 __all__ = [
-    'Float', 'RGBColour',
+    'Float',
+    'RGBColour',
 ]
 
 
 class Float(object):
-    """Descriptor for properties of type float.
-
-    Parameters
-    ----------
-    value : float
-        The value of the property.
-    minval : float, optional
-        The minimum value of the property.
-    maxval : float, optional
-        The maximum value of the property.
-    """
-
-    __slots__ = ('value', 'minval', 'maxval')
-
-    def __init__(self, value, minval=None, maxval=None):
-        self.minval = None
-        self.maxval = None
-        if minval is not None:
-            self.minval = float(minval)
-        if maxval is not None:
-            self.maxval = float(maxval)
-        if self.minval is not None and self.maxval is not None:
-            if self.minval > self.maxval:
-                raise ValueError("The minimum value cannot be greater than the maximum value.")
-        value = float(value)
-        if self.minval is not None:
-            if value < self.minval:
-                raise ValueError("The value cannot be smaller than the minimum value.")
-        if self.maxval is not None:
-            if value > self.maxval:
-                raise ValueError("The value cannot be greater than the maximum value.")
-        self.value = value
-
-    def __get__(self, obj, objtype):
-        return self.value
-
-    def __set__(self, obj, value):
-        value = float(value)
-        if self.minval is not None:
-            if value < self.minval:
-                raise ValueError("The value cannot be smaller than the minimum value.")
-        if self.maxval is not None:
-            if value > self.maxval:
-                raise ValueError("The value cannot be greater than the maximum value.")
-        self.value = value
+    def __init__(self):
+        warnings.warn("This class will be removed.",
+                      DeprecationWarning)
 
 
 class RGBColour(object):
-    """Descriptor for RGB color properties.
-
-    Parameters
-    ----------
-    default : tuple
-        The default color.
-    normalize : bool, optional
-        Normalize the color components, if true.
-    description : str, optional
-        A description of the purpose of the color property.
-
-    Attributes
-    ----------
-    value : tuple
-        The current value of the color property.
-    """
-
-    __slots__ = ('default', 'normalize', 'description', 'value')
-
-    def __init__(self, default, normalize=False, description=""):
-        self.default = default
-        self.normalize = normalize
-        self.description = description
-        self.value = None
-
-    def __get__(self, obj, objtype):
-        if self.value is None:
-            return self.default
-        return self.value
-
-    def __set__(self, obj, value):
-        self.value = color_to_rgb(value, normalize=self.normalize)
+    def __init__(self):
+        warnings.warn("This class will be removed.",
+                      DeprecationWarning)

src/compas_blender/artists/__init__.py

@@ -5,7 +5,7 @@
 
 .. currentmodule:: compas_blender.artists
 
-Artists for visualising (painting) COMPAS data structures in Blender.
+Artists for visualizing (painting) COMPAS data structures in Blender.
 
 
 Primitive Artists
@@ -14,7 +14,13 @@
 .. autosummary::
     :toctree: generated/
 
+    CircleArtist
     FrameArtist
+    LineArtist
+    PointArtist
+    PolygonArtist
+    PolylineArtist
+    VectorArtist
 
 
 Shape Artists
@@ -28,8 +34,8 @@
     CapsuleArtist
     ConeArtist
     CylinderArtist
-    SphereArtist
     PolyhedronArtist
+    SphereArtist
 
 
 Datastructure Artists
@@ -39,8 +45,8 @@
     :toctree: generated/
     :nosignatures:
 
-    NetworkArtist
     MeshArtist
+    NetworkArtist
 
 
 Robot Artist
@@ -71,28 +77,40 @@
 
 from compas.geometry import Box
 from compas.geometry import Capsule
+from compas.geometry import Circle
 from compas.geometry import Cone
 from compas.geometry import Cylinder
 from compas.geometry import Frame
+from compas.geometry import Line
+from compas.geometry import Point
+from compas.geometry import Polygon
 from compas.geometry import Polyhedron
+from compas.geometry import Polyline
 from compas.geometry import Sphere
 from compas.geometry import Torus
+from compas.geometry import Vector
 from compas.datastructures import Mesh
 from compas.datastructures import Network
 from compas.robots import RobotModel
 
 from .artist import BlenderArtist
 from .boxartist import BoxArtist
 from .capsuleartist import CapsuleArtist
+from .circleartist import CircleArtist
 from .coneartist import ConeArtist
 from .cylinderartist import CylinderArtist
 from .frameartist import FrameArtist
+from .lineartist import LineArtist
 from .meshartist import MeshArtist
 from .networkartist import NetworkArtist
+from .pointartist import PointArtist
+from .polygonartist import PolygonArtist
 from .polyhedronartist import PolyhedronArtist
+from .polylineartist import PolylineArtist
 from .robotmodelartist import RobotModelArtist
 from .sphereartist import SphereArtist
 from .torusartist import TorusArtist
+from .vectorartist import VectorArtist
 
 
 @plugin(category='drawing-utils', pluggable_name='clear', requires=['bpy'])
@@ -116,15 +134,21 @@ def new_artist_blender(cls, *args, **kwargs):
     if not artists_registered:
         BlenderArtist.register(Box, BoxArtist)
         BlenderArtist.register(Capsule, CapsuleArtist)
+        BlenderArtist.register(Circle, CircleArtist)
         BlenderArtist.register(Cone, ConeArtist)
         BlenderArtist.register(Cylinder, CylinderArtist)
         BlenderArtist.register(Frame, FrameArtist)
+        BlenderArtist.register(Line, LineArtist)
         BlenderArtist.register(Mesh, MeshArtist)
         BlenderArtist.register(Network, NetworkArtist)
+        BlenderArtist.register(Point, PointArtist)
+        BlenderArtist.register(Polygon, PolygonArtist)
         BlenderArtist.register(Polyhedron, PolyhedronArtist)
+        BlenderArtist.register(Polyline, PolylineArtist)
         BlenderArtist.register(RobotModel, RobotModelArtist)
         BlenderArtist.register(Sphere, SphereArtist)
         BlenderArtist.register(Torus, TorusArtist)
+        BlenderArtist.register(Vector, VectorArtist)
         artists_registered = True
 
     data = args[0]
@@ -140,13 +164,19 @@ def new_artist_blender(cls, *args, **kwargs):
     'BlenderArtist',
     'BoxArtist',
     'CapsuleArtist',
+    'CircleArtist',
     'ConeArtist',
     'CylinderArtist',
     'FrameArtist',
+    'LineArtist',
     'MeshArtist',
     'NetworkArtist',
+    'PointArtist',
+    'PolygonArtist',
     'PolyhedronArtist',
+    'PolylineArtist',
     'RobotModelArtist',
     'SphereArtist',
     'TorusArtist',
+    'VectorArtist',
 ]

src/compas_blender/artists/boxartist.py

@@ -1,9 +1,11 @@
-from typing import Optional
 from typing import Any
+from typing import List
+from typing import Optional
 from typing import Union
 
 import bpy
 import compas_blender
+from compas_blender.utilities import RGBColor
 from compas.geometry import Box
 from compas.artists import ShapeArtist
 from .artist import BlenderArtist
@@ -27,7 +29,7 @@ def __init__(self,
 
         super().__init__(shape=box, collection=collection or box.name, **kwargs)
 
-    def draw(self, color=None):
+    def draw(self, color: Optional[RGBColor] = None) -> List[bpy.types.Object]:
         """Draw the box associated with the artist.
 
         Parameters

src/compas_blender/artists/capsuleartist.py

@@ -1,10 +1,12 @@
-from typing import Optional
 from typing import Any
+from typing import List
+from typing import Optional
 from typing import Union
 
 import bpy
 
 import compas_blender
+from compas_blender.utilities import RGBColor
 from compas.geometry import Capsule
 from compas.artists import ShapeArtist
 from .artist import BlenderArtist
@@ -28,12 +30,12 @@ def __init__(self,
 
         super().__init__(shape=capsule, collection=collection or capsule.name, **kwargs)
 
-    def draw(self, color=None, u=None, v=None):
+    def draw(self, color: Optional[RGBColor] = None, u: int = None, v: int = None) -> List[bpy.types.Object]:
         """Draw the capsule associated with the artist.
 
         Parameters
         ----------
-        color : tuple of float, optional
+        color : tuple of float or tuple of int, optional
             The RGB color of the capsule.
         u : int, optional
             Number of faces in the "u" direction.

src/compas_blender/artists/circleartist.py

@@ -0,0 +1,65 @@
+from typing import Any
+from typing import List
+from typing import Optional
+from typing import Union
+
+import bpy
+
+import compas_blender
+from compas_blender.utilities import RGBColor
+from compas.geometry import add_vectors
+from compas.geometry import Circle
+from compas.artists import PrimitiveArtist
+from .artist import BlenderArtist
+
+
+class CircleArtist(BlenderArtist, PrimitiveArtist):
+    """Artist for drawing circles.
+
+    Parameters
+    ----------
+    circle : :class:`compas.geometry.Circle`
+        A COMPAS circle.
+    collection :  str or :class:`bpy.types.Collection`
+        The name of the collection the object belongs to.
+    """
+
+    def __init__(self,
+                 circle: Circle,
+                 collection: Optional[Union[str, bpy.types.Collection]] = None,
+                 **kwargs: Any):
+        super().__init__(primitive=circle, collection=collection or circle.name, **kwargs)
+
+    def draw(self,  color: Optional[RGBColor] = None, show_point=False, show_normal=False) -> List[bpy.types.Object]:
+        """Draw the circle.
+
+        Parameters
+        ----------
+        color : tuple of float or tuple of int, optional
+            The RGB color of the capsule.
+        show_point : bool, optional
+            Default is ``False``.
+        show_normal : bool, optional
+            Default is ``False``.
+
+        Returns
+        -------
+        list
+            The objects created in Blender.
+        """
+        color = color or self.color
+        point = self.primitive.plane.point
+        normal = self.primitive.plane.normal
+        plane = point, normal
+        radius = self.primitive.radius
+        objects = []
+        if show_point:
+            points = [{'pos': point, 'color': color, 'name': self.primitive.name, 'radius': 0.01}]
+            objects += compas_blender.draw_points(points, collection=self.collection)
+        if show_normal:
+            end = add_vectors(point, normal)
+            lines = [{'start': point, 'end': end, 'color': color, 'name': self.primitive.name}]
+            objects += compas_blender.draw_lines(lines, collection=self.collection)
+        circles = [{'plane': plane, 'radius': radius, 'color': color, 'name': self.primitive.name}]
+        objects += compas_blender.draw_circles(circles, collection=self.collection)
+        return objects