summaryrefslogtreecommitdiffstats
path: root/src/math
diff options
context:
space:
mode:
authorKore Nordmann <github@kore-nordmann.de>2008-08-20 11:10:02 +0000
committerKore Nordmann <github@kore-nordmann.de>2008-08-20 11:10:02 +0000
commitcc24ba1a3e2bb75ce751a7ec72d140a6582ecf2c (patch)
tree7eae31b768d5ec8c6f90c7fe76ba02a1155d3729 /src/math
parent59e15d56899406f7cff4fd3eae3a370410e0c898 (diff)
downloadzetacomponents-graph-cc24ba1a3e2bb75ce751a7ec72d140a6582ecf2c.zip
zetacomponents-graph-cc24ba1a3e2bb75ce751a7ec72d140a6582ecf2c.tar.gz
- More documentation improvements
# There is still some way to go...
Diffstat (limited to 'src/math')
-rw-r--r--src/math/boundings.php4
-rw-r--r--src/math/rotation.php9
-rw-r--r--src/math/transformation.php15
-rw-r--r--src/math/translation.php9
-rw-r--r--src/math/vector.php7
5 files changed, 42 insertions, 2 deletions
diff --git a/src/math/boundings.php b/src/math/boundings.php
index 825700f..f88f4b2 100644
--- a/src/math/boundings.php
+++ b/src/math/boundings.php
@@ -14,6 +14,10 @@
* Currently only works with plane rectangular boundings, should be enhanced by
* rotated rectangular boundings.
*
+ * This class is only used internally to represent space which is used by
+ * certain obejcts on the drawing plane, or which free space is still
+ * available.
+ *
* @version //autogentag//
* @package Graph
* @access private
diff --git a/src/math/rotation.php b/src/math/rotation.php
index bbc4f1e..12ddd44 100644
--- a/src/math/rotation.php
+++ b/src/math/rotation.php
@@ -11,6 +11,15 @@
/**
* Class to create rotation matrices from given rotation and center point
*
+ * Three dimensional matrices (3x3) may be used to specify transformation of
+ * points, vectors and complexer structures in a two dimensional cartesian
+ * coordinate system. For more details have a look here:
+ * http://en.wikipedia.org/wiki/Transformation_matrix
+ *
+ * This class implements a convenient interface to create matrixes to rotate
+ * elements. This matrix may be combined with other transformation matrices, as
+ * usual.
+ *
* @version //autogentag//
* @package Graph
* @access private
diff --git a/src/math/transformation.php b/src/math/transformation.php
index 78b95f1..a1ed70b 100644
--- a/src/math/transformation.php
+++ b/src/math/transformation.php
@@ -9,8 +9,19 @@
* @access private
*/
/**
- * Class defining transformations like scaling and rotation by a
- * 3x3 transformation matrix for |R^2
+ * Class defining transformations
+ *
+ * Three dimensional matrices (3x3) may be used to specify transformation of
+ * points, vectors and complexer structures in a two dimensional cartesian
+ * coordinate system. For more details have a look here:
+ * http://en.wikipedia.org/wiki/Transformation_matrix
+ *
+ * There are some classes extending this basic tranformation class, to
+ * give you more convinient access to the creation of such transformation
+ * matrices, which are:
+ *
+ * - ezcGraphRotation (rotations of objects)
+ * - ezcGraphTranslation (moving of objects)
*
* @version //autogentag//
* @package Graph
diff --git a/src/math/translation.php b/src/math/translation.php
index ca22063..a9b1c3c 100644
--- a/src/math/translation.php
+++ b/src/math/translation.php
@@ -11,6 +11,15 @@
/**
* Class creating translation matrices from given movements
*
+ * Three dimensional matrices (3x3) may be used to specify transformation of
+ * points, vectors and complexer structures in a two dimensional cartesian
+ * coordinate system. For more details have a look here:
+ * http://en.wikipedia.org/wiki/Transformation_matrix
+ *
+ * This class implements a convenient interface to create matrixes to move
+ * elements. This matrix may be combined with other transformation matrices, as
+ * usual.
+ *
* @version //autogentag//
* @package Graph
* @access private
diff --git a/src/math/vector.php b/src/math/vector.php
index 9415bca..c34b34d 100644
--- a/src/math/vector.php
+++ b/src/math/vector.php
@@ -11,6 +11,13 @@
/**
* Represents two dimensional vectors
*
+ * This class is internally used to represent vectors for geometric calculation
+ * in the two dimensional cartesian coordinate system.
+ *
+ * Vectors are an extension of the basic coordinate class, and add methods to
+ * calculate the length of a vector, perform various operations on angles, like
+ * rotations and the calculation of angles between two vectors.
+ *
* @version //autogentag//
* @package Graph
* @access private
OpenPOWER on IntegriCloud