Merge pull request #914 from compas-dev/ghpython_moar_artists

Ghpython moar artists

Author: gonzalocasas

CHANGELOG.md

@@ -24,6 +24,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * Added `compas_blender.artists.RobotModelArtist.clear`.
 * Added `compas_blender.geometry.booleans` as plugin for boolean pluggables.
 * Added version-based installation for Blender.
+* Added several shape artists to `compas_ghpython`: `BoxArtist`, `CapsuleArtist`, `ConeArtist`, `CylinderArtist`, `PolygonArtist`, `PolyhedronArtist`, `SphereArtist`, `TorusArtist` and `VectorArtist`.
+
 
 ### Changed
 
@@ -36,6 +38,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * Generalized the parameter `color` of `compas_blender.draw_texts` and various label drawing methods.
 * Changed `compas.IPY` to `compas.RHINO` in `orientation_rhino`.
 * Changed `planarity` to `requires_extra` for pip installations.
+* Fixed bug in handling of ngonal meshes in `compas_ghpython` artists / drawing functions.
 
 ### Removed
 

src/compas_ghpython/artists/__init__.py

@@ -13,11 +13,20 @@
     :toctree: generated/
     :nosignatures:
 
+    BoxArtist
+    CapsuleArtist
     CircleArtist
+    ConeArtist
+    CylinderArtist
     FrameArtist
     LineArtist
     PointArtist
+    PolygonArtist
+    PolyhedronArtist
     PolylineArtist
+    SphereArtist
+    TorusArtist
+    VectorArtist
 
 
 Datastructure Artists
@@ -61,11 +70,20 @@
 from compas.artists import ShapeArtist
 from compas.artists import DataArtistNotRegistered
 
+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
@@ -74,15 +92,24 @@
 from compas.robots import RobotModel
 
 from .artist import GHArtist
+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 .pointartist import PointArtist
-from .polylineartist import PolylineArtist
 from .meshartist import MeshArtist
 from .networkartist import NetworkArtist
-from .volmeshartist import VolMeshArtist
+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
+from .volmeshartist import VolMeshArtist
 
 ShapeArtist.default_color = (255, 255, 255)
 
@@ -120,15 +147,24 @@ def new_artist_gh(cls, *args, **kwargs):
     global artists_registered
 
     if not artists_registered:
+        GHArtist.register(Box, BoxArtist)
+        GHArtist.register(Capsule, CapsuleArtist)
         GHArtist.register(Circle, CircleArtist)
+        GHArtist.register(Cone, ConeArtist)
+        GHArtist.register(Cylinder, CylinderArtist)
         GHArtist.register(Frame, FrameArtist)
         GHArtist.register(Line, LineArtist)
-        GHArtist.register(Point, PointArtist)
-        GHArtist.register(Polyline, PolylineArtist)
         GHArtist.register(Mesh, MeshArtist)
         GHArtist.register(Network, NetworkArtist)
-        GHArtist.register(VolMesh, VolMeshArtist)
+        GHArtist.register(Point, PointArtist)
+        GHArtist.register(Polygon, PolygonArtist)
+        GHArtist.register(Polyhedron, PolyhedronArtist)
+        GHArtist.register(Polyline, PolylineArtist)
         GHArtist.register(RobotModel, RobotModelArtist)
+        GHArtist.register(Sphere, SphereArtist)
+        GHArtist.register(Torus, TorusArtist)
+        GHArtist.register(Vector, VectorArtist)
+        GHArtist.register(VolMesh, VolMeshArtist)
         artists_registered = True
 
     data = args[0]
@@ -153,15 +189,23 @@ def new_artist_gh(cls, *args, **kwargs):
 
 __all__ = [
     'GHArtist',
-    'PrimitiveArtist',
     'ShapeArtist',
+    'BoxArtist',
+    'CapsuleArtist',
     'CircleArtist',
+    'ConeArtist',
+    'CylinderArtist',
     'FrameArtist',
     'LineArtist',
-    'PointArtist',
-    'PolylineArtist',
     'MeshArtist',
     'NetworkArtist',
-    'VolMeshArtist',
+    'PointArtist',
+    'PolygonArtist',
+    'PolyhedronArtist',
+    'PolylineArtist',
     'RobotModelArtist'
+    'SphereArtist',
+    'TorusArtist',
+    'VectorArtist',
+    'VolMeshArtist',
 ]

src/compas_ghpython/artists/boxartist.py

@@ -0,0 +1,40 @@
+from __future__ import print_function
+from __future__ import absolute_import
+from __future__ import division
+
+import compas_ghpython
+from compas.artists import ShapeArtist
+from .artist import GHArtist
+
+
+class BoxArtist(GHArtist, ShapeArtist):
+    """Artist for drawing box shapes.
+
+    Parameters
+    ----------
+    box : :class:`compas.geometry.Box`
+        A COMPAS box.
+    """
+
+    def __init__(self, box, **kwargs):
+        super(BoxArtist, self).__init__(shape=box, **kwargs)
+
+    def draw(self, color=None):
+        """Draw the box associated with the artist.
+
+        Parameters
+        ----------
+        color : tuple of float, optional
+            The RGB color of the box.
+
+        Returns
+        -------
+        :class:`Rhino.Geometry.Mesh`
+        """
+        color = color or self.color
+        vertices = [list(vertex) for vertex in self.shape.vertices]
+        faces = self.shape.faces
+        mesh = compas_ghpython.draw_mesh(vertices,
+                                         faces,
+                                         color=color)
+        return mesh

src/compas_ghpython/artists/capsuleartist.py

