ic
/
magnum
mirror of https://github.com/mosra/magnum.git
6
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

SceneGraph: doc++, show privates as private. 

Forgot to remove the protected doxygen override when implementing this
doxygen feature a year ago.
pull/420/head
Vladimír Vondruš 6 years ago
parent
ea92c5b36f
commit
17f0112732
12 changed files with 75 additions and 92 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 4
      src/Magnum/SceneGraph/AbstractTranslation.h
  2. 8
      src/Magnum/SceneGraph/AbstractTranslationRotation2D.h
  3. 20
      src/Magnum/SceneGraph/AbstractTranslationRotation3D.h
  4. 8
      src/Magnum/SceneGraph/AbstractTranslationRotationScaling2D.h
  5. 8
      src/Magnum/SceneGraph/AbstractTranslationRotationScaling3D.h
  6. 12
      src/Magnum/SceneGraph/DualComplexTransformation.h
  7. 12
      src/Magnum/SceneGraph/DualQuaternionTransformation.h
  8. 16
      src/Magnum/SceneGraph/RigidMatrixTransformation2D.h
  9. 28
      src/Magnum/SceneGraph/RigidMatrixTransformation3D.h
  10. 16
      src/Magnum/SceneGraph/TranslationRotationScalingTransformation2D.h
  11. 31
      src/Magnum/SceneGraph/TranslationRotationScalingTransformation3D.h
  12. 4
      src/Magnum/SceneGraph/TranslationTransformation.h

4
src/Magnum/SceneGraph/AbstractTranslation.h
Unescape View File

