dali/public-api/common/constants.h

   1 #ifndef __DALI_CONSTANTS_H__
   2 #define __DALI_CONSTANTS_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 // EXTERNAL INCLUDES
  22 #include <math.h> // M_PI
  23
  24 // INTERNAL INCLUDES
  25 #include <dali/public-api/math/vector3.h>
  26 #include <dali/public-api/math/vector4.h>
  27
  28 namespace Dali
  29 {
  30 /**
  31  * @addtogroup dali_core_common
  32  * @{
  33  */
  34
  35 /**
  36  * @brief ParentOrigin constants
  37  *
  38  * Note that for 2D layouting, the typical Z position is 0.5f (not 0.0f)
  39  */
  40 namespace ParentOrigin
  41 {
  42 extern const Vector3 DEFAULT; ///< TOP_LEFT
  43 static const float TOP = 0.0f;
  44 static const float BOTTOM = 1.0f;
  45 static const float LEFT = 0.0f;
  46 static const float RIGHT = 1.0f;
  47 static const float MIDDLE = 0.5f;
  48
  49 DALI_IMPORT_API extern const Vector3 TOP_LEFT;           ///< 0.0f, 0.0f, 0.5f
  50 DALI_IMPORT_API extern const Vector3 TOP_CENTER;         ///< 0.5f, 0.0f, 0.5f
  51 DALI_IMPORT_API extern const Vector3 TOP_RIGHT;          ///< 1.0f, 0.0f, 0.5f
  52 DALI_IMPORT_API extern const Vector3 CENTER_LEFT;        ///< 0.0f, 0.5f, 0.5f
  53 DALI_IMPORT_API extern const Vector3 CENTER;             ///< 0.5f, 0.5f, 0.5f
  54 DALI_IMPORT_API extern const Vector3 CENTER_RIGHT;       ///< 1.0f, 0.5f, 0.5f
  55 DALI_IMPORT_API extern const Vector3 BOTTOM_LEFT;        ///< 0.0f, 1.0f, 0.5f
  56 DALI_IMPORT_API extern const Vector3 BOTTOM_CENTER;      ///< 0.5f, 1.0f, 0.5f
  57 DALI_IMPORT_API extern const Vector3 BOTTOM_RIGHT;       ///< 1.0f, 1.0f, 0.5f
  58
  59 }
  60
  61 /**
  62  * @brief AnchorPoint constants
  63  *
  64  * Note that for 2D layouting, the typical Z position is 0.5f (not 0.0f)
  65  */
  66 namespace AnchorPoint
  67 {
  68 static const float TOP = 0.0f;
  69 static const float BOTTOM = 1.0f;
  70 static const float LEFT = 0.0f;
  71 static const float RIGHT = 1.0f;
  72 static const float MIDDLE = 0.5f;
  73
  74 extern const Vector3 DEFAULT; ///< CENTER
  75 DALI_IMPORT_API extern const Vector3 TOP_LEFT;           ///< 0.0f, 0.0f, 0.5f
  76 DALI_IMPORT_API extern const Vector3 TOP_CENTER;         ///< 0.5f, 0.0f, 0.5f
  77 DALI_IMPORT_API extern const Vector3 TOP_RIGHT;          ///< 1.0f, 0.0f, 0.5f
  78 DALI_IMPORT_API extern const Vector3 CENTER_LEFT;        ///< 0.0f, 0.5f, 0.5f
  79 DALI_IMPORT_API extern const Vector3 CENTER;             ///< 0.5f, 0.5f, 0.5f
  80 DALI_IMPORT_API extern const Vector3 CENTER_RIGHT;       ///< 1.0f, 0.5f, 0.5f
  81 DALI_IMPORT_API extern const Vector3 BOTTOM_LEFT;        ///< 0.0f, 1.0f, 0.5f
  82 DALI_IMPORT_API extern const Vector3 BOTTOM_CENTER;      ///< 0.5f, 1.0f, 0.5f
  83 DALI_IMPORT_API extern const Vector3 BOTTOM_RIGHT;       ///< 1.0f, 1.0f, 0.5f
  84
  85 }
  86
  87
  88 /**
  89  * @brief Color Constants.
  90  *
  91  * Color is represented by the Vector4 class (see vector4.h).
  92  */
  93 namespace Color
  94 {
  95 DALI_IMPORT_API extern const Vector4 BLACK;       ///< Pure black (0.0f, 0.0f, 0.0f, 1.0f);
  96 DALI_IMPORT_API extern const Vector4 WHITE;       ///< Pure white (1.0f, 1.0f, 1.0f, 1.0f);
  97
  98 DALI_IMPORT_API extern const Vector4 RED;         ///< Pure red   (1.0f, 0.0f, 0.0f, 1.0f);
  99 DALI_IMPORT_API extern const Vector4 GREEN;       ///< Pure green (0.0f, 1.0f, 0.0f, 1.0f);
 100 DALI_IMPORT_API extern const Vector4 BLUE;        ///< Pure blue  (0.0f, 0.0f, 1.0f, 1.0f);
 101
 102 DALI_IMPORT_API extern const Vector4 YELLOW;      ///< Pure yellow  (1.0f, 1.0f, 0.0f, 1.0f);
 103 DALI_IMPORT_API extern const Vector4 MAGENTA;     ///< Pure magenta (1.0f, 0.0f, 1.0f, 1.0f);
 104 DALI_IMPORT_API extern const Vector4 CYAN;        ///< Pure cyan    (0.0f, 1.0f, 1.0f, 1.0f);
 105
 106 DALI_IMPORT_API extern const Vector4 TRANSPARENT; ///< Black transparent (0.0f, 0.0f, 0.0f, 0.0f);
 107
 108 } // namespace Color
 109
 110 /**
 111  * @brief Math constants
 112  */
 113 namespace Math
 114 {
 115 DALI_IMPORT_API extern const float MACHINE_EPSILON_0;      ///< Epsilon for values near zero
 116 DALI_IMPORT_API extern const float MACHINE_EPSILON_1;      ///< Epsilon for values near 1
 117 DALI_IMPORT_API extern const float MACHINE_EPSILON_10;     ///< Epsilon for values near 10
 118 DALI_IMPORT_API extern const float MACHINE_EPSILON_100;    ///< Epsilon for values near 100
 119 DALI_IMPORT_API extern const float MACHINE_EPSILON_1000;   ///< Epsilon for values near 1000
 120 DALI_IMPORT_API extern const float MACHINE_EPSILON_10000;  ///< Epsilon for values near 10000
 121
 122 // float is preferred to double for performance on ARM targets
 123 static const float PI   = static_cast<float>(M_PI);       ///< Constant representing PI
 124 static const float PI_2 = static_cast<float>(M_PI_2);     ///< Constant representing PI/2
 125 static const float PI_4 = static_cast<float>(M_PI_4);     ///< Constant representing PI/4
 126 static const float PI_OVER_180 = Dali::Math::PI/180.0f;   ///< Constant used to convert degree to radian
 127 static const float ONE80_OVER_PI = 180.0f/Dali::Math::PI; ///< Constant used to convert radian to degree
 128
 129 } // namespace Math
 130
 131 /**
 132  * @}
 133  */
 134 } // namespace Dali
 135
 136 #endif // __DALI_CONSTANTS_H__