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

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