|
|
@@ -53,14 +53,16 @@ namespace glm
|
|
|
/// @{
|
|
|
|
|
|
//! Compute a cross product between a quaternion and a vector.
|
|
|
- //! From GLM_GTX_quaternion extension.
|
|
|
+ ///
|
|
|
+ /// @see gtx_quaternion
|
|
|
template <typename valType>
|
|
|
detail::tvec3<valType> cross(
|
|
|
detail::tquat<valType> const & q,
|
|
|
detail::tvec3<valType> const & v);
|
|
|
|
|
|
//! Compute a cross product between a vector and a quaternion.
|
|
|
- //! From GLM_GTX_quaternion extension.
|
|
|
+ ///
|
|
|
+ /// @see gtx_quaternion
|
|
|
template <typename valType>
|
|
|
detail::tvec3<valType> cross(
|
|
|
detail::tvec3<valType> const & v,
|
|
|
@@ -68,7 +70,8 @@ namespace glm
|
|
|
|
|
|
//! Compute a point on a path according squad equation.
|
|
|
//! q1 and q2 are control points; s1 and s2 are intermediate control points.
|
|
|
- //! From GLM_GTX_quaternion extension.
|
|
|
+ ///
|
|
|
+ /// @see gtx_quaternion
|
|
|
template <typename valType>
|
|
|
detail::tquat<valType> squad(
|
|
|
detail::tquat<valType> const & q1,
|
|
|
@@ -78,7 +81,8 @@ namespace glm
|
|
|
valType const & h);
|
|
|
|
|
|
//! Returns an intermediate control point for squad interpolation.
|
|
|
- //! From GLM_GTX_quaternion extension.
|
|
|
+ ///
|
|
|
+ /// @see gtx_quaternion
|
|
|
template <typename valType>
|
|
|
detail::tquat<valType> intermediate(
|
|
|
detail::tquat<valType> const & prev,
|
|
|
@@ -86,59 +90,70 @@ namespace glm
|
|
|
detail::tquat<valType> const & next);
|
|
|
|
|
|
//! Returns a exp of a quaternion.
|
|
|
- //! From GLM_GTX_quaternion extension.
|
|
|
+ ///
|
|
|
+ /// @see gtx_quaternion
|
|
|
template <typename valType>
|
|
|
detail::tquat<valType> exp(
|
|
|
detail::tquat<valType> const & q,
|
|
|
valType const & exponent);
|
|
|
|
|
|
//! Returns a log of a quaternion.
|
|
|
- //! From GLM_GTX_quaternion extension.
|
|
|
+ ///
|
|
|
+ /// @see gtx_quaternion
|
|
|
template <typename valType>
|
|
|
detail::tquat<valType> log(
|
|
|
detail::tquat<valType> const & q);
|
|
|
|
|
|
- //! Returns x raised to the y power.
|
|
|
- //! From GLM_GTX_quaternion extension.
|
|
|
+ /// Returns x raised to the y power.
|
|
|
+ ///
|
|
|
+ /// @see gtx_quaternion
|
|
|
template <typename valType>
|
|
|
detail::tquat<valType> pow(
|
|
|
detail::tquat<valType> const & x,
|
|
|
valType const & y);
|
|
|
|
|
|
//! Returns quarternion square root.
|
|
|
- //! From GLM_GTX_quaternion extension.
|
|
|
+ ///
|
|
|
+ /// @see gtx_quaternion
|
|
|
//template <typename valType>
|
|
|
//detail::tquat<valType> sqrt(
|
|
|
// detail::tquat<valType> const & q);
|
|
|
|
|
|
//! Rotates a 3 components vector by a quaternion.
|
|
|
- //! From GLM_GTX_transform extension.
|
|
|
+ ///
|
|
|
+ /// @see gtx_quaternion
|
|
|
template <typename valType>
|
|
|
detail::tvec3<valType> rotate(
|
|
|
detail::tquat<valType> const & q,
|
|
|
detail::tvec3<valType> const & v);
|
|
|
|
|
|
- //! Rotates a 4 components vector by a quaternion.
|
|
|
- //! From GLM_GTX_transform extension.
|
|
|
+ /// Rotates a 4 components vector by a quaternion.
|
|
|
+ ///
|
|
|
+ /// @see gtx_quaternion
|
|
|
template <typename valType>
|
|
|
detail::tvec4<valType> rotate(
|
|
|
detail::tquat<valType> const & q,
|
|
|
detail::tvec4<valType> const & v);
|
|
|
|
|
|
- //! Returns the quaternion rotation angle.
|
|
|
- //! From GLM_GTX_quaternion extension.
|
|
|
+ /// Returns the quaternion rotation angle.
|
|
|
+ ///
|
|
|
+ /// @see gtx_quaternion
|
|
|
template <typename valType>
|
|
|
valType angle(
|
|
|
detail::tquat<valType> const & x);
|
|
|
|
|
|
- //! Returns the q rotation axis.
|
|
|
- //! From GLM_GTX_quaternion extension.
|
|
|
+ /// Returns the q rotation axis.
|
|
|
+ ///
|
|
|
+ /// @see gtx_quaternion
|
|
|
template <typename valType>
|
|
|
detail::tvec3<valType> axis(
|
|
|
detail::tquat<valType> const & x);
|
|
|
|
|
|
- //! Build a quaternion from an angle and a normalized axis.
|
|
|
- //! From GLM_GTX_quaternion extension.
|
|
|
+ /// Build a quaternion from an angle and a normalized axis.
|
|
|
+ ///
|
|
|
+ /// @param angle Angle expressed in radians if GLM_FORCE_RADIANS is define or degrees otherwise.
|
|
|
+ ///
|
|
|
+ /// @see gtx_quaternion
|
|
|
template <typename valType>
|
|
|
detail::tquat<valType> angleAxis(
|
|
|
valType const & angle,
|
|
|
@@ -146,77 +161,92 @@ namespace glm
|
|
|
valType const & y,
|
|
|
valType const & z);
|
|
|
|
|
|
- //! Build a quaternion from an angle and a normalized axis.
|
|
|
- //! From GLM_GTX_quaternion extension.
|
|
|
+ /// Build a quaternion from an angle and a normalized axis.
|
|
|
+ ///
|
|
|
+ /// @param angle Angle expressed in radians if GLM_FORCE_RADIANS is define or degrees otherwise.
|
|
|
+ /// @param axis Axis of the quaternion, must be normalized.
|
|
|
+ ///
|
|
|
+ /// @see gtx_quaternion
|
|
|
template <typename valType>
|
|
|
detail::tquat<valType> angleAxis(
|
|
|
valType const & angle,
|
|
|
detail::tvec3<valType> const & axis);
|
|
|
|
|
|
- //! Extract the real component of a quaternion.
|
|
|
- //! From GLM_GTX_quaternion extension.
|
|
|
+ /// Extract the real component of a quaternion.
|
|
|
+ ///
|
|
|
+ /// @see gtx_quaternion
|
|
|
template <typename valType>
|
|
|
valType extractRealComponent(
|
|
|
detail::tquat<valType> const & q);
|
|
|
|
|
|
- //! Returns roll value of euler angles in degrees.
|
|
|
- //! From GLM_GTX_quaternion extension.
|
|
|
+ /// Returns roll value of euler angles expressed in radians if GLM_FORCE_RADIANS is define or degrees otherwise.
|
|
|
+ ///
|
|
|
+ /// @see gtx_quaternion
|
|
|
template <typename valType>
|
|
|
valType roll(
|
|
|
detail::tquat<valType> const & x);
|
|
|
|
|
|
- //! Returns pitch value of euler angles in degrees.
|
|
|
- //! From GLM_GTX_quaternion extension.
|
|
|
+ /// Returns pitch value of euler angles expressed in radians if GLM_FORCE_RADIANS is define or degrees otherwise.
|
|
|
+ ///
|
|
|
+ /// @see gtx_quaternion
|
|
|
template <typename valType>
|
|
|
valType pitch(
|
|
|
detail::tquat<valType> const & x);
|
|
|
|
|
|
- //! Returns yaw value of euler angles in degrees.
|
|
|
- //! From GLM_GTX_quaternion extension.
|
|
|
+ /// Returns yaw value of euler angles expressed in radians if GLM_FORCE_RADIANS is define or degrees otherwise.
|
|
|
+ ///
|
|
|
+ /// @see gtx_quaternion
|
|
|
template <typename valType>
|
|
|
valType yaw(
|
|
|
detail::tquat<valType> const & x);
|
|
|
|
|
|
- //! Returns euler angles, yitch as x, yaw as y, roll as z.
|
|
|
- //! From GLM_GTX_quaternion extension.
|
|
|
+ /// Returns euler angles, yitch as x, yaw as y, roll as z.
|
|
|
+ ///
|
|
|
+ /// @see gtx_quaternion
|
|
|
template <typename valType>
|
|
|
detail::tvec3<valType> eulerAngles(
|
|
|
detail::tquat<valType> const & x);
|
|
|
|
|
|
- //! Converts a quaternion to a 3 * 3 matrix.
|
|
|
- //! From GLM_GTX_quaternion extension.
|
|
|
+ /// Converts a quaternion to a 3 * 3 matrix.
|
|
|
+ ///
|
|
|
+ /// @see gtx_quaternion
|
|
|
template <typename valType>
|
|
|
detail::tmat3x3<valType> toMat3(
|
|
|
detail::tquat<valType> const & x){return mat3_cast(x);}
|
|
|
|
|
|
- //! Converts a quaternion to a 4 * 4 matrix.
|
|
|
- //! From GLM_GTX_quaternion extension.
|
|
|
+ /// Converts a quaternion to a 4 * 4 matrix.
|
|
|
+ ///
|
|
|
+ /// @see gtx_quaternion
|
|
|
template <typename valType>
|
|
|
detail::tmat4x4<valType> toMat4(
|
|
|
detail::tquat<valType> const & x){return mat4_cast(x);}
|
|
|
|
|
|
- //! Converts a 3 * 3 matrix to a quaternion.
|
|
|
- //! From GLM_GTX_quaternion extension.
|
|
|
+ /// Converts a 3 * 3 matrix to a quaternion.
|
|
|
+ ///
|
|
|
+ /// @see gtx_quaternion
|
|
|
template <typename valType>
|
|
|
detail::tquat<valType> toQuat(
|
|
|
detail::tmat3x3<valType> const & x){return quat_cast(x);}
|
|
|
|
|
|
- //! Converts a 4 * 4 matrix to a quaternion.
|
|
|
- //! From GLM_GTX_quaternion extension.
|
|
|
+ /// Converts a 4 * 4 matrix to a quaternion.
|
|
|
+ ///
|
|
|
+ /// @see gtx_quaternion
|
|
|
template <typename valType>
|
|
|
detail::tquat<valType> toQuat(
|
|
|
detail::tmat4x4<valType> const & x){return quat_cast(x);}
|
|
|
|
|
|
- //! Quaternion interpolation using the rotation short path.
|
|
|
- //! From GLM_GTX_quaternion extension.
|
|
|
+ /// Quaternion interpolation using the rotation short path.
|
|
|
+ ///
|
|
|
+ /// @see gtx_quaternion
|
|
|
template <typename T>
|
|
|
detail::tquat<T> shortMix(
|
|
|
detail::tquat<T> const & x,
|
|
|
detail::tquat<T> const & y,
|
|
|
T const & a);
|
|
|
|
|
|
- //! Quaternion normalized linear interpolation.
|
|
|
- //! From GLM_GTX_quaternion extension.
|
|
|
+ /// Quaternion normalized linear interpolation.
|
|
|
+ ///
|
|
|
+ /// @see gtx_quaternion
|
|
|
template <typename T>
|
|
|
detail::tquat<T> fastMix(
|
|
|
detail::tquat<T> const & x,
|