dali/internal/update/manager/update-manager.h

   1 #ifndef __DALI_INTERNAL_SCENE_GRAPH_UPDATE_MANAGER_H__
   2 #define __DALI_INTERNAL_SCENE_GRAPH_UPDATE_MANAGER_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/common/vector-wrapper.h>
  23 #include <dali/public-api/common/dali-common.h>
  24
  25 #include <dali/integration-api/resource-declarations.h>
  26
  27 #include <dali/internal/common/message.h>
  28 #include <dali/internal/common/type-abstraction-enums.h>
  29 #include <dali/internal/event/common/event-thread-services.h>
  30 #include <dali/internal/update/animation/scene-graph-animation.h>
  31 #include <dali/internal/update/common/scene-graph-buffers.h>
  32 #include <dali/internal/update/common/scene-graph-property-notification.h>
  33 #include <dali/internal/update/manager/object-owner-container.h>
  34 #include <dali/internal/update/node-attachments/node-attachment.h>
  35 #include <dali/internal/update/nodes/node.h>
  36 #include <dali/internal/update/nodes/scene-graph-layer.h>
  37
  38 #include <dali/internal/render/shaders/scene-graph-shader.h>
  39
  40 namespace Dali
  41 {
  42
  43 namespace Integration
  44 {
  45 class GlSyncAbstraction;
  46 class RenderController;
  47 struct DynamicsWorldSettings;
  48
  49 } // namespace Integration
  50
  51 namespace Internal
  52 {
  53
  54 class PropertyNotifier;
  55 struct DynamicsWorldSettings;
  56 class NotificationManager;
  57 class CompleteNotificationInterface;
  58 class ResourceManager;
  59 class TouchResampler;
  60
  61 // value types used by messages
  62 template <> struct ParameterType< PropertyNotification::NotifyMode >
  63 : public BasicType< PropertyNotification::NotifyMode > {};
  64
  65 namespace SceneGraph
  66 {
  67
  68 class Animation;
  69 class DiscardQueue;
  70 class PanGesture;
  71 class RenderManager;
  72 class RenderTaskList;
  73 class RenderQueue;
  74 class DynamicsWorld;
  75 class TextureCache;
  76 class Geometry;
  77 class PropertyBuffer;
  78 class Material;
  79 class Sampler;
  80 class RendererAttachment;
  81
  82 /**
  83  * UpdateManager holds a scene graph i.e. a tree of nodes.
  84  * It controls the Update traversal, in which nodes are repositioned/animated,
  85  * and organises the culling and rendering of the scene.
  86  */
  87 class UpdateManager
  88 {
  89 public:
  90
  91   /**
  92    * Construct a new UpdateManager.
  93    * @param[in] notificationManager This should be notified when animations have finished.
  94    * @param[in] glSyncAbstraction Used to determine when framebuffers are ready
  95    * @param[in] animationFinishedNotifier The CompleteNotificationInterface that handles animation completions
  96    * @param[in] propertyNotifier The PropertyNotifier
  97    * @param[in] resourceManager The resource manager used to load textures etc.
  98    * @param[in] discardQueue Nodes are added here when disconnected from the scene-graph.
  99    * @param[in] controller After messages are flushed, we request a render from the RenderController.
 100    * @param[in] renderManager This is responsible for rendering the results of each "update".
 101    * @param[in] renderQueue Used to queue messages for the next render.
 102    * @param[in] textureCache Used for caching textures.
 103    * @param[in] touchResampler Used for re-sampling touch events.
 104    */
 105   UpdateManager( NotificationManager& notificationManager,
 106                  Integration::GlSyncAbstraction& glSyncAbstraction,
 107                  CompleteNotificationInterface& animationFinishedNotifier,
 108                  PropertyNotifier& propertyNotifier,
 109                  ResourceManager& resourceManager,
 110                  DiscardQueue& discardQueue,
 111                  Integration::RenderController& controller,
 112                  RenderManager& renderManager,
 113                  RenderQueue& renderQueue,
 114                  TextureCache& textureCache,
 115                  TouchResampler& touchResampler );
 116
 117   /**
 118    * Destructor. Not virtual as this is not a base class
 119    */
 120   ~UpdateManager();
 121
 122   // Node connection methods
 123
 124   /**
 125    * Get the scene graph side list of RenderTasks.
 126    * @param[in] systemLevel True if using the system-level overlay.
 127    * @return The list of render tasks
 128    */
 129   RenderTaskList* GetRenderTaskList( bool systemLevel );
 130
 131   /**
 132    * Installs a new layer as the root node.
 133    * @pre The UpdateManager does not already have an installed root node.
 134    * @pre The layer is of derived Node type Layer.
 135    * @pre The layer does not have a parent.
 136    * @param[in] layer The new root node.
 137    * @param[in] systemLevel True if using the system-level overlay.
 138    * @post The node is owned by UpdateManager.
 139    */
 140   void InstallRoot( Layer* layer, bool systemLevel );
 141
 142   /**
 143    * Add a Node; UpdateManager takes ownership.
 144    * @pre The node does not have a parent.
 145    * @param[in] node The node to add.
 146    */
 147   void AddNode( Node* node );
 148
 149   /**
 150    * Connect a Node to the scene-graph.
 151    * A disconnected Node has has no parent or children, and its properties cannot be animated/constrained.
 152    * @pre The node does not already have a parent.
 153    * @param[in] node The new parent node.
 154    * @param[in] node The node to connect.
 155    */
 156   void ConnectNode( Node* parent, Node* node, int index );
 157
 158   /**
 159    * Disconnect a Node from the scene-graph.
 160    * A disconnected Node has has no parent or children, and its properties cannot be animated/constrained.
 161    * @pre The node has a parent.
 162    * @param[in] node The node to disconnect.
 163    */
 164   void DisconnectNode( Node* node );
 165
 166   /**
 167    * Called when a property is set on a disconnected Node (via public API)
 168    * A disconnected Node has has no parent or children, and its properties cannot be animated/constrained.
 169    * @pre The node does not have a parent.
 170    * @param[in] node The node to set as "active".
 171    */
 172   void SetNodeActive( Node* node );
 173
 174   /**
 175    * Destroy a Node owned by UpdateManager.
 176    * This is not immediate; Nodes are passed to the RenderQueue to allow GL resources to be deleted.
 177    * In the following update, the previously queued Nodes may be deleted.
 178    * @pre The node has been disconnected from the scene-graph i.e. has no parent or children.
 179    * @param[in] node The node to destroy.
 180    */
 181   void DestroyNode( Node* node );
 182
 183   /**
 184    * Attach an object to a Node.
 185    * The UpdateManager is responsible for calling NodeAttachment::Initialize().
 186    * @param[in] node The node which will own the attachment.
 187    * @param[in] attachment The object to attach.
 188    */
 189   void AttachToNode( Node* node, NodeAttachment* attachment );
 190
 191   /**
 192    * Attach a renderer to the scene graph
 193    */
 194   void AttachToSceneGraph( RendererAttachment* renderer );
 195
 196
 197   /**
 198    * Add a newly created object.
 199    * @param[in] object The object to add.
 200    * @post The object is owned by UpdateManager.
 201    */
 202   void AddObject( PropertyOwner* object );
 203
 204   /**
 205    * Remove an object.
 206    * @param[in] object The object to remove.
 207    */
 208   void RemoveObject( PropertyOwner* object );
 209
 210   // Animations
 211
 212   /**
 213    * Add a newly created animation.
 214    * @param[in] animation The animation to add.
 215    * @post The animation is owned by UpdateManager.
 216    */
 217   void AddAnimation( Animation* animation );
 218
 219   /**
 220    * Stop an animation.
 221    * @param[in] animation The animation to stop.
 222    */
 223   void StopAnimation( Animation* animation );
 224
 225   /**
 226    * Remove an animation.
 227    * @param[in] animation The animation to remove.
 228    */
 229   void RemoveAnimation( Animation* animation );
 230
 231   /**
 232    * Query whether any animations are currently running.
 233    * @return True if any animations are running.
 234    */
 235   bool IsAnimationRunning() const;
 236
 237   // Property Notification
 238
 239   /**
 240    * Add a newly created property notification
 241    * @param[in] propertyNotification The notification to add
 242    * @post The propertyNotification is owned by UpdateManager.
 243    */
 244   void AddPropertyNotification( PropertyNotification* propertyNotification );
 245
 246   /**
 247    * Remove a property notification
 248    * @param[in] propertyNotification The notification to remove
 249    */
 250   void RemovePropertyNotification( PropertyNotification* propertyNotification );
 251
 252   /**
 253    * Set Notify state for PropertyNotification
 254    * @param[in] propertyNotification The notification to remove
 255    * @param[in] notifyMode The notification mode.
 256    */
 257   void PropertyNotificationSetNotify( PropertyNotification* propertyNotification, PropertyNotification::NotifyMode notifyMode );
 258
 259   /**
 260    * @brief Get the geometry owner
 261    *
 262    * @return The geometry owner
 263    */
 264   ObjectOwnerContainer< Geometry >& GetGeometryOwner();
 265
 266   /**
 267    * @brief Get the material owner
 268    *
 269    * @return The material owner
 270    */
 271   ObjectOwnerContainer< Material >& GetMaterialOwner();
 272
 273   /**
 274    * @brief Get the sampler owner
 275    *
 276    * @return The sampler owner
 277    */
 278   ObjectOwnerContainer< Sampler >& GetSamplerOwner();
 279
 280   /**
 281    * @brief Get the property buffer owner
 282    *
 283    * @return The property buffer owner
 284    */
 285   ObjectOwnerContainer< PropertyBuffer >& GetPropertyBufferOwner();
 286
 287
 288   // Shaders
 289
 290   /**
 291    * Add a newly created shader.
 292    * @param[in] shader The shader to add.
 293    * @post The shader is owned by the UpdateManager.
 294    */
 295   void AddShader(Shader* shader);
 296
 297   /**
 298    * Remove a shader.
 299    * @pre The shader has been added to the UpdateManager.
 300    * @param[in] shader The shader to remove.
 301    * @post The shader is destroyed.
 302    */
 303   void RemoveShader(Shader* shader);
 304
 305   /**
 306    * Set the shader program for a specified GeometryType to a Shader object
 307    * @param[in] shader        The shader to modify
 308    * @param[in] geometryType  The GeometryType to map to the program
 309    * @param[in] subType       The program subtype
 310    * @param[in] resourceId    A ResourceManager ticket ID for the program data (source and compiled binary)
 311    * @param[in] shaderHash    hash key created with vertex and fragment shader code
 312    * @param[in] modifiesGeometry True if the vertex shader modifies geometry
 313    */
 314   void SetShaderProgram( Shader* shader, GeometryType geometryType, ShaderSubTypes subType, Integration::ResourceId resourceId, size_t shaderHash, bool modifiesGeometry );
 315
 316   /**
 317    * Add a newly created gesture.
 318    * @param[in] gesture The gesture to add.
 319    * @post The gesture is owned by the UpdateManager.
 320    */
 321   void AddGesture( PanGesture* gesture );
 322
 323   /**
 324    * Remove a gesture.
 325    * @pre The gesture has been added to the UpdateManager.
 326    * @param[in] gesture The gesture to remove.
 327    * @post The gesture is destroyed.
 328    */
 329   void RemoveGesture( PanGesture* gesture );
 330
 331 // Message queue handling
 332
 333   /**
 334    * Reserve space for another message in the queue; this must then be initialized by the caller.
 335    * The message will be read from the update-thread after the next FlushMessages is called.
 336    * @post Calling this method may invalidate any previously returned slots.
 337    * @param[in] size The message size with respect to the size of type "char".
 338    * @param[in] updateScene A flag, when true denotes that the message will cause the scene-graph node tree to require an update.
 339    * @note the default value of updateScene should match that in EventThreadServices::ReserveMessageSlot.
 340    * @return A pointer to the first char allocated for the message.
 341    */
 342   unsigned int* ReserveMessageSlot( std::size_t size, bool updateScene = true );
 343
 344   /**
 345    * @return the current event-buffer index.
 346    */
 347   BufferIndex GetEventBufferIndex() const
 348   {
 349     // inlined as its called often from event thread
 350     return mSceneGraphBuffers.GetEventBufferIndex();
 351   }
 352
 353   /**
 354    * Called by the event-thread to signal that FlushQueue will be called
 355    * e.g. when it has finished event processing.
 356    */
 357   void EventProcessingStarted();
 358
 359   /**
 360    * Flush the set of messages, which were previously stored with QueueMessage().
 361    * Calls to this thread-safe method should be minimized, to avoid thread blocking.
 362    *
 363    * @return True if there are messages to process.
 364    */
 365   bool FlushQueue();
 366
 367 public:
 368
 369   /**
 370    * Performs an Update traversal on the scene-graph.
 371    * @param[in] elapsedSeconds The elapsed time that should be applied to animations.
 372    * @param[in] lastVSyncTimeMilliseconds The last time, in milliseconds, that we had a VSync.
 373    * @param[in] nextVSyncTimeMilliseconds The estimated time, in milliseconds, of the next VSync.
 374    * @return True if further updates are required e.g. during animations.
 375    */
 376   unsigned int Update( float elapsedSeconds, unsigned int lastVSyncTimeMilliseconds, unsigned int nextVSyncTimeMilliseconds );
 377
 378   /**
 379    * Set the background color i.e. the glClear color used at the beginning of each frame.
 380    * @param[in] color The new background color.
 381    */
 382   void SetBackgroundColor(const Vector4& color);
 383
 384   /**
 385    * Set the default surface rect.
 386    * @param[in] rect The rect value representing the surface.
 387    */
 388   void SetDefaultSurfaceRect( const Rect<int>& rect );
 389
 390   /**
 391    * @copydoc Dali::Stage::KeepRendering()
 392    */
 393   void KeepRendering( float durationSeconds );
 394
 395   /**
 396    * Sets the depths of all layers.
 397    * @param layers The layers in depth order.
 398    * @param[in] systemLevel True if using the system-level overlay.
 399    */
 400   void SetLayerDepths( const std::vector< Layer* >& layers, bool systemLevel );
 401
 402 #ifdef DYNAMICS_SUPPORT
 403
 404   /**
 405    * Initialize the dynamics world
 406    * @param[in] world The dynamics world
 407    * @param[in] worldSettings The dynamics world settings
 408    * @param[in] debugShader The shader used for rendering dynamics debug information
 409    */
 410   void InitializeDynamicsWorld( DynamicsWorld* world, Integration::DynamicsWorldSettings* worldSettings );
 411
 412   /**
 413    * Terminate the dynamics world
 414    */
 415   void TerminateDynamicsWorld();
 416
 417 #endif // DYNAMICS_SUPPORT
 418
 419 private:
 420
 421   // Undefined
 422   UpdateManager(const UpdateManager&);
 423
 424   // Undefined
 425   UpdateManager& operator=(const UpdateManager& rhs);
 426
 427   /**
 428    * Helper to check whether the update-thread should keep going.
 429    * @param[in] elapsedSeconds The time in seconds since the previous update.
 430    * @return True if the update-thread should keep going.
 431    */
 432   unsigned int KeepUpdatingCheck( float elapsedSeconds ) const;
 433
 434   /**
 435    * Helper to calculate new camera setup when root node resizes.
 436    * @param[in] updateBuffer The buffer to read the root node size from.
 437    */
 438   void UpdateProjectionAndViewMatrices(int updateBuffer);
 439
 440   /**
 441    * Post process resources that have been updated by renderer
 442    */
 443   void PostProcessResources();
 444
 445   /**
 446    * Helper to reset a Node properties.
 447    * @param[in] node The node.
 448    */
 449   void ResetNodeProperty( Node& node );
 450
 451   /**
 452    * Helper to reset all Node properties
 453    */
 454   void ResetProperties();
 455
 456   /**
 457    * Perform gesture updates.
 458    * @param[in]  lastVSyncTime  The last VSync time in milliseconds.
 459    * @param[in]  nextVSyncTime  The estimated time of the next VSync in milliseconds.
 460    * @return true, if any properties were updated.
 461    */
 462   bool ProcessGestures( unsigned int lastVSyncTimeMilliseconds, unsigned int nextVSyncTimeMilliseconds );
 463
 464   /**
 465    * Perform animation updates
 466    * @param[in] elapsedSeconds time since last frame
 467    */
 468   void Animate( float elapsedSeconds );
 469
 470   /**
 471    * Perform constraint updates.
 472    * @note Applies constraints to nodes first (depth first search order).
 473    * Then shader constraints second (construction order)
 474    */
 475   void ApplyConstraints();
 476
 477   /**
 478    * Perform property notification updates
 479    */
 480   void ProcessPropertyNotifications();
 481
 482   /**
 483    * Update the default camera.
 484    * This must be altered to match the root Node for 2D layouting.
 485    * @param[in] updateBuffer The buffer to read the root node size from.
 486    */
 487   void UpdateDefaultCamera( int updateBuffer );
 488
 489   /**
 490    * Update node shaders, opacity, geometry etc.
 491    */
 492   void UpdateNodes();
 493
 494 private:
 495
 496   // needs to be direct member so that getter for event buffer can be inlined
 497   SceneGraphBuffers mSceneGraphBuffers;
 498
 499   struct Impl;
 500   Impl* mImpl;
 501
 502 };
 503
 504 // Messages for UpdateManager
 505
 506 inline void InstallRootMessage( UpdateManager& manager, Layer& root, bool systemLevel )
 507 {
 508   typedef MessageValue2< UpdateManager, Layer*, bool > LocalType;
 509
 510   // Reserve some memory inside the message queue
 511   unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
 512
 513   // Construct message in the message queue memory; note that delete should not be called on the return value
 514   new (slot) LocalType( &manager, &UpdateManager::InstallRoot, &root, systemLevel );
 515 }
 516
 517 inline void AddNodeMessage( UpdateManager& manager, Node& node )
 518 {
 519   typedef MessageValue1< UpdateManager, OwnerPointer<Node> > LocalType;
 520
 521   // Reserve some memory inside the message queue
 522   unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
 523
 524   // Construct message in the message queue memory; note that delete should not be called on the return value
 525   new (slot) LocalType( &manager, &UpdateManager::AddNode, &node );
 526 }
 527
 528 inline void ConnectNodeMessage( UpdateManager& manager, const Node& constParent, const Node& constChild, int index )
 529 {
 530   // Update thread can edit the object
 531   Node& parent = const_cast< Node& >( constParent );
 532   Node& child = const_cast< Node& >( constChild );
 533
 534   typedef MessageValue3< UpdateManager, Node*, Node*, int > LocalType;
 535
 536   // Reserve some memory inside the message queue
 537   unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
 538
 539   // Construct message in the message queue memory; note that delete should not be called on the return value
 540   new (slot) LocalType( &manager, &UpdateManager::ConnectNode, &parent, &child, index );
 541 }
 542
 543 inline void DisconnectNodeMessage( UpdateManager& manager, const Node& constNode )
 544 {
 545   // Scene graph thread can modify this object.
 546   Node& node = const_cast< Node& >( constNode );
 547
 548   typedef MessageValue1< UpdateManager, Node* > LocalType;
 549
 550   // Reserve some memory inside the message queue
 551   unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
 552
 553   // Construct message in the message queue memory; note that delete should not be called on the return value
 554   new (slot) LocalType( &manager, &UpdateManager::DisconnectNode, &node );
 555 }
 556
 557 inline void DestroyNodeMessage( UpdateManager& manager, const Node& constNode )
 558 {
 559   // Scene graph thread can destroy this object.
 560   Node& node = const_cast< Node& >( constNode );
 561
 562   typedef MessageValue1< UpdateManager, Node* > LocalType;
 563
 564   // Reserve some memory inside the message queue
 565   unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
 566
 567   // Construct message in the message queue memory; note that delete should not be called on the return value
 568   new (slot) LocalType( &manager, &UpdateManager::DestroyNode, &node );
 569 }
 570
 571 inline void AttachToNodeMessage( UpdateManager& manager, const Node& constParent, NodeAttachment* attachment )
 572 {
 573   // Scene graph thread can modify this object.
 574   Node& parent = const_cast< Node& >( constParent );
 575
 576   typedef MessageValue2< UpdateManager, Node*, NodeAttachmentOwner > LocalType;
 577
 578   // Reserve some memory inside the message queue
 579   unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
 580
 581   // Construct message in the message queue memory; note that delete should not be called on the return value
 582   new (slot) LocalType( &manager, &UpdateManager::AttachToNode, &parent, attachment );
 583 }
 584
 585 inline void AttachToSceneGraphMessage( UpdateManager& manager, RendererAttachment* renderer )
 586 {
 587   typedef MessageValue1< UpdateManager, RendererAttachment* > LocalType;
 588
 589   // Reserve some memory inside the message queue
 590   unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
 591
 592   // Construct message in the message queue memory; note that delete should not be called on the return value
 593   new (slot) LocalType( &manager, &UpdateManager::AttachToSceneGraph, renderer );
 594 }
 595
 596 inline void AddObjectMessage( UpdateManager& manager, PropertyOwner* object )
 597 {
 598   typedef MessageValue1< UpdateManager, OwnerPointer<PropertyOwner> > LocalType;
 599
 600   // Reserve some memory inside the message queue
 601   unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
 602
 603   // Construct message in the message queue memory; note that delete should not be called on the return value
 604   new (slot) LocalType( &manager, &UpdateManager::AddObject, object );
 605 }
 606
 607 inline void RemoveObjectMessage( UpdateManager& manager, PropertyOwner* object )
 608 {
 609   typedef MessageValue1< UpdateManager, PropertyOwner* > LocalType;
 610
 611   // Reserve some memory inside the message queue
 612   unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
 613
 614   // Construct message in the message queue memory; note that delete should not be called on the return value
 615   new (slot) LocalType( &manager, &UpdateManager::RemoveObject, object );
 616 }
 617
 618 inline void AddAnimationMessage( UpdateManager& manager, Animation* animation )
 619 {
 620   typedef MessageValue1< UpdateManager, Animation* > LocalType;
 621
 622   // Reserve some memory inside the message queue
 623   unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
 624
 625   // Construct message in the message queue memory; note that delete should not be called on the return value
 626   new (slot) LocalType( &manager, &UpdateManager::AddAnimation, animation );
 627 }
 628
 629 inline void StopAnimationMessage( UpdateManager& manager, const Animation& constAnimation )
 630 {
 631   // The scene-graph thread owns this object so it can safely edit it.
 632   Animation& animation = const_cast< Animation& >( constAnimation );
 633
 634   typedef MessageValue1< UpdateManager, Animation* > LocalType;
 635
 636   // Reserve some memory inside the message queue
 637   unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
 638
 639   // Construct message in the message queue memory; note that delete should not be called on the return value
 640   new (slot) LocalType( &manager, &UpdateManager::StopAnimation, &animation );
 641 }
 642
 643 inline void RemoveAnimationMessage( UpdateManager& manager, const Animation& constAnimation )
 644 {
 645   // The scene-graph thread owns this object so it can safely edit it.
 646   Animation& animation = const_cast< Animation& >( constAnimation );
 647
 648   typedef MessageValue1< UpdateManager, Animation* > LocalType;
 649
 650   // Reserve some memory inside the message queue
 651   unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
 652
 653   // Construct message in the message queue memory; note that delete should not be called on the return value
 654   new (slot) LocalType( &manager, &UpdateManager::RemoveAnimation, &animation );
 655 }
 656
 657 inline void AddPropertyNotificationMessage( UpdateManager& manager, PropertyNotification* propertyNotification )
 658 {
 659   typedef MessageValue1< UpdateManager, PropertyNotification* > LocalType;
 660
 661   // Reserve some memory inside the message queue
 662   unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
 663
 664   // Construct message in the message queue memory; note that delete should not be called on the return value
 665   new (slot) LocalType( &manager, &UpdateManager::AddPropertyNotification, propertyNotification );
 666 }
 667
 668 inline void RemovePropertyNotificationMessage( UpdateManager& manager, const PropertyNotification& constPropertyNotification )
 669 {
 670   // The scene-graph thread owns this object so it can safely edit it.
 671   PropertyNotification& propertyNotification = const_cast< PropertyNotification& >( constPropertyNotification );
 672
 673   typedef MessageValue1< UpdateManager, PropertyNotification* > LocalType;
 674
 675   // Reserve some memory inside the message queue
 676   unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
 677
 678   // Construct message in the message queue memory; note that delete should not be called on the return value
 679   new (slot) LocalType( &manager, &UpdateManager::RemovePropertyNotification, &propertyNotification );
 680 }
 681
 682 inline void PropertyNotificationSetNotifyModeMessage( UpdateManager& manager,
 683                                                       const PropertyNotification* constPropertyNotification,
 684                                                       PropertyNotification::NotifyMode notifyMode )
 685 {
 686   // The scene-graph thread owns this object so it can safely edit it.
 687   PropertyNotification* propertyNotification = const_cast< PropertyNotification* >( constPropertyNotification );
 688
 689   typedef MessageValue2< UpdateManager, PropertyNotification*, PropertyNotification::NotifyMode > LocalType;
 690
 691   // Reserve some memory inside the message queue
 692   unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
 693
 694   // Construct message in the message queue memory; note that delete should not be called on the return value
 695   new (slot) LocalType( &manager, &UpdateManager::PropertyNotificationSetNotify, propertyNotification, notifyMode );
 696 }
 697
 698
 699
 700 // The render thread can safely change the Shader
 701 inline void AddShaderMessage( UpdateManager& manager, Shader& shader )
 702 {
 703   typedef MessageValue1< UpdateManager, OwnerPointer< Shader > > LocalType;
 704
 705   // Reserve some memory inside the message queue
 706   unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
 707
 708   // Construct message in the message queue memory; note that delete should not be called on the return value
 709   new (slot) LocalType( &manager, &UpdateManager::AddShader, &shader );
 710 }
 711
 712 // The render thread can safely change the Shader
 713 inline void RemoveShaderMessage( UpdateManager& manager, Shader& shader )
 714 {
 715   typedef MessageValue1< UpdateManager, Shader* > LocalType;
 716
 717   // Reserve some memory inside the message queue
 718   unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
 719
 720   // Construct message in the message queue memory; note that delete should not be called on the return value
 721   new (slot) LocalType( &manager, &UpdateManager::RemoveShader, &shader );
 722 }
 723
 724 inline void SetShaderProgramMessage( UpdateManager& manager,
 725                                      Shader& shader,
 726                                      GeometryType geometryType,
 727                                      ShaderSubTypes subType,
 728                                      Integration::ResourceId resourceId,
 729                                      size_t shaderHash,
 730                                      bool modifiesGeometry )
 731 {
 732   typedef MessageValue6< UpdateManager, Shader*, GeometryType, ShaderSubTypes, Integration::ResourceId, size_t, bool > LocalType;
 733
 734   // Reserve some memory inside the message queue
 735   unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
 736
 737   // Construct message in the message queue memory; note that delete should not be called on the return value
 738   new (slot) LocalType( &manager, &UpdateManager::SetShaderProgram, &shader, geometryType, subType, resourceId, shaderHash, modifiesGeometry );
 739 }
 740
 741 inline void SetBackgroundColorMessage( UpdateManager& manager, const Vector4& color )
 742 {
 743   typedef MessageValue1< UpdateManager, Vector4 > LocalType;
 744
 745   // Reserve some memory inside the message queue
 746   unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
 747
 748   // Construct message in the message queue memory; note that delete should not be called on the return value
 749   new (slot) LocalType( &manager, &UpdateManager::SetBackgroundColor, color );
 750 }
 751
 752 inline void SetDefaultSurfaceRectMessage( UpdateManager& manager, const Rect<int>& rect  )
 753 {
 754   typedef MessageValue1< UpdateManager, Rect<int> > LocalType;
 755
 756   // Reserve some memory inside the message queue
 757   unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
 758
 759   // Construct message in the message queue memory; note that delete should not be called on the return value
 760   new (slot) LocalType( &manager, &UpdateManager::SetDefaultSurfaceRect, rect );
 761 }
 762
 763 inline void KeepRenderingMessage( UpdateManager& manager, float durationSeconds )
 764 {
 765   typedef MessageValue1< UpdateManager, float > LocalType;
 766
 767   // Reserve some memory inside the message queue
 768   unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
 769
 770   // Construct message in the message queue memory; note that delete should not be called on the return value
 771   new (slot) LocalType( &manager, &UpdateManager::KeepRendering, durationSeconds );
 772 }
 773
 774 /**
 775  * Create a message for setting the depth of a layer
 776  * @param[in] manager The update manager
 777  * @param[in] layers list of layers
 778  * @param[in] systemLevel True if the layers are added via the SystemOverlay API
 779  */
 780 inline void SetLayerDepthsMessage( UpdateManager& manager, const std::vector< Layer* >& layers, bool systemLevel )
 781 {
 782   typedef MessageValue2< UpdateManager, std::vector< Layer* >, bool > LocalType;
 783
 784   // Reserve some memory inside the message queue
 785   unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
 786
 787   // Construct message in the message queue memory; note that delete should not be called on the return value
 788   new (slot) LocalType( &manager, &UpdateManager::SetLayerDepths, layers, systemLevel );
 789 }
 790
 791 inline void AddGestureMessage( UpdateManager& manager, PanGesture* gesture )
 792 {
 793   typedef MessageValue1< UpdateManager, PanGesture* > LocalType;
 794
 795   // Reserve some memory inside the message queue
 796   unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
 797
 798   // Construct message in the message queue memory; note that delete should not be called on the return value
 799   new (slot) LocalType( &manager, &UpdateManager::AddGesture, gesture );
 800 }
 801
 802 inline void RemoveGestureMessage( UpdateManager& manager, PanGesture* gesture )
 803 {
 804   typedef MessageValue1< UpdateManager, PanGesture* > LocalType;
 805
 806   // Reserve some memory inside the message queue
 807   unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
 808
 809   // Construct message in the message queue memory; note that delete should not be called on the return value
 810   new (slot) LocalType( &manager, &UpdateManager::RemoveGesture, gesture );
 811 }
 812
 813 #ifdef DYNAMICS_SUPPORT
 814
 815 // Dynamics messages
 816 inline void InitializeDynamicsWorldMessage( UpdateManager& manager, DynamicsWorld* dynamicsworld, Integration::DynamicsWorldSettings* worldSettings )
 817 {
 818   typedef MessageValue2< UpdateManager, DynamicsWorld*, Integration::DynamicsWorldSettings* > LocalType;
 819
 820   // Reserve some memory inside the message queue
 821   unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
 822
 823   // Construct message in the message queue memory; note that delete should not be called on the return value
 824   new (slot) LocalType( &manager, &UpdateManager::InitializeDynamicsWorld, dynamicsworld, worldSettings );
 825 }
 826
 827 inline void TerminateDynamicsWorldMessage(UpdateManager& manager)
 828 {
 829   typedef Message< UpdateManager > LocalType;
 830
 831   // Reserve some memory inside the message queue
 832   unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
 833
 834   // Construct message in the message queue memory; note that delete should not be called on the return value
 835   new (slot) LocalType( &manager, &UpdateManager::TerminateDynamicsWorld );
 836 }
 837
 838 #endif // DYNAMICS_SUPPORT
 839
 840
 841 template< typename T >
 842 inline void AddMessage( UpdateManager& manager, ObjectOwnerContainer<T>& owner, T& object )
 843 {
 844   typedef MessageValue1< ObjectOwnerContainer<T>, OwnerPointer< T > > LocalType;
 845
 846   // Reserve some memory inside the message queue
 847   unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
 848   // Construct message in the message queue memory; note that delete should not be called on the return value
 849   new (slot) LocalType( &owner, &ObjectOwnerContainer<T>::Add, &object );
 850 }
 851
 852 template< typename T >
 853 inline void RemoveMessage( UpdateManager& manager, ObjectOwnerContainer<T>& owner, T& object )
 854 {
 855   typedef MessageValue1< ObjectOwnerContainer<T>, OwnerPointer< T > > LocalType;
 856
 857   // Reserve some memory inside the message queue
 858   unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
 859   // Construct message in the message queue memory; note that delete should not be called on the return value
 860   new (slot) LocalType( &owner, &ObjectOwnerContainer<T>::Remove, &object );
 861 }
 862
 863 } // namespace SceneGraph
 864
 865 } // namespace Internal
 866
 867 } // namespace Dali
 868
 869 #endif // __DALI_INTERNAL_SCENE_GRAPH_UPDATE_MANAGER_H__