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