/* This source file is part of Castor3D (http://castor3d.developpez.com/castor3d.htm) This program is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with the program; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA, or go to http://www.gnu.org/copyleft/lesser.txt. */ #ifndef ___CastorAngle___ # define ___CastorAngle___ # include "CastorUtils.hpp" namespace Castor { /*! \author Sylvain DOREMUS \version 0.6.1.0 \date 19/10/2011 \~english \brief Angle helper class \remark Used to manage angles without taking care of degrees or radians \~french \brief Classe d'angle \remark Utilisée pour gérer les angles sans avoir à se préoccuper des convertions degré / radian / gradient */ class Angle { private: real m_rAngle; // Angle in radian public: //!\~english Radian to degree conversion constant \~french Constante de conversion de radian vers degré static const double RadianToDegree; //!\~english Radian to gradient conversion constant \~french Constante de conversion de radian vers gradient static const double RadianToGrad; //!\~english Degree to radian conversion constant \~french Constante de conversion de degré vers radian static const double DegreeToRadian; //!\~english Degree to gradient conversion constant \~french Constante de conversion de degré vers gradient static const double DegreeToGrad; //!\~english Gradient to degree conversion constant \~french Constante de conversion de gradient vers degré static const double GradToDegree; //!\~english Gradient to radian conversion constant \~french Constante de conversion de gradient vers radian static const double GradToRadian; //!\~english Pi constant, expressed in real \~french Constante pi exprimée en real static const real Pi; //!\~english Pi constant, expressed in double \~french Constante pi exprimée en double static const double PiDouble; //!\~english Pi constant, expressed in float \~french Constante pi exprimée en float static const float PiFloat; //!\~english Pi * 2 constant \~french Constante pi * 2 static const real PiMult2; //!\~english Pi / 2 constant \~french Constante pi / 2 static const real PiDiv2; private: /** *\~english *\brief Specified Constructor *\remark Private so specified construction only available through named ctors *\~french *\brief Constructeur spécifié *\remark Privé afin que la construction spécifiée ne soit accessible qu'à partir des constructeurs nommés */ template< typename T > Angle( T p_radians ) : m_rAngle ( real( p_radians ) ) { } public: /** *\~english *\brief Named constructor, from a degrees angle *\param[in] p_degrees The angle in degrees *\return The built angle *\~french *\brief Constructeur nommé, à partir d'un angle en degrés *\param[in] p_degrees L'angle, exprimé en degrés *\return L'angle construit */ template< typename T > static Angle FromDegrees( T p_degrees ) { return Angle( p_degrees * DegreeToRadian ); } /** *\~english *\brief Named constructor, from a radians angle *\param[in] p_radians The angle in radians *\return The built angle *\~french *\brief Constructeur nommé, à partir d'un angle en radians *\param[in] p_radians L'angle, exprimé en radians *\return L'angle construit */ template< typename T > static Angle FromRadians( T p_radians ) { return Angle( p_radians * 1.0 ); } /** *\~english *\brief Named constructor, from a gradients angle *\param[in] p_grads The angle in gradients *\return The built angle *\~french *\brief Constructeur nommé, à partir d'un angle en gradients *\param[in] p_grads L'angle, exprimé en gradients *\return L'angle construit */ template< typename T > static Angle FromGrads( T p_grads ) { return Angle( p_grads * GradToRadian ); } /** *\~english *\brief Default constructor *\~french *\brief Constructeur par défaut */ Angle(); /** *\~english *\brief Destructor *\~french *\brief Destructeur */ ~Angle(); /** *\~english *\brief Copy constructor *\param[in] p_copy The object to copy *\~french *\brief Constructeur par copie *\param[in] p_copy L'objet à copier */ Angle( Angle const & p_angle ); /** *\~english *\brief Move constructor *\param[in] p_copy The object to move *\~french *\brief Constructeur par déplacement *\param[in] p_copy L'objet à déplacer */ Angle( Angle && p_angle ); /** *\~english *\brief Copy assignment operator *\param[in] p_copy The object to copy *\return A reference to this object *\~french *\brief Opérateur d'affectation par copie *\param[in] p_copy L'objet à copier *\return Une référence sur cet objet */ Angle & operator =( Angle const & p_angle ); /** *\~english *\brief Move assignment operator *\param[in] p_copy The object to move *\return A reference to this object *\~french *\brief Opérateur d'affectation par déplacement *\param[in] p_copy L'objet à déplacer *\return Une référence sur cet objet */ Angle & operator =( Angle && p_angle ); /** *\~english *\brief Conversion to degrees *\return Angle value, in degrees *\~french *\brief Conversion en degrés *\return La valeur de l'angle, en degrés */ real Degrees()const; /** *\~english *\brief Conversion to radians *\return Angle value, in radians *\~french *\brief Conversion en radians *\return La valeur de l'angle, en radians */ real Radians()const; /** *\~english *\brief Conversion to gradients *\return Angle value, in gradients *\~french *\brief Conversion en gradients *\return La valeur de l'angle, en gradients */ real Grads()const; /** *\~english *\brief Sets this angle value from degrees *\param[in] p_rAngle Angle in degrees *\return Reference to this angle *\~french *\brief Définit la valeur de cet angle à partir de degrés *\param[in] p_rAngle L'angle exprimé en degrés *\return Une référence sur cet angle */ Angle & Degrees( real p_rAngle ); /** *\~english *\brief Sets this angle value from radians *\param[in] p_rAngle Angle in radians *\return Reference to this angle *\~french *\brief Définit la valeur de cet angle à partir de radians *\param[in] p_rAngle L'angle exprimé en radians *\return Une référence sur cet angle */ Angle & Radians( real p_rAngle ); /** *\~english *\brief Sets this angle value from gradients *\param[in] p_rAngle Angle in gradients *\return Reference to this angle *\~french *\brief Définit la valeur de cet angle à partir de gradients *\param[in] p_rAngle L'angle exprimé en gradients *\return Une référence sur cet angle */ Angle & Grads( real p_rAngle ); /** *\~english *\brief Trigonometric cosine *\return Cosine of this angle *\~french *\brief Cosinus trigonométrique *\return Le cosinus de cet angle */ real Cos()const; /** *\~english *\brief Trigonometric sine *\return sine of this angle *\~french *\brief Sinus trigonométrique *\return Le sinus de cet angle */ real Sin()const; /** *\~english *\brief Trigonometric tangent *\return Tangent of this angle *\~french *\brief Tangente trigonométrique *\return La tangente de cet angle */ real Tan()const; /** *\~english *\brief Hyperbolic cosine *\return Hyperbolic cosine of this angle *\~french *\brief Cosinus hyperbolique *\return Le cosinus hyperbolique de cet angle */ real Cosh()const; /** *\~english *\brief Hyperbolic sine *\return Hyperbolic sine of this angle *\~french *\brief Sinus hyperbolique *\return Le sinus hyperbolique de cet angle */ real Sinh()const; /** *\~english *\brief Hyperbolic tangent *\return Hyperbolic tangent of this angle *\~french *\brief Tangente hyperbolique *\return La tangente hyperbolique de cet angle */ real Tanh()const; /** *\~english *\brief Computes this angle's value from the given cosine value *\param[in] p_rValue The cosine value *\return A reference to this angle *\~french *\brief Calcule la valeur de cet angle à partir du cosinus donné *\param[in] p_rValue Le cosinus *\return Une référence sur cet angle */ Angle & ACos( real p_rValue ); /** *\~english *\brief Computes this angle's value from the given sine value *\param[in] p_rValue The sine value *\return A reference to this angle *\~french *\brief Calcule la valeur de cet angle à partir du sinus donné *\param[in] p_rValue Le sinus *\return Une référence sur cet angle */ Angle & ASin( real p_rValue ); /** *\~english *\brief Computes this angle's value from the given tangent value *\param[in] p_rValue The tangent value *\return A reference to this angle *\~french *\brief Calcule la valeur de cet angle à partir de la tangente donné *\param[in] p_rValue La tangente *\return Une référence sur cet angle */ Angle & ATan( real p_rValue ); /** *\~english *\brief Equality operator *\param[in] p_angle Angle to test *\return \p true if this angle is equal to p_angle *\~french *\brief Opérateur d'égalité *\param[in] p_angle L'angle à tester *\return \p true si cet angle est égal à p_angle */ bool operator ==( Angle const & p_angle ); /** *\~english *\brief Addition assignment operator *\param[in] p_angle Angle to add to this one *\return A reference to this angle *\~french *\brief Opérateur d'affection par addition *\param[in] p_angle L'angle à ajouter à celui-ci *\return Une référence sur cet angle */ Angle & operator +=( Angle const & p_angle ); /** *\~english *\brief Substraction assignment operator *\param[in] p_angle Angle to substract to this one *\return A reference to this angle *\~french *\brief Opérateur d'affection par soustraction *\param[in] p_angle L'angle à soustraire de celui-ci *\return Une référence sur cet angle */ Angle & operator -=( Angle const & p_angle ); /** *\~english *\brief Multiplication assignment operator *\param[in] p_angle Angle to multiply to this one *\return A reference to this angle *\~french *\brief Opérateur d'affection par multiplication *\param[in] p_angle L'angle à multiplier à celui-ci *\return Une référence sur cet angle */ Angle & operator *=( Angle const & p_angle ); /** *\~english *\brief Division assignment operator *\param[in] p_angle Angle divider of this one *\return A reference to this angle *\~french *\brief Opérateur d'affection par division *\param[in] p_angle L'angle diviseur de celui-ci *\return Une référence sur cet angle */ Angle & operator /=( Angle const & p_angle ); /** *\~english *\brief Multiplication assignment operator *\param[in] p_scalar Scalar to multiply to this one *\return A reference to this angle *\~french *\brief Opérateur d'affection par multiplication *\param[in] p_scalar Le scalaire à multiplier à celui-ci *\return Une référence sur cet angle */ Angle & operator *=( real p_scalar ); /** *\~english *\brief Division assignment operator *\param[in] p_scalar Scalar divider of this one *\return A reference to this angle *\~french *\brief Opérateur d'affection par division *\param[in] p_scalar Le scalaire diviseur de celui-ci *\return Une référence sur cet angle */ Angle & operator /=( real p_scalar ); }; /** *\~english *\brief Addition operator *\param[in] p_angleA First operand *\param[in] p_angleB Second operand *\return Result of addition *\~french *\brief Opérateur d'addition *\param[in] p_angleA Premier opérande *\param[in] p_angleB Second opérande *\return Le résultat de l'addition */ Angle operator +( Angle const & p_angleA, Angle const & p_angleB ); /** *\~english *\brief Substraction operator *\param[in] p_angleA First operand *\param[in] p_angleB Second operand *\return Result of substraction *\~french *\brief Opérateur de soustraction *\param[in] p_angleA Premier opérande *\param[in] p_angleB Second opérande *\return Le résultat de la soustraction */ Angle operator -( Angle const & p_angleA, Angle const & p_angleB ); /** *\~english *\brief Multiplication operator *\param[in] p_angleA First operand *\param[in] p_angleB Second operand *\return Result of multiplication *\~french *\brief Opérateur de multiplication *\param[in] p_angleA Premier opérande *\param[in] p_angleB Second opérande *\return Le résultat de la multiplication */ Angle operator *( Angle const & p_angleA, Angle const & p_angleB ); /** *\~english *\brief Division operator *\param[in] p_angleA First operand *\param[in] p_angleB Second operand *\return Result of division *\~french *\brief Opérateur de division *\param[in] p_angleA Premier opérande *\param[in] p_angleB Second opérande *\return Le résultat de la division */ Angle operator /( Angle const & p_angleA, Angle const & p_angleB ); /** *\~english *\brief Multiplication operator *\param[in] p_angle First operand *\param[in] p_scalar Second operand *\return Result of multiplication *\~french *\brief Opérateur de multiplication *\param[in] p_angle Premier opérande *\param[in] p_scalar Second opérande *\return Le résultat de la multiplication */ Angle operator *( Angle const & p_angle, real p_scalar ); /** *\~english *\brief Division operator *\param[in] p_angle First operand *\param[in] p_scalar Second operand *\return Result of division *\~french *\brief Opérateur de division *\param[in] p_angle Premier opérande *\param[in] p_scalar Second opérande *\return Le résultat de la division */ Angle operator /( Angle const & p_angle, real p_scalar ); } #endif