Browse Source

Math: code cleanup, doc++

pull/7/head
Vladimír Vondruš 13 years ago
parent
commit
e94a596a80
  1. 3
      src/Math/DualQuaternion.h
  2. 5
      src/Math/Matrix3.h
  3. 7
      src/Math/Matrix4.h
  4. 11
      src/Math/Quaternion.h

3
src/Math/DualQuaternion.h

@ -29,7 +29,8 @@ namespace Magnum { namespace Math {
@brief %Dual quaternion
@tparam T Underlying data type
@see Dual, Quaternion
Represents 3D rotation and translation.
@see Dual, Quaternion, Matrix4
*/
template<class T> class DualQuaternion: public Dual<Quaternion<T>> {
public:

5
src/Math/Matrix3.h

@ -25,11 +25,10 @@
namespace Magnum { namespace Math {
/**
@brief 3x3 matrix for transformations in 2D
@brief 3x3 matrix
@tparam T Underlying data type
Provides functions for transformations in 2D. See Matrix4 for 3D
transformations. See also @ref matrix-vector for brief introduction.
Represents 2D transformation. See @ref matrix-vector for brief introduction.
@see Magnum::Matrix3, SceneGraph::MatrixTransformation2D
@configurationvalueref{Magnum::Math::Matrix3}
*/

7
src/Math/Matrix4.h

@ -25,12 +25,11 @@
namespace Magnum { namespace Math {
/**
@brief 4x4 matrix for transformations in 3D
@brief 4x4 matrix
@tparam T Underlying data type
Provides functions for transformations in 3D. See Matrix3 for 2D
transformations. See also @ref matrix-vector for brief introduction.
@see Magnum::Matrix4, SceneGraph::MatrixTransformation3D
Represents 3D transformation. See @ref matrix-vector for brief introduction.
@see Magnum::Matrix4, DualQuaternion, SceneGraph::MatrixTransformation3D
@configurationvalueref{Magnum::Math::Matrix4}
*/
template<class T> class Matrix4: public Matrix<4, T> {

11
src/Math/Quaternion.h

@ -34,7 +34,8 @@ namespace Magnum { namespace Math {
@brief %Quaternion
@tparam T Underlying data type
@see DualQuaternion, Magnum::Quaternion
Represents 3D rotation.
@see Magnum::Quaternion, DualQuaternion, Matrix4
*/
template<class T> class Quaternion {
public:
@ -238,7 +239,7 @@ template<class T> class Quaternion {
* @see operator+=()
*/
inline Quaternion<T> operator+(const Quaternion<T>& other) const {
return Quaternion<T>(*this)+=other;
return Quaternion<T>(*this) += other;
}
/**
@ -271,7 +272,7 @@ template<class T> class Quaternion {
* @see operator-=()
*/
inline Quaternion<T> operator-(const Quaternion<T>& other) const {
return Quaternion<T>(*this)-=other;
return Quaternion<T>(*this) -= other;
}
/**
@ -293,7 +294,7 @@ template<class T> class Quaternion {
* @see operator*=(T)
*/
inline Quaternion<T> operator*(T scalar) const {
return Quaternion<T>(*this)*=scalar;
return Quaternion<T>(*this) *= scalar;
}
/**
@ -315,7 +316,7 @@ template<class T> class Quaternion {
* @see operator/=(T)
*/
inline Quaternion<T> operator/(T scalar) const {
return Quaternion<T>(*this)/=scalar;
return Quaternion<T>(*this) /= scalar;
}
/**

Loading…
Cancel
Save