projects / platform / core / uifw / dali-core.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Moved (DEFAULT|DEBUG)_BACKGROUND_COLOR out of Stage and over to constants.h
[platform/core/uifw/dali-core.git] / dali / public-api / common / constants.h
diff --git a/dali/public-api/common/constants.h b/dali/public-api/common/constants.h
index ec7d8ee..d8e7515 100644 (file)
--- a/dali/public-api/common/constants.h
+++ b/dali/public-api/common/constants.h
@@ -1,8 +1,8 @@
-#ifndef __DALI_CONSTANTS_H__
-#define __DALI_CONSTANTS_H__
+#ifndef DALI_CONSTANTS_H
+#define DALI_CONSTANTS_H
 
 /*
- * Copyright (c) 2014 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2020 Samsung Electronics Co., Ltd.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -22,104 +22,65 @@
 #include <math.h> // M_PI
 
 // INTERNAL INCLUDES
+#include <dali/public-api/math/compile-time-math.h>
 #include <dali/public-api/math/vector3.h>
 #include <dali/public-api/math/vector4.h>
-#include <dali/public-api/math/radian.h>
 
-namespace Dali DALI_IMPORT_API
+namespace Dali
 {
+/**
+ * @addtogroup dali_core_common
+ * @{
+ */
 
 /**
- * @brief ParentOrigin constants
+ * @brief ParentOrigin constants.
  *
- * Note that for 2D layouting, the typical Z position is 0.5f (not 0.0f)
+ * Note that for 2D layouting, the typical Z position is 0.5f (not 0.0f).
+ * @SINCE_1_0.0
  */
 namespace ParentOrigin
 {
-extern const Vector3 DEFAULT; ///< TOP_LEFT
-
-extern const float TOP;    ///< 0.0f
-extern const float BOTTOM; ///< 1.0f
-extern const float LEFT;   ///< 0.0f
-extern const float RIGHT;  ///< 1.0f
-extern const float MIDDLE; ///< 0.5f
-
-extern const Vector3 BACK_TOP_LEFT;      ///< 0.0f, 0.0f, 0.0f
-extern const Vector3 BACK_TOP_CENTER;    ///< 0.5f, 0.0f, 0.0f
-extern const Vector3 BACK_TOP_RIGHT;     ///< 1.0f, 0.0f, 0.0f
-extern const Vector3 BACK_CENTER_LEFT;   ///< 0.0f, 0.5f, 0.0f
-extern const Vector3 BACK_CENTER;        ///< 0.5f, 0.5f, 0.0f
-extern const Vector3 BACK_CENTER_RIGHT;  ///< 1.0f, 0.5f, 0.0f
-extern const Vector3 BACK_BOTTOM_LEFT;   ///< 0.0f, 1.0f, 0.0f
-extern const Vector3 BACK_BOTTOM_CENTER; ///< 0.5f, 1.0f, 0.0f
-extern const Vector3 BACK_BOTTOM_RIGHT;  ///< 1.0f, 1.0f, 0.0f
-
-extern const Vector3 TOP_LEFT;           ///< 0.0f, 0.0f, 0.5f
-extern const Vector3 TOP_CENTER;         ///< 0.5f, 0.0f, 0.5f
-extern const Vector3 TOP_RIGHT;          ///< 1.0f, 0.0f, 0.5f
-extern const Vector3 CENTER_LEFT;        ///< 0.0f, 0.5f, 0.5f
-extern const Vector3 CENTER;             ///< 0.5f, 0.5f, 0.5f
-extern const Vector3 CENTER_RIGHT;       ///< 1.0f, 0.5f, 0.5f
-extern const Vector3 BOTTOM_LEFT;        ///< 0.0f, 1.0f, 0.5f
-extern const Vector3 BOTTOM_CENTER;      ///< 0.5f, 1.0f, 0.5f
-extern const Vector3 BOTTOM_RIGHT;       ///< 1.0f, 1.0f, 0.5f
-
-extern const Vector3 FRONT_TOP_LEFT;     ///< 0.0f, 0.0f, 1.0f
-extern const Vector3 FRONT_TOP_CENTER;   ///< 0.5f, 0.0f, 1.0f
-extern const Vector3 FRONT_TOP_RIGHT;    ///< 1.0f, 0.0f, 1.0f
-extern const Vector3 FRONT_CENTER_LEFT;  ///< 0.0f, 0.5f, 1.0f
-extern const Vector3 FRONT_CENTER;       ///< 0.5f, 0.5f, 1.0f
-extern const Vector3 FRONT_CENTER_RIGHT; ///< 1.0f, 0.5f, 1.0f
-extern const Vector3 FRONT_BOTTOM_LEFT;  ///< 0.0f, 1.0f, 1.0f
-extern const Vector3 FRONT_BOTTOM_CENTER;///< 0.5f, 1.0f, 1.0f
-extern const Vector3 FRONT_BOTTOM_RIGHT; ///< 1.0f, 1.0f, 1.0f
-
+static constexpr float TOP = 0.0f;
+static constexpr float BOTTOM = 1.0f;
+static constexpr float LEFT = 0.0f;
+static constexpr float RIGHT = 1.0f;
+static constexpr float MIDDLE = 0.5f;
+static constexpr Vector3 TOP_LEFT     (0.0f, 0.0f, 0.5f);
+static constexpr Vector3 TOP_CENTER   (0.5f, 0.0f, 0.5f);
+static constexpr Vector3 TOP_RIGHT    (1.0f, 0.0f, 0.5f);
+static constexpr Vector3 CENTER_LEFT  (0.0f, 0.5f, 0.5f);
+static constexpr Vector3 CENTER       (0.5f, 0.5f, 0.5f);
+static constexpr Vector3 CENTER_RIGHT (1.0f, 0.5f, 0.5f);
+static constexpr Vector3 BOTTOM_LEFT  (0.0f, 1.0f, 0.5f);
+static constexpr Vector3 BOTTOM_CENTER(0.5f, 1.0f, 0.5f);
+static constexpr Vector3 BOTTOM_RIGHT (1.0f, 1.0f, 0.5f);
+static constexpr Vector3 DEFAULT( TOP_LEFT );
 }
 
 /**
- * @brief AnchorPoint constants
+ * @brief AnchorPoint constants.
  *
- * Note that for 2D layouting, the typical Z position is 0.5f (not 0.0f)
+ * Note that for 2D layouting, the typical Z position is 0.5f (not 0.0f).
+ * @SINCE_1_0.0
  */
 namespace AnchorPoint
 {
-extern const float TOP;    ///< 0.0f
-extern const float BOTTOM; ///< 1.0f
-extern const float LEFT;   ///< 0.0f
-extern const float RIGHT;  ///< 1.0f
-extern const float MIDDLE; ///< 0.5f
-
-extern const Vector3 DEFAULT; ///< CENTER
-
-extern const Vector3 BACK_TOP_LEFT;      ///< 0.0f, 0.0f, 0.0f
-extern const Vector3 BACK_TOP_CENTER;    ///< 0.5f, 0.0f, 0.0f
-extern const Vector3 BACK_TOP_RIGHT;     ///< 1.0f, 0.0f, 0.0f
-extern const Vector3 BACK_CENTER_LEFT;   ///< 0.0f, 0.5f, 0.0f
-extern const Vector3 BACK_CENTER;        ///< 0.5f, 0.5f, 0.0f
-extern const Vector3 BACK_CENTER_RIGHT;  ///< 1.0f, 0.5f, 0.0f
-extern const Vector3 BACK_BOTTOM_LEFT;   ///< 0.0f, 1.0f, 0.0f
-extern const Vector3 BACK_BOTTOM_CENTER; ///< 0.5f, 1.0f, 0.0f
-extern const Vector3 BACK_BOTTOM_RIGHT;  ///< 1.0f, 1.0f, 0.0f
-
-extern const Vector3 TOP_LEFT;           ///< 0.0f, 0.0f, 0.5f
-extern const Vector3 TOP_CENTER;         ///< 0.5f, 0.0f, 0.5f
-extern const Vector3 TOP_RIGHT;          ///< 1.0f, 0.0f, 0.5f
-extern const Vector3 CENTER_LEFT;        ///< 0.0f, 0.5f, 0.5f
-extern const Vector3 CENTER;             ///< 0.5f, 0.5f, 0.5f
-extern const Vector3 CENTER_RIGHT;       ///< 1.0f, 0.5f, 0.5f
-extern const Vector3 BOTTOM_LEFT;        ///< 0.0f, 1.0f, 0.5f
-extern const Vector3 BOTTOM_CENTER;      ///< 0.5f, 1.0f, 0.5f
-extern const Vector3 BOTTOM_RIGHT;       ///< 1.0f, 1.0f, 0.5f
-
-extern const Vector3 FRONT_TOP_LEFT;     ///< 0.0f, 0.0f, 1.0f
-extern const Vector3 FRONT_TOP_CENTER;   ///< 0.5f, 0.0f, 1.0f
-extern const Vector3 FRONT_TOP_RIGHT;    ///< 1.0f, 0.0f, 1.0f
-extern const Vector3 FRONT_CENTER_LEFT;  ///< 0.0f, 0.5f, 1.0f
-extern const Vector3 FRONT_CENTER;       ///< 0.5f, 0.5f, 1.0f
-extern const Vector3 FRONT_CENTER_RIGHT; ///< 1.0f, 0.5f, 1.0f
-extern const Vector3 FRONT_BOTTOM_LEFT;  ///< 0.0f, 1.0f, 1.0f
-extern const Vector3 FRONT_BOTTOM_CENTER;///< 0.5f, 1.0f, 1.0f
-extern const Vector3 FRONT_BOTTOM_RIGHT; ///< 1.0f, 1.0f, 1.0f
+static constexpr float TOP = 0.0f;
+static constexpr float BOTTOM = 1.0f;
+static constexpr float LEFT = 0.0f;
+static constexpr float RIGHT = 1.0f;
+static constexpr float MIDDLE = 0.5f;
+static constexpr Vector3 TOP_LEFT     (0.0f, 0.0f, 0.5f);
+static constexpr Vector3 TOP_CENTER   (0.5f, 0.0f, 0.5f);
+static constexpr Vector3 TOP_RIGHT    (1.0f, 0.0f, 0.5f);
+static constexpr Vector3 CENTER_LEFT  (0.0f, 0.5f, 0.5f);
+static constexpr Vector3 CENTER       (0.5f, 0.5f, 0.5f);
+static constexpr Vector3 CENTER_RIGHT (1.0f, 0.5f, 0.5f);
+static constexpr Vector3 BOTTOM_LEFT  (0.0f, 1.0f, 0.5f);
+static constexpr Vector3 BOTTOM_CENTER(0.5f, 1.0f, 0.5f);
+static constexpr Vector3 BOTTOM_RIGHT (1.0f, 1.0f, 0.5f);
+static constexpr Vector3 DEFAULT( CENTER );
 }
 
 
