dali/public-api/animation/path.h

   1 #ifndef __DALI_PATH_H__
   2 #define __DALI_PATH_H__
   3
   4 /*
   5  * Copyright (c) 2015 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 // INTERNAL INCLUDES
  22 #include <dali/public-api/object/handle.h>
  23 #include <dali/public-api/object/property-index-ranges.h>
  24
  25 namespace Dali
  26 {
  27 /**
  28  * @addtogroup dali_core_animation
  29  * @{
  30  */
  31
  32 namespace Internal DALI_INTERNAL
  33 {
  34 class Path;
  35 }
  36
  37 /**
  38  * @brief A 3D parametric curve
  39  *
  40  * Paths can be used to animate position and orientation of actors using Dali::Animate()
  41  *
  42  * @SINCE_1_0.0
  43  */
  44 class DALI_IMPORT_API Path : public Handle
  45 {
  46 public:
  47
  48   /**
  49    * @brief An enumeration of properties belonging to the Path class.
  50    * @SINCE_1_0.0
  51    */
  52   struct Property
  53   {
  54     /**
  55      * @brief An enumeration of properties belonging to the Path class.
  56      * @SINCE_1_0.0
  57      */
  58     enum
  59     {
  60       POINTS         = DEFAULT_OBJECT_PROPERTY_START_INDEX, ///< name "points",         type Vector3 @SINCE_1_0.0
  61       CONTROL_POINTS,                                       ///< name "controlPoints",  type Vector3 @SINCE_1_0.0
  62     };
  63   };
  64
  65   /**
  66    * @brief Create an initialized Path handle.
  67    *
  68    * @SINCE_1_0.0
  69    * @return A handle to a newly allocated Dali resource.
  70    */
  71   static Path New();
  72
  73   /**
  74    * @brief Downcast a handle to Path handle.
  75    *
  76    * If handle points to a Path object the downcast produces
  77    * valid handle. If not the returned handle is left uninitialized.
  78    * @SINCE_1_0.0
  79    * @param[in] handle Handle to an object
  80    * @return Handle to a Path object or an uninitialized handle
  81    */
  82   static Path DownCast( BaseHandle handle );
  83
  84   /**
  85    * @brief Create an uninitialized Path handle.
  86    *
  87    * This can be initialized with Path::New().
  88    * Calling member functions with an uninitialized Path handle is not allowed.
  89    * @SINCE_1_0.0
  90    */
  91   Path();
  92
  93   /**
  94    * @brief Destructor
  95    *
  96    * This is non-virtual since derived Handle types must not contain data or virtual methods.
  97    * @SINCE_1_0.0
  98    */
  99   ~Path();
 100
 101   /**
 102    * @brief This copy constructor is required for (smart) pointer semantics.
 103    *
 104    * @SINCE_1_0.0
 105    * @param [in] handle A reference to the copied handle
 106    */
 107   Path(const Path& handle);
 108
 109   /**
 110    * @brief This assignment operator is required for (smart) pointer semantics.
 111    *
 112    * @SINCE_1_0.0
 113    * @param [in] rhs  A reference to the copied handle
 114    * @return A reference to this
 115    */
 116   Path& operator=(const Path& rhs);
 117
 118   /**
 119    * @brief Add an interpolation point.
 120    *
 121    * @SINCE_1_0.0
 122    * @param[in] point The new interpolation point to be added
 123    */
 124   void AddPoint(const Vector3& point );
 125
 126   /**
 127    * @brief Add a control point.
 128    *
 129    * @SINCE_1_0.0
 130    * @param[in] point The new control point to be added
 131    */
 132   void AddControlPoint(const Vector3& point );
 133
 134   /**
 135    * @brief Automatic generation of control points. Generated control points which result in a smooth join between the splines of each segment.
 136    *
 137    * The generating algorithm is as follows:
 138    * For a given knot point K[N], find the vector that bisects K[N-1],[N] and [N],[N+1].
 139    * Calculate the tangent vector by taking the normal of this bisector.
 140    * The in control point is the length of the preceding segment back along this bisector multiplied by the curvature.
 141    * The out control point is the length of the succeeding segment forward along this bisector multiplied by the curvature.
 142    *
 143    * @SINCE_1_0.0
 144    * @param[in] curvature The curvature of the spline. 0 gives straight lines between the knots,
 145    *                      negative values means the spline contains loops, positive values up to
 146    *                      0.5 result in a smooth curve, positive values between 0.5 and 1 result
 147    *                      in looped curves where the loops are not distinct (i.e. the curve appears
 148    *                      to be non-continuous), positive values higher than 1 result in looped curves.
 149    * @pre There are at least two points in the path ( one segment ).
 150    *
 151    */
 152   void GenerateControlPoints( float curvature );
 153
 154   /**
 155    * @brief Sample path at a given progress. Calculates position and tangent at that point of the curve
 156    *
 157    * @SINCE_1_0.0
 158    * @param[in]  progress  A floating point value between 0.0 and 1.0.
 159    * @param[out] position The interpolated position at that progress.
 160    * @param[out] tangent The interpolated tangent at that progress.
 161    */
 162   void Sample( float progress, Vector3& position, Vector3& tangent ) const;
 163
 164   /**
 165    * @brief Accessor for the interpolation points.
 166    *
 167    * @SINCE_1_0.0
 168    * @param[in] index The index of the interpolation point.
 169    * @return A reference to the interpolation point.
 170    */
 171   Vector3& GetPoint( size_t index );
 172
 173   /**
 174    * @brief Accessor for the control points.
 175    *
 176    * @SINCE_1_0.0
 177    * @param[in] index The index of the control point.
 178    * @return A reference to the control point.
 179    */
 180   Vector3& GetControlPoint( size_t index );
 181
 182   /**
 183    * @brief Get the number of interpolation points in the path
 184    *
 185    * @SINCE_1_0.0
 186    * @return The number of interpolation points in the path
 187    */
 188   size_t GetPointCount() const;
 189
 190 public: // Not intended for application developers
 191   /**
 192    * @internal
 193    * @brief This constructor is used by Path::New() methods.
 194    *
 195    * @SINCE_1_0.0
 196    * @param[in] path A pointer to an internal path resource
 197    */
 198   explicit DALI_INTERNAL Path(Internal::Path* path);
 199 };
 200
 201 /**
 202  * @}
 203  */
 204 } // namespace Dali
 205
 206 #endif // __DALI_KEY_FRAMES_H__