dali/internal/event/common/object-impl.h

   1 #ifndef DALI_INTERNAL_OBJECT_H
   2 #define DALI_INTERNAL_OBJECT_H
   3
   4 /*
   5  * Copyright (c) 2020 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 // EXTERNAL INCLUDES
  22 #include <cstdint> // uint32_t
  23
  24 // INTERNAL INCLUDES
  25 #include <dali/public-api/animation/constraint.h>
  26 #include <dali/public-api/common/dali-vector.h>
  27 #include <dali/public-api/common/vector-wrapper.h>
  28 #include <dali/public-api/object/base-object.h>
  29 #include <dali/public-api/object/handle.h>
  30 #include <dali/public-api/object/property.h>
  31 #include <dali/public-api/object/property-index-ranges.h>
  32 #include <dali/public-api/object/property-input.h>
  33 #include <dali/public-api/object/property-map.h>
  34 #include <dali/public-api/object/property-notification.h>
  35 #include <dali/devel-api/common/owner-container.h>
  36 #include <dali/devel-api/object/handle-devel.h>
  37 #include <dali/internal/event/animation/animation-impl.h>
  38 #include <dali/internal/event/common/event-thread-services.h>
  39 #include <dali/internal/event/common/property-input-impl.h>
  40 #include <dali/internal/event/common/property-metadata.h>
  41 #include <dali/internal/update/common/property-base.h>
  42
  43 namespace Dali
  44 {
  45
  46 class PropertyNotification;
  47
  48 namespace Internal
  49 {
  50 class ConstraintBase;
  51 class EventThreadServices;
  52 class PropertyCondition;
  53 class PropertyInputImpl;
  54 class Stage;
  55 class TypeInfo;
  56
  57 namespace SceneGraph
  58 {
  59 class PropertyBase;
  60 class PropertyOwner;
  61 }
  62
  63 using ConstraintContainer = std::vector< Dali::Constraint >;
  64 using ConstraintIter = ConstraintContainer::iterator;
  65 using ConstraintConstIter = ConstraintContainer::const_iterator;
  66
  67 /**
  68  * A base class for objects which optionally provide properties.
  69  * The concrete derived class is responsible for implementing the property system methods.
  70  * Classes may derive from Dali::BaseObject, until any properties are required.
  71  *
  72  * An object for a property-owning object in the scene-graph.
  73  * This provides an interface for observing the addition/removal of scene-objects.
  74  *
  75  * The derived class should either:
  76  *   a) Create their own scene-graph object and pass it to Object constructor.
  77  *   b) pass nullptr to Object constructor, in this case Object will create default scene object for property handling
  78  */
  79 class Object : public Dali::BaseObject
  80 {
  81 public:
  82
  83   using Capability = Dali::Handle::Capability;
  84
  85   class Observer
  86   {
  87   public:
  88
  89     /**
  90      * Called immediately after the object has created & passed ownership of a scene-graph object.
  91      * @param[in] object The object object.
  92      */
  93     virtual void SceneObjectAdded(Object& object) = 0;
  94
  95     /**
  96      * Called shortly before the object sends a message to remove its scene object.
  97      * @param[in] object The object object.
  98      */
  99     virtual void SceneObjectRemoved(Object& object) = 0;
 100
 101     /**
 102      * Called shortly before the object itself is destroyed; no further callbacks will be received.
 103      * @param[in] object The object object.
 104      */
 105     virtual void ObjectDestroyed(Object& object) = 0;
 106
 107   protected:
 108
 109     /**
 110      * Virtual destructor
 111      */
 112     virtual ~Observer(){}
 113   };
 114
 115   /**
 116    * Creates a new object
 117    *
 118    * @return an smart pointer to the object
 119    */
 120   static IntrusivePtr<Object> New();
 121
 122   /**
 123    * Add an observer to the object.
 124    * @param[in] observer The observer to add.
 125    */
 126   void AddObserver( Observer& observer );
 127
 128   /**
 129    * Remove an observer from the object
 130    * @pre The observer has already been added.
 131    * @param[in] observer The observer to remove.
 132    */
 133   void RemoveObserver( Observer& observer );
 134
 135   /**
 136    * @copydoc Dali::Handle::Supports()
 137    */
 138   bool Supports( Capability capability ) const;
 139
 140   /**
 141    * @copydoc Dali::Handle::GetPropertyCount()
 142    */
 143   uint32_t GetPropertyCount() const;
 144
 145   /**
 146    * @copydoc Dali::Handle::GetPropertyName()
 147    */
 148   std::string GetPropertyName( Property::Index index ) const;
 149
 150   /**
 151    * @copydoc Dali::Handle::GetPropertyIndex()
 152    */
 153   Property::Index GetPropertyIndex( Property::Key key ) const;
 154
 155   /**
 156    * @copydoc Dali::Handle::IsPropertyWritable()
 157    */
 158   bool IsPropertyWritable( Property::Index index ) const;
 159
 160   /**
 161    * @copydoc Dali::Handle::IsPropertyAnimatable()
 162    */
 163   bool IsPropertyAnimatable( Property::Index index ) const;
 164
 165   /**
 166    * @copydoc Dali::Handle::IsPropertyAConstraintInput()
 167    */
 168   bool IsPropertyAConstraintInput( Property::Index index ) const;
 169
 170   /**
 171    * @copydoc Dali::Handle::GetPropertyType()
 172    */
 173   Property::Type GetPropertyType( Property::Index index ) const;
 174
 175   /**
 176    * @copydoc Dali::Handle::SetProperty()
 177    */
 178   void SetProperty(Property::Index index, Property::Value propertyValue);
 179
 180   /**
 181    * @copydoc Dali::Handle::GetProperty()
 182    */
 183   Property::Value GetProperty( Property::Index index ) const;
 184
 185   /**
 186    * @brief Retrieves the latest value of the property on the scene-graph.
 187    * @param[in]  index  The index of the property required.
 188    * @return The latest value of the property on the scene-graph.
 189    */
 190   Property::Value GetCurrentProperty( Property::Index index ) const;
 191
 192   /**
 193    * @copydoc Dali::Handle::GetPropertyIndices()
 194    */
 195   void GetPropertyIndices( Property::IndexContainer& indices ) const;
 196
 197   /**
 198    * @copydoc Dali::Handle::RegisterProperty()
 199    */
 200   Property::Index RegisterProperty(std::string name, Property::Value propertyValue);
 201
 202   /**
 203    * @copydoc Dali::Handle::RegisterProperty()
 204    */
 205   Property::Index RegisterProperty(std::string name, Property::Index key, Property::Value propertyValue);
 206
 207   /**
 208    * @copydoc Dali::DevelHandle::SetProperties()
 209    */
 210   void SetProperties( const Property::Map& properties );
 211
 212   /**
 213    * @copydoc Dali::DevelHandle::GetProperties()
 214    */
 215   void GetProperties( Property::Map& properties );
 216
 217   /**
 218    * @copydoc Dali::Handle::RegisterProperty(std::string name, Property::Value propertyValue, Property::AccessMode accessMode)
 219    */
 220   Property::Index RegisterProperty(std::string name, Property::Value propertyValue, Property::AccessMode accessMode);
 221
 222   /**
 223    * @brief Implementing method for this override
 224    */
 225   Property::Index RegisterProperty(std::string          name,
 226                                    Property::Index      key,
 227                                    Property::Value      propertyValue,
 228                                    Property::AccessMode accessMode);
 229
 230   /**
 231    * @brief returns true if the custom property exists on this object.
 232    *
 233    * @note The property may be defined for a type within the type registry, but it isn't explicity
 234    * defined in every consequent instantiation. It can be automatically added, e.g. parenting an actor
 235    * automatically registers it's parent container's child properties.
 236    *
 237    * @param[in] handle The handle of the object to test
 238    * @param[in] index The property index to look for.
 239    * @return true if the property exists on the object, false otherwise.
 240    */
 241   bool DoesCustomPropertyExist( Property::Index index );
 242
 243   /**
 244    * @copydoc Dali::Handle::AddPropertyNotification()
 245    */
 246   Dali::PropertyNotification AddPropertyNotification( Property::Index index,
 247                                                       int32_t componentIndex,
 248                                                       const Dali::PropertyCondition& condition );
 249
 250   /**
 251    * @copydoc Dali::Handle::RemovePropertyNotification()
 252    */
 253   void RemovePropertyNotification( Dali::PropertyNotification propertyNotification );
 254
 255   /**
 256    * @copydoc Dali::Handle::RemovePropertyNotifications()
 257    */
 258   void RemovePropertyNotifications();
 259
 260   /**
 261    * Notifies that a property is being animated.
 262    * @param[in] animation The animation animating the property.
 263    * @param[in] index The index of the property.
 264    * @param[in] value The value of the property after the animation.
 265    * @param[in] animationType Whether the property value given is the target or a relative value.
 266    */
 267   void NotifyPropertyAnimation( Animation& animation, Property::Index index, const Property::Value& value, Animation::Type animationType );
 268
 269   /******************************** Uniform Mappings ********************************/
 270
 271   /**
 272    * Adds uniform mapping for given property
 273    * @param propertyIndex index of the property
 274    * @param uniformName name of the uniform (same as property name)
 275    */
 276   void AddUniformMapping(Property::Index propertyIndex, std::string uniformName) const;
 277
 278   /**
 279    * Removes uniform mapping for given property
 280    * @param uniformName name of the uniform (same as property name)
 281    */
 282   void RemoveUniformMapping( const std::string& uniformName ) const;
 283
 284   /******************************** Constraints ********************************/
 285
 286   /**
 287    * Apply a constraint to an Object.
 288    * @param[in] constraint The constraint to apply.
 289    */
 290   void ApplyConstraint( ConstraintBase& constraint );
 291
 292   /**
 293    * Remove one constraint from an Object.
 294    * @param[in] constraint The constraint to remove.
 295    */
 296   void RemoveConstraint( ConstraintBase& constraint );
 297
 298   /**
 299    * Remove all constraints from a Object.
 300    */
 301   void RemoveConstraints();
 302
 303   /**
 304    * @copydoc Dali::Handle::RemoveConstraints( uint32_t )
 305    */
 306   void RemoveConstraints( uint32_t tag );
 307
 308   /**
 309    * Called by TypeInfo to set the type-info that this object-impl is created by.
 310    * @param[in] typeInfo The TypeInfo that creates this object-impl.
 311    */
 312   void SetTypeInfo( const TypeInfo* typeInfo );
 313
 314   /**
 315    * @return the index from which custom properties start
 316    */
 317   uint32_t CustomPropertyStartIndex()
 318   {
 319     return PROPERTY_CUSTOM_START_INDEX;
 320   }
 321
 322   /**
 323    * Retrieve the scene-graph object added by this object.
 324    * @return reference to the scene-graph object, it will always exist
 325    */
 326   const SceneGraph::PropertyOwner& GetSceneObject() const;
 327
 328   /********************  Can be overridden by deriving classes ********************/
 329
 330   /**
 331    * Retrieve an animatable property owned by the scene-graph object.
 332    * @pre -1 < index < GetPropertyCount().
 333    * @param[in] index The index of the property.
 334    * @return A dereferenceable pointer to a property, or NULL if a scene-object does not exist with this property.
 335    */
 336   virtual const SceneGraph::PropertyBase* GetSceneObjectAnimatableProperty( Property::Index index ) const;
 337
 338   /**
 339    * Retrieve a constraint input-property owned by the scene-graph object.
 340    * @pre -1 < index < GetPropertyCount().
 341    * @param[in] index The index of the property.
 342    * @return A dereferenceable pointer to an input property, or NULL if a scene-object does not exist with this property.
 343    */
 344   virtual const PropertyInputImpl* GetSceneObjectInputProperty( Property::Index index ) const;
 345
 346   /**
 347    * Query whether the property is a component of a scene-graph property.
 348    * @pre -1 < index < GetPropertyCount().
 349    * @param[in] index The index of the property.
 350    * @return The index or Property::INVALID_COMPONENT_INDEX.
 351    */
 352   virtual int32_t GetPropertyComponentIndex( Property::Index index ) const;
 353
 354   /**
 355    * Query whether playing an animation is possible or not.
 356    * @return true if playing an animation is possible.
 357    */
 358   virtual bool IsAnimationPossible() const
 359   {
 360     return true;
 361   }
 362
 363   /**
 364    * @copydoc Dali::Handle::PropertySetSignal()
 365    */
 366   Handle::PropertySetSignalType& PropertySetSignal();
 367
 368 protected:
 369
 370   /**
 371    * Constructor. Protected so use New to construct an instance of this class
 372    *
 373    * @param sceneObject the scene graph property owner
 374    */
 375   Object( const SceneGraph::PropertyOwner* sceneObject );
 376
 377   /**
 378    * A reference counted object may only be deleted by calling Unreference()
 379    */
 380   ~Object() override;
 381
 382   /**
 383    * Called immediately by derived classes, after the scene-object has been created & passed to the scene-graph.
 384    */
 385   void OnSceneObjectAdd();
 386
 387   /**
 388    * Called by derived classes, shortly before send a message to remove the scene-object.
 389    */
 390   void OnSceneObjectRemove();
 391
 392   /**
 393    * For overriding by derived classes to return the parent of this object.
 394    */
 395   virtual Object* GetParentObject() const
 396   {
 397     // By default the Object does not have a parent
 398     return nullptr;
 399   };
 400
 401   /**
 402    * For use in derived classes.
 403    * This is called after a property is set.
 404    * @param [in] index The index of the property.
 405    * @param [in] propertyValue The value of the property.
 406    */
 407   virtual void OnPropertySet( Property::Index index, const Property::Value& propertyValue ) {}
 408
 409   /**
 410    * Retrieves the TypeInfo for this object. Only retrieves it from the type-registry once and then stores a pointer
 411    * to it locally there-after. The type info will not change during the life-time of the application.
 412    * @return The type-info for this object (Can be NULL)
 413    */
 414   const TypeInfo* GetTypeInfo() const;
 415
 416   /**
 417    * Helper to find custom property
 418    * @param index
 419    * @return pointer to the property
 420    */
 421   CustomPropertyMetadata* FindCustomProperty( Property::Index index ) const;
 422
 423   /**
 424    * Helper to find animatable property
 425    * @param index
 426    * @return pointer to the property
 427    */
 428   AnimatablePropertyMetadata* FindAnimatableProperty( Property::Index index ) const;
 429
 430   /**
 431    * Helper to register a scene-graph property
 432    * @param [in] name The name of the property.
 433    * @param [in] key The key of the property
 434    * @param [in] index The index of the property
 435    * @param [in] value The value of the property.
 436    * @return The index of the registered property or Property::INVALID_INDEX if registration failed.
 437    */
 438   Property::Index RegisterSceneGraphProperty( std::string name, Property::Index key, Property::Index index, Property::Value propertyValue ) const;
 439
 440   /**
 441    * Registers animatable scene property
 442    * @param typeInfo to check the default value
 443    * @param index of the property to register
 444    * @param value initial value or nullptr
 445    */
 446   void RegisterAnimatableProperty( const TypeInfo& typeInfo, Property::Index index, const Property::Value* value ) const;
 447
 448   /**
 449    * Check whether the animatable property is registered already, if not then register on.
 450    * @param [in] index The index of the property
 451    * @param [in] value optional value for the property
 452    * @return pointer to the property metadata
 453    */
 454   AnimatablePropertyMetadata* GetSceneAnimatableProperty( Property::Index index, const Property::Value* value ) const;
 455
 456   /**
 457    * Resolve the index and name of child properties if any.
 458    */
 459   void ResolveChildProperties();
 460
 461 private: // Default property extensions for derived classes
 462
 463   /**
 464    * Set the value of a default property.
 465    * @pre The property types match i.e. propertyValue.GetType() is equal to GetPropertyType(index).
 466    * @param [in] index The index of the property.
 467    * @param [in] propertyValue The new value of the property.
 468    */
 469   virtual void SetDefaultProperty( Property::Index index, const Property::Value& propertyValue );
 470
 471   /**
 472    * Retrieve a default property value.
 473    * @param [in] index The index of the property.
 474    * @return The property value.
 475    */
 476   virtual Property::Value GetDefaultProperty( Property::Index index ) const;
 477
 478   /**
 479    * Retrieve the latest scene-graph value of a default property.
 480    * @param[in] index The index of the property.
 481    * @return The latest scene-graph value of a default property.
 482    */
 483   virtual Property::Value GetDefaultPropertyCurrentValue( Property::Index index ) const;
 484
 485   /**
 486    * Notifies that a default property is being animated so the deriving class should update the cached value.
 487    * @param[in] animation The animation animating the property.
 488    * @param[in] index The index of the property.
 489    * @param[in] value The value of the property after the animation.
 490    * @param[in] animationType Whether the property value given is the target or a relative value.
 491    */
 492   virtual void OnNotifyDefaultPropertyAnimation( Animation& animation, Property::Index index, const Property::Value& value, Animation::Type propertyChangeType )
 493   { }
 494
 495 private:
 496
 497   // no default, copy or assignment
 498   Object() = delete;
 499   Object(const Object& rhs) = delete;
 500   Object& operator=(const Object& rhs) = delete;
 501
 502   /**
 503    * Enable property notifications in scene graph
 504    */
 505   void EnablePropertyNotifications();
 506
 507   /**
 508    * Enable property notifications in scene graph
 509    */
 510   void DisablePropertyNotifications();
 511
 512   /**
 513    * Get the latest value of the property on the scene-graph.
 514    * @param[in] entry An entry from the property lookup container.
 515    * @return The latest value of the property.
 516    */
 517   Property::Value GetCurrentPropertyValue( const PropertyMetadata& entry ) const;
 518
 519   /**
 520    * Set the value of scene graph property.
 521    * @param [in] index The index of the property.
 522    * @param [in] entry An entry from the property lookup container.
 523    * @param [in] value The new value of the property.
 524    */
 525   virtual void SetSceneGraphProperty( Property::Index index, const PropertyMetadata& entry, const Property::Value& value );
 526
 527 protected:
 528   /**
 529    * Get the event thread services object - used for sending messages to the scene graph
 530    * Assert if called from the wrong thread.
 531    * This is intentionally inline for performance reasons.
 532    *
 533    * @return The event thread services object
 534    */
 535   inline EventThreadServices& GetEventThreadServices()
 536   {
 537     DALI_ASSERT_ALWAYS( EventThreadServices::IsCoreRunning() );
 538     return mEventThreadServices;
 539   }
 540
 541   /**
 542    * Get the event thread services object - used for sending messages to the scene graph
 543    * Assert if called from the wrong thread
 544    * This is intentionally inline for performance reasons.
 545    *
 546    * @return The event thread services object
 547    */
 548   inline const EventThreadServices& GetEventThreadServices() const
 549   {
 550     DALI_ASSERT_ALWAYS( EventThreadServices::IsCoreRunning() );
 551     return mEventThreadServices;
 552   }
 553
 554 private:
 555
 556   EventThreadServices& mEventThreadServices;
 557
 558 protected:
 559
 560   // mutable because it's lazy initialised and GetSceneObject has to be const so it can be called from const methods
 561   // const to prevent accidentally calling setters directly from event thread
 562   // protected to allow fast access from derived classes that have their own scene object (no function call overhead)
 563   mutable const SceneGraph::PropertyOwner* mUpdateObject; ///< Reference to object to hold the scene graph properties
 564
 565 private:
 566
 567   Dali::Vector<Observer*> mObservers;
 568   mutable OwnerContainer<PropertyMetadata*> mCustomProperties; ///< Used for accessing custom Node properties
 569   mutable OwnerContainer<PropertyMetadata*> mAnimatableProperties; ///< Used for accessing animatable Node properties
 570   mutable const TypeInfo* mTypeInfo; ///< The type-info for this object, mutable so it can be lazy initialized from const method if it is required
 571
 572   ConstraintContainer* mConstraints;               ///< Container of owned -constraints.
 573
 574   using PropertyNotificationContainer = std::vector< Dali::PropertyNotification >;
 575   PropertyNotificationContainer* mPropertyNotifications; ///< Container of owned property notifications.
 576
 577   Handle::PropertySetSignalType mPropertySetSignal;
 578 };
 579
 580 } // namespace Internal
 581
 582 // Helpers for public-api forwarding methods
 583
 584 inline Internal::Object& GetImplementation(Dali::Handle& object)
 585 {
 586   DALI_ASSERT_ALWAYS( object && "Object handle is empty" );
 587
 588   BaseObject& handle = object.GetBaseObject();
 589
 590   return static_cast<Internal::Object&>(handle);
 591 }
 592
 593 inline const Internal::Object& GetImplementation(const Dali::Handle& object)
 594 {
 595   DALI_ASSERT_ALWAYS( object && "Object handle is empty" );
 596
 597   const BaseObject& handle = object.GetBaseObject();
 598
 599   return static_cast<const Internal::Object&>(handle);
 600 }
 601
 602 } // namespace Dali
 603
 604 #endif // DALI_INTERNAL_OBJECT_H