dali/public-api/common/constants.h

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