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

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