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

Math: better documentation for vector/quat constructors.

pull/7/head
Vladimír Vondruš 13 years ago
parent
3ad264893e
commit
5673cf2656
8 changed files with 77 additions and 37 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. 6
      src/Math/DualQuaternion.h
  2. 21
      src/Math/Point2D.h
  3. 22
      src/Math/Point3D.h
  4. 24
      src/Math/Quaternion.h
  5. 8
      src/Math/Vector.h
  6. 6
      src/Math/Vector2.h
  7. 13
      src/Math/Vector3.h
  8. 14
      src/Math/Vector4.h

6
src/Math/DualQuaternion.h
Unescape View File

@ -64,7 +64,9 @@ template<class T> class DualQuaternion: public Dual<Quaternion<T>> {
/**
* @brief Default constructor
*
* All components set to zero except real scalar part, which is `1`.
* @f[
* \hat q = [\boldsymbol 0, 1] + \epsilon [\boldsymbol 0, 0]
* @f]
* @todoc Remove workaround when Doxygen is predictable
*/
#ifdef DOXYGEN_GENERATING_OUTPUT
@ -148,7 +150,7 @@ template<class T> class DualQuaternion: public Dual<Quaternion<T>> {
* @brief Conjugated dual quaternion
*
* Both quaternion and dual conjugation. @f[
* \overline{\hat q^*} = q_0^* - \epsilon q_\epsilon^* = q_0^* + \epsilon [\boldsymbol q_{\epsilon V}, -q_S]
* \overline{\hat q^*} = q_0^* - \epsilon q_\epsilon^* = q_0^* + \epsilon [\boldsymbol q_{V \epsilon}, -q_{S \epsilon}]
* @f]
* @see quaternionConjugated(), dualConjugated(), Quaternion::conjugated(),
* Dual::conjugated()

21
src/Math/Point2D.h
Unescape View File

@ -37,29 +37,36 @@ template<class T> class Point2D: public Vector3<T> {
/**
* @brief Default constructor
*
* X and Y components are set to zero, Z is set to one.
* @f[
* \boldsymbol p = (0, 0, 1)^T
* @f]
*/
inline constexpr /*implicit*/ Point2D(): Vector3<T>(T(0), T(0), T(1)) {}
/**
* @brief Constructor
* @param x X component
* @param y Y component
* @param z Z component
*
* @f[
* \boldsymbol p = (x, y, z)^T
* @f]
*/
inline constexpr /*implicit*/ Point2D(T x, T y, T z = T(1)): Vector3<T>(x, y, z) {}
/**
* @brief Constructor
* @param xy Two-component vector
* @param z Z component
*
* @f[
* \boldsymbol p = (v_x, v_y, z)^T
* @f]
*/
inline constexpr /*implicit*/ Point2D(const Vector2<T>& xy, T z): Vector3<T>(xy, z) {}
/**
* @brief Construct 2D point from 2D vector
*
* Z component is set to `1`.
* @f[
* \boldsymbol p = (v_x, v_y, 1)^T
* @f]
*/
inline constexpr explicit Point2D(const Vector2<T>& xy): Vector3<T>(xy, T(1)) {}

22
src/Math/Point3D.h
Unescape View File

@ -37,30 +37,36 @@ template<class T> class Point3D: public Vector4<T> {
/**
* @brief Default constructor
*
* X, Y and Z components are set to zero, W is set to one.
* @f[
* \boldsymbol p = (0, 0, 0, 1)^T
* @f]
*/
inline constexpr /*implicit*/ Point3D(): Vector4<T>(T(0), T(0), T(0), T(1)) {}
/**
* @brief Constructor
* @param x X component
* @param y Y component
* @param z Z component
* @param w W component
*
* @f[
* \boldsymbol p = (x, y, z, w)^T
* @f]
*/
inline constexpr /*implicit*/ Point3D(T x, T y, T z, T w = T(1)): Vector4<T>(x, y, z, w) {}
/**
* @brief Constructor
* @param xyz Three-component vector
* @param w W component
*
* @f[
* \boldsymbol p = (v_x, v_y, v_z, w)^T
* @f]
*/
inline constexpr /*implicit*/ Point3D(const Vector3<T>& xyz, T w): Vector4<T>(xyz, w) {}
/**
* @brief Construct 3D point from 3D vector
*
* W component is set to `1`.
* @f[
* \boldsymbol p = (v_x, v_y, v_z, 1)^T
* @f]
*/
inline constexpr explicit Point3D(const Vector3<T>& xyz): Vector4<T>(xyz, T(1)) {}

24
src/Math/Quaternion.h
Unescape View File

@ -124,17 +124,28 @@ template<class T> class Quaternion {
/**
* @brief Default constructor
*
* %Vector part is set to zero, scalar part to `1`.
* @f[
* q = [\boldsymbol 0, 1]
* @f]
*/
inline constexpr /*implicit*/ Quaternion(): _scalar(T(1)) {}
/** @brief Create quaternion from vector and scalar */
/**
* @brief Construct quaternion from vector and scalar
*
* @f[
* q = [\boldsymbol v, s]
* @f]
*/
inline constexpr /*implicit*/ Quaternion(const Vector3<T>& vector, T scalar): _vector(vector), _scalar(scalar) {}
/**
* @brief Create quaternion from vector
* @brief Construct quaternion from vector
*
* Scalar is set to `0`.
* To be used in transformations later. @f[
* q = [\boldsymbol v, 0]
* @f]
* @see rotateVector(), rotateVectorNormalized()
*/
inline constexpr explicit Quaternion(const Vector3<T>& vector): _vector(vector), _scalar(T(0)) {}
@ -388,10 +399,10 @@ template<class T> class Quaternion {
/**
* @brief Rotate vector with quaternion
*
* @f[
* See rotateVectorNormalized(), which is faster for normalized
* quaternions. @f[
* v' = qvq^{-1} = q [\boldsymbol v, 0] q^{-1}
* @f]
* @see rotateVectorNormalized()
*/
inline Vector3<T> rotateVector(const Vector3<T>& vector) const {
return ((*this)*Quaternion<T>(vector)*inverted()).vector();
@ -404,6 +415,7 @@ template<class T> class Quaternion {
* normalized. @f[
* v' = qvq^{-1} = qvq^* = q [\boldsymbol v, 0] q^*
* @f]
* @see DualQuaternion::transformVectorNormalized()
*/
inline Vector3<T> rotateVectorNormalized(const Vector3<T>& vector) const {
CORRADE_ASSERT(MathTypeTraits<T>::equals(dot(), T(1)),

8
src/Math/Vector.h
Unescape View File

@ -90,7 +90,13 @@ template<std::size_t size, class T> class Vector {
return std::acos(dot(normalizedA, normalizedB));
}
/** @brief Construct zero-filled vector */
/**
* @brief Default constructor
*
* @f[
* \boldsymbol v = \boldsymbol 0
* @f]
*/
inline constexpr /*implicit*/ Vector(): _data() {}
/** @todo Creating Vector from combination of vector and scalar types */

6
src/Math/Vector2.h
Unescape View File

@ -79,8 +79,10 @@ template<class T> class Vector2: public Vector<2, T> {
/**
* @brief Constructor
* @param x X component
* @param y Y component
*
* @f[
* \boldsymbol v = (x, y)^T
* @f]
*/
inline constexpr /*implicit*/ Vector2(T x, T y): Vector<2, T>(x, y) {}

13
src/Math/Vector3.h
Unescape View File

@ -112,16 +112,19 @@ template<class T> class Vector3: public Vector<3, T> {
/**
* @brief Constructor
* @param x X component
* @param y Y component
* @param z Z component
*
* @f[
* \boldsymbol v = (x, y, z)^T
* @f]
*/
inline constexpr /*implicit*/ Vector3(T x, T y, T z): Vector<3, T>(x, y, z) {}
/**
* @brief Constructor
* @param xy Two-component vector
* @param z Z component
*
* @f[
* \boldsymbol v = (v_x, v_y, z)^T
* @f]
*/
inline constexpr /*implicit*/ Vector3(const Vector2<T>& xy, T z): Vector<3, T>(xy[0], xy[1], z) {}

14
src/Math/Vector4.h
Unescape View File

@ -42,17 +42,19 @@ template<class T> class Vector4: public Vector<4, T> {
/**
* @brief Constructor
* @param x X component
* @param y Y component
* @param z Z component
* @param w W component
*
* @f[
* \boldsymbol v = (x, y, z, w)^T
* @f]
*/
inline constexpr /*implicit*/ Vector4(T x, T y, T z, T w): Vector<4, T>(x, y, z, w) {}
/**
* @brief Constructor
* @param xyz Three-component vector
* @param w W component
*
* @f[
* \boldsymbol v = (v_x, v_y, v_z, w)^T
* @f]
*/
inline constexpr /*implicit*/ Vector4(const Vector3<T>& xyz, T w): Vector<4, T>(xyz[0], xyz[1], xyz[2], w) {}

Write Preview
Loading…
Cancel
Save