1 #ifndef __DALI_LINEAR_CONSTRAINER_H__
2 #define __DALI_LINEAR_CONSTRAINER_H__
5 * Copyright (c) 2015 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
22 #include <cfloat> //For FLT_MAX
25 #include <dali/public-api/object/handle.h>
26 #include <dali/public-api/object/property-index-ranges.h>
31 * @addtogroup dali_core_animation
35 namespace Internal DALI_INTERNAL
37 class LinearConstrainer;
43 * LinearConstrainer applies constraints to objects given a linear map.
44 * A linear map is defined by a set of value-progress pairs.
45 * Progress must be normalized between [0,1]. If no progress is defined, the values
46 * are considered to be equally spaced along the x axis.
48 class DALI_IMPORT_API LinearConstrainer : public Handle
53 * @brief An enumeration of properties belonging to the LinearConstrainer class.
59 VALUE = DEFAULT_OBJECT_PROPERTY_START_INDEX, ///< name "value" type Array of float
60 PROGRESS, ///< name "progress" type Array of float
65 * @brief Create an initialized LinearConstrainer handle.
67 * @return a handle to a newly allocated Dali resource.
69 static LinearConstrainer New();
72 * @brief Downcast an Object handle to LinearConstrainer handle.
74 * If handle points to a LinearConstrainer object the downcast produces
75 * valid handle. If not the returned handle is left uninitialized.
76 * @param[in] handle to An object
77 * @return handle to a LinearConstrainer object or an uninitialized handle
79 static LinearConstrainer DownCast( BaseHandle handle );
82 * @brief Create an uninitialized LinearConstrainer handle.
84 * This can be initialized with PathConstrainer::New(). Calling member
85 * functions with an uninitialized Dali::Object is not allowed.
92 * This is non-virtual since derived Handle types must not contain data or virtual methods.
97 * @brief This copy constructor is required for (smart) pointer semantics.
99 * @param [in] handle A reference to the copied handle
101 LinearConstrainer(const LinearConstrainer& handle);
104 * @brief This assignment operator is required for (smart) pointer semantics.
106 * @param [in] rhs A reference to the copied handle
107 * @return A reference to this
109 LinearConstrainer& operator=(const LinearConstrainer& rhs);
112 * @brief Applies the linear constraint to the target property
114 * @param[in] target Property to be constrained
115 * @param[in] source Property used as parameter for the path
116 * @param[in] range The range of values in the source property which will be mapped to [0,1]
117 * @param[in] wrap Wrapping domain. Source property will be wrapped in the domain [wrap.x,wrap.y] before mapping to [0,1]
119 void Apply( Dali::Property target, Dali::Property source, const Vector2& range, const Vector2& wrap = Vector2(-FLT_MAX, FLT_MAX) );
122 * @brief Removes the linear constraint in the target object
124 * @param[in] target A handle to an object constrained by the LinearConstrainer
126 void Remove( Dali::Handle& target );
128 public: // Not intended for application developers
130 * @brief This constructor is used by Dali::New() methods.
132 * @param[in] pathConstrainer A pointer to an internal PathConstrainer resource
134 explicit DALI_INTERNAL LinearConstrainer(Internal::LinearConstrainer* pathConstrainer);
142 #endif // __DALI_LINEAR_CONSTRAINER_H__