1 #ifndef __DALI_INTERNAL_ACTIVE_CONSTRAINT_BASE_H__
2 #define __DALI_INTERNAL_ACTIVE_CONSTRAINT_BASE_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/internal/common/owner-pointer.h>
23 #include <dali/public-api/animation/constraint.h>
24 #include <dali/public-api/common/dali-common.h>
25 #include <dali/public-api/object/base-object.h>
26 #include <dali/internal/event/animation/constraint-source-impl.h>
34 class EventThreadServices;
36 typedef Dali::Vector<Object*> ObjectContainer;
37 typedef ObjectContainer::Iterator ObjectIter;
44 class AnimatableProperty;
48 * An abstract base class for active constraints.
50 class ConstraintBase : public BaseObject, public Object::Observer
54 typedef Dali::Constraint::RemoveAction RemoveAction;
58 * @param[in] object The property owning object.
59 * @param[in] messageController Used to send messages to the update-thread.
60 * @param[in] targetPropertyIndex The index of the property being constrained.
61 * @param[in] sources The sources of the input properties.
63 ConstraintBase( Object& object, Property::Index targetPropertyIndex, SourceContainer& sources );
66 * Clone this constraint for another object.
67 * @param[in] object The object to clone this constraint for
68 * @return A new constraint.
70 virtual ConstraintBase* Clone( Object& object ) = 0;
75 virtual ~ConstraintBase();
78 * Adds a constraint source to the constraint
80 * @param[in] source The constraint source input to add
82 void AddSource( Source source );
85 * @copydoc Dali::Constraint::Apply()
90 * @copydoc Dali::Constraint::Remove()
95 * Called when the Constraint is removed.
97 * @note This removes the scene-object as well but then does not call back into the target-object.
99 void RemoveInternal();
102 * Retrieve the parent of the constraint.
103 * @return The parent object, or NULL.
108 * @copydoc Dali::Constraint::GetTargetObject()
110 Dali::Handle GetTargetObject();
113 * @copydoc Dali::Constraint::GetTargetProperty()
115 Property::Index GetTargetProperty();
118 * @copydoc Dali::Constraint::SetRemoveAction()
120 void SetRemoveAction(RemoveAction action);
123 * @copydoc Dali::Constraint::GetRemoveAction()
125 RemoveAction GetRemoveAction() const;
128 * @copydoc Dali::Constraint::SetTag()
130 void SetTag(const unsigned int tag);
133 * @copydoc Dali::Constraint::GetTag()
135 unsigned int GetTag() const;
137 private: // Object::Observer methods
140 * @copydoc Object::Observer::SceneObjectAdded()
142 virtual void SceneObjectAdded( Object& object );
145 * @copydoc Object::Observer::SceneObjectRemoved()
147 virtual void SceneObjectRemoved( Object& object );
150 * @copydoc Object::Observer::ObjectDestroyed()
152 virtual void ObjectDestroyed( Object& object );
157 * Helper to observe an object, if not already observing it
159 void ObserveObject( Object& object );
162 * Helper to stop observing objects
164 void StopObservation();
166 // To be implemented in derived classes
169 * Create and connect a constraint for a scene-object.
171 virtual void ConnectConstraint() = 0;
176 * Get the event thread services object - used for sending messages to the scene graph
177 * Assert if called from the wrong thread.
178 * This is intentionally inline for performance reasons.
180 * @return The event thread services object
182 inline EventThreadServices& GetEventThreadServices()
184 DALI_ASSERT_DEBUG( EventThreadServices::IsCoreRunning() );
185 return mEventThreadServices;
189 * Get the event thread services object - used for sending messages to the scene graph
190 * Assert if called from the wrong thread
191 * This is intentionally inline for performance reasons.
193 * @return The event thread services object
195 inline const EventThreadServices& GetEventThreadServices() const
197 DALI_ASSERT_DEBUG( EventThreadServices::IsCoreRunning() );
198 return mEventThreadServices;
202 EventThreadServices& mEventThreadServices;
203 Object* mTargetObject; ///< The object owns the constraint.
204 const SceneGraph::ConstraintBase* mSceneGraphConstraint;
205 SourceContainer mSources;
206 ObjectContainer mObservedObjects; // We don't observe the same object twice
207 Property::Index mTargetPropertyIndex;
208 RemoveAction mRemoveAction;
210 bool mApplied:1; ///< Whether the constraint has been applied
211 bool mSourceDestroyed:1; ///< Is set to true if any of our input source objects are destroyed
214 } // namespace Internal
216 // Helpers for public-api forwarding methods
218 inline Internal::ConstraintBase& GetImplementation(Dali::Constraint& constraint)
220 DALI_ASSERT_ALWAYS( constraint && "Constraint handle is empty" );
222 BaseObject& handle = constraint.GetBaseObject();
224 return static_cast<Internal::ConstraintBase&>(handle);
227 inline const Internal::ConstraintBase& GetImplementation(const Dali::Constraint& constraint)
229 DALI_ASSERT_ALWAYS( constraint && "Constraint handle is empty" );
231 const BaseObject& handle = constraint.GetBaseObject();
233 return static_cast<const Internal::ConstraintBase&>(handle);
238 #endif // __DALI_INTERNAL_ACTIVE_CONSTRAINT_BASE_H__