add subd to docs

Author: tomvanmele

docs/_images/cgal_subd.png

@@ -0,0 +1,44 @@
+from compas.geometry import Box, Polyhedron
+from compas.geometry import Translation
+from compas_cgal.subdivision import catmull_clark
+from compas_view2.app import App
+
+# ==============================================================================
+# Input
+# ==============================================================================
+
+box = Box.from_diagonal(([0, 0, 0], [1, 1, 1]))
+
+V, F = box.to_vertices_and_faces()
+
+VF2 = catmull_clark((V, F), 2)
+VF4 = catmull_clark((V, F), 4)
+VF6 = catmull_clark((V, F), 6)
+VF8 = catmull_clark((V, F), 8)
+
+S2 = Polyhedron(*VF2)
+S4 = Polyhedron(*VF4)
+S6 = Polyhedron(*VF6)
+S8 = Polyhedron(*VF8)
+
+S2.transform(Translation.from_vector([1, 0, 0]))
+S4.transform(Translation.from_vector([2, 0, 0]))
+S6.transform(Translation.from_vector([3, 0, 0]))
+S8.transform(Translation.from_vector([4, 0, 0]))
+
+# ==============================================================================
+# Viz
+# ==============================================================================
+
+viewer = App(width=1200, height=750)
+viewer.view.camera.tx = -2.5
+viewer.view.camera.ty = -1
+viewer.view.camera.rz = 0
+viewer.view.camera.distance = 5
+
+viewer.add(box)
+viewer.add(S2)
+viewer.add(S4)
+viewer.add(S6)
+viewer.add(S8)
+viewer.show()

docs/examples/subd.py

@@ -0,0 +1,11 @@
+********************************************************************************
+Subdivision with Catmull Clark
+********************************************************************************
+
+.. figure:: /_images/cgal_subd.png
+    :figclass: figure
+    :class: figure-img img-fluid
+
+
+.. literalinclude:: subd.py
+    :language: python

docs/examples/subd.rst

@@ -13,7 +13,7 @@ m2r
 nbsphinx
 pydocstyle
 pytest >=3.2
-sphinx_compas_theme >=0.15
+sphinx_compas_theme >=0.15.11
 sphinx >=3.4
 twine
 wheel

requirements-dev.txt

@@ -17,9 +17,9 @@ def _boolean(A, B, operation):
 
     Returns
     -------
-    NDArray[(Any, 3) np.float64]
+    NDArray[(Any, 3), np.float64]
         The vertices of the boolean mesh.
-    NDArray[(Any, 3) np.int32]
+    NDArray[(Any, 3), np.int32]
         The faces of the boolean mesh.
 
     Raises
@@ -62,9 +62,9 @@ def boolean_union(A, B):
 
     Returns
     -------
-    NDArray[(Any, 3) np.float64]
+    NDArray[(Any, 3), np.float64]
         The vertices of the boolean mesh.
-    NDArray[(Any, 3) np.int32]
+    NDArray[(Any, 3), np.int32]
         The faces of the boolean mesh.
 
     """
@@ -86,9 +86,9 @@ def boolean_difference(A, B):
 
     Returns
     -------
-    NDArray[(Any, 3) np.float64]
+    NDArray[(Any, 3), np.float64]
         The vertices of the boolean mesh.
-    NDArray[(Any, 3) np.int32]
+    NDArray[(Any, 3), np.int32]
         The faces of the boolean mesh.
 
     """
@@ -110,9 +110,9 @@ def boolean_intersection(A, B):
 
     Returns
     -------
-    NDArray[(Any, 3) np.float64]
+    NDArray[(Any, 3), np.float64]
         The vertices of the boolean mesh.
-    NDArray[(Any, 3) np.int32]
+    NDArray[(Any, 3), np.int32]
         The faces of the boolean mesh.
 
     """

scripts/subd.py

@@ -14,9 +14,9 @@ def catmull_clark(mesh, k=1):
 
     Returns
     -------
-    NDArray[(Any, 3) np.float64]
+    NDArray[(Any, 3), np.float64]
         The vertices of the subdivided mesh.
-    NDArray[(Any, 4) np.int32]
+    NDArray[(Any, 4), np.int32]
         The faces of the subdivided mesh.
 
     """