diff options
| author | Anthony LaTorre <tlatorre9@gmail.com> | 2011-09-09 12:54:56 -0400 |
|---|---|---|
| committer | Anthony LaTorre <tlatorre9@gmail.com> | 2011-09-09 12:54:56 -0400 |
| commit | cb07b863464ad85cf4f18a2e97764db5c3bcc766 (patch) | |
| tree | dd4d1bf664e470f91859e7be1eaa4edfd7c35e14 /doc/source/geometry.rst | |
| parent | eb964fe9fcf13ad1a72e40451c5d85b6765d945f (diff) | |
| download | chroma-cb07b863464ad85cf4f18a2e97764db5c3bcc766.tar.gz chroma-cb07b863464ad85cf4f18a2e97764db5c3bcc766.tar.bz2 chroma-cb07b863464ad85cf4f18a2e97764db5c3bcc766.zip | |
update sphinx documentation.
Diffstat (limited to 'doc/source/geometry.rst')
| -rw-r--r-- | doc/source/geometry.rst | 61 |
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 |