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

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