diff options
| author | Ferenc Arn <tagcup@yahoo.com> | 2017-03-23 12:27:00 -0500 |
|---|---|---|
| committer | Ferenc Arn <tagcup@yahoo.com> | 2017-03-23 12:27:00 -0500 |
| commit | 6bb9b58b09aee7fc543c03844ce51b62c838dadd (patch) | |
| tree | dcb9a80383698af2b9d741f151a03f5a2b739987 /doc | |
| parent | c37fad650f92845a6f59740fea2fea1b46f56db1 (diff) | |
Explicitly documented that Transform.basis is not necessarily an orthogonal matrix.
Also added a check that in axis-angle rotations, axis is a normalized vector, and modified the docs accordingly.
Fixes #8113.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/base/classes.xml | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/doc/base/classes.xml b/doc/base/classes.xml index 0b6e2d99ea..9a87c08fc3 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -20704,7 +20704,7 @@ 3x3 matrix datatype. </brief_description> <description> - 3x3 matrix used for 3D rotation and scale. Contains 3 vector fields x,y and z as its columns, which can be interpreted as the local basis vectors of a transformation. Can also be accessed as array of 3D vectors. Almost always used as orthogonal basis for a [Transform]. + 3x3 matrix used for 3D rotation and scale. Contains 3 vector fields x,y and z as its columns, which can be interpreted as the local basis vectors of a transformation. Can also be accessed as array of 3D vectors. These vectors are orthogonal to each other, but are not necessarily normalized. Almost always used as orthogonal basis for a [Transform]. For such use, it is composed of a scaling and a rotation matrix, in that order (M = R.S). </description> <methods> @@ -20725,7 +20725,7 @@ <argument index="1" name="phi" type="float"> </argument> <description> - Create a rotation matrix which rotates around the given axis by the specified angle. + Create a rotation matrix which rotates around the given axis by the specified angle. The axis must be a normalized vector. </description> </method> <method name="Matrix3"> @@ -20792,7 +20792,7 @@ <argument index="1" name="phi" type="float"> </argument> <description> - Introduce an additional rotation around the given axis by phi. Only relevant when the matrix is being used as a part of [Transform]. + Introduce an additional rotation around the given axis by phi. Only relevant when the matrix is being used as a part of [Transform]. The axis must be a normalized vector. </description> </method> <method name="scaled"> @@ -31548,7 +31548,7 @@ <argument index="1" name="angle" type="float"> </argument> <description> - Returns a quaternion that will rotate around the given axis by the specified angle. + Returns a quaternion that will rotate around the given axis by the specified angle. The axis must be a normalized vector. </description> </method> <method name="Quat"> @@ -43200,7 +43200,7 @@ <argument index="1" name="phi" type="float"> </argument> <description> - Rotate the transform around given axis by phi. + Rotate the transform around given axis by phi. The axis must be a normalized vector. </description> </method> <method name="scaled"> @@ -45402,7 +45402,7 @@ do_property]. <argument index="1" name="phi" type="float"> </argument> <description> - Rotates the vector around some axis by phi radians. + Rotates the vector around some axis by phi radians. The axis must be a normalized vector. </description> </method> <method name="slide"> |