remove robots and update the docs

compas-dev · Sep 19, 2023 · 7275dc9 · 7275dc9
1 parent 4b50dcb
commit 7275dc9
Show file tree

Hide file tree

Showing 38 changed files with 337 additions and 6,412 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -285,6 +285,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * Removed `compas_rhino.artists.VolMeshArtist.draw_edgelabels`.
 * Removed `compas_rhino.artists.VolMeshArtist.draw_facelabels`.
 * Removed `compas_rhino.artists.VolMeshArtist.draw_celllabels`.
+* Removed `compas.robots`.
+* Removed `compas.artists.robotmodelartist`.
+* Removed `compas_blender.artists.robotmodelartist`.
+* Removed `compas_ghpython.artists.robotmodelartist`.
+* Removed `compas_rhino.artists.robotmodelartist`.
 
 ## [1.17.5] 2023-02-16
 

diff --git a/docs/reference/compas.robots.rst b/docs/reference/compas.robots.rst
diff --git a/docs/reference/compas_blender.conversions.rst b/docs/reference/compas_blender.conversions.rst
@@ -8,13 +8,36 @@ compas_blender.conversions
 
 This package provides classes for converting between COMPAS geometry and Blender geometry.
 
-Classes
-=======
+To Blender
+==========
 
 .. autosummary::
     :toctree: generated/
     :nosignatures:
 
-    BlenderGeometry
-    BlenderCurve
-    BlenderMesh
+    circle_to_blender_curve
+    color_to_blender_material
+    cylinder_to_blender_mesh
+    line_to_blender_curve
+    mesh_to_blender
+    nurbscurve_to_blender_curve
+    nurbssurface_to_blender_surface
+    pointcloud_to_blender
+    polygon_to_blender_mesh
+    polyline_to_blender_curve
+    sphere_to_blender_mesh
+    transformation_to_blender
+    vertices_and_faces_to_blender_mesh
+
+
+To COMPAS
+=========
+
+.. autosummary::
+    :toctree: generated/
+    :nosignatures:
+
+    bmesh_to_compas
+    mesh_to_compas
+    monkey_to_compas
+    transformation_to_compas
diff --git a/docs/reference/compas_blender.rst b/docs/reference/compas_blender.rst
@@ -19,7 +19,6 @@ Modules
     compas_blender.artists
     compas_blender.conversions
     compas_blender.geometry
-    compas_blender.ui
     compas_blender.utilities
 
 
