projects / platform / core / uifw / dali-core.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
[3.0] Update doxygen comments
[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 053642a..14da714 100644 (file)
--- a/dali/public-api/common/constants.h
+++ b/dali/public-api/common/constants.h
@@ -2,7 +2,7 @@
 #define __DALI_CONSTANTS_H__
 
 /*
- * Copyright (c) 2014 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2015 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,105 +22,68 @@
 #include <math.h> // M_PI
 
 // INTERNAL INCLUDES
-#include <dali/public-api/math/vector2.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 const float TOP = 0.0f;
+static const float BOTTOM = 1.0f;
+static const float LEFT = 0.0f;
+static const float RIGHT = 1.0f;
+static const float MIDDLE = 0.5f;
+
+DALI_IMPORT_API extern const Vector3 TOP_LEFT;           ///< 0.0f, 0.0f, 0.5f
+DALI_IMPORT_API extern const Vector3 TOP_CENTER;         ///< 0.5f, 0.0f, 0.5f
+DALI_IMPORT_API extern const Vector3 TOP_RIGHT;          ///< 1.0f, 0.0f, 0.5f
+DALI_IMPORT_API extern const Vector3 CENTER_LEFT;        ///< 0.0f, 0.5f, 0.5f
+DALI_IMPORT_API extern const Vector3 CENTER;             ///< 0.5f, 0.5f, 0.5f
+DALI_IMPORT_API extern const Vector3 CENTER_RIGHT;       ///< 1.0f, 0.5f, 0.5f
+DALI_IMPORT_API extern const Vector3 BOTTOM_LEFT;        ///< 0.0f, 1.0f, 0.5f
+DALI_IMPORT_API extern const Vector3 BOTTOM_CENTER;      ///< 0.5f, 1.0f, 0.5f
+DALI_IMPORT_API extern const Vector3 BOTTOM_RIGHT;       ///< 1.0f, 1.0f, 0.5f
 
 }
 
 /**
- * @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
+static const float TOP = 0.0f;
+static const float BOTTOM = 1.0f;
+static const float LEFT = 0.0f;
+static const float RIGHT = 1.0f;
+static const float MIDDLE = 0.5f;
 
 extern const Vector3 DEFAULT; ///< CENTER
+DALI_IMPORT_API extern const Vector3 TOP_LEFT;           ///< 0.0f, 0.0f, 0.5f
+DALI_IMPORT_API extern const Vector3 TOP_CENTER;         ///< 0.5f, 0.0f, 0.5f
+DALI_IMPORT_API extern const Vector3 TOP_RIGHT;          ///< 1.0f, 0.0f, 0.5f
+DALI_IMPORT_API extern const Vector3 CENTER_LEFT;        ///< 0.0f, 0.5f, 0.5f
+DALI_IMPORT_API extern const Vector3 CENTER;             ///< 0.5f, 0.5f, 0.5f
+DALI_IMPORT_API extern const Vector3 CENTER_RIGHT;       ///< 1.0f, 0.5f, 0.5f
+DALI_IMPORT_API extern const Vector3 BOTTOM_LEFT;        ///< 0.0f, 1.0f, 0.5f
+DALI_IMPORT_API extern const Vector3 BOTTOM_CENTER;      ///< 0.5f, 1.0f, 0.5f
+DALI_IMPORT_API extern const Vector3 BOTTOM_RIGHT;       ///< 1.0f, 1.0f, 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
 }
 
 
@@ -128,51 +91,50 @@ 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);
+DALI_IMPORT_API extern const Vector4 BLACK;       ///< Pure black (0.0f, 0.0f, 0.0f, 1.0f);
+DALI_IMPORT_API 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);
+DALI_IMPORT_API extern const Vector4 RED;         ///< Pure red   (1.0f, 0.0f, 0.0f, 1.0f);
+DALI_IMPORT_API extern const Vector4 GREEN;       ///< Pure green (0.0f, 1.0f, 0.0f, 1.0f);
+DALI_IMPORT_API 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);
+DALI_IMPORT_API extern const Vector4 YELLOW;      ///< Pure yellow  (1.0f, 1.0f, 0.0f, 1.0f);
+DALI_IMPORT_API extern const Vector4 MAGENTA;     ///< Pure magenta (1.0f, 0.0f, 1.0f, 1.0f);
+DALI_IMPORT_API 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);
+DALI_IMPORT_API extern const Vector4 TRANSPARENT; ///< Black 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
+DALI_IMPORT_API extern const float MACHINE_EPSILON_0;      ///< Epsilon for values near zero
+DALI_IMPORT_API extern const float MACHINE_EPSILON_1;      ///< Epsilon for values near 1
+DALI_IMPORT_API extern const float MACHINE_EPSILON_10;     ///< Epsilon for values near 10
+DALI_IMPORT_API extern const float MACHINE_EPSILON_100;    ///< Epsilon for values near 100
+DALI_IMPORT_API extern const float MACHINE_EPSILON_1000;   ///< Epsilon for values near 1000
+DALI_IMPORT_API extern const float MACHINE_EPSILON_10000;  ///< Epsilon for values near 10000
 
 // 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 const float PI   = static_cast<float>(M_PI);       ///< Constant representing PI
+static const float PI_2 = static_cast<float>(M_PI_2);     ///< Constant representing PI/2
+static const float PI_4 = static_cast<float>(M_PI_4);     ///< Constant representing PI/4
+static const float PI_OVER_180 = Dali::Math::PI/180.0f;   ///< Constant used to convert degree to radian
+static const float ONE80_OVER_PI = 180.0f/Dali::Math::PI; ///< Constant used to convert radian to degree
 
 } // namespace Math
 
 /**
- * @brief String Constants
+ * @}
  */
-namespace String
-{
-extern const std::string EMPTY; ///< The empty string
-}
-
 } // namespace Dali
 
 #endif // __DALI_CONSTANTS_H__
Domain: Graphics System / DALi;