aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/QuickReference.dox
diff options
context:
space:
mode:
authorGravatar Gael Guennebaud <g.gael@free.fr>2017-08-22 16:48:07 +0200
committerGravatar Gael Guennebaud <g.gael@free.fr>2017-08-22 16:48:07 +0200
commit9deee79922c38415125e4d6c2cd34cd05bda7889 (patch)
treeda1abdf71c944400bad9abff3ce49cd0669ad66c /doc/QuickReference.dox
parentbc4dae9aeb84cc3d3114ee496d55654cc7256584 (diff)
bug #1457: add setUnit() methods for consistency.
Diffstat (limited to 'doc/QuickReference.dox')
-rw-r--r--doc/QuickReference.dox10
1 files changed, 9 insertions, 1 deletions
diff --git a/doc/QuickReference.dox b/doc/QuickReference.dox
index 44f5410db..59d7d05e4 100644
--- a/doc/QuickReference.dox
+++ b/doc/QuickReference.dox
@@ -261,6 +261,8 @@ x.setIdentity();
Vector3f::UnitX() // 1 0 0
Vector3f::UnitY() // 0 1 0
Vector3f::UnitZ() // 0 0 1
+Vector4f::Unit(i)
+x.setUnit(i);
\endcode
</td>
<td>
@@ -278,6 +280,7 @@ N/A
VectorXf::Unit(size,i)
+x.setUnit(size,i);
VectorXf::Unit(4,1) == Vector4f(0,1,0,0)
== Vector4f::UnitY()
\endcode
@@ -285,7 +288,12 @@ VectorXf::Unit(4,1) == Vector4f(0,1,0,0)
</tr>
</table>
-
+Note that it is allowed to call any of the \c set* functions to a dynamic-sized vector or matrix without passing new sizes.
+For instance:
+\code
+MatrixXi M(3,3);
+M.setIdentity();
+\endcode
\subsection QuickRef_Map Mapping external arrays