1 #ifndef __DALI_ACTIVE_CONSTRAINT_H__
2 #define __DALI_ACTIVE_CONSTRAINT_H__
5 * Copyright (c) 2014 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 <dali/public-api/animation/active-constraint-declarations.h>
23 #include <dali/public-api/object/any.h>
24 #include <dali/public-api/object/handle.h>
25 #include <dali/public-api/object/property.h>
27 namespace Dali DALI_IMPORT_API
30 namespace Internal DALI_INTERNAL
32 class ActiveConstraintBase;
36 * @brief A constraint which is being applied to an object.
38 class DALI_IMPORT_API ActiveConstraint : public Handle
43 static const Property::Index WEIGHT; ///< Property 0, name "weight", type FLOAT
45 static const float FINAL_WEIGHT; ///< 1.0f means the constraint is fully-applied, unless weight is still being animated
46 static const float DEFAULT_WEIGHT; ///< 1.0f
49 static const char* const SIGNAL_APPLIED; ///< name "applied"
52 * @brief Create an uninitialized Constraint; this can be initialized with Constraint::New().
54 * Calling member functions with an uninitialized Dali::Object is not allowed.
59 * @brief Dali::ActiveConstraint is intended as a base class
61 * This is non-virtual since derived Handle types must not contain data or virtual methods.
66 * @copydoc Dali::BaseHandle::operator=
68 using BaseHandle::operator=;
71 * @brief Retrieve the object which this constraint is targeting.
73 * @return The target object.
75 Handle GetTargetObject();
78 * @brief Retrieve the property which this constraint is targeting.
80 * @return The target property.
82 Property::Index GetTargetProperty();
85 * @brief Set the weight of the constraint; this is a value clamped between 0.
87 * The default is 1.0f.
88 * 0.0f means the constraint has no effect, and 1.0f means the constraint is fully-applied.
89 * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentWeight().
90 * @param [in] weight The weight.
92 void SetWeight( float weight );
95 * @brief Retrieve the current weight of the constraint.
97 * @return The current weight.
99 float GetCurrentWeight() const;
102 * @brief This signal is emitted after the apply-time of the constraint has expired.
104 * @note A non-zero apply-time must have been set using Constraint::SetApplyTime().
105 * @return A signal object to Connect() with.
107 ActiveConstraintSignalV2& AppliedSignal();
109 public: // Not intended for use by Application developers
112 * @brief This constructor is used by Dali New() methods.
114 * @param [in] constraint A pointer to a newly allocated Dali resource
116 explicit DALI_INTERNAL ActiveConstraint( Internal::ActiveConstraintBase* constraint );
121 #endif // __DALI_ACTIVE_CONSTRAINT_H__