dali/public-api/math/degree.h

   1 #ifndef __DALI_DEGREE_H__
   2 #define __DALI_DEGREE_H__
   3
   4 /*
   5  * Copyright (c) 2015 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 // INTERNAL INCLUDES
  22 #include <dali/public-api/common/constants.h>
  23 #include <dali/public-api/common/dali-common.h>
  24 #include <dali/public-api/math/math-utils.h>
  25
  26 namespace Dali
  27 {
  28 /**
  29  * @addtogroup dali_core_math
  30  * @{
  31  */
  32
  33 struct Radian;
  34
  35 /**
  36  * @brief An angle in degrees.
  37  *
  38  * This reduces ambiguity when using methods which accept angles in degrees or radians.
  39  */
  40 struct Degree
  41 {
  42   /**
  43    * @brief default constructor, initialises to 0.
  44    */
  45   Degree()
  46   : degree( 0.f )
  47   { }
  48
  49   /**
  50    * @brief Create an angle in degrees.
  51    *
  52    * @param[in] value The initial value in degrees.
  53    */
  54   explicit Degree( float value )
  55   : degree( value )
  56   { }
  57
  58   /**
  59    * @brief Create an angle in degrees from a Radian.
  60    *
  61    * @param[in] value The initial value in Radians.
  62    */
  63   DALI_EXPORT_API Degree( Radian value );
  64
  65 public:
  66
  67   // member data
  68   float degree; ///< The value in degrees
  69
  70 };
  71
  72 // compiler generated destructor, copy constructor and assignment operators are ok as this class is POD
  73
  74 /**
  75  * @brief Compare equality between two degrees.
  76  *
  77  * @param[in] lhs Degree to compare
  78  * @param[in] rhs Degree to compare to
  79  * @return true if the values are identical
  80  */
  81 inline bool operator==( const Degree& lhs, const Degree& rhs )
  82 {
  83   return fabsf( lhs.degree - rhs.degree ) < Math::MACHINE_EPSILON_1000; // expect degree angles to be between 0 and 1000
  84 }
  85
  86 /**
  87  * @brief Compare inequality between two degrees.
  88  *
  89  * @param[in] lhs Degree to compare
  90  * @param[in] rhs Degree to compare to
  91  * @return true if the values are not identical
  92  */
  93 inline bool operator!=( const Degree& lhs, const Degree& rhs )
  94 {
  95   return !( operator==( lhs, rhs ) );
  96 }
  97
  98 /**
  99  * @brief Clamp a radian value
 100  * @param angle to clamp
 101  * @param min value
 102  * @param max value
 103  * @return the resulting radian
 104  */
 105 inline Degree Clamp( Degree angle, float min, float max )
 106 {
 107   return Degree( Clamp<float>( angle.degree, min, max ) );
 108 }
 109
 110 /**
 111  * @}
 112  */
 113 } // namespace Dali
 114
 115 #endif // __DALI_DEGREE_H__