Universal CAD artists

CHANGELOG.md

@@ -15,6 +15,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * Added `__add__`, `__sub__`, `__and__` to `compas.geometry.Shape` for boolean operations using binary operators.
 * Added `is_closed` to `compas.geometry.Polyhedron`.
 * Added `Plane.offset`.
+* Added `compas.artists.Artist`.
+* Added pluggable `compas.artists.new_artist`.
+* Added plugin `compas_rhino.artists.new_artist_rhino`.
+* Added plugin `compas_blender.artists.new_artist_blender`.
+* Added `compas.artist.DataArtistNotRegistered`.
 * Added `draw_node_labels` and `draw_edgelabels` to `compas_blender.artists.NetworkArtist`.
 * Added `compas_blender.artists.RobotModelArtist.clear`.
 * Added `compas_blender.geometry.booleans` as plugin for boolean pluggables.
@@ -23,6 +28,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 
 * Fixed bug in `compas_blender.draw_texts`.
+* Changed `compas_rhino.artists.BaseArtist` to `compas_rhino.artists.RhinoArtist`.
+* Changed `compas_blender.artists.BaseArtist` to `compas_blender.artists.BlenderArtist`.
 * Changed default resolution for shape discretisation to 16 for both u and v where relevant.
 * Changed base class of `compas.geometry.Primitive` and `compas.geometry.Shape` to `compas.geometry.Geometry`.
 * `compas_blender.artists.RobotModelArtist.collection` can be assigned as a Blender collection or a name.

docs/api/compas.artists.rst

@@ -0,0 +1,2 @@
+
+.. automodule:: compas.artists

docs/conf.py

@@ -350,6 +350,6 @@ def linkcode_resolve(domain, info):
 html_copy_source = False
 html_show_sourcelink = False
 html_permalinks = False
-html_add_permalinks = ""
+html_permalinks_icon = ""
 html_experimental_html5_writer = True
 html_compact_lists = True

docs/devguide.rst

@@ -390,10 +390,12 @@ Advanced options
 
 There are a few additional options that plugins can use:
 
-* ``requires``: List of required python modules. COMPAS will filter out plugins if their
+* ``requires``: List of requirements. COMPAS will filter out plugins if their
   requirements list is not satisfied at runtime. This allows to have multiple implementations
-  of the same operation and have them selected based on which packages are installed.
-  on the system. Eg. `requires=['scipy']`.
+  of the same operation and have them selected based on different criteria.
+  The requirement can either be a package name string (e.g. ``requires=['scipy']``) or
+  a ``callable`` with a boolean return value, in which any arbitrary check can be implemented
+  (e.g. ``requires=[lambda: is_rhino_active()]``).
 * ``tryfirst`` and ``trylast``: Plugins cannot control the exact priority they will have
   but they can indicate whether to try to prioritize them or demote them as fallback using
   these two boolean parameters.

docs/tutorial/plotters_line-options.py

@@ -18,4 +18,5 @@
                 draw_points=True)
 
 plotter.zoom_extents()
-plotter.save('docs/_images/tutorial/plotters_line-options.png', dpi=300)
+plotter.show()
+# plotter.save('docs/_images/tutorial/plotters_line-options.png', dpi=300)

docs/tutorial/plotters_point-options.py

@@ -10,4 +10,5 @@
 for point in pointcloud:
     plotter.add(point, size=random.randint(1, 10), edgecolor=i_to_rgb(random.random(), normalize=True))
 plotter.zoom_extents()
-plotter.save('docs/_images/tutorial/plotters_point-options.png', dpi=300)
+plotter.show()
+# plotter.save('docs/_images/tutorial/plotters_point-options.png', dpi=300)

docs/tutorial/plotters_polygon-options.py

@@ -11,4 +11,5 @@
 plotter.add(poly2, linestyle='dashed', facecolor=(1.0, 0.8, 0.8), edgecolor=(1.0, 0.0, 0.0))
 plotter.add(poly3, alpha=0.5)
 plotter.zoom_extents()
-plotter.save('docs/_images/tutorial/plotters_polygon-options.png', dpi=300)
+plotter.show()
+# plotter.save('docs/_images/tutorial/plotters_polygon-options.png', dpi=300)

docs/tutorial/plotters_vector-options.py

@@ -15,4 +15,5 @@
 plotter.add(b, size=10, edgecolor=(1, 0, 0))
 
 plotter.zoom_extents()
+plotter.show()
 plotter.save('docs/_images/tutorial/plotters_vector-options.png', dpi=300)

src/compas/__init__.py

@@ -9,6 +9,7 @@
     :maxdepth: 1
     :titlesonly:
 
+    compas.artists
     compas.data
     compas.datastructures
     compas.files

src/compas/artists/__init__.py

@@ -0,0 +1,58 @@
+"""
+********************************************************************************
+artists
+********************************************************************************
+
+.. currentmodule:: compas.artists
+
+Classes
+=======
+
+.. autosummary::
+    :toctree: generated/
+    :nosignatures:
+
+    Artist
+    RobotModelArtist
+    MeshArtist
+    NetworkArtist
+    PrimitiveArtist
+    ShapeArtist
+    VolMeshArtist
+
+
+Exceptions
+==========
+
+.. autosummary::
+    :toctree: generated/
+    :nosignatures:
+
+    DataArtistNotRegistered
+
+"""
+from __future__ import print_function
+from __future__ import absolute_import
+from __future__ import division
+
+from .exceptions import DataArtistNotRegistered
+from .artist import Artist
+from .meshartist import MeshArtist
+from .networkartist import NetworkArtist
+from .primitiveartist import PrimitiveArtist
+from .robotmodelartist import RobotModelArtist
+from .shapeartist import ShapeArtist
+from .volmeshartist import VolMeshArtist
+
+BaseRobotModelArtist = RobotModelArtist
+
+__all__ = [
+    'DataArtistNotRegistered',
+    'Artist',
+    'MeshArtist',
+    'NetworkArtist',
+    'PrimitiveArtist',
+    'RobotModelArtist',
+    'ShapeArtist',
+    'VolMeshArtist',
+]

src/compas/artists/artist.py

@@ -0,0 +1,51 @@
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import print_function
+
+from abc import abstractmethod
+from compas.plugins import pluggable
+
+
+@pluggable(category='drawing-utils')
+def clear():
+    raise NotImplementedError
+
+
+@pluggable(category='drawing-utils')
+def redraw():
+    raise NotImplementedError
+
+
+@pluggable(category='factories')
+def new_artist(cls, *args, **kwargs):
+    raise NotImplementedError
+
+
+class Artist(object):
+    """Base class for all artists.
+    """
+
+    ITEM_ARTIST = {}
+
+    def __new__(cls, *args, **kwargs):
+        return new_artist(cls, *args, **kwargs)
+
+    @staticmethod
+    def clear():
+        return clear()
+
+    @staticmethod
+    def redraw():
+        return redraw()
+
+    @staticmethod
+    def register(item_type, artist_type):
+        Artist.ITEM_ARTIST[item_type] = artist_type
+
+    @abstractmethod
+    def draw(self):
+        raise NotImplementedError
+
+    @staticmethod
+    def draw_collection(collection):
+        raise NotImplementedError

src/compas/robots/base_artist/__init__.py → src/compas/artists/exceptions.py

@@ -1,7 +1,7 @@
+from __future__ import print_function
 from __future__ import absolute_import
 from __future__ import division
-from __future__ import print_function
 
-from ._artist import *  # noqa: F401 F403
 
-__all__ = [name for name in dir() if not name.startswith('_')]
+class DataArtistNotRegistered(Exception):
+    pass