@@ -0,0 +1,48 @@
+from __future__ import print_function
+from __future__ import absolute_import
+from __future__ import division
+
+import compas_ghpython
+from compas.artists import ShapeArtist
+from .artist import GHArtist
+
+
+class CapsuleArtist(GHArtist, ShapeArtist):
+    """Artist for drawing capsule shapes.
+
+    Parameters
+    ----------
+    capsule : :class:`compas.geometry.Capsule`
+        A COMPAS capsule.
+    """
+
+    def __init__(self, capsule, **kwargs):
+        super(CapsuleArtist, self).__init__(shape=capsule, **kwargs)
+
+    def draw(self, color=None, u=None, v=None):
+        """Draw the capsule associated with the artist.
+
+        Parameters
+        ----------
+        color : tuple of float, optional
+            The RGB color of the capsule.
+        u : int, optional
+            Number of faces in the "u" direction.
+            Default is ``~CapsuleArtist.u``.
+        v : int, optional
+            Number of faces in the "v" direction.
+            Default is ``~CapsuleArtist.v``.
+
+        Returns
+        -------
+        :class:`Rhino.Geometry.Mesh`
+        """
+        color = color or self.color
+        u = u or self.u
+        v = v or self.v
+        vertices, faces = self.shape.to_vertices_and_faces(u=u, v=v)
+        vertices = [list(vertex) for vertex in vertices]
+        mesh = compas_ghpython.draw_mesh(vertices,
+                                         faces,
+                                         color=color)
+        return mesh

src/compas_ghpython/artists/coneartist.py

@@ -0,0 +1,44 @@
+from __future__ import print_function
+from __future__ import absolute_import
+from __future__ import division
+
+import compas_ghpython
+from compas.artists import ShapeArtist
+from .artist import GHArtist
+
+
+class ConeArtist(GHArtist, ShapeArtist):
+    """Artist for drawing cone shapes.
+
+    Parameters
+    ----------
+    shape : :class:`compas.geometry.Cone`
+        A COMPAS cone.
+    """
+
+    def __init__(self, cone, **kwargs):
+        super(ConeArtist, self).__init__(shape=cone, **kwargs)
+
+    def draw(self, color=None, u=None):
+        """Draw the cone associated with the artist.
+
+        Parameters
+        ----------
+        color : tuple of float, optional
+            The RGB color of the cone.
+        u : int, optional
+            Number of faces in the "u" direction.
+            Default is ``~ConeArtist.u``.
+
+        Returns
+        -------
+        :class:`Rhino.Geometry.Mesh`
+        """
+        color = color or self.color
+        u = u or self.u
+        vertices, faces = self.shape.to_vertices_and_faces(u=u)
+        vertices = [list(vertex) for vertex in vertices]
+        mesh = compas_ghpython.draw_mesh(vertices,
+                                         faces,
+                                         color=color)
+        return mesh

src/compas_ghpython/artists/cylinderartist.py

@@ -0,0 +1,44 @@
+from __future__ import print_function
+from __future__ import absolute_import
+from __future__ import division
+
+import compas_ghpython
+from compas.artists import ShapeArtist
+from .artist import GHArtist
+
+
+class CylinderArtist(GHArtist, ShapeArtist):
+    """Artist for drawing cylinder shapes.
+
+    Parameters
+    ----------
+    cylinder : :class:`compas.geometry.Cylinder`
+        A COMPAS cylinder.
+    """
+
+    def __init__(self, cylinder, **kwargs):
+        super(CylinderArtist, self).__init__(shape=cylinder, **kwargs)
+
+    def draw(self, color=None, u=None):
+        """Draw the cylinder associated with the artist.
+
+        Parameters
+        ----------
+        color : tuple of float, optional
+            The RGB color of the cylinder.
+        u : int, optional
+            Number of faces in the "u" direction.
+            Default is ``~CylinderArtist.u``.
+
+        Returns
+        -------
+        :class:`Rhino.Geometry.Mesh`
+        """
+        color = color or self.color
+        u = u or self.u
+        vertices, faces = self.shape.to_vertices_and_faces(u=u)
+        vertices = [list(vertex) for vertex in vertices]
+        mesh = compas_ghpython.draw_mesh(vertices,
+                                         faces,
+                                         color=color)
+        return mesh

src/compas_ghpython/artists/polygonartist.py

@@ -0,0 +1,50 @@
+from __future__ import print_function
+from __future__ import absolute_import
+from __future__ import division
+
+import compas_ghpython
+from compas.artists import PrimitiveArtist
+from .artist import GHArtist
+
+
+class PolygonArtist(GHArtist, PrimitiveArtist):
+    """Artist for drawing polygons.
+
+    Parameters
+    ----------
+    polygon : :class:`compas.geometry.Polygon`
+        A COMPAS polygon.
+    """
+
+    def __init__(self, polygon, **kwargs):
+        super(PolygonArtist, self).__init__(primitive=polygon, **kwargs)
+
+    def draw(self, show_points=False, show_edges=False, show_face=True):
+        """Draw the polygon.
+
+        Parameters
+        ----------
+        show_points : bool, optional
+            Default is ``False``.
+        show_edges : bool, optional
+            Default is ``False``.
+        show_face : bool, optional
+            Default is ``True``.
+
+        Returns
+        -------
+        list
+            The Rhino points, lines and face.
+        """
+        _points = map(list, self.primitive.points)
+        result = []
+        if show_points:
+            points = [{'pos': point, 'color': self.color, 'name': self.primitive.name} for point in _points]
+            result += compas_ghpython.draw_points(points)
+        if show_edges:
+            lines = [{'start': list(a), 'end': list(b), 'color': self.color, 'name': self.primitive.name} for a, b in self.primitive.lines]
+            result += compas_ghpython.draw_lines(lines)
+        if show_face:
+            polygons = [{'points': _points, 'color': self.color, 'name': self.primitive.name}]
+            result += compas_ghpython.draw_faces(polygons)
+        return result