[dali_1.1.19] Merge branch 'devel/master'

[platform/core/uifw/dali-core.git] / dali / public-api / animation / path.h

diff --git a/dali/public-api/animation/path.h b/dali/public-api/animation/path.h
index 36e79d1..30f6cda 100644 (file)
--- a/dali/public-api/animation/path.h
+++ b/dali/public-api/animation/path.h
@@ -39,6 +39,7 @@ class Path;
  *
  * Paths can be used to animate position and orientation of actors using Dali::Animate( Actor, Path, ... )
  *
+ * @SINCE_1_0.0
  */
 class DALI_IMPORT_API Path : public Handle
 {
@@ -46,19 +47,21 @@ public:
 
   /**
    * @brief An enumeration of properties belonging to the Path class.
+   * @SINCE_1_0.0
    */
   struct Property
   {
     enum
     {
-      POINTS         = DEFAULT_OBJECT_PROPERTY_START_INDEX, ///< name "points",         type Vector3
-      CONTROL_POINTS,                                       ///< name "controlPoints",  type Vector3
+      POINTS         = DEFAULT_OBJECT_PROPERTY_START_INDEX, ///< name "points",         type Vector3 @SINCE_1_0.0
+      CONTROL_POINTS,                                       ///< name "controlPoints",  type Vector3 @SINCE_1_0.0
     };
   };
 
   /**
    * @brief Create an initialized Path handle.
    *
+   * @SINCE_1_0.0
    * @return a handle to a newly allocated Dali resource.
    */
   static Path New();
@@ -68,6 +71,7 @@ public:
    *
    * If handle points to a KeyFrames object the downcast produces
    * valid handle. If not the returned handle is left uninitialized.
+   * @SINCE_1_0.0
    * @param[in] handle to An object
    * @return handle to a Path object or an uninitialized handle
    */
@@ -78,6 +82,7 @@ public:
    *
    * This can be initialized with Path::New(). Calling member
    * functions with an uninitialized Dali::Object is not allowed.
+   * @SINCE_1_0.0
    */
   Path();
 
@@ -85,12 +90,14 @@ public:
    * @brief Destructor
    *
    * This is non-virtual since derived Handle types must not contain data or virtual methods.
+   * @SINCE_1_0.0
    */
   ~Path();
 
   /**
    * @brief This copy constructor is required for (smart) pointer semantics.
    *
+   * @SINCE_1_0.0
    * @param [in] handle A reference to the copied handle
    */
   Path(const Path& handle);
@@ -98,6 +105,7 @@ public:
   /**
    * @brief This assignment operator is required for (smart) pointer semantics.
    *
+   * @SINCE_1_0.0
    * @param [in] rhs  A reference to the copied handle
    * @return A reference to this
    */
@@ -106,6 +114,7 @@ public:
   /**
    * @brief Add an interpolation point.
    *
+   * @SINCE_1_0.0
    * @param[in] point The new interpolation point to be added
    */
   void AddPoint(const Vector3& point );
@@ -113,6 +122,7 @@ public:
   /**
    * @brief Add a control point.
    *
+   * @SINCE_1_0.0
    * @param[in] point The new control point to be added
    */
   void AddControlPoint(const Vector3& point );
@@ -126,19 +136,21 @@ public:
    * The in control point is the length of the preceding segment back along this bisector multiplied by the curvature
    * The out control point is the length of the succeeding segment forward along this bisector multiplied by the curvature
    *
-   * @pre There are at least two points in the path ( one segment ).
-   *
+   * @SINCE_1_0.0
    * @param[in] curvature The curvature of the spline. 0 gives straight lines between the knots,
    *                      negative values means the spline contains loops, positive values up to
    *                      0.5 result in a smooth curve, positive values between 0.5 and 1 result
    *                      in looped curves where the loops are not distinct (i.e. the curve appears
    *                      to be non-continuous), positive values higher than 1 result in looped curves.
+   * @pre There are at least two points in the path ( one segment ).
+   *
    */
   void GenerateControlPoints( float curvature );
 
   /**
    * @brief Sample path at a given progress. Calculates position and tangent at that point of the curve
    *
+   * @SINCE_1_0.0
    * @param[in]  progress  A floating point value between 0.0 and 1.0.
    * @param[out] position The interpolated position at that progress.
    * @param[out] tangent The interpolated tangent at that progress.
@@ -148,6 +160,7 @@ public:
   /**
    * @brief Accessor for the interpolation points.
    *
+   * @SINCE_1_0.0
    * @param[in] index The index of the interpolation point.
    * @return A reference to the interpolation point.
    */
@@ -156,6 +169,7 @@ public:
   /**
    * @brief Accessor for the control points.
    *
+   * @SINCE_1_0.0
    * @param[in] index The index of the control point.
    * @return A reference to the control point.
    */
@@ -164,6 +178,7 @@ public:
   /**
    * @brief Get the number of interpolation points in the path
    *
+   * @SINCE_1_0.0
    * @return The number of interpolation points in the path
    */
   size_t GetPointCount() const;
@@ -172,6 +187,7 @@ public: // Not intended for application developers
   /**
    * @brief This constructor is used by Dali::New() methods.
    *
+   * @SINCE_1_0.0
    * @param[in] path A pointer to an internal path resource
    */
   explicit DALI_INTERNAL Path(Internal::Path* path);