Merge pull request #1200 from compas-dev/ellipse-artists

Add ellipse artists for rhino/gh

CHANGELOG.md

@@ -9,6 +9,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+* Added `EllipseArtist` to `compas_rhino` and `compas_ghpython`.
+
 ### Changed
 
 * Changed `Network.is_planar` to rely on `NetworkX` instead `planarity` for planarity checking.

docs/reference/compas_ghpython.artists.rst

@@ -25,6 +25,7 @@ Classes
     ConeArtist
     CurveArtist
     CylinderArtist
+    EllipseArtist
     FrameArtist
     LineArtist
     MeshArtist

docs/reference/compas_rhino.artists.rst

@@ -19,6 +19,7 @@ Classes
     ConeArtist
     CurveArtist
     CylinderArtist
+    EllipseArtist
     FrameArtist
     LineArtist
     MeshArtist

src/compas_ghpython/artists/__init__.py

@@ -9,6 +9,7 @@
 from compas.geometry import Cone
 from compas.geometry import Curve
 from compas.geometry import Cylinder
+from compas.geometry import Ellipse
 from compas.geometry import Frame
 from compas.geometry import Line
 from compas.geometry import Point
@@ -32,6 +33,7 @@
 from .coneartist import ConeArtist
 from .curveartist import CurveArtist
 from .cylinderartist import CylinderArtist
+from .ellipseartist import EllipseArtist
 from .frameartist import FrameArtist
 from .lineartist import LineArtist
 from .meshartist import MeshArtist
@@ -56,6 +58,7 @@ def register_artists():
     Artist.register(Cone, ConeArtist, context="Grasshopper")
     Artist.register(Curve, CurveArtist, context="Grasshopper")
     Artist.register(Cylinder, CylinderArtist, context="Grasshopper")
+    Artist.register(Ellipse, EllipseArtist, context="Grasshopper")
     Artist.register(Frame, FrameArtist, context="Grasshopper")
     Artist.register(Line, LineArtist, context="Grasshopper")
     Artist.register(Mesh, MeshArtist, context="Grasshopper")
@@ -81,6 +84,7 @@ def register_artists():
     "ConeArtist",
     "CurveArtist",
     "CylinderArtist",
+    "EllipseArtist",
     "FrameArtist",
     "LineArtist",
     "MeshArtist",

src/compas_ghpython/artists/ellipseartist.py

@@ -0,0 +1,40 @@
+from __future__ import print_function
+from __future__ import absolute_import
+from __future__ import division
+
+from compas_rhino import conversions
+
+from compas.artists import GeometryArtist
+from .artist import GHArtist
+
+
+class EllipseArtist(GHArtist, GeometryArtist):
+    """Artist for drawing ellipses.
+
+    Parameters
+    ----------
+    ellipse : :class:`~compas.geometry.Ellipse`
+        A COMPAS ellipse.
+    **kwargs : dict, optional
+        Additional keyword arguments.
+
+    """
+
+    def __init__(self, ellipse, **kwargs):
+        super(EllipseArtist, self).__init__(geometry=ellipse, **kwargs)
+
+    def draw(self):
+        """Draw the ellipse.
+
+        Returns
+        -------
+        :rhino:`Rhino.Geometry.Ellipse`
+
+        """
+        ellipse = conversions.ellipse_to_rhino(self.geometry)
+
+        if self.transformation:
+            transformation = conversions.transformation_to_rhino(self.transformation)
+            ellipse.Transform(transformation)
+
+        return ellipse

src/compas_rhino/artists/__init__.py

@@ -4,6 +4,7 @@
 from compas.artists import Artist
 
 from compas.geometry import Circle
+from compas.geometry import Ellipse
 from compas.geometry import Frame
 from compas.geometry import Line
 from compas.geometry import Plane
@@ -32,20 +33,23 @@
 
 from .artist import RhinoArtist
 from .circleartist import CircleArtist
+from .ellipseartist import EllipseArtist
 from .frameartist import FrameArtist
 from .lineartist import LineArtist
 from .planeartist import PlaneArtist
 from .pointartist import PointArtist
 from .polygonartist import PolygonArtist
 from .polylineartist import PolylineArtist
 from .vectorartist import VectorArtist
+
 from .boxartist import BoxArtist
 from .capsuleartist import CapsuleArtist
 from .coneartist import ConeArtist
 from .cylinderartist import CylinderArtist
 from .polyhedronartist import PolyhedronArtist
 from .sphereartist import SphereArtist
 from .torusartist import TorusArtist
+
 from .meshartist import MeshArtist
 from .networkartist import NetworkArtist
 from .volmeshartist import VolMeshArtist
@@ -68,6 +72,7 @@ def redraw_rhino():
 @plugin(category="factories", requires=["Rhino"])
 def register_artists():
     Artist.register(Circle, CircleArtist, context="Rhino")
+    Artist.register(Ellipse, EllipseArtist, context="Rhino")
     Artist.register(Frame, FrameArtist, context="Rhino")
     Artist.register(Line, LineArtist, context="Rhino")
     Artist.register(Plane, PlaneArtist, context="Rhino")
@@ -94,6 +99,7 @@ def register_artists():
 __all__ = [
     "RhinoArtist",
     "CircleArtist",
+    "EllipseArtist",
     "FrameArtist",
     "LineArtist",
     "PlaneArtist",

src/compas_rhino/artists/ellipseartist.py

@@ -0,0 +1,53 @@
+from __future__ import print_function
+from __future__ import absolute_import
+from __future__ import division
+
+import scriptcontext as sc  # type: ignore
+
+from compas.artists import GeometryArtist
+from compas.colors import Color
+from compas_rhino.conversions import ellipse_to_rhino
+
+from compas_rhino.conversions import transformation_to_rhino
+from .artist import RhinoArtist
+from ._helpers import attributes
+
+
+class EllipseArtist(RhinoArtist, GeometryArtist):
+    """Artist for drawing ellipses.
+
+    Parameters
+    ----------
+    ellipse : :class:`~compas.geometry.Ellipse`
+        A COMPAS ellipse.
+    **kwargs : dict, optional
+        Additional keyword arguments.
+
+    """
+
+    def __init__(self, ellipse, **kwargs):
+        super(EllipseArtist, self).__init__(geometry=ellipse, **kwargs)
+
+    def draw(self, color=None):
+        """Draw the ellipse.
+
+        Parameters
+        ----------
+        color : rgb1 | rgb255 | :class:`~compas.colors.Color`, optional
+            The RGB color of the ellipse.
+
+        Returns
+        -------
+        System.Guid
+            The GUID of the created Rhino object.
+
+        """
+        color = Color.coerce(color) or self.color
+        attr = attributes(name=self.geometry.name, color=color, layer=self.layer)
+
+        geometry = ellipse_to_rhino(self.geometry)
+
+        if self.transformation:
+            geometry.Transform(transformation_to_rhino(self.transformation))
+
+        return sc.doc.Objects.AddEllipse(geometry, attr)