aboutsummaryrefslogtreecommitdiffhomepage
path: root/Eigen/src/Geometry/Hyperplane.h
diff options
context:
space:
mode:
authorGravatar Gael Guennebaud <g.gael@free.fr>2008-10-26 15:04:31 +0000
committerGravatar Gael Guennebaud <g.gael@free.fr>2008-10-26 15:04:31 +0000
commit94f6f2a7de5c06c331fc491eab39b0c9cc0495b9 (patch)
tree6ff684c95eafcf26480f46b9a3e3f738ea36c8ef /Eigen/src/Geometry/Hyperplane.h
parentec0a423862d74cea10e2b33f7b37f43957adb465 (diff)
Add an axis aligned box in the geometry module.
Some naming questions: - for "extend" we could also think of: "expand", "union", "add" - same for "clamp": "crop", "intersect" - same for "contains": "isInside", "intersect" => ah "intersect" is conflicting, so that eliminates this one !
Diffstat (limited to 'Eigen/src/Geometry/Hyperplane.h')
-rw-r--r--Eigen/src/Geometry/Hyperplane.h4
1 files changed, 2 insertions, 2 deletions
diff --git a/Eigen/src/Geometry/Hyperplane.h b/Eigen/src/Geometry/Hyperplane.h
index a45268f07..4edbcece2 100644
--- a/Eigen/src/Geometry/Hyperplane.h
+++ b/Eigen/src/Geometry/Hyperplane.h
@@ -203,7 +203,7 @@ public:
}
}
- /** \returns the transformation of \c *this by the transformation matrix \a mat.
+ /** Applies the transformation matrix \a mat to \c *this and returns a reference to \c *this.
*
* \param mat the Dim x Dim transformation matrix
* \param traits specifies whether the matrix \a mat represents an Isometry
@@ -223,7 +223,7 @@ public:
return *this;
}
- /** \returns the transformation of \c *this by the transformation \a t
+ /** Applies the transformation \a t to \c *this and returns a reference to \c *this.
*
* \param t the transformation of dimension Dim
* \param traits specifies whether the transformation \a t represents an Isometry