Deploy to GitHub pages

latest/genindex.html

@@ -5547,8 +5547,66 @@ <h2 id="R">R</h2>
       </ul></li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="reference/generated/compas.artists.register_artists.html#compas.artists.register_artists">register_artists() (in module compas.artists)</a>
+      <li><a href="reference/generated/compas.artists.Artist.register_artists.html#compas.artists.Artist.register_artists">register_artists() (compas.artists.Artist static method)</a>
+
+      <ul>
+        <li><a href="reference/generated/compas.artists.CurveArtist.register_artists.html#compas.artists.CurveArtist.register_artists">(compas.artists.CurveArtist static method)</a>
+</li>
+        <li><a href="reference/generated/compas.artists.MeshArtist.register_artists.html#compas.artists.MeshArtist.register_artists">(compas.artists.MeshArtist static method)</a>
+</li>
+        <li><a href="reference/generated/compas.artists.NetworkArtist.register_artists.html#compas.artists.NetworkArtist.register_artists">(compas.artists.NetworkArtist static method)</a>
+</li>
+        <li><a href="reference/generated/compas.artists.PrimitiveArtist.register_artists.html#compas.artists.PrimitiveArtist.register_artists">(compas.artists.PrimitiveArtist static method)</a>
+</li>
+        <li><a href="reference/generated/compas.artists.RobotModelArtist.register_artists.html#compas.artists.RobotModelArtist.register_artists">(compas.artists.RobotModelArtist static method)</a>
+</li>
+        <li><a href="reference/generated/compas.artists.ShapeArtist.register_artists.html#compas.artists.ShapeArtist.register_artists">(compas.artists.ShapeArtist static method)</a>
+</li>
+        <li><a href="reference/generated/compas.artists.SurfaceArtist.register_artists.html#compas.artists.SurfaceArtist.register_artists">(compas.artists.SurfaceArtist static method)</a>
+</li>
+        <li><a href="reference/generated/compas.artists.VolMeshArtist.register_artists.html#compas.artists.VolMeshArtist.register_artists">(compas.artists.VolMeshArtist static method)</a>
+</li>
+        <li><a href="reference/generated/compas_blender.artists.BlenderArtist.register_artists.html#compas_blender.artists.BlenderArtist.register_artists">(compas_blender.artists.BlenderArtist static method)</a>
+</li>
+        <li><a href="reference/generated/compas_blender.artists.BoxArtist.register_artists.html#compas_blender.artists.BoxArtist.register_artists">(compas_blender.artists.BoxArtist static method)</a>
+</li>
+        <li><a href="reference/generated/compas_blender.artists.CapsuleArtist.register_artists.html#compas_blender.artists.CapsuleArtist.register_artists">(compas_blender.artists.CapsuleArtist static method)</a>
+</li>
+        <li><a href="reference/generated/compas_blender.artists.CircleArtist.register_artists.html#compas_blender.artists.CircleArtist.register_artists">(compas_blender.artists.CircleArtist static method)</a>
+</li>
+        <li><a href="reference/generated/compas_blender.artists.ConeArtist.register_artists.html#compas_blender.artists.ConeArtist.register_artists">(compas_blender.artists.ConeArtist static method)</a>
+</li>
+        <li><a href="reference/generated/compas_blender.artists.CurveArtist.register_artists.html#compas_blender.artists.CurveArtist.register_artists">(compas_blender.artists.CurveArtist static method)</a>
 </li>
