1 #ifndef DALI_INTERNAL_ACTIVE_CONSTRAINT_BASE_H
2 #define DALI_INTERNAL_ACTIVE_CONSTRAINT_BASE_H
5 * Copyright (c) 2021 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/internal/event/animation/constraint-source-impl.h>
24 #include <dali/internal/update/animation/scene-graph-constraint-base.h>
25 #include <dali/public-api/animation/constraint.h>
26 #include <dali/public-api/common/dali-common.h>
27 #include <dali/public-api/object/base-object.h>
33 class EventThreadServices;
35 using ObjectContainer = Dali::Vector<Object*>;
36 using ObjectIter = ObjectContainer::Iterator;
43 class AnimatableProperty;
44 } // namespace SceneGraph
47 * An abstract base class for active constraints.
49 class ConstraintBase : public BaseObject, public Object::Observer
52 using RemoveAction = Dali::Constraint::RemoveAction;
56 * @param[in] object The property owning object.
57 * @param[in] messageController Used to send messages to the update-thread.
58 * @param[in] targetPropertyIndex The index of the property being constrained.
59 * @param[in] sources The sources of the input properties.
61 ConstraintBase(Object& object, Property::Index targetPropertyIndex, SourceContainer& sources);
64 * Clone this constraint for another object.
65 * @param[in] object The object to clone this constraint for
66 * @return A new constraint.
68 ConstraintBase* Clone(Object& object);
73 ~ConstraintBase() override;
76 * Adds a constraint source to the constraint
78 * @param[in] source The constraint source input to add
80 void AddSource(Source source);
83 * @copydoc Dali::Constraint::Apply()
88 * @copydoc Dali::Constraint::Remove()
93 * Called when the Constraint is removed.
95 * @note This removes the scene-object as well but then does not call back into the target-object.
97 void RemoveInternal();
100 * Retrieve the parent of the constraint.
101 * @return The parent object, or NULL.
106 * @copydoc Dali::Constraint::GetTargetObject()
108 Dali::Handle GetTargetObject();
111 * @copydoc Dali::Constraint::GetTargetProperty()
113 Property::Index GetTargetProperty();
116 * @copydoc Dali::Constraint::SetRemoveAction()
118 void SetRemoveAction(RemoveAction action);
121 * @copydoc Dali::Constraint::GetRemoveAction()
123 RemoveAction GetRemoveAction() const;
126 * @copydoc Dali::Constraint::SetTag()
128 void SetTag(uint32_t tag);
131 * @copydoc Dali::Constraint::GetTag()
133 uint32_t GetTag() const;
135 private: // Object::Observer methods
137 * @copydoc Object::Observer::SceneObjectAdded()
139 void SceneObjectAdded(Object& object) override;
142 * @copydoc Object::Observer::SceneObjectRemoved()
144 void SceneObjectRemoved(Object& object) override;
147 * @copydoc Object::Observer::ObjectDestroyed()
149 void ObjectDestroyed(Object& object) override;
153 * Helper to observe an object, if not already observing it
155 void ObserveObject(Object& object);
158 * Helper to stop observing objects
160 void StopObservation();
162 // To be implemented in derived classes
165 * Clone the actual constraint
167 * @param object to clone to
168 * @return pointer to the clone
170 virtual ConstraintBase* DoClone(Object& object) = 0;
173 * Connect the constraint
175 virtual void ConnectConstraint() = 0;
179 * Helper to Add an input property to the container of property owners
180 * @param source constraint[in] source used to determine the type and locate the property on the object
181 * @param propertyOwners[out] reference to the container to add
182 * @param componentIndex[out] component index
183 * @return pointer to input property if it was found, nullptr otherwise
185 PropertyInputImpl* AddInputProperty(Source& source, SceneGraph::PropertyOwnerContainer& propertyOwners, int32_t& componentIndex);
188 * Get the event thread services object - used for sending messages to the scene graph
189 * Assert if called from the wrong thread.
190 * This is intentionally inline for performance reasons.
192 * @return The event thread services object
194 inline EventThreadServices& GetEventThreadServices()
196 DALI_ASSERT_DEBUG(EventThreadServices::IsCoreRunning());
197 return mEventThreadServices;
201 * Get the event thread services object - used for sending messages to the scene graph
202 * Assert if called from the wrong thread
203 * This is intentionally inline for performance reasons.
205 * @return The event thread services object
207 inline const EventThreadServices& GetEventThreadServices() const
209 DALI_ASSERT_DEBUG(EventThreadServices::IsCoreRunning());
210 return mEventThreadServices;
214 EventThreadServices& mEventThreadServices;
215 Object* mTargetObject; ///< The object owns the constraint.
216 const SceneGraph::ConstraintBase* mSceneGraphConstraint;
217 SourceContainer mSources;
218 ObjectContainer mObservedObjects; // We don't observe the same object twice
219 Property::Index mTargetPropertyIndex;
220 RemoveAction mRemoveAction;
222 bool mApplied : 1; ///< Whether the constraint has been applied
223 bool mSourceDestroyed : 1; ///< Is set to true if any of our input source objects are destroyed
226 } // namespace Internal
228 // Helpers for public-api forwarding methods
230 inline Internal::ConstraintBase& GetImplementation(Dali::Constraint& constraint)
232 DALI_ASSERT_ALWAYS(constraint && "Constraint handle is empty");
234 BaseObject& handle = constraint.GetBaseObject();
236 return static_cast<Internal::ConstraintBase&>(handle);
239 inline const Internal::ConstraintBase& GetImplementation(const Dali::Constraint& constraint)
241 DALI_ASSERT_ALWAYS(constraint && "Constraint handle is empty");
243 const BaseObject& handle = constraint.GetBaseObject();
245 return static_cast<const Internal::ConstraintBase&>(handle);
250 #endif // DALI_INTERNAL_ACTIVE_CONSTRAINT_BASE_H