X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali-toolkit%2Fpublic-api%2Fvisuals%2Fprimitive-visual-properties.h;h=1e3afcfe209be202a4ddb0e00de1c2e6a103b7cc;hb=fedd5ae8da46cd798f730fd07c942df853e055dd;hp=a5aac2d6c0f335c352d10cc5e9efdd9138b9caeb;hpb=11ed6421771d05113ae1a6510167d8c2557ac20e;p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git

diff --git a/dali-toolkit/public-api/visuals/primitive-visual-properties.h b/dali-toolkit/public-api/visuals/primitive-visual-properties.h
index a5aac2d..1e3afcf 100644
--- a/dali-toolkit/public-api/visuals/primitive-visual-properties.h
+++ b/dali-toolkit/public-api/visuals/primitive-visual-properties.h
@@ -19,7 +19,7 @@
  */
 
 // INTERNAL INCLUDES
-#include <dali-toolkit/public-api/visuals/visual-properties.h>
+#include <dali-toolkit/public-api/toolkit-property-index-ranges.h>
 
 namespace Dali
 {
@@ -27,12 +27,29 @@ namespace Dali
 namespace Toolkit
 {
 
+/**
+ * @addtogroup dali_toolkit_visuals
+ * @{
+ */
+
+/**
+ * @brief PrimitiveVisual is to render a simple 3D shape, such as a cube or sphere.
+ * @SINCE_1_1.45
+ */
 namespace PrimitiveVisual
 {
 
+/**
+ * @brief PrimitiveVisual Property.
+ * @SINCE_1_1.45
+ */
 namespace Property
 {
 
+/**
+ * @brief Enumeration for the instance of properties belonging to the PrimitiveVisual.
+ * @SINCE_1_1.45
+ */
 enum
 {
   /**
@@ -46,22 +63,22 @@ enum
 
   /**
    * @brief The color of the shape.
-   * @details Name "shapeColor", type Property::VECTOR4.
-   * @SINCE_1_1.45
+   * @details Name "mixColor", type Property::VECTOR4.
+   * @SINCE_1_2_4
    * @note Optional. If not specified, the default is Vector4(0.5, 0.5, 0.5, 1.0).
    * @note Applies to ALL shapes.
    */
-  COLOR,
+  MIX_COLOR,
 
   /**
    * @brief The number of slices as you go around the shape.
    * @details Name "slices", type Property::INTEGER.
-   * For spheres and conical frustrums, this determines how many divisions there are as you go around the object.
+   * For spheres and conical frustums, this determines how many divisions there are as you go around the object.
    * @SINCE_1_1.45
    * @note Optional. If not specified, the default is 128.
    * @note Applies to:
    *      - Shape::SPHERE
-   *      - Shape::CONICAL_FRUSTRUM
+   *      - Shape::CONICAL_FRUSTUM
    *      - Shape::CONE
    *      - Shape::CYLINDER
    * @note The range is from 1 to 255.
@@ -81,23 +98,23 @@ enum
   STACKS,
 
   /**
-   * @brief The scale of the radius of the top circle of a conical frustrum.
+   * @brief The scale of the radius of the top circle of a conical frustum.
    * @details Name "scaleTopRadius", type Property::FLOAT.
    * @SINCE_1_1.45
    * @note Optional. If not specified, the default is 1.0f.
    * @note Applies to:
-   *      - Shape::CONICAL_FRUSTRUM
+   *      - Shape::CONICAL_FRUSTUM
    * @note Only values greater than or equal to 0.0f are accepted.
    */
   SCALE_TOP_RADIUS,
 
   /**
-   * @brief The scale of the radius of the bottom circle of a conical frustrum.
+   * @brief The scale of the radius of the bottom circle of a conical frustum.
    * @details Name "scaleBottomRadius", type Property::FLOAT.
    * @SINCE_1_1.45
    * @note Optional. If not specified, the default is 1.5f.
    * @note Applies to:
-   *      - Shape::CONICAL_FRUSTRUM
+   *      - Shape::CONICAL_FRUSTUM
    *      - Shape::CONE
    * @note Only values greater than or equal to 0.0f are accepted.
    */
@@ -109,7 +126,7 @@ enum
    * @SINCE_1_1.45
    * @note Optional. If not specified, the default is 3.0f.
    * @note Applies to:
-   *      - Shape::CONICAL_FRUSTRUM
+   *      - Shape::CONICAL_FRUSTUM
    *      - Shape::CONE
    *      - Shape::CYLINDER
    * @note Only values greater than or equal to 0.0f are accepted.
@@ -177,26 +194,36 @@ enum
 
 } // namespace Property
 
+/**
+ * @brief The primitive shape to render as a PrimitiveVisual.
+ * @SINCE_1_1.45
+ */
 namespace Shape
 {
 
 /**
- * @brief The primitive shape to render.
+ * @brief The primitive shape to render as a PrimitiveVisual.
+ * @SINCE_1_1.45
  */
 enum Type
 {
   SPHERE, ///< A perfectly round geometrical object in three-dimensional space. @SINCE_1_1.45
-  CONICAL_FRUSTRUM, ///< The area bound between two circles, i.e. a cone with the tip removed. @SINCE_1_1.45
-  CONE, ///< Equivalent to a conical frustrum with top radius of zero. @SINCE_1_1.45
-  CYLINDER, ///< Equivalent to a conical frustrum with equal radii for the top and bottom circles. @SINCE_1_1.45
+  CONICAL_FRUSTRUM, ///< @DEPRECATED_1_3.15, use CONICAL_FRUSTUM instead. The area bound between two circles, i.e. a cone with the tip removed. @SINCE_1_1.45
+  CONE, ///< Equivalent to a conical frustum with top radius of zero. @SINCE_1_1.45
+  CYLINDER, ///< Equivalent to a conical frustum with equal radii for the top and bottom circles. @SINCE_1_1.45
   CUBE, ///< Equivalent to a bevelled cube with a bevel percentage of zero. @SINCE_1_1.45
   OCTAHEDRON, ///< Equivalent to a bevelled cube with a bevel percentage of one. @SINCE_1_1.45
   BEVELLED_CUBE, ///< A cube/cuboid with all edges flattened to some degree. @SINCE_1_1.45
+  CONICAL_FRUSTUM ///< The area bound between two circles, i.e. a cone with the tip removed. @SINCE_1_3.15
 };
 }
 
 } // namespace PrimitiveVisual
 
+/**
+ * @}
+ */
+
 } // namespace Toolkit
 
 } // namespace Dali