+        <li><a href="reference/generated/compas_blender.artists.CylinderArtist.register_artists.html#compas_blender.artists.CylinderArtist.register_artists">(compas_blender.artists.CylinderArtist static method)</a>
+</li>
+        <li><a href="reference/generated/compas_blender.artists.FrameArtist.register_artists.html#compas_blender.artists.FrameArtist.register_artists">(compas_blender.artists.FrameArtist static method)</a>
+</li>
+        <li><a href="reference/generated/compas_blender.artists.LineArtist.register_artists.html#compas_blender.artists.LineArtist.register_artists">(compas_blender.artists.LineArtist static method)</a>
+</li>
+        <li><a href="reference/generated/compas_blender.artists.MeshArtist.register_artists.html#compas_blender.artists.MeshArtist.register_artists">(compas_blender.artists.MeshArtist static method)</a>
+</li>
+        <li><a href="reference/generated/compas_blender.artists.NetworkArtist.register_artists.html#compas_blender.artists.NetworkArtist.register_artists">(compas_blender.artists.NetworkArtist static method)</a>
+</li>
+        <li><a href="reference/generated/compas_blender.artists.PointArtist.register_artists.html#compas_blender.artists.PointArtist.register_artists">(compas_blender.artists.PointArtist static method)</a>
+</li>
+        <li><a href="reference/generated/compas_blender.artists.PolygonArtist.register_artists.html#compas_blender.artists.PolygonArtist.register_artists">(compas_blender.artists.PolygonArtist static method)</a>
+</li>
+        <li><a href="reference/generated/compas_blender.artists.PolyhedronArtist.register_artists.html#compas_blender.artists.PolyhedronArtist.register_artists">(compas_blender.artists.PolyhedronArtist static method)</a>
+</li>
+        <li><a href="reference/generated/compas_blender.artists.PolylineArtist.register_artists.html#compas_blender.artists.PolylineArtist.register_artists">(compas_blender.artists.PolylineArtist static method)</a>
+</li>
+        <li><a href="reference/generated/compas_blender.artists.RobotModelArtist.register_artists.html#compas_blender.artists.RobotModelArtist.register_artists">(compas_blender.artists.RobotModelArtist static method)</a>
+</li>
+        <li><a href="reference/generated/compas_blender.artists.SphereArtist.register_artists.html#compas_blender.artists.SphereArtist.register_artists">(compas_blender.artists.SphereArtist static method)</a>
+</li>
+        <li><a href="reference/generated/compas_blender.artists.SurfaceArtist.register_artists.html#compas_blender.artists.SurfaceArtist.register_artists">(compas_blender.artists.SurfaceArtist static method)</a>
+</li>
+        <li><a href="reference/generated/compas_blender.artists.VectorArtist.register_artists.html#compas_blender.artists.VectorArtist.register_artists">(compas_blender.artists.VectorArtist static method)</a>
+</li>
+        <li><a href="reference/generated/compas.artists.register_artists.html#compas.artists.register_artists">(in module compas.artists)</a>
+</li>
+      </ul></li>
       <li><a href="reference/generated/compas.rpc.Server.register_function.html#compas.rpc.Server.register_function">register_function() (compas.rpc.Server method)</a>
 </li>
       <li><a href="reference/generated/compas.rpc.Server.register_instance.html#compas.rpc.Server.register_instance">register_instance() (compas.rpc.Server method)</a>

latest/reference/compas.artists.html

@@ -1223,7 +1223,7 @@ <h2>Pluggables</h2>
 <td><p></p></td>
 </tr>
 <tr class="row-odd"><td><p><a class="reference internal" href="generated/compas.artists.register_artists.html" title="compas.artists.register_artists"><code class="xref py py-obj docutils literal notranslate"><span class="pre">register_artists</span></code></a></p></td>
-<td><p></p></td>
+<td><p>Registers artists available in the current context.</p></td>
 </tr>
 </tbody>
 </table>

latest/reference/compas_blender.conversions.html

@@ -65,7 +65,7 @@
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
     <link rel="next" title="BlenderGeometry" href="generated/compas_blender.conversions.BlenderGeometry.html" />
-    <link rel="prev" title="BlenderArtist.register" href="generated/compas_blender.artists.BlenderArtist.register.html" />
+    <link rel="prev" title="BlenderArtist.register_artists" href="generated/compas_blender.artists.BlenderArtist.register_artists.html" />
   <meta name="viewport" content="width=device-width, initial-scale=1"/>
   <meta name="docsearch:language" content="en"/>
   </head>
@@ -1184,12 +1184,12 @@ <h2>Classes</h2>
     <div class="footer-article-item"><!-- Previous / next buttons -->
 <div class="prev-next-area">
     <a class="left-prev"
-       href="generated/compas_blender.artists.BlenderArtist.register.html"
+       href="generated/compas_blender.artists.BlenderArtist.register_artists.html"
        title="previous page">
       <i class="fa-solid fa-angle-left"></i>
       <div class="prev-next-info">
         <p class="prev-next-subtitle">previous</p>
