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