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