Added some docs

[linpy.git] / doc / geometry.rst

diff --git a/doc/geometry.rst b/doc/geometry.rst
new file mode 100644 (file)
index 0000000..224fb3a
--- /dev/null
+++ b/doc/geometry.rst
@@ -0,0 +1,38 @@
+Geometry Module
+===============
+
+The geometry module is used to obtain information about the points and vertices of a ployhedra.
+
+.. py:class:: Points
+
+This class represents points in space.
+
+    .. py:method:: isorigin(self)
+    
+        Return true is given point is the origin.
+        
+    .. py:method:: 
+        
+.. py:class:: Vector
+
+This class represents displacements in space.        
+
+    .. py:method:: angle(self, other)
+    
+        Retrieve the angle required to rotate the vector into the vector passed
+        in argument. The result is an angle in radians, ranging between -pi and
+        pi.
+
+    .. py:method:: cross(self, other)
+    
+        Calculate the cross product of two Vector3D structures. 
+
+    .. py:method:: dot(self, other)
+    
+        Calculate the dot product of two vectors. 
+        
+    .. py:method:: __trudiv__(self, other)
+    
+       Divide the vector by the specified scalar and returns the result as a
+       vector.         
+