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  *
  47  * Basically, a linear constrainer allows constraining a property to another property
  48  * with the changes mapped over a certain range. For example, if you want to change the
  49  * opacity of an actor depending on its position along the X-axis, so that it’s fully
  50  * transparent on the edges and fully opaque in the center. To do this, an array with
  51  * values, 0.0f, 1.0f, 0.0f, is created, which means that there are 3 control points.
  52  * You can add as many control points as you want, but they will be linearly spaced.
  53  * Then you can apply the linear constrainer by using the alpha of the actor as the
  54  * target and the source as the actor’s position.
  55  * @SINCE_1_0.0
  56  */
  57 class DALI_IMPORT_API LinearConstrainer : public Handle
  58 {
  59 public:
  60
  61   /**
  62    * @brief An enumeration of properties belonging to the LinearConstrainer class.
  63    * @SINCE_1_0.0
  64    */
  65   struct Property
  66   {
  67     enum
  68     {
  69       VALUE     = DEFAULT_OBJECT_PROPERTY_START_INDEX,  ///< name "value" type Array of float @SINCE_1_0.0
  70       PROGRESS,                                         ///< name "progress" type Array of float @SINCE_1_0.0
  71     };
  72   };
  73
  74   /**
  75    * @brief Create an initialized LinearConstrainer handle.
  76    *
  77    * @SINCE_1_0.0
  78    * @return A handle to a newly allocated Dali resource.
  79    */
  80   static LinearConstrainer New();
  81
  82   /**
  83    * @brief Downcast a handle to LinearConstrainer handle.
  84    *
  85    * If handle points to a LinearConstrainer object the downcast produces
  86    * valid handle. If not the returned handle is left uninitialized.
  87    * @SINCE_1_0.0
  88    * @param[in] handle Handle to an object
  89    * @return Handle to a LinearConstrainer object or an uninitialized handle
  90    */
  91   static LinearConstrainer DownCast( BaseHandle handle );
  92
  93   /**
  94    * @brief Create an uninitialized LinearConstrainer handle.
  95    *
  96    * This can be initialized with @ref LinearConstrainer::New
  97    * Calling member functions with an uninitialized LinearConstrainer handle is not allowed.
  98    * @SINCE_1_0.0
  99    */
 100   LinearConstrainer();
 101
 102   /**
 103    * @brief Destructor
 104    *
 105    * This is non-virtual since derived Handle types must not contain data or virtual methods.
 106    * @SINCE_1_0.0
 107    */
 108   ~LinearConstrainer();
 109
 110   /**
 111    * @brief This copy constructor is required for (smart) pointer semantics.
 112    *
 113    * @SINCE_1_0.0
 114    * @param [in] handle A reference to the copied handle
 115    */
 116   LinearConstrainer(const LinearConstrainer& handle);
 117
 118   /**
 119    * @brief This assignment operator is required for (smart) pointer semantics.
 120    *
 121    * @SINCE_1_0.0
 122    * @param [in] rhs  A reference to the copied handle
 123    * @return A reference to this
 124    */
 125   LinearConstrainer& operator=(const LinearConstrainer& rhs);
 126
 127   /**
 128    * @brief Applies the linear constraint to the target property
 129    *
 130    * @SINCE_1_0.0
 131    * @param[in] target Property to be constrained
 132    * @param[in] source Property used as parameter for the linear map
 133    * @param[in] range The range of values in the source property which will be mapped to [0,1]
 134    * @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
 135    */
 136   void Apply( Dali::Property target, Dali::Property source, const Vector2& range, const Vector2& wrap = Vector2(-FLT_MAX, FLT_MAX) );
 137
 138   /**
 139    * @brief Removes the linear constraint in the target object
 140    *
 141    * @SINCE_1_0.0
 142    * @param[in] target A handle to an object constrained by the LinearConstrainer
 143    */
 144   void Remove( Dali::Handle& target );
 145
 146 public: // Not intended for application developers
 147   /**
 148    * @brief This constructor is used by LinearConstrainer::New() methods.
 149    *
 150    * @SINCE_1_0.0
 151    * @param[in] internal A pointer to an internal LinearConstrainer resource
 152    */
 153   explicit DALI_INTERNAL LinearConstrainer(Internal::LinearConstrainer* internal);
 154 };
 155
 156 /**
 157  * @}
 158  */
 159 } // namespace Dali
 160
 161 #endif // __DALI_LINEAR_CONSTRAINER_H__