-        <p class="prev-next-title">BlenderArtist.register</p>
+        <p class="prev-next-title">BlenderArtist.register_artists</p>
       </div>
     </a>
     <a class="right-next"

latest/reference/generated/compas.artists.Artist.html

@@ -1155,12 +1155,17 @@ <h1>Artist</h1>
 <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
 <p>Base class for all artists.</p>
 <dl class="field-list">
-<dt class="field-odd">Attributes</dt>
-<dd class="field-odd"><dl>
-<dt><strong>AVAILABLE_CONTEXTS</strong><span class="classifier">list[str]</span></dt><dd><p>The available visualization contexts.</p>
+<dt class="field-odd">Parameters</dt>
+<dd class="field-odd"><dl class="simple">
+<dt><strong>item: Any</strong></dt><dd><p>The item which should be visualized using the created Artist.</p>
 </dd>
-<dt><strong>CONTEXT</strong><span class="classifier">str | None</span></dt><dd><p>The current visualization context is one of <code class="xref py py-attr docutils literal notranslate"><span class="pre">AVAILABLE_CONTEXTS</span></code>.</p>
+<dt><strong>context: str, optional</strong></dt><dd><p>Explicit context to pick the Artist from. One of <code class="xref py py-attr docutils literal notranslate"><span class="pre">AVAILABLE_CONTEXTS</span></code>.
+If not specified, an attempt will be made to automatically detect the appropriate context.</p>
 </dd>
+</dl>
+</dd>
+<dt class="field-even">Attributes</dt>
+<dd class="field-even"><dl>
 <dt><strong>ITEM_ARTIST</strong><span class="classifier">dict[str, dict[Type[<a class="reference internal" href="compas.data.Data.html#compas.data.Data" title="compas.data.Data"><code class="xref py py-class docutils literal notranslate"><span class="pre">Data</span></code></a>], Type[<a class="reference internal" href="#compas.artists.Artist" title="compas.artists.Artist"><code class="xref py py-class docutils literal notranslate"><span class="pre">Artist</span></code></a>]]]</span></dt><dd><p>Dictionary mapping data types to the corresponding artists types per visualization context.</p>
 </dd>
 </dl>
@@ -1194,6 +1199,9 @@ <h1>Artist</h1>
 <tr class="row-odd"><td><p><a class="reference internal" href="compas.artists.Artist.register.html#compas.artists.Artist.register" title="compas.artists.Artist.register"><code class="xref py py-obj docutils literal notranslate"><span class="pre">register</span></code></a></p></td>
 <td><p>Register an artist type to a data type.</p></td>
 </tr>
+<tr class="row-even"><td><p><a class="reference internal" href="compas.artists.Artist.register_artists.html#compas.artists.Artist.register_artists" title="compas.artists.Artist.register_artists"><code class="xref py py-obj docutils literal notranslate"><span class="pre">register_artists</span></code></a></p></td>
+<td><p>Register Artists using available plugins.</p></td>
+</tr>
 </tbody>
 </table>
 </dd></dl>

latest/reference/generated/compas.artists.Artist.register.html

@@ -64,7 +64,7 @@
     <link rel="shortcut icon" href="../../_static/compas.ico"/>
     <link rel="index" title="Index" href="../../genindex.html" />
     <link rel="search" title="Search" href="../../search.html" />
-    <link rel="next" title="CurveArtist" href="compas.artists.CurveArtist.html" />
+    <link rel="next" title="Artist.register_artists" href="compas.artists.Artist.register_artists.html" />
     <link rel="prev" title="Artist.redraw" href="compas.artists.Artist.redraw.html" />
   <meta name="viewport" content="width=device-width, initial-scale=1"/>
   <meta name="docsearch:language" content="en"/>
@@ -1195,11 +1195,11 @@ <h1>Artist.register</h1>
       </div>
     </a>
     <a class="right-next"
-       href="compas.artists.CurveArtist.html"
+       href="compas.artists.Artist.register_artists.html"
        title="next page">
       <div class="prev-next-info">
         <p class="prev-next-subtitle">next</p>
-        <p class="prev-next-title">CurveArtist</p>
+        <p class="prev-next-title">Artist.register_artists</p>
       </div>
       <i class="fa-solid fa-angle-right"></i>
     </a>