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