@@ -127,51 +88,51 @@ extern const Vector3 FRONT_BOTTOM_RIGHT; ///< 1.0f, 1.0f, 1.0f
  * @brief Color Constants.
  *
  * Color is represented by the Vector4 class (see vector4.h).
+ * @SINCE_1_0.0
  */
 namespace Color
 {
-extern const Vector4 BLACK;       ///< Pure black (0.0f, 0.0f, 0.0f, 1.0f);
-extern const Vector4 WHITE;       ///< Pure white (1.0f, 1.0f, 1.0f, 1.0f);
-
-extern const Vector4 RED;         ///< Pure red   (1.0f, 0.0f, 0.0f, 1.0f);
-extern const Vector4 GREEN;       ///< Pure green (0.0f, 1.0f, 0.0f, 1.0f);
-extern const Vector4 BLUE;        ///< Pure blue  (0.0f, 0.0f, 1.0f, 1.0f);
-
-extern const Vector4 YELLOW;      ///< Pure yellow  (1.0f, 1.0f, 0.0f, 1.0f);
-extern const Vector4 MAGENTA;     ///< Pure magenta (1.0f, 0.0f, 1.0f, 1.0f);
-extern const Vector4 CYAN;        ///< Pure cyan    (0.0f, 1.0f, 1.0f, 1.0f);
-
-extern const Vector4 TRANSPARENT; ///< Black transparent (0.0f, 0.0f, 0.0f, 0.0f);
+static constexpr Vector4 BLACK( 0.0f, 0.0f, 0.0f, 1.0f );
+static constexpr Vector4 WHITE( 1.0f, 1.0f, 1.0f, 1.0f );
+static constexpr Vector4 RED(   1.0f, 0.0f, 0.0f, 1.0f );
+static constexpr Vector4 GREEN( 0.0f, 1.0f, 0.0f, 1.0f );
+static constexpr Vector4 BLUE(  0.0f, 0.0f, 1.0f, 1.0f );
+static constexpr Vector4 YELLOW(  1.0f, 1.0f, 0.0f, 1.0f );
+static constexpr Vector4 MAGENTA( 1.0f, 0.0f, 1.0f, 1.0f );
+static constexpr Vector4 CYAN(    0.0f, 1.0f, 1.0f, 1.0f );
+static constexpr Vector4 TRANSPARENT( 0.0f, 0.0f, 0.0f, 0.0f );
 
 } // namespace Color
 
 /**
- * @brief Math constants
+ * @brief Math constants.
+ * @SINCE_1_0.0
  */
 namespace Math
 {
-extern const float MACHINE_EPSILON_0;      ///< Epsilon for values near zero
-extern const float MACHINE_EPSILON_1;      ///< Epsilon for values near 1
-extern const float MACHINE_EPSILON_10;     ///< Epsilon for values near 10
-extern const float MACHINE_EPSILON_100;    ///< Epsilon for values near 100
-extern const float MACHINE_EPSILON_1000;   ///< Epsilon for values near 1000
-extern const float MACHINE_EPSILON_10000;  ///< Epsilon for values near 10000
+static constexpr float MACHINE_EPSILON_0     = Epsilon<0>::value;
+static constexpr float MACHINE_EPSILON_1     = Epsilon<1>::value;
+static constexpr float MACHINE_EPSILON_10    = Epsilon<10>::value;
+static constexpr float MACHINE_EPSILON_100   = Epsilon<100>::value;
+static constexpr float MACHINE_EPSILON_1000  = Epsilon<1000>::value;
+static constexpr float MACHINE_EPSILON_10000 = Epsilon<10000>::value;
 
 // float is preferred to double for performance on ARM targets
-const float PI   = static_cast<float>(M_PI);   ///< Constant representing PI
-const float PI_2 = static_cast<float>(M_PI_2); ///< Constant representing PI/2
-const float PI_4 = static_cast<float>(M_PI_4); ///< Constant representing PI/4
+static constexpr float PI   = static_cast<float>(M_PI);       ///< Pi
+static constexpr float PI_2 = static_cast<float>(M_PI_2);     ///< Pi/2
+static constexpr float PI_4 = static_cast<float>(M_PI_4);     ///< Pi/4
+static constexpr float PI_OVER_180 = Dali::Math::PI/180.0f;   ///< Constant used to convert degree to radian
+static constexpr float ONE80_OVER_PI = 180.0f/Dali::Math::PI; ///< Constant used to convert radian to degree
 
 } // namespace Math
 
+// background colors
+static constexpr Vector4 DEFAULT_BACKGROUND_COLOR = Color::BLACK;
+static constexpr Vector4 DEBUG_BACKGROUND_COLOR(0.2f, 0.5f, 0.2f, 1.0f); ///< Dark green, useful for debugging visuals (texture / shader issues / culling etc.).
+
 /**
- * @brief String Constants
+ * @}
  */
-namespace String
-{
-extern const std::string EMPTY; ///< The empty string
-}
-
 } // namespace Dali
 
-#endif // __DALI_CONSTANTS_H__
+#endif // DALI_CONSTANTS_H
Domain: Graphics System / DALi;