diff --git a/docs/reference/compas_blender.ui.rst b/docs/reference/compas_blender.ui.rst
diff --git a/docs/reference/compas_ghpython.artists.rst b/docs/reference/compas_ghpython.artists.rst
@@ -0,0 +1,59 @@
+********************************************************************************
+compas_ghpython.artists
+********************************************************************************
+
+.. currentmodule:: compas_ghpython.artists
+
+.. rst-class:: lead
+
+Artists for visualizing (painting) COMPAS geometry, robots, and data structures in Grasshopper using the GH Python component.
+The artists in this package provide plugins for the pluggable methods of the base artists in :mod:`compas.artists`.
+Therefore, they can be used directly, from here, or through the base artists :class:`~compas.artists.Artist`.
+
+
+Geometry Artists
+================
+
+.. autosummary::
+    :toctree: generated/
+    :nosignatures:
+
+    BoxArtist
+    CapsuleArtist
+    CircleArtist
+    ConeArtist
+    CurveArtist
+    CylinderArtist
+    FrameArtist
+    LineArtist
+    PointArtist
+    PolygonArtist
+    PolyhedronArtist
+    PolylineArtist
+    SphereArtist
+    SurfaceArtist
+    TorusArtist
+    VectorArtist
+    BrepArtist
+
+
+Datastructure Artists
+=====================
+
+.. autosummary::
+    :toctree: generated/
+    :nosignatures:
+
+    MeshArtist
+    NetworkArtist
+    VolMeshArtist
+
+
+Base Classes
+============
+
+.. autosummary::
+    :toctree: generated/
+    :nosignatures:
+
+    GHArtist
diff --git a/docs/reference/compas_rhino.artists.rst b/docs/reference/compas_rhino.artists.rst
@@ -0,0 +1,55 @@
+"""
+********************************************************************************
+compas_rhino.artists
+********************************************************************************
+
+.. currentmodule:: compas_rhino.artists
+
+
+Geometry Artists
+================
+
+.. autosummary::
+    :toctree: generated/
+    :nosignatures:
+
+    BoxArtist
+    BrepArtist
+    CapsuleArtist
+    CircleArtist
+    ConeArtist
+    CurveArtist
+    CylinderArtist
+    FrameArtist
+    LineArtist
+    PlaneArtist
+    PointArtist
+    PolygonArtist
+    PolyhedronArtist
+    PolylineArtist
+    VectorArtist
+    SphereArtist
+    SurfaceArtist
+    TorusArtist
+
+
+Datastructure Artists
+=====================
+
+.. autosummary::
+    :toctree: generated/
+    :nosignatures:
+
+    MeshArtist
+    NetworkArtist
+    VolMeshArtist
+
+
+Base Classes
+============
+
+.. autosummary::
+    :toctree: generated/
+    :nosignatures:
+
+    RhinoArtist
diff --git a/docs/reference/compas_rhino.conversions.rst b/docs/reference/compas_rhino.conversions.rst
@@ -0,0 +1,98 @@
+********************************************************************************
+compas_rhino.conversions
+********************************************************************************
+
+.. currentmodule:: compas_rhino.conversions
+
+.. rst-class:: lead
+
+Conversions between Rhino geometry objects (:mod:`Rhino.Geometry`) and COMPAS geometry objects (:mod:`compas.geometry`).
+
+Exceptions
+==========
+
+.. autosummary::
+    :toctree: generated/
+    :nosignatures:
+
+    ConversionError
+
+
+To Rhino
+========
+
+.. autosummary::
+    :toctree: generated/
+    :nosignatures:
+
+    arc_to_rhino
+    box_to_rhino
+    brep_to_rhino
+    capsule_to_rhino_brep
+    circle_to_rhino
+    circle_to_rhino_curve
+    cone_to_rhino
+    cone_to_rhino_brep
+    curve_to_rhino
+    cylinder_to_rhino
+    cylinder_to_rhino_brep
+    ellipse_to_rhino
+    ellipse_to_rhino_curve
+    frame_to_rhino
+    frame_to_rhino_plane
+    line_to_rhino
+    line_to_rhino_curve
+    mesh_to_rhino
+    plane_to_rhino
+    point_to_rhino
+    polygon_to_rhino
+    polyhedron_to_rhino
+    polyline_to_rhino
+    polyline_to_rhino_curve
+    sphere_to_rhino
+    surface_to_rhino
+    torus_to_rhino
+    torus_to_rhino_brep
+    transformation_to_rhino
+    transformation_matrix_to_rhino
+    vertices_and_faces_to_rhino
+    vector_to_rhino
+
+
+To COMPAS
+=========
+
+.. autosummary::
+    :toctree: generated/
+    :nosignatures:
+
+    arc_to_compas
+    box_to_compas
+    brep_to_compas_box
+    brep_to_compas_cone
+    brep_to_compas_cylinder
+    brep_to_compas_sphere
+    circle_to_compas
+    cone_to_compas
+    curve_to_compas_circle
+    curve_to_compas_ellipse
+    curve_to_compas_line
+    curve_to_compas_polyline
+    cylinder_to_compas
+    ellipse_to_compas
+    extrusion_to_compas_box
+    extrusion_to_compas_cylinder
+    extrusion_to_compas_torus
+    line_to_compas
+    mesh_to_compas
+    plane_to_compas
+    plane_to_compas_frame
+    point_to_compas
+    polygon_to_compas
+    polyline_to_compas
+    sphere_to_compas
+    surface_to_compas
+    surface_to_compas_data
+    surface_to_compas_mesh
+    surface_to_compas_quadmesh
+    vector_to_compas