summaryrefslogtreecommitdiff
path: root/doc/source/geometry.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/source/geometry.rst')
-rw-r--r--doc/source/geometry.rst61
1 files changed, 57 insertions, 4 deletions
diff --git a/doc/source/geometry.rst b/doc/source/geometry.rst
index 347e1d3..a3f7463 100644
--- a/doc/source/geometry.rst
+++ b/doc/source/geometry.rst
@@ -9,14 +9,67 @@ The Mesh Class
.. autoclass:: Mesh
:members:
+The Solid Class
+---------------
+
+.. autoclass:: Solid
+ :members:
+
+The Material Class
+------------------
+
+.. autoclass:: Material
+ :members:
+
+The Geometry Class
+------------------
+
+.. autoclass:: Geometry
+ :members:
+
Importing from STL
------------------
-.. automodule:: chroma.stl
- :members: mesh_from_stl
+.. autofunction:: chroma.mesh_from_stl
Mesh Modelling Tools
--------------------
-.. automodule:: chroma.make
- :members: linear_extrude, rotate_extrude, box, cube, cylinder, segmented_cylinder, sphere, torus
+.. module:: chroma.make
+
+.. autofunction:: linear_extrude
+
+.. image:: images/hexagonal_prism.png
+ :height: 100px
+
+.. autofunction:: rotate_extrude
+
+.. image:: images/bipyramid.png
+ :height: 100px
+
+.. autofunction:: box
+
+.. image:: images/box.png
+ :height: 100px
+
+.. autofunction:: cube
+
+.. image:: images/cube.png
+ :height: 100px
+
+.. autofunction:: cylinder
+
+.. image:: images/cylinder.png
+ :height: 100px
+
+.. autofunction:: segmented_cylinder
+
+.. autofunction:: sphere
+
+.. image:: images/sphere.png
+ :height: 100px
+
+.. autofunction:: torus
+
+.. image:: images/torus.png
+ :height: 100px