Added some docs
[linpy.git] / doc / geometry.rst
1 Geometry Module
2 ===============
3
4 The geometry module is used to obtain information about the points and vertices of a ployhedra.
5
6 .. py:class:: Points
7
8 This class represents points in space.
9
10 .. py:method:: isorigin(self)
11
12 Return true is given point is the origin.
13
14 .. py:method::
15
16 .. py:class:: Vector
17
18 This class represents displacements in space.
19
20 .. py:method:: angle(self, other)
21
22 Retrieve the angle required to rotate the vector into the vector passed
23 in argument. The result is an angle in radians, ranging between -pi and
24 pi.
25
26 .. py:method:: cross(self, other)
27
28 Calculate the cross product of two Vector3D structures.
29
30 .. py:method:: dot(self, other)
31
32 Calculate the dot product of two vectors.
33
34 .. py:method:: __trudiv__(self, other)
35
36 Divide the vector by the specified scalar and returns the result as a
37 vector.
38