dali/internal/event/animation/constraint-base.h

   1 #ifndef DALI_INTERNAL_ACTIVE_CONSTRAINT_BASE_H
   2 #define DALI_INTERNAL_ACTIVE_CONSTRAINT_BASE_H
   3
   4 /*
   5  * Copyright (c) 2021 Samsung Electronics Co., Ltd.
   6  *
   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
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  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.
  18  *
  19  */
  20
  21 // INTERNAL INCLUDES
  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>
  28
  29 namespace Dali
  30 {
  31 namespace Internal
  32 {
  33 class EventThreadServices;
  34 class Object;
  35 using ObjectContainer = Dali::Vector<Object*>;
  36 using ObjectIter      = ObjectContainer::Iterator;
  37
  38 namespace SceneGraph
  39 {
  40 class ConstraintBase;
  41
  42 template<typename T>
  43 class AnimatableProperty;
  44 } // namespace SceneGraph
  45
  46 /**
  47  * An abstract base class for active constraints.
  48  */
  49 class ConstraintBase : public BaseObject, public Object::Observer
  50 {
  51 public:
  52   using RemoveAction = Dali::Constraint::RemoveAction;
  53
  54   /**
  55    * Constructor.
  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.
  60    */
  61   ConstraintBase(Object& object, Property::Index targetPropertyIndex, SourceContainer& sources);
  62
  63   /**
  64    * Clone this constraint for another object.
  65    * @param[in]  object  The object to clone this constraint for
  66    * @return A new constraint.
  67    */
  68   ConstraintBase* Clone(Object& object);
  69
  70   /**
  71    * Virtual destructor.
  72    */
  73   ~ConstraintBase() override;
  74
  75   /**
  76    * Adds a constraint source to the constraint
  77    *
  78    * @param[in] source The constraint source input to add
  79    */
  80   void AddSource(Source source);
  81
  82   /**
  83    * @copydoc Dali::Constraint::Apply()
  84    */
  85   void Apply(bool isPreConstraint = true);
  86
  87   /**
  88    * @copydoc Dali::Constraint::ApplyPost()
  89    */
  90   void ApplyPost();
  91
  92   /**
  93    * @copydoc Dali::Constraint::Remove()
  94    */
  95   void Remove();
  96
  97   /**
  98    * Called when the Constraint is removed.
  99    *
 100    * @note This removes the scene-object as well but then does not call back into the target-object.
 101    */
 102   void RemoveInternal();
 103
 104   /**
 105    * Retrieve the parent of the constraint.
 106    * @return The parent object, or NULL.
 107    */
 108   Object* GetParent();
 109
 110   /**
 111    * @copydoc Dali::Constraint::GetTargetObject()
 112    */
 113   Dali::Handle GetTargetObject();
 114
 115   /**
 116    * @copydoc Dali::Constraint::GetTargetProperty()
 117    */
 118   Property::Index GetTargetProperty();
 119
 120   /**
 121    * @copydoc Dali::Constraint::SetRemoveAction()
 122    */
 123   void SetRemoveAction(RemoveAction action);
 124
 125   /**
 126    * @copydoc Dali::Constraint::GetRemoveAction()
 127    */
 128   RemoveAction GetRemoveAction() const;
 129
 130   /**
 131    * @copydoc Dali::Constraint::SetTag()
 132    */
 133   void SetTag(uint32_t tag);
 134
 135   /**
 136    * @copydoc Dali::Constraint::GetTag()
 137    */
 138   uint32_t GetTag() const;
 139
 140 private: // Object::Observer methods
 141   /**
 142    * @copydoc Object::Observer::SceneObjectAdded()
 143    */
 144   void SceneObjectAdded(Object& object) override;
 145
 146   /**
 147    * @copydoc Object::Observer::SceneObjectRemoved()
 148    */
 149   void SceneObjectRemoved(Object& object) override;
 150
 151   /**
 152    * @copydoc Object::Observer::ObjectDestroyed()
 153    */
 154   void ObjectDestroyed(Object& object) override;
 155
 156 private:
 157   /**
 158    * Helper to observe an object, if not already observing it
 159    */
 160   void ObserveObject(Object& object);
 161
 162   /**
 163    * Helper to stop observing objects
 164    */
 165   void StopObservation();
 166
 167   // To be implemented in derived classes
 168
 169   /**
 170    * Clone the actual constraint
 171    *
 172    * @param object to clone to
 173    * @return pointer to the clone
 174    */
 175   virtual ConstraintBase* DoClone(Object& object) = 0;
 176
 177   /**
 178    * Connect the constraint
 179    */
 180   virtual void ConnectConstraint(bool isPreConstraint = true) = 0;
 181
 182 protected:
 183   /**
 184    * Helper to Add an input property to the container of property owners
 185    * @param source constraint[in] source used to determine the type and locate the property on the object
 186    * @param propertyOwners[out] reference to the container to add
 187    * @param componentIndex[out] component index
 188    * @return pointer to input property if it was found, nullptr otherwise
 189    */
 190   PropertyInputImpl* AddInputProperty(Source& source, SceneGraph::PropertyOwnerContainer& propertyOwners, int32_t& componentIndex);
 191
 192   /**
 193    * Get the event thread services object - used for sending messages to the scene graph
 194    * Assert if called from the wrong thread.
 195    * This is intentionally inline for performance reasons.
 196    *
 197    * @return The event thread services object
 198    */
 199   inline EventThreadServices& GetEventThreadServices()
 200   {
 201     DALI_ASSERT_DEBUG(EventThreadServices::IsCoreRunning());
 202     return mEventThreadServices;
 203   }
 204
 205   /**
 206    * Get the event thread services object - used for sending messages to the scene graph
 207    * Assert if called from the wrong thread
 208    * This is intentionally inline for performance reasons.
 209    *
 210    * @return The event thread services object
 211    */
 212   inline const EventThreadServices& GetEventThreadServices() const
 213   {
 214     DALI_ASSERT_DEBUG(EventThreadServices::IsCoreRunning());
 215     return mEventThreadServices;
 216   }
 217
 218 protected:
 219   EventThreadServices&              mEventThreadServices;
 220   Object*                           mTargetObject; ///< The object owns the constraint.
 221   const SceneGraph::ConstraintBase* mSceneGraphConstraint;
 222   SourceContainer                   mSources;
 223   ObjectContainer                   mObservedObjects; // We don't observe the same object twice
 224   Property::Index                   mTargetPropertyIndex;
 225   RemoveAction                      mRemoveAction;
 226   uint32_t                          mTag;
 227   bool                              mApplied : 1;         ///< Whether the constraint has been applied
 228   bool                              mSourceDestroyed : 1; ///< Is set to true if any of our input source objects are destroyed
 229   bool                              mIsPreConstraint : 1; ///< Is set to true if this constraint is run before transform.
 230 };
 231
 232 } // namespace Internal
 233
 234 // Helpers for public-api forwarding methods
 235
 236 inline Internal::ConstraintBase& GetImplementation(Dali::Constraint& constraint)
 237 {
 238   DALI_ASSERT_ALWAYS(constraint && "Constraint handle is empty");
 239
 240   BaseObject& handle = constraint.GetBaseObject();
 241
 242   return static_cast<Internal::ConstraintBase&>(handle);
 243 }
 244
 245 inline const Internal::ConstraintBase& GetImplementation(const Dali::Constraint& constraint)
 246 {
 247   DALI_ASSERT_ALWAYS(constraint && "Constraint handle is empty");
 248
 249   const BaseObject& handle = constraint.GetBaseObject();
 250
 251   return static_cast<const Internal::ConstraintBase&>(handle);
 252 }
 253
 254 } // namespace Dali
 255
 256 #endif // DALI_INTERNAL_ACTIVE_CONSTRAINT_BASE_H