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