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