1 #ifndef DALI_INTERNAL_ACTIVE_CONSTRAINT_BASE_H
2 #define DALI_INTERNAL_ACTIVE_CONSTRAINT_BASE_H
5 * Copyright (c) 2019 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/constraint.h>
23 #include <dali/public-api/common/dali-common.h>
24 #include <dali/public-api/object/base-object.h>
25 #include <dali/internal/common/owner-pointer.h>
26 #include <dali/internal/event/animation/constraint-source-impl.h>
27 #include <dali/internal/update/animation/scene-graph-constraint-base.h>
35 class EventThreadServices;
37 typedef Dali::Vector<Object*> ObjectContainer;
38 typedef ObjectContainer::Iterator ObjectIter;
45 class AnimatableProperty;
49 * An abstract base class for active constraints.
51 class ConstraintBase : public BaseObject, public Object::Observer
55 typedef Dali::Constraint::RemoveAction RemoveAction;
59 * @param[in] object The property owning object.
60 * @param[in] messageController Used to send messages to the update-thread.
61 * @param[in] targetPropertyIndex The index of the property being constrained.
62 * @param[in] sources The sources of the input properties.
64 ConstraintBase( Object& object, Property::Index targetPropertyIndex, SourceContainer& sources );
67 * Clone this constraint for another object.
68 * @param[in] object The object to clone this constraint for
69 * @return A new constraint.
71 ConstraintBase* Clone( Object& object );
76 virtual ~ConstraintBase();
79 * Adds a constraint source to the constraint
81 * @param[in] source The constraint source input to add
83 void AddSource( Source source );
86 * @copydoc Dali::Constraint::Apply()
91 * @copydoc Dali::Constraint::Remove()
96 * Called when the Constraint is removed.
98 * @note This removes the scene-object as well but then does not call back into the target-object.
100 void RemoveInternal();
103 * Retrieve the parent of the constraint.
104 * @return The parent object, or NULL.
109 * @copydoc Dali::Constraint::GetTargetObject()
111 Dali::Handle GetTargetObject();
114 * @copydoc Dali::Constraint::GetTargetProperty()
116 Property::Index GetTargetProperty();
119 * @copydoc Dali::Constraint::SetRemoveAction()
121 void SetRemoveAction(RemoveAction action);
124 * @copydoc Dali::Constraint::GetRemoveAction()
126 RemoveAction GetRemoveAction() const;
129 * @copydoc Dali::Constraint::SetTag()
131 void SetTag( uint32_t tag );
134 * @copydoc Dali::Constraint::GetTag()
136 uint32_t GetTag() const;
138 private: // Object::Observer methods
141 * @copydoc Object::Observer::SceneObjectAdded()
143 virtual void SceneObjectAdded( Object& object );
146 * @copydoc Object::Observer::SceneObjectRemoved()
148 virtual void SceneObjectRemoved( Object& object );
151 * @copydoc Object::Observer::ObjectDestroyed()
153 virtual void ObjectDestroyed( Object& object );
158 * Helper to observe an object, if not already observing it
160 void ObserveObject( Object& object );
163 * Helper to stop observing objects
165 void StopObservation();
167 // To be implemented in derived classes
170 * Clone the actual constraint
172 * @param object to clone to
173 * @return pointer to the clone
175 virtual ConstraintBase* DoClone( Object& object ) = 0;
178 * Connect the constraint
180 virtual void ConnectConstraint() = 0;
185 * Helper to Add an input property to the container of property owners
186 * @param source constraint[in] source used to determine the type and locate the property on the object
187 * @param propertyOwners[out] reference to the container to add
188 * @param componentIndex[out] component index
189 * @return pointer to input property if it was found, nullptr otherwise
191 PropertyInputImpl* AddInputProperty( Source& source, SceneGraph::PropertyOwnerContainer& propertyOwners, int32_t& componentIndex );
194 * Get the event thread services object - used for sending messages to the scene graph
195 * Assert if called from the wrong thread.
196 * This is intentionally inline for performance reasons.
198 * @return The event thread services object
200 inline EventThreadServices& GetEventThreadServices()
202 DALI_ASSERT_DEBUG( EventThreadServices::IsCoreRunning() );
203 return mEventThreadServices;
207 * Get the event thread services object - used for sending messages to the scene graph
208 * Assert if called from the wrong thread
209 * This is intentionally inline for performance reasons.
211 * @return The event thread services object
213 inline const EventThreadServices& GetEventThreadServices() const
215 DALI_ASSERT_DEBUG( EventThreadServices::IsCoreRunning() );
216 return mEventThreadServices;
220 EventThreadServices& mEventThreadServices;
221 Object* mTargetObject; ///< The object owns the constraint.
222 const SceneGraph::ConstraintBase* mSceneGraphConstraint;
223 SourceContainer mSources;
224 ObjectContainer mObservedObjects; // We don't observe the same object twice
225 Property::Index mTargetPropertyIndex;
226 RemoveAction mRemoveAction;
228 bool mApplied:1; ///< Whether the constraint has been applied
229 bool mSourceDestroyed:1; ///< Is set to true if any of our input source objects are destroyed
232 } // namespace Internal
234 // Helpers for public-api forwarding methods
236 inline Internal::ConstraintBase& GetImplementation(Dali::Constraint& constraint)
238 DALI_ASSERT_ALWAYS( constraint && "Constraint handle is empty" );
240 BaseObject& handle = constraint.GetBaseObject();
242 return static_cast<Internal::ConstraintBase&>(handle);
245 inline const Internal::ConstraintBase& GetImplementation(const Dali::Constraint& constraint)
247 DALI_ASSERT_ALWAYS( constraint && "Constraint handle is empty" );
249 const BaseObject& handle = constraint.GetBaseObject();
251 return static_cast<const Internal::ConstraintBase&>(handle);
256 #endif // DALI_INTERNAL_ACTIVE_CONSTRAINT_BASE_H