1 #ifndef __DALI_DEGREE_H__
2 #define __DALI_DEGREE_H__
5 * Copyright (c) 2015 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
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>
32 * @brief An angle in degrees.
34 * This reduces ambiguity when using methods which accept angles in degrees or radians.
39 * @brief default constructor, initialises to 0.
46 * @brief Create an angle in degrees.
48 * @param[in] value The initial value in degrees.
50 explicit Degree( float value )
55 * @brief Create an angle in degrees from a Radian.
57 * @param[in] value The initial value in Radians.
59 DALI_EXPORT_API Degree( Radian value );
64 float degree; ///< The value in degrees
68 // compiler generated destructor, copy constructor and assignment operators are ok as this class is POD
71 * @brief Compare equality between two degrees.
73 * @param[in] lhs Degree to compare
74 * @param[in] rhs Degree to compare to
75 * @return true if the values are identical
77 inline bool operator==( const Degree& lhs, const Degree& rhs )
79 return fabsf( lhs.degree - rhs.degree ) < Math::MACHINE_EPSILON_1000; // expect degree angles to be between 0 and 1000
83 * @brief Compare inequality between two degrees.
85 * @param[in] lhs Degree to compare
86 * @param[in] rhs Degree to compare to
87 * @return true if the values are not identical
89 inline bool operator!=( const Degree& lhs, const Degree& rhs )
91 return !( operator==( lhs, rhs ) );
95 * @brief Clamp a radian value
96 * @param angle to clamp
99 * @return the resulting radian
101 inline Degree Clamp( Degree angle, float min, float max )
103 return Degree( Clamp<float>( angle.degree, min, max ) );
108 #endif // __DALI_DEGREE_H__