dali/public-api/animation/linear-constrainer.h

   1 #ifndef __DALI_LINEAR_CONSTRAINER_H__
   2 #define __DALI_LINEAR_CONSTRAINER_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 //EXTERNAL INCLUDES
  22 #include <cfloat> //For FLT_MAX
  23
  24 // INTERNAL INCLUDES
  25 #include <dali/public-api/object/handle.h>
  26 #include <dali/public-api/object/property-index-ranges.h>
  27
  28 namespace Dali
  29 {
  30 /**
  31  * @addtogroup dali_core_animation
  32  * @{
  33  */
  34
  35 namespace Internal DALI_INTERNAL
  36 {
  37   class LinearConstrainer;
  38 }
  39
  40 /**
  41  * @brief LinearConstrainer applies constraints to objects given a linear map.
  42  *
  43  * A linear map is defined by a set of value-progress pairs.
  44  * Progress must be normalized between [0,1]. If no progress is defined, the values
  45  * are considered to be equally spaced along the x axis.
  46  * @since_tizen 2.4
  47  */
  48 class DALI_IMPORT_API LinearConstrainer : public Handle
  49 {
  50 public:
  51
  52   /**
  53    * @brief An enumeration of properties belonging to the LinearConstrainer class.
  54    * @since_tizen 2.4
  55    */
  56   struct Property
  57   {
  58     enum
  59     {
  60       VALUE     = DEFAULT_OBJECT_PROPERTY_START_INDEX,  ///< type Array of float @since_tizen 2.4
  61       PROGRESS,                                         ///< type Array of float @since_tizen 2.4
  62     };
  63   };
  64
  65   /**
  66    * @brief Create an initialized LinearConstrainer handle.
  67    *
  68    * @since_tizen 2.4
  69    * @return A handle to a newly allocated Dali resource.
  70    */
  71   static LinearConstrainer New();
  72
  73   /**
  74    * @brief Downcast a handle to LinearConstrainer handle.
  75    *
  76    * If handle points to a LinearConstrainer object the downcast produces
  77    * valid handle. If not the returned handle is left uninitialized.
  78    * @since_tizen 2.4
  79    * @param[in] handle Handle to an object
  80    * @return Handle to a LinearConstrainer object or an uninitialized handle
  81    */
  82   static LinearConstrainer DownCast( BaseHandle handle );
  83
  84   /**
  85    * @brief Create an uninitialized LinearConstrainer handle.
  86    *
  87    * This can be initialized with @ref PathConstrainer::New
  88    * Calling member functions with an uninitialized LinearConstrainer handle is not allowed.
  89    * @since_tizen 2.4
  90    */
  91   LinearConstrainer();
  92
  93   /**
  94    * @brief Destructor
  95    *
  96    * This is non-virtual since derived Handle types must not contain data or virtual methods.
  97    * @since_tizen 2.4
  98    */
  99   ~LinearConstrainer();
 100
 101   /**
 102    * @brief This copy constructor is required for (smart) pointer semantics.
 103    *
 104    * @since_tizen 2.4
 105    * @param [in] handle A reference to the copied handle
 106    */
 107   LinearConstrainer(const LinearConstrainer& handle);
 108
 109   /**
 110    * @brief This assignment operator is required for (smart) pointer semantics.
 111    *
 112    * @since_tizen 2.4
 113    * @param [in] rhs  A reference to the copied handle
 114    * @return A reference to this
 115    */
 116   LinearConstrainer& operator=(const LinearConstrainer& rhs);
 117
 118   /**
 119    * @brief Applies the linear constraint to the target property
 120    *
 121    * @since_tizen 2.4
 122    * @param[in] target Property to be constrained
 123    * @param[in] source Property used as parameter for the path
 124    * @param[in] range The range of values in the source property which will be mapped to [0,1]
 125    * @param[in] wrap Wrapping domain. Source property will be wrapped in the domain [wrap.x,wrap.y] before mapping to [0,1]. See cfloat.h for FLT_MAX
 126    */
 127   void Apply( Dali::Property target, Dali::Property source, const Vector2& range, const Vector2& wrap = Vector2(-FLT_MAX, FLT_MAX) );
 128
 129   /**
 130    * @brief Removes the linear constraint in the target object
 131    *
 132    * @since_tizen 2.4
 133    * @param[in] target A handle to an object constrained by the LinearConstrainer
 134    */
 135   void Remove( Dali::Handle& target );
 136
 137 public: // Not intended for application developers
 138   /**
 139    * @brief This constructor is used by LinearConstrainer::New() methods.
 140    *
 141    * @since_tizen 2.4
 142    * @param[in] pathConstrainer A pointer to an internal PathConstrainer resource
 143    */
 144   explicit DALI_INTERNAL LinearConstrainer(Internal::LinearConstrainer* pathConstrainer);
 145 };
 146
 147 /**
 148  * @}
 149  */
 150 } // namespace Dali
 151
 152 #endif // __DALI_LINEAR_CONSTRAINER_H__