@ -58,7 +58,7 @@ class AbstractTranslation: public AbstractTransformation<dimensions, T> {
explicit AbstractTranslation() = default;
/**
* @brief Translate object
* @brief Translate the object
* @return Reference to self (for method chaining)
*
* @see @ref translateLocal(), @ref Math::Vector2::xAxis(),
@ -71,7 +71,7 @@ class AbstractTranslation: public AbstractTransformation<dimensions, T> {
}
/**
* @brief Translate object as a local transformation
* @brief Translate the object as a local transformation
*
* Similar to the above, except that the transformation is applied
* before all others.

8
src/Magnum/SceneGraph/AbstractTranslationRotation2D.h
Unescape View File

@ -47,7 +47,7 @@ template<class T> class AbstractBasicTranslationRotation2D: public AbstractBasic
explicit AbstractBasicTranslationRotation2D() = default;
/**
* @brief Rotate object
* @brief Rotate the object
* @param angle Angle (counterclockwise)
* @return Reference to self (for method chaining)
*
@ -59,7 +59,7 @@ template<class T> class AbstractBasicTranslationRotation2D: public AbstractBasic
}
/**
* @brief Rotate object as a local transformation
* @brief Rotate the object as a local transformation
*
* Similar to the above, except that the transformation is applied
* before all others.
@ -88,11 +88,7 @@ template<class T> class AbstractBasicTranslationRotation2D: public AbstractBasic
protected:
~AbstractBasicTranslationRotation2D() = default;
#ifdef DOXYGEN_GENERATING_OUTPUT
protected:
#else
private:
#endif
/** @brief Polymorphic implementation for @ref rotate() */
virtual void doRotate(Math::Rad<T> angle) = 0;

20
src/Magnum/SceneGraph/AbstractTranslationRotation3D.h
Unescape View File

@ -48,7 +48,7 @@ template<class T> class AbstractBasicTranslationRotation3D: public AbstractBasic
explicit AbstractBasicTranslationRotation3D() = default;
/**
* @brief Rotate object
* @brief Rotate the object
* @param angle Angle (counterclockwise)
* @param normalizedAxis Normalized rotation axis
* @return Reference to self (for method chaining)
@ -63,7 +63,7 @@ template<class T> class AbstractBasicTranslationRotation3D: public AbstractBasic
}
/**
* @brief Rotate object as a local transformation
* @brief Rotate the object as a local transformation
*
* Similar to the above, except that the transformation is applied
* before all others.
@ -74,7 +74,7 @@ template<class T> class AbstractBasicTranslationRotation3D: public AbstractBasic
}
/**
* @brief Rotate object around X axis
* @brief Rotate the object around X axis
* @param angle Angle (counterclockwise)
* @return Reference to self (for method chaining)
*
@ -89,7 +89,7 @@ template<class T> class AbstractBasicTranslationRotation3D: public AbstractBasic
}
/**
* @brief Rotate object around X axis as a local transformation
* @brief Rotate the object around X axis as a local transformation
*
* Similar to the above, except that the transformation is applied
* before all others. In some implementations faster than calling
@ -102,7 +102,7 @@ template<class T> class AbstractBasicTranslationRotation3D: public AbstractBasic
}
/**
* @brief Rotate object around Y axis
* @brief Rotate the object around Y axis
* @param angle Angle (counterclockwise)
* @return Reference to self (for method chaining)
*
@ -117,7 +117,7 @@ template<class T> class AbstractBasicTranslationRotation3D: public AbstractBasic
}
/**
* @brief Rotate object around Y axis as a local transformation
* @brief Rotate the object around Y axis as a local transformation
*
* Similar to the above, except that the transformation is applied
* before all others. In some implementations faster than calling
@ -130,7 +130,7 @@ template<class T> class AbstractBasicTranslationRotation3D: public AbstractBasic
}
/**
* @brief Rotate object around Z axis
* @brief Rotate the object around Z axis
* @param angle Angle (counterclockwise)
* @return Reference to self (for method chaining)
*
@ -145,7 +145,7 @@ template<class T> class AbstractBasicTranslationRotation3D: public AbstractBasic
}
/**
* @brief Rotate object around Z axis as a local transformation
* @brief Rotate the object around Z axis as a local transformation
*
* Similar to the above, except that the transformation is applied
* before all others. In some implementations faster than calling
@ -176,11 +176,7 @@ template<class T> class AbstractBasicTranslationRotation3D: public AbstractBasic
protected:
~AbstractBasicTranslationRotation3D() = default;
#ifdef DOXYGEN_GENERATING_OUTPUT
protected:
#else
private:
#endif
/** @brief Polymorphic implementation for @ref rotate() */
virtual void doRotate(Math::Rad<T> angle, const Math::Vector3<T>& normalizedAxis) = 0;

8
src/Magnum/SceneGraph/AbstractTranslationRotationScaling2D.h
Unescape View File

@ -47,7 +47,7 @@ template<class T> class AbstractBasicTranslationRotationScaling2D: public Abstra
explicit AbstractBasicTranslationRotationScaling2D() = default;
/**
* @brief Scale object
* @brief Scale the object
* @return Reference to self (for method chaining)
*
* @see @ref scaleLocal(), @ref Math::Vector2::xScale(),
@ -59,7 +59,7 @@ template<class T> class AbstractBasicTranslationRotationScaling2D: public Abstra
}
/**
* @brief Scale object as a local transformation
* @brief Scale the object as a local transformation
*
* Similar to the above, except that the transformation is applied
* before all others.
@ -96,11 +96,7 @@ template<class T> class AbstractBasicTranslationRotationScaling2D: public Abstra
protected:
~AbstractBasicTranslationRotationScaling2D() = default;
#ifdef DOXYGEN_GENERATING_OUTPUT
protected:
#else
private:
#endif
/** @brief Polymorphic implementation for @ref scale() */
virtual void doScale(const Math::Vector2<T>& vector) = 0;

8
src/Magnum/SceneGraph/AbstractTranslationRotationScaling3D.h
Unescape View File

@ -47,7 +47,7 @@ template<class T> class AbstractBasicTranslationRotationScaling3D: public Abstra
explicit AbstractBasicTranslationRotationScaling3D() = default;
/**
* @brief Scale object
* @brief Scale the object
* @return Reference to self (for method chaining)
*
* @see @ref scaleLocal(), @ref Math::Vector3::xScale(),
@ -59,7 +59,7 @@ template<class T> class AbstractBasicTranslationRotationScaling3D: public Abstra
}
/**
* @brief Scale object as a local transformation
* @brief Scale the object as a local transformation
*
* Similar to the above, except that the transformation is applied
* before all others.
@ -120,11 +120,7 @@ template<class T> class AbstractBasicTranslationRotationScaling3D: public Abstra
protected:
~AbstractBasicTranslationRotationScaling3D() = default;
#ifdef DOXYGEN_GENERATING_OUTPUT
protected:
#else
private:
#endif
/** @brief Polymorphic implementation for @ref scale() */
virtual void doScale(const Math::Vector3<T>& vector) = 0;

12
src/Magnum/SceneGraph/DualComplexTransformation.h
Unescape View File

@ -83,7 +83,7 @@ template<class T> class BasicDualComplexTransformation: public AbstractBasicTran
}
/**
* @brief Transform object
* @brief Transform the object
* @return Reference to self (for method chaining)
*
* Expects that the dual complex number is normalized.
@ -97,7 +97,7 @@ template<class T> class BasicDualComplexTransformation: public AbstractBasicTran
}
/**
* @brief Transform object as a local transformation
* @brief Transform the object as a local transformation
*
* Similar to the above, except that the transformation is applied
* before all others.
@ -110,7 +110,7 @@ template<class T> class BasicDualComplexTransformation: public AbstractBasicTran
}
/**
* @brief Translate object
* @brief Translate the object
* @return Reference to self (for method chaining)
*
* Same as calling @ref transform() with @ref Math::DualComplex::translation().
@ -122,7 +122,7 @@ template<class T> class BasicDualComplexTransformation: public AbstractBasicTran
}
/**
* @brief Translate object as a local transformation
* @brief Translate the object as a local transformation
*
* Similar to the above, except that the transformation is applied
* before all others. Same as calling @ref transformLocal() with
@ -133,7 +133,7 @@ template<class T> class BasicDualComplexTransformation: public AbstractBasicTran
}
/**
* @brief Rotate object
* @brief Rotate the object
* @param angle Angle (counterclockwise)
* @return Reference to self (for method chaining)
*
@ -145,7 +145,7 @@ template<class T> class BasicDualComplexTransformation: public AbstractBasicTran
}
/**
* @brief Rotate object as a local transformation
* @brief Rotate the object as a local transformation
*
* Similar to the above, except that the transformation is applied
* before all others.

12
src/Magnum/SceneGraph/DualQuaternionTransformation.h
Unescape View File

@ -83,7 +83,7 @@ template<class T> class BasicDualQuaternionTransformation: public AbstractBasicT
}
/**
* @brief Transform object
* @brief Transform the object
* @return Reference to self (for method chaining)
*
* Expects that the dual quaternion is normalized.
@ -97,7 +97,7 @@ template<class T> class BasicDualQuaternionTransformation: public AbstractBasicT
}
/**
* @brief Transform object as a local transformation
* @brief Transform the object as a local transformation
*
* Similar to the above, except that the transformation is applied
* before all others.
@ -110,7 +110,7 @@ template<class T> class BasicDualQuaternionTransformation: public AbstractBasicT
}
/**
* @brief Translate object
* @brief Translate the object
* @return Reference to self (for method chaining)
*
* Same as calling @ref transform() with @ref Math::DualQuaternion::translation().
@ -122,7 +122,7 @@ template<class T> class BasicDualQuaternionTransformation: public AbstractBasicT
}
/**
* @brief Translate object as a local transformation
* @brief Translate the object as a local transformation
*
* Similar to the above, except that the transformation is applied
* before all others.
@ -132,7 +132,7 @@ template<class T> class BasicDualQuaternionTransformation: public AbstractBasicT
}
/**
* @brief Rotate object
* @brief Rotate the object
* @param angle Angle (counterclockwise)
* @param normalizedAxis Normalized rotation axis
* @return Reference to self (for method chaining)
@ -147,7 +147,7 @@ template<class T> class BasicDualQuaternionTransformation: public AbstractBasicT
}
/**
* @brief Rotate object as a local transformation
* @brief Rotate the object as a local transformation
*
* Similar to the above, except that the transformation is applied
* before all others.

16
src/Magnum/SceneGraph/RigidMatrixTransformation2D.h
Unescape View File

@ -88,7 +88,7 @@ template<class T> class BasicRigidMatrixTransformation2D: public AbstractBasicTr
}
/**
* @brief Transform object
* @brief Transform the object
* @return Reference to self (for method chaining)
*
* Expects that the matrix represents rigid transformation.
@ -102,7 +102,7 @@ template<class T> class BasicRigidMatrixTransformation2D: public AbstractBasicTr
}
/**
* @brief Transform object as a local transformation
* @brief Transform the object as a local transformation
*
* Similar to the above, except that the transformation is applied
* before all others.
@ -115,7 +115,7 @@ template<class T> class BasicRigidMatrixTransformation2D: public AbstractBasicTr
}
/**
* Translate object
* @brief Translate the object
* @return Reference to self (for method chaining)
*
* Same as calling @ref transform() with @ref Math::Matrix3::translation().
@ -127,7 +127,7 @@ template<class T> class BasicRigidMatrixTransformation2D: public AbstractBasicTr
}
/**
* @brief Translate object as a local transformation
* @brief Translate the object as a local transformation
*
* Similar to the above, except that the transformation is applied
* before all others. Same as calling @ref transformLocal() with
@ -138,7 +138,7 @@ template<class T> class BasicRigidMatrixTransformation2D: public AbstractBasicTr
}
/**
* @brief Rotate object
* @brief Rotate the object
* @param angle Angle (counterclockwise)
* @return Reference to self (for method chaining)
*
@ -150,7 +150,7 @@ template<class T> class BasicRigidMatrixTransformation2D: public AbstractBasicTr
}
/**
* @brief Rotate object as a local transformation
* @brief Rotate the object as a local transformation
*
* Similar to the above, except that the transformation is applied
* before all others. Same as calling @ref transformLocal() with
@ -162,7 +162,7 @@ template<class T> class BasicRigidMatrixTransformation2D: public AbstractBasicTr
}
/**
* @brief Reflect object
* @brief Reflect the object
* @param normal Normal of the line through which to reflect
* (normalized)
* @return Reference to self (for method chaining)
@ -175,7 +175,7 @@ template<class T> class BasicRigidMatrixTransformation2D: public AbstractBasicTr
}
/**
* @brief Reflect object as a local transformation
* @brief Reflect the object as a local transformation
*
* Similar to the above, except that the transformation is applied
* before all others. Same as calling @ref transformLocal() with

28
src/Magnum/SceneGraph/RigidMatrixTransformation3D.h
Unescape View File

@ -87,7 +87,7 @@ template<class T> class BasicRigidMatrixTransformation3D: public AbstractBasicTr
}
/**
* @brief Transform object
* @brief Transform the object
* @return Reference to self (for method chaining)
*
* Expects that the matrix represents rigid transformation.
@ -101,7 +101,7 @@ template<class T> class BasicRigidMatrixTransformation3D: public AbstractBasicTr
}
/**
* @brief Transform object as a local transformation
* @brief Transform the object as a local transformation
*
* Similar to the above, except that the transformation is applied
* before all others.
@ -114,7 +114,7 @@ template<class T> class BasicRigidMatrixTransformation3D: public AbstractBasicTr
}
/**
* @brief Translate object
* @brief Translate the object
* @return Reference to self (for method chaining)
*
* Same as calling @ref transform() with @ref Math::Matrix4::translation().
@ -126,7 +126,7 @@ template<class T> class BasicRigidMatrixTransformation3D: public AbstractBasicTr
}
/**
* @brief Translate object as a local transformation
* @brief Translate the object as a local transformation
*
* Similar to the above, except that the transformation is applied
* before all others. Same as calling @ref transformLocal() with
@ -137,7 +137,7 @@ template<class T> class BasicRigidMatrixTransformation3D: public AbstractBasicTr
}
/**
* @brief Rotate object
* @brief Rotate the object
* @param angle Angle (counterclockwise)
* @param normalizedAxis Normalized rotation axis
* @return Reference to self (for method chaining)
@ -153,7 +153,7 @@ template<class T> class BasicRigidMatrixTransformation3D: public AbstractBasicTr
}
/**
* @brief Rotate object as a local transformation
* @brief Rotate the object as a local transformation
*
* Similar to the above, except that the transformation is applied
* before all others. Same as calling @ref transformLocal() with
@ -164,7 +164,7 @@ template<class T> class BasicRigidMatrixTransformation3D: public AbstractBasicTr
}
/**
* @brief Rotate object around X axis
* @brief Rotate the object around X axis
* @param angle Angle (counterclockwise)
* @return Reference to self (for method chaining)
*
@ -176,7 +176,7 @@ template<class T> class BasicRigidMatrixTransformation3D: public AbstractBasicTr
}
/**
* @brief Rotate object around X axis as a local transformation
* @brief Rotate the object around X axis as a local transformation
*
* Similar to the above, except that the transformation is applied
* before all others. Same as calling @ref transformLocal() with
@ -187,7 +187,7 @@ template<class T> class BasicRigidMatrixTransformation3D: public AbstractBasicTr
}
/**
* @brief Rotate object around Y axis
* @brief Rotate the object around Y axis
* @param angle Angle (counterclockwise)
* @return Reference to self (for method chaining)
*
@ -199,7 +199,7 @@ template<class T> class BasicRigidMatrixTransformation3D: public AbstractBasicTr
}
/**
* @brief Rotate object around Y axis as a local transformation
* @brief Rotate the object around Y axis as a local transformation
*
* Similar to the above, except that the transformation is applied
* before all others. Same as calling @ref transformLocal() with
@ -210,7 +210,7 @@ template<class T> class BasicRigidMatrixTransformation3D: public AbstractBasicTr
}
/**
* @brief Rotate object around Z axis
* @brief Rotate the object around Z axis
* @param angle Angle (counterclockwise)
* @return Reference to self (for method chaining)
*
@ -222,7 +222,7 @@ template<class T> class BasicRigidMatrixTransformation3D: public AbstractBasicTr
}
/**
* @brief Rotate object around Z axis as a local transformation
* @brief Rotate the object around Z axis as a local transformation
*
* Similar to the above, except that the transformation is applied
* before all others. Same as calling @ref transformLocal() with
@ -233,7 +233,7 @@ template<class T> class BasicRigidMatrixTransformation3D: public AbstractBasicTr
}
/**
* @brief Reflect object
* @brief Reflect the object
* @param normal Normal of the plane through which to reflect
* (normalized)
* @return Reference to self (for method chaining)
@ -246,7 +246,7 @@ template<class T> class BasicRigidMatrixTransformation3D: public AbstractBasicTr
}
/**
* @brief Reflect object as a local transformation
* @brief Reflect the object as a local transformation
*
* Similar to the above, except that the transformation is applied
* before all others. Same as calling @ref transformLocal() with

16
src/Magnum/SceneGraph/TranslationRotationScalingTransformation2D.h
Unescape View File

@ -106,7 +106,7 @@ template<class T> class BasicTranslationRotationScalingTransformation2D: public
}
/**
* @brief Translate object
* @brief Translate the object
* @return Reference to self (for method chaining)
*
* Note that translation is always applied last, after rotation and
@ -119,7 +119,7 @@ template<class T> class BasicTranslationRotationScalingTransformation2D: public
}
/**
* @brief Translate object as a local transformation
* @brief Translate the object as a local transformation
*
* Equivalent to the above, as translation is commutative. Note that
* translation is always applied last, after rotation and scaling.
@ -129,7 +129,7 @@ template<class T> class BasicTranslationRotationScalingTransformation2D: public
}
/**
* @brief Rotate object using a complex number
* @brief Rotate the object using a complex number
* @param complex Normalized complex number
* @return Reference to self (for method chaining)
*
@ -143,7 +143,7 @@ template<class T> class BasicTranslationRotationScalingTransformation2D: public
}
/**
* @brief Rotate object using a complex number as a local transformation
* @brief Rotate the object using a complex number as a local transformation
*
* Equivalent to the above, as 2D rotation is commutative. Note that
* rotation is always applied after scaling and before translation.
@ -153,7 +153,7 @@ template<class T> class BasicTranslationRotationScalingTransformation2D: public
}
/**
* @brief Rotate object
* @brief Rotate the object
* @param angle Angle (counterclockwise)
* @return Reference to self (for method chaining)
*
@ -167,7 +167,7 @@ template<class T> class BasicTranslationRotationScalingTransformation2D: public
}
/**
* @brief Rotate object as a local transformation
* @brief Rotate the object as a local transformation
*
* Similar to the above, except that the rotation is applied before all
* other rotations. Note that rotation is always applied after scaling
@ -180,7 +180,7 @@ template<class T> class BasicTranslationRotationScalingTransformation2D: public
}
/**
* @brief Scale object
* @brief Scale the object
* @return Reference to self (for method chaining)
*
* Note that scaling is always applied first, before rotation and
@ -193,7 +193,7 @@ template<class T> class BasicTranslationRotationScalingTransformation2D: public
}
/**
* @brief Scale object as a local transformation
* @brief Scale the object as a local transformation
*
* Equivalent to the above, as scaling is commutative. Note that
* scaling is always first, before rotation and translation.

31
src/Magnum/SceneGraph/TranslationRotationScalingTransformation3D.h
Unescape View File

@ -106,7 +106,7 @@ template<class T> class BasicTranslationRotationScalingTransformation3D: public
}
/**
* @brief Translate object
* @brief Translate the object
* @return Reference to self (for method chaining)
*
* Note that translation is always applied last, after rotation and
@ -119,7 +119,7 @@ template<class T> class BasicTranslationRotationScalingTransformation3D: public
}
/**
* @brief Translate object as a local transformation
* @brief Translate the object as a local transformation
*
* Equivalent to the above, as translation is commutative. Note that
* translation is always applied last, after rotation and scaling.
@ -129,7 +129,7 @@ template<class T> class BasicTranslationRotationScalingTransformation3D: public
}
/**
* @brief Rotate object using a quaternion
* @brief Rotate the object using a quaternion
* @param quaternion Normalized quaternion
* @return Reference to self (for method chaining)
*
@ -137,15 +137,14 @@ template<class T> class BasicTranslationRotationScalingTransformation3D: public
* translation. Expects that the quaternion is normalized.
* @see @ref rotate(Math::Rad<T>, const Math::Vector3<T>&),
* @ref rotateLocal(const Math::Quaternion<T>&), @ref rotateX(),
* @ref rotateY(), @ref rotateZ(), @ref Math::Vector3::xAxis(),
* @ref Math::Vector3::yAxis(), @ref Math::Vector3::zAxis()
* @ref rotateY(), @ref rotateZ()
*/
Object<BasicTranslationRotationScalingTransformation3D<T>>& rotate(const Math::Quaternion<T>& quaternion) {
return setRotation(quaternion*_rotation);
}
/**
* @brief Rotate object using a quaternion as a local transformation
* @brief Rotate the object using a quaternion as a local transformation
*
* Similar to the above, except that the rotation is applied before all
* other rotations. Note that rotation is always applied after scaling
@ -156,7 +155,7 @@ template<class T> class BasicTranslationRotationScalingTransformation3D: public
}
/**
* @brief Rotate object
* @brief Rotate the object
* @param angle Angle (counterclockwise)
* @param normalizedAxis Normalized rotation axis
* @return Reference to self (for method chaining)
@ -173,7 +172,7 @@ template<class T> class BasicTranslationRotationScalingTransformation3D: public
}
/**
* @brief Rotate object as a local transformation
* @brief Rotate the object as a local transformation
*
* Similar to the above, except that the rotation is applied before all
* other rotations. Note that rotation is always applied after scaling
@ -186,7 +185,7 @@ template<class T> class BasicTranslationRotationScalingTransformation3D: public
}
/**
* @brief Rotate object around X axis
* @brief Rotate the object around X axis
* @param angle Angle (counterclockwise)
* @return Reference to self (for method chaining)
*
@ -199,7 +198,7 @@ template<class T> class BasicTranslationRotationScalingTransformation3D: public
}
/**
* @brief Rotate object around X axis as a local transformation
* @brief Rotate the object around X axis as a local transformation
*
* Similar to the above, except that the rotation is applied before all
* other rotations. Note that rotation is always applied after scaling
@ -211,7 +210,7 @@ template<class T> class BasicTranslationRotationScalingTransformation3D: public
}
/**
* @brief Rotate object around Y axis
* @brief Rotate the object around Y axis
* @param angle Angle (counterclockwise)
* @return Reference to self (for method chaining)
*
@ -224,7 +223,7 @@ template<class T> class BasicTranslationRotationScalingTransformation3D: public
}
/**
* @brief Rotate object around Y axis as a local transformation
* @brief Rotate the object around Y axis as a local transformation
*
* Similar to the above, except that the rotation is applied before all
* other rotations. Note that rotation is always applied after scaling
@ -236,7 +235,7 @@ template<class T> class BasicTranslationRotationScalingTransformation3D: public
}
/**
* @brief Rotate object around Z axis
* @brief Rotate the object around Z axis
* @param angle Angle (counterclockwise)
* @return Reference to self (for method chaining)
*
@ -249,7 +248,7 @@ template<class T> class BasicTranslationRotationScalingTransformation3D: public
}
/**
* @brief Rotate object around Z axis as a local transformation
* @brief Rotate the object around Z axis as a local transformation
*
* Similar to the above, except that the rotation is applied before all
* other rotations. Note that rotation is always applied after scaling
@ -261,7 +260,7 @@ template<class T> class BasicTranslationRotationScalingTransformation3D: public
}
/**
* @brief Scale object
* @brief Scale the object
* @return Reference to self (for method chaining)
*
* Note that scaling is always applied first, before rotation and
@ -274,7 +273,7 @@ template<class T> class BasicTranslationRotationScalingTransformation3D: public
}
/**
* @brief Scale object as a local transformation
* @brief Scale the object as a local transformation
*
* Equivalent to the above, as scaling is commutative. Note that
* scaling is always first, before rotation and translation.

4
src/Magnum/SceneGraph/TranslationTransformation.h
Unescape View File

@ -83,7 +83,7 @@ class TranslationTransformation: public AbstractTranslation<dimensions, T, Trans
}
/**
* @brief Transform object
* @brief Transform the object
* @return Reference to self (for method chaining)
*
* Equivalent to @ref translate(), provided only for compatibility with
@ -95,7 +95,7 @@ class TranslationTransformation: public AbstractTranslation<dimensions, T, Trans
}
/**
* @brief Translate object
* @brief Translate the object
* @return Reference to self (for method chaining)
*
* There is no difference between global and local translation.

Write Preview
Loading…
Cancel
Save