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/common/shader-saver.h>
  30 #include <dali/internal/event/common/event-thread-services.h>
  31 #include <dali/internal/update/animation/scene-graph-animation.h>
  32 #include <dali/internal/update/common/scene-graph-buffers.h>
  33 #include <dali/internal/update/common/scene-graph-property-notification.h>
  34 #include <dali/internal/update/manager/object-owner-container.h>
  35 #include <dali/internal/update/node-attachments/node-attachment.h>
  36 #include <dali/internal/update/nodes/node.h>
  37 #include <dali/internal/update/nodes/scene-graph-layer.h>
  38 #include <dali/internal/update/rendering/scene-graph-renderer.h>
  39 #include <dali/internal/render/shaders/scene-graph-shader.h>
  40 #include <dali/internal/render/renderers/render-property-buffer.h>
  41
  42 namespace Dali
  43 {
  44
  45 namespace Integration
  46 {
  47 class GlSyncAbstraction;
  48 class RenderController;
  49
  50 } // namespace Integration
  51
  52 namespace Internal
  53 {
  54
  55 class PropertyNotifier;
  56 class NotificationManager;
  57 class CompleteNotificationInterface;
  58 class ResourceManager;
  59 class TouchResampler;
  60
  61 namespace Render
  62 {
  63 class Sampler;
  64 }
  65 // value types used by messages
  66 template <> struct ParameterType< PropertyNotification::NotifyMode >
  67 : public BasicType< PropertyNotification::NotifyMode > {};
  68
  69 namespace SceneGraph
  70 {
  71
  72 class Animation;
  73 class DiscardQueue;
  74 class PanGesture;
  75 class RenderManager;
  76 class RenderTaskList;
  77 class RenderQueue;
  78 class TextureCache;
  79 class PropertyBuffer;
  80 class TextureSet;
  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 : public ShaderSaver
  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] animationFinishedNotifier The CompleteNotificationInterface that handles animation completions
  98    * @param[in] propertyNotifier The PropertyNotifier
  99    * @param[in] resourceManager The resource manager used to load textures etc.
 100    * @param[in] discardQueue Nodes are added here when disconnected from the scene-graph.
 101    * @param[in] controller After messages are flushed, we request a render from the RenderController.
 102    * @param[in] renderManager This is responsible for rendering the results of each "update".
 103    * @param[in] renderQueue Used to queue messages for the next render.
 104    * @param[in] textureCache Used for caching textures.
 105    * @param[in] touchResampler Used for re-sampling touch events.
 106    */
 107   UpdateManager( NotificationManager& notificationManager,
 108                  CompleteNotificationInterface& animationFinishedNotifier,
 109                  PropertyNotifier& propertyNotifier,
 110                  ResourceManager& resourceManager,
 111                  DiscardQueue& discardQueue,
 112                  Integration::RenderController& controller,
 113                  RenderManager& renderManager,
 114                  RenderQueue& renderQueue,
 115                  TextureCache& textureCache,
 116                  TouchResampler& touchResampler );
 117
 118   /**
 119    * Destructor.
 120    */
 121   virtual ~UpdateManager();
 122
 123   // Node connection methods
 124
 125   /**
 126    * Get the scene graph side list of RenderTasks.
 127    * @param[in] systemLevel True if using the system-level overlay.
 128    * @return The list of render tasks
 129    */
 130   RenderTaskList* GetRenderTaskList( bool systemLevel );
 131
 132   /**
 133    * Installs a new layer as the root node.
 134    * @pre The UpdateManager does not already have an installed root node.
 135    * @pre The layer is of derived Node type Layer.
 136    * @pre The layer does not have a parent.
 137    * @param[in] layer The new root node.
 138    * @param[in] systemLevel True if using the system-level overlay.
 139    * @post The node is owned by UpdateManager.
 140    */
 141   void InstallRoot( Layer* layer, bool systemLevel );
 142
 143   /**
 144    * Add a Node; UpdateManager takes ownership.
 145    * @pre The node does not have a parent.
 146    * @param[in] node The node to add.
 147    */
 148   void AddNode( Node* node );
 149
 150   /**
 151    * Connect a Node to the scene-graph.
 152    * A disconnected Node has has no parent or children, and its properties cannot be animated/constrained.
 153    * @pre The node does not already have a parent.
 154    * @param[in] parent The new parent node.
 155    */
 156   void ConnectNode( Node* parent, Node* node );
 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    * Destroy a Node owned by UpdateManager.
 168    * This is not immediate; Nodes are passed to the RenderQueue to allow GL resources to be deleted.
 169    * In the following update, the previously queued Nodes may be deleted.
 170    * @pre The node has been disconnected from the scene-graph i.e. has no parent or children.
 171    * @param[in] node The node to destroy.
 172    */
 173   void DestroyNode( Node* node );
 174
 175   /**
 176    * Attach an object to a Node.
 177    * The UpdateManager is responsible for calling NodeAttachment::Initialize().
 178    * @param[in] node The node which will own the attachment.
 179    * @param[in] attachment The object to attach.
 180    */
 181   void AttachToNode( Node* node, NodeAttachment* attachment );
 182
 183   /**
 184    * Add a newly created object.
 185    * @param[in] object The object to add.
 186    * @post The object is owned by UpdateManager.
 187    */
 188   void AddObject( PropertyOwner* object );
 189
 190   /**
 191    * Remove an object.
 192    * @param[in] object The object to remove.
 193    */
 194   void RemoveObject( PropertyOwner* object );
 195
 196   // Animations
 197
 198   /**
 199    * Add a newly created animation.
 200    * @param[in] animation The animation to add.
 201    * @post The animation is owned by UpdateManager.
 202    */
 203   void AddAnimation( Animation* animation );
 204
 205   /**
 206    * Stop an animation.
 207    * @param[in] animation The animation to stop.
 208    */
 209   void StopAnimation( Animation* animation );
 210
 211   /**
 212    * Remove an animation.
 213    * @param[in] animation The animation to remove.
 214    */
 215   void RemoveAnimation( Animation* animation );
 216
 217   /**
 218    * Query whether any animations are currently running.
 219    * @return True if any animations are running.
 220    */
 221   bool IsAnimationRunning() const;
 222
 223   // Property Notification
 224
 225   /**
 226    * Add a newly created property notification
 227    * @param[in] propertyNotification The notification to add
 228    * @post The propertyNotification is owned by UpdateManager.
 229    */
 230   void AddPropertyNotification( PropertyNotification* propertyNotification );
 231
 232   /**
 233    * Remove a property notification
 234    * @param[in] propertyNotification The notification to remove
 235    */
 236   void RemovePropertyNotification( PropertyNotification* propertyNotification );
 237
 238   /**
 239    * Set Notify state for PropertyNotification
 240    * @param[in] propertyNotification The notification to remove
 241    * @param[in] notifyMode The notification mode.
 242    */
 243   void PropertyNotificationSetNotify( PropertyNotification* propertyNotification, PropertyNotification::NotifyMode notifyMode );
 244
 245   /**
 246    * @brief Get the renderer owner
 247    *
 248    * @return The renderer owner
 249    */
 250   ObjectOwnerContainer< Renderer >& GetRendererOwner();
 251
 252   /**
 253    * @brief Get the property buffer owner
 254    *
 255    * @return The property buffer owner
 256    */
 257   ObjectOwnerContainer< PropertyBuffer >& GetPropertyBufferOwner();
 258
 259
 260   // Shaders
 261
 262   /**
 263    * Add a newly created shader.
 264    * @param[in] shader The shader to add.
 265    * @post The shader is owned by the UpdateManager.
 266    */
 267   void AddShader(Shader* shader);
 268
 269   /**
 270    * Remove a shader.
 271    * @pre The shader has been added to the UpdateManager.
 272    * @param[in] shader The shader to remove.
 273    * @post The shader is destroyed.
 274    */
 275   void RemoveShader(Shader* shader);
 276
 277   /**
 278    * Add a newly created TextureSet.
 279    * @param[in] textureSet The texture set to add.
 280    * @post The TextureSet is owned by the UpdateManager.
 281    */
 282   void AddTextureSet(TextureSet* textureSet);
 283
 284   /**
 285    * Remove a TextureSet.
 286    * @pre The TextureSet has been added to the UpdateManager.
 287    * @param[in] textureSet The TextureSet to remove.
 288    * @post The TextureSet is destroyed.
 289    */
 290   void RemoveTextureSet(TextureSet* textureSet);
 291
 292   /**
 293    * Set the shader program for a Shader object
 294    * @param[in] shader        The shader to modify
 295    * @param[in] shaderData    Source code, hash over source, and optional compiled binary for the shader program
 296    * @param[in] modifiesGeometry True if the vertex shader modifies geometry
 297    */
 298   void SetShaderProgram( Shader* shader, Internal::ShaderDataPtr shaderData, bool modifiesGeometry );
 299
 300   /**
 301    * @brief Accept compiled shaders passed back on render thread for saving.
 302    * @param[in] shaderData Source code, hash over source, and corresponding compiled binary to be saved.
 303    */
 304   virtual void SaveBinary( Internal::ShaderDataPtr shaderData );
 305
 306   /**
 307    * @brief Set the destination for compiled shader binaries to be passed on to.
 308    * The dispatcher passed in will be called from the update thread.
 309    * @param[in] upstream A sink for ShaderDatas to be passed into.
 310    */
 311   void SetShaderSaver( ShaderSaver& upstream );
 312
 313   // Gestures
 314
 315   /**
 316    * Add a newly created gesture.
 317    * @param[in] gesture The gesture to add.
 318    * @post The gesture is owned by the UpdateManager.
 319    */
 320   void AddGesture( PanGesture* gesture );
 321
 322   /**
 323    * Remove a gesture.
 324    * @pre The gesture has been added to the UpdateManager.
 325    * @param[in] gesture The gesture to remove.
 326    * @post The gesture is destroyed.
 327    */
 328   void RemoveGesture( PanGesture* gesture );
 329
 330 // Message queue handling
 331
 332   /**
 333    * Reserve space for another message in the queue; this must then be initialized by the caller.
 334    * The message will be read from the update-thread after the next FlushMessages is called.
 335    * @post Calling this method may invalidate any previously returned slots.
 336    * @param[in] size The message size with respect to the size of type "char".
 337    * @param[in] updateScene A flag, when true denotes that the message will cause the scene-graph node tree to require an update.
 338    * @note the default value of updateScene should match that in EventThreadServices::ReserveMessageSlot.
 339    * @return A pointer to the first char allocated for the message.
 340    */
 341   unsigned int* ReserveMessageSlot( std::size_t size, bool updateScene = true );
 342
 343   /**
 344    * @return the current event-buffer index.
 345    */
 346   BufferIndex GetEventBufferIndex() const
 347   {
 348     // inlined as its called often from event thread
 349     return mSceneGraphBuffers.GetEventBufferIndex();
 350   }
 351
 352   /**
 353    * Called by the event-thread to signal that FlushQueue will be called
 354    * e.g. when it has finished event processing.
 355    */
 356   void EventProcessingStarted();
 357
 358   /**
 359    * Flush the set of messages, which were previously stored with QueueMessage().
 360    * Calls to this thread-safe method should be minimized, to avoid thread blocking.
 361    *
 362    * @return True if there are messages to process.
 363    */
 364   bool FlushQueue();
 365
 366   /**
 367    * Add a new sampler to RenderManager
 368    * @param[in] sampler The sampler to add
 369    * @post Sends a message to RenderManager to add the sampler.
 370    * The sampler will be owned by RenderManager
 371    */
 372   void AddSampler( Render::Sampler* sampler );
 373
 374   /**
 375    * Removes an existing sampler from RenderManager
 376    * @param[in] sampler The sampler to remove
 377    * @post The sampler will be destroyed in the render thread
 378    */
 379   void RemoveSampler( Render::Sampler* sampler );
 380
 381   /**
 382    * Sets the filter modes for an existing sampler
 383    * @param[in] sampler The sampler
 384    * @param[in] minFilterMode The filter to use under minification
 385    * @param[in] magFilterMode The filter to use under magnification
 386    */
 387   void SetFilterMode( Render::Sampler* sampler, unsigned int minFilterMode, unsigned int magFilterMode );
 388
 389   /**
 390    * Sets the wrap mode for an existing sampler
 391    * @param[in] sampler The sampler
 392    * @param[in] uWrapMode Wrapping mode in x direction
 393    * @param[in] vWrapMode Wrapping mode in y direction
 394    */
 395   void SetWrapMode( Render::Sampler* sampler, unsigned int uWrapMode, unsigned int vWrapMode );
 396
 397   /**
 398    * Add a new property buffer to RenderManager
 399    * @param[in] propertryBuffer The property buffer to add
 400    * @post Sends a message to RenderManager to add the property buffer.
 401    * The property buffer will be owned by RenderManager
 402    */
 403   void AddPropertyBuffer( Render::PropertyBuffer* propertryBuffer );
 404
 405   /**
 406    * Removes an existing PropertyBuffer from RenderManager
 407    * @param[in] propertryBuffer The property buffer to remove
 408    * @post The property buffer will be destroyed in the render thread
 409    */
 410   void RemovePropertyBuffer( Render::PropertyBuffer* propertryBuffer );
 411
 412   /**
 413    * Sets the format of an existing property buffer
 414    * @param[in] propertyBuffer The property buffer.
 415    * @param[in] format The new format of the buffer
 416    * @post Sends a message to RenderManager to set the new format to the property buffer.
 417    */
 418   void SetPropertyBufferFormat(Render::PropertyBuffer* propertyBuffer, Render::PropertyBuffer::Format* format );
 419
 420   /**
 421    * Sets the data of an existing property buffer
 422    * @param[in] propertyBuffer The property buffer.
 423    * @param[in] data The new data of the buffer
 424    * @param[in] size The new size of the buffer
 425    * @post Sends a message to RenderManager to set the new data to the property buffer.
 426    */
 427   void SetPropertyBufferData(Render::PropertyBuffer* propertyBuffer, Dali::Vector<char>* data, size_t size);
 428
 429   /**
 430    * Adds a geometry to the RenderManager
 431    * @param[in] geometry The geometry to add
 432    * @post Sends a message to RenderManager to add the Geometry
 433    * The geometry will be owned by RenderManager
 434    */
 435   void AddGeometry( Render::Geometry* geometry );
 436
 437   /**
 438    * Removes an existing Geometry from RenderManager
 439    * @param[in] geometry The geometry to remove
 440    * @post The geometry will be destroyed in the render thread
 441    */
 442   void RemoveGeometry( Render::Geometry* geometry );
 443
 444   /**
 445    * Sets the geometry type of an existing Geometry
 446    * @param[in] geometry The geometry
 447    * @param[in] geometryType The type of the geometry
 448    */
 449   void SetGeometryType( Render::Geometry* geometry, unsigned int geometryType );
 450
 451   /**
 452    * Sets the index buffer to be used by a geometry
 453    * @param[in] geometry The geometry
 454    * @param[in] indices A vector containing the indices for the geometry
 455    */
 456   void SetIndexBuffer( Render::Geometry* geometry, Dali::Vector<unsigned short>& indices );
 457
 458   /**
 459    * Adds a vertex buffer to a geomtry
 460    * @param[in] geometry The geometry
 461    * @param[in] propertyBuffer The property buffer
 462    */
 463   void AddVertexBuffer( Render::Geometry* geometry, Render::PropertyBuffer* propertyBuffer );
 464
 465   /**
 466    * Removes a vertex buffer from a geometry
 467    * @param[in] geometry The geometry
 468    * @param[in] propertyBuffer The property buffer
 469    */
 470   void RemoveVertexBuffer( Render::Geometry* geometry, Render::PropertyBuffer* propertyBuffer );
 471
 472
 473 public:
 474
 475   /**
 476    * Performs an Update traversal on the scene-graph.
 477    * @param[in] elapsedSeconds The elapsed time that should be applied to animations.
 478    * @param[in] lastVSyncTimeMilliseconds The last time, in milliseconds, that we had a VSync.
 479    * @param[in] nextVSyncTimeMilliseconds The estimated time, in milliseconds, of the next VSync.
 480    * @return True if further updates are required e.g. during animations.
 481    */
 482   unsigned int Update( float elapsedSeconds, unsigned int lastVSyncTimeMilliseconds, unsigned int nextVSyncTimeMilliseconds );
 483
 484   /**
 485    * Set the background color i.e. the glClear color used at the beginning of each frame.
 486    * @param[in] color The new background color.
 487    */
 488   void SetBackgroundColor(const Vector4& color);
 489
 490   /**
 491    * Set the default surface rect.
 492    * @param[in] rect The rect value representing the surface.
 493    */
 494   void SetDefaultSurfaceRect( const Rect<int>& rect );
 495
 496   /**
 497    * @copydoc Dali::Stage::KeepRendering()
 498    */
 499   void KeepRendering( float durationSeconds );
 500
 501   /**
 502    * Sets the depths of all layers.
 503    * @param layers The layers in depth order.
 504    * @param[in] systemLevel True if using the system-level overlay.
 505    */
 506   void SetLayerDepths( const std::vector< Layer* >& layers, bool systemLevel );
 507
 508 private:
 509
 510   // Undefined
 511   UpdateManager(const UpdateManager&);
 512
 513   // Undefined
 514   UpdateManager& operator=(const UpdateManager& rhs);
 515
 516   /**
 517    * Helper to check whether the update-thread should keep going.
 518    * @param[in] elapsedSeconds The time in seconds since the previous update.
 519    * @return True if the update-thread should keep going.
 520    */
 521   unsigned int KeepUpdatingCheck( float elapsedSeconds ) const;
 522
 523   /**
 524    * Helper to calculate new camera setup when root node resizes.
 525    * @param[in] updateBuffer The buffer to read the root node size from.
 526    */
 527   void UpdateProjectionAndViewMatrices(int updateBuffer);
 528
 529   /**
 530    * Post process resources that have been updated by renderer
 531    */
 532   void PostProcessResources();
 533
 534   /**
 535    * Helper to reset all Node properties
 536    * @param[in] bufferIndex to use
 537    */
 538   void ResetProperties( BufferIndex bufferIndex );
 539
 540   /**
 541    * Perform gesture updates.
 542    * @param[in] bufferIndex to use
 543    * @param[in] lastVSyncTime  The last VSync time in milliseconds.
 544    * @param[in] nextVSyncTime  The estimated time of the next VSync in milliseconds.
 545    * @return true, if any properties were updated.
 546    */
 547   bool ProcessGestures( BufferIndex bufferIndex, unsigned int lastVSyncTimeMilliseconds, unsigned int nextVSyncTimeMilliseconds );
 548
 549   /**
 550    * Perform animation updates
 551    * @param[in] bufferIndex to use
 552    * @param[in] elapsedSeconds time since last frame
 553    */
 554   void Animate( BufferIndex bufferIndex, float elapsedSeconds );
 555
 556   /**
 557    * Applies constraints to CustomObjects
 558    * @param[in] bufferIndex to use
 559    */
 560   void ConstrainCustomObjects( BufferIndex bufferIndex );
 561
 562   /**
 563    * Applies constraints to RenderTasks
 564    * @param[in] bufferIndex to use
 565    */
 566   void ConstrainRenderTasks( BufferIndex bufferIndex );
 567
 568   /**
 569    * Applies constraints to Shaders
 570    * @param[in] bufferIndex to use
 571    */
 572   void ConstrainShaders( BufferIndex bufferIndex );
 573
 574   /**
 575    * Perform property notification updates
 576    * @param[in] bufferIndex to use
 577    */
 578   void ProcessPropertyNotifications( BufferIndex bufferIndex );
 579
 580   /**
 581    * Prepare textures for rendering
 582    */
 583   void PrepareTextureSets( BufferIndex bufferIndex );
 584
 585   /**
 586    * Pass shader binaries queued here on to event thread.
 587    */
 588   void ForwardCompiledShadersToEventThread();
 589
 590   /**
 591    * Update the default camera.
 592    * This must be altered to match the root Node for 2D layouting.
 593    * @param[in] updateBuffer The buffer to read the root node size from.
 594    */
 595   void UpdateDefaultCamera( int updateBuffer );
 596
 597   /**
 598    * Update node shaders, opacity, geometry etc.
 599    * @param[in] bufferIndex to use
 600    */
 601   void UpdateNodes( BufferIndex bufferIndex );
 602
 603   /**
 604    * Update Renderers
 605    * @param[in] bufferIndex to use
 606    */
 607   void UpdateRenderers( BufferIndex bufferIndex );
 608
 609 private:
 610
 611   // needs to be direct member so that getter for event buffer can be inlined
 612   SceneGraphBuffers mSceneGraphBuffers;
 613
 614   struct Impl;
 615   Impl* mImpl;
 616
 617 };
 618
 619 // Messages for UpdateManager
 620
 621 inline void InstallRootMessage( UpdateManager& manager, Layer& root, bool systemLevel )
 622 {
 623   typedef MessageValue2< UpdateManager, Layer*, bool > LocalType;
 624
 625   // Reserve some memory inside the message queue
 626   unsigned int* slot = manager.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::InstallRoot, &root, systemLevel );
 630 }
 631
 632 inline void AddNodeMessage( UpdateManager& manager, Node& node )
 633 {
 634   typedef MessageValue1< UpdateManager, OwnerPointer<Node> > 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::AddNode, &node );
 641 }
 642
 643 inline void ConnectNodeMessage( UpdateManager& manager, const Node& constParent, const Node& constChild )
 644 {
 645   // Update thread can edit the object
 646   Node& parent = const_cast< Node& >( constParent );
 647   Node& child = const_cast< Node& >( constChild );
 648
 649   typedef MessageValue2< UpdateManager, Node*, Node* > LocalType;
 650
 651   // Reserve some memory inside the message queue
 652   unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
 653
 654   // Construct message in the message queue memory; note that delete should not be called on the return value
 655   new (slot) LocalType( &manager, &UpdateManager::ConnectNode, &parent, &child );
 656 }
 657
 658 inline void DisconnectNodeMessage( UpdateManager& manager, const Node& constNode )
 659 {
 660   // Scene graph thread can modify this object.
 661   Node& node = const_cast< Node& >( constNode );
 662
 663   typedef MessageValue1< UpdateManager, Node* > 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::DisconnectNode, &node );
 670 }
 671
 672 inline void DestroyNodeMessage( UpdateManager& manager, const Node& constNode )
 673 {
 674   // Scene graph thread can destroy this object.
 675   Node& node = const_cast< Node& >( constNode );
 676
 677   typedef MessageValue1< UpdateManager, Node* > 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::DestroyNode, &node );
 684 }
 685
 686 inline void AttachToNodeMessage( UpdateManager& manager, const Node& constParent, NodeAttachment* attachment )
 687 {
 688   // Scene graph thread can modify this object.
 689   Node& parent = const_cast< Node& >( constParent );
 690
 691   typedef MessageValue2< UpdateManager, Node*, NodeAttachmentOwner > LocalType;
 692
 693   // Reserve some memory inside the message queue
 694   unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
 695
 696   // Construct message in the message queue memory; note that delete should not be called on the return value
 697   new (slot) LocalType( &manager, &UpdateManager::AttachToNode, &parent, attachment );
 698 }
 699
 700 inline void AddObjectMessage( UpdateManager& manager, PropertyOwner* object )
 701 {
 702   typedef MessageValue1< UpdateManager, OwnerPointer<PropertyOwner> > LocalType;
 703
 704   // Reserve some memory inside the message queue
 705   unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
 706
 707   // Construct message in the message queue memory; note that delete should not be called on the return value
 708   new (slot) LocalType( &manager, &UpdateManager::AddObject, object );
 709 }
 710
 711 inline void RemoveObjectMessage( UpdateManager& manager, PropertyOwner* object )
 712 {
 713   typedef MessageValue1< UpdateManager, PropertyOwner* > LocalType;
 714
 715   // Reserve some memory inside the message queue
 716   unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
 717
 718   // Construct message in the message queue memory; note that delete should not be called on the return value
 719   new (slot) LocalType( &manager, &UpdateManager::RemoveObject, object );
 720 }
 721
 722 inline void AddAnimationMessage( UpdateManager& manager, Animation* animation )
 723 {
 724   typedef MessageValue1< UpdateManager, Animation* > LocalType;
 725
 726   // Reserve some memory inside the message queue
 727   unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
 728
 729   // Construct message in the message queue memory; note that delete should not be called on the return value
 730   new (slot) LocalType( &manager, &UpdateManager::AddAnimation, animation );
 731 }
 732
 733 inline void StopAnimationMessage( UpdateManager& manager, const Animation& constAnimation )
 734 {
 735   // The scene-graph thread owns this object so it can safely edit it.
 736   Animation& animation = const_cast< Animation& >( constAnimation );
 737
 738   typedef MessageValue1< UpdateManager, Animation* > LocalType;
 739
 740   // Reserve some memory inside the message queue
 741   unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
 742
 743   // Construct message in the message queue memory; note that delete should not be called on the return value
 744   new (slot) LocalType( &manager, &UpdateManager::StopAnimation, &animation );
 745 }
 746
 747 inline void RemoveAnimationMessage( UpdateManager& manager, const Animation& constAnimation )
 748 {
 749   // The scene-graph thread owns this object so it can safely edit it.
 750   Animation& animation = const_cast< Animation& >( constAnimation );
 751
 752   typedef MessageValue1< UpdateManager, Animation* > LocalType;
 753
 754   // Reserve some memory inside the message queue
 755   unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
 756
 757   // Construct message in the message queue memory; note that delete should not be called on the return value
 758   new (slot) LocalType( &manager, &UpdateManager::RemoveAnimation, &animation );
 759 }
 760
 761 inline void AddPropertyNotificationMessage( UpdateManager& manager, PropertyNotification* propertyNotification )
 762 {
 763   typedef MessageValue1< UpdateManager, PropertyNotification* > LocalType;
 764
 765   // Reserve some memory inside the message queue
 766   unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
 767
 768   // Construct message in the message queue memory; note that delete should not be called on the return value
 769   new (slot) LocalType( &manager, &UpdateManager::AddPropertyNotification, propertyNotification );
 770 }
 771
 772 inline void RemovePropertyNotificationMessage( UpdateManager& manager, const PropertyNotification& constPropertyNotification )
 773 {
 774   // The scene-graph thread owns this object so it can safely edit it.
 775   PropertyNotification& propertyNotification = const_cast< PropertyNotification& >( constPropertyNotification );
 776
 777   typedef MessageValue1< UpdateManager, PropertyNotification* > LocalType;
 778
 779   // Reserve some memory inside the message queue
 780   unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
 781
 782   // Construct message in the message queue memory; note that delete should not be called on the return value
 783   new (slot) LocalType( &manager, &UpdateManager::RemovePropertyNotification, &propertyNotification );
 784 }
 785
 786 inline void PropertyNotificationSetNotifyModeMessage( UpdateManager& manager,
 787                                                       const PropertyNotification* constPropertyNotification,
 788                                                       PropertyNotification::NotifyMode notifyMode )
 789 {
 790   // The scene-graph thread owns this object so it can safely edit it.
 791   PropertyNotification* propertyNotification = const_cast< PropertyNotification* >( constPropertyNotification );
 792
 793   typedef MessageValue2< UpdateManager, PropertyNotification*, PropertyNotification::NotifyMode > 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::PropertyNotificationSetNotify, propertyNotification, notifyMode );
 800 }
 801
 802 // The render thread can safely change the Shader
 803 inline void AddShaderMessage( UpdateManager& manager, Shader& shader )
 804 {
 805   typedef MessageValue1< UpdateManager, OwnerPointer< Shader > > LocalType;
 806
 807   // Reserve some memory inside the message queue
 808   unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
 809
 810   // Construct message in the message queue memory; note that delete should not be called on the return value
 811   new (slot) LocalType( &manager, &UpdateManager::AddShader, &shader );
 812 }
 813
 814 // The render thread can safely change the Shader
 815 inline void RemoveShaderMessage( UpdateManager& manager, Shader& shader )
 816 {
 817   typedef MessageValue1< UpdateManager, Shader* > LocalType;
 818
 819   // Reserve some memory inside the message queue
 820   unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
 821
 822   // Construct message in the message queue memory; note that delete should not be called on the return value
 823   new (slot) LocalType( &manager, &UpdateManager::RemoveShader, &shader );
 824 }
 825
 826 inline void SetShaderProgramMessage( UpdateManager& manager,
 827                                      Shader& shader,
 828                                      Internal::ShaderDataPtr shaderData,
 829                                      bool modifiesGeometry )
 830 {
 831   typedef MessageValue3< UpdateManager, Shader*, Internal::ShaderDataPtr, bool > LocalType;
 832
 833   // Reserve some memory inside the message queue
 834   unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
 835
 836   // Construct message in the message queue memory; note that delete should not be called on the return value
 837   new (slot) LocalType( &manager, &UpdateManager::SetShaderProgram, &shader, shaderData, modifiesGeometry );
 838 }
 839
 840 inline void SetBackgroundColorMessage( UpdateManager& manager, const Vector4& color )
 841 {
 842   typedef MessageValue1< UpdateManager, Vector4 > LocalType;
 843
 844   // Reserve some memory inside the message queue
 845   unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
 846
 847   // Construct message in the message queue memory; note that delete should not be called on the return value
 848   new (slot) LocalType( &manager, &UpdateManager::SetBackgroundColor, color );
 849 }
 850
 851 inline void SetDefaultSurfaceRectMessage( UpdateManager& manager, const Rect<int>& rect  )
 852 {
 853   typedef MessageValue1< UpdateManager, Rect<int> > LocalType;
 854
 855   // Reserve some memory inside the message queue
 856   unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
 857
 858   // Construct message in the message queue memory; note that delete should not be called on the return value
 859   new (slot) LocalType( &manager, &UpdateManager::SetDefaultSurfaceRect, rect );
 860 }
 861
 862 inline void KeepRenderingMessage( UpdateManager& manager, float durationSeconds )
 863 {
 864   typedef MessageValue1< UpdateManager, float > LocalType;
 865
 866   // Reserve some memory inside the message queue
 867   unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
 868
 869   // Construct message in the message queue memory; note that delete should not be called on the return value
 870   new (slot) LocalType( &manager, &UpdateManager::KeepRendering, durationSeconds );
 871 }
 872
 873 /**
 874  * Create a message for setting the depth of a layer
 875  * @param[in] manager The update manager
 876  * @param[in] layers list of layers
 877  * @param[in] systemLevel True if the layers are added via the SystemOverlay API
 878  */
 879 inline void SetLayerDepthsMessage( UpdateManager& manager, const std::vector< Layer* >& layers, bool systemLevel )
 880 {
 881   typedef MessageValue2< UpdateManager, std::vector< Layer* >, bool > LocalType;
 882
 883   // Reserve some memory inside the message queue
 884   unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
 885
 886   // Construct message in the message queue memory; note that delete should not be called on the return value
 887   new (slot) LocalType( &manager, &UpdateManager::SetLayerDepths, layers, systemLevel );
 888 }
 889
 890 inline void AddGestureMessage( UpdateManager& manager, PanGesture* gesture )
 891 {
 892   typedef MessageValue1< UpdateManager, PanGesture* > LocalType;
 893
 894   // Reserve some memory inside the message queue
 895   unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
 896
 897   // Construct message in the message queue memory; note that delete should not be called on the return value
 898   new (slot) LocalType( &manager, &UpdateManager::AddGesture, gesture );
 899 }
 900
 901 inline void RemoveGestureMessage( UpdateManager& manager, PanGesture* gesture )
 902 {
 903   typedef MessageValue1< UpdateManager, PanGesture* > LocalType;
 904
 905   // Reserve some memory inside the message queue
 906   unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
 907
 908   // Construct message in the message queue memory; note that delete should not be called on the return value
 909   new (slot) LocalType( &manager, &UpdateManager::RemoveGesture, gesture );
 910 }
 911
 912 template< typename T >
 913 inline void AddMessage( UpdateManager& manager, ObjectOwnerContainer<T>& owner, T& object )
 914 {
 915   typedef MessageValue1< ObjectOwnerContainer<T>, OwnerPointer< T > > LocalType;
 916
 917   // Reserve some memory inside the message queue
 918   unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
 919   // Construct message in the message queue memory; note that delete should not be called on the return value
 920   new (slot) LocalType( &owner, &ObjectOwnerContainer<T>::Add, &object );
 921 }
 922
 923 template< typename T >
 924 inline void RemoveMessage( UpdateManager& manager, ObjectOwnerContainer<T>& owner, T& object )
 925 {
 926   typedef MessageValue1< ObjectOwnerContainer<T>, T* > LocalType;
 927
 928   // Reserve some memory inside the message queue
 929   unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
 930   // Construct message in the message queue memory; note that delete should not be called on the return value
 931   new (slot) LocalType( &owner, &ObjectOwnerContainer<T>::Remove, &object );
 932 }
 933
 934 // The render thread can safely change the Shader
 935 inline void AddTextureSetMessage( UpdateManager& manager, TextureSet& textureSet )
 936 {
 937   typedef MessageValue1< UpdateManager, OwnerPointer< TextureSet > > LocalType;
 938
 939   // Reserve some memory inside the message queue
 940   unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
 941
 942   // Construct message in the message queue memory; note that delete should not be called on the return value
 943   new (slot) LocalType( &manager, &UpdateManager::AddTextureSet, &textureSet );
 944 }
 945
 946 // The render thread can safely change the Shader
 947 inline void RemoveTextureSetMessage( UpdateManager& manager, TextureSet& textureSet )
 948 {
 949   typedef MessageValue1< UpdateManager, TextureSet* > LocalType;
 950
 951   // Reserve some memory inside the message queue
 952   unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
 953
 954   // Construct message in the message queue memory; note that delete should not be called on the return value
 955   new (slot) LocalType( &manager, &UpdateManager::RemoveTextureSet, &textureSet );
 956 }
 957
 958 inline void AddSamplerMessage( UpdateManager& manager, Render::Sampler& sampler )
 959 {
 960   typedef MessageValue1< UpdateManager, Render::Sampler* > LocalType;
 961
 962   // Reserve some memory inside the message queue
 963   unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
 964
 965   // Construct message in the message queue memory; note that delete should not be called on the return value
 966   new (slot) LocalType( &manager, &UpdateManager::AddSampler, &sampler );
 967 }
 968
 969 inline void RemoveSamplerMessage( UpdateManager& manager, Render::Sampler& sampler )
 970 {
 971   typedef MessageValue1< UpdateManager, Render::Sampler* > LocalType;
 972
 973   // Reserve some memory inside the message queue
 974   unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
 975
 976   // Construct message in the message queue memory; note that delete should not be called on the return value
 977   new (slot) LocalType( &manager, &UpdateManager::RemoveSampler, &sampler );
 978 }
 979
 980 inline void SetFilterModeMessage( UpdateManager& manager, Render::Sampler& sampler, unsigned int minFilterMode, unsigned int magFilterMode )
 981 {
 982   typedef MessageValue3< UpdateManager, Render::Sampler*, unsigned int, unsigned int > LocalType;
 983
 984   // Reserve some memory inside the message queue
 985   unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
 986
 987   // Construct message in the message queue memory; note that delete should not be called on the return value
 988   new (slot) LocalType( &manager, &UpdateManager::SetFilterMode, &sampler, minFilterMode, magFilterMode );
 989 }
 990
 991 inline void SetWrapModeMessage( UpdateManager& manager, Render::Sampler& sampler, unsigned int uWrapMode, unsigned int vWrapMode )
 992 {
 993   typedef MessageValue3< UpdateManager, Render::Sampler*, unsigned int, unsigned int  > LocalType;
 994
 995   // Reserve some memory inside the message queue
 996   unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
 997
 998   // Construct message in the message queue memory; note that delete should not be called on the return value
 999   new (slot) LocalType( &manager, &UpdateManager::SetWrapMode, &sampler, uWrapMode, vWrapMode );
1000 }
1001
1002 inline void AddPropertyBuffer( UpdateManager& manager, Render::PropertyBuffer& propertyBuffer )
1003 {
1004   typedef MessageValue1< UpdateManager, Render::PropertyBuffer*  > LocalType;
1005
1006   // Reserve some memory inside the message queue
1007   unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1008
1009   // Construct message in the message queue memory; note that delete should not be called on the return value
1010   new (slot) LocalType( &manager, &UpdateManager::AddPropertyBuffer, &propertyBuffer );
1011 }
1012
1013 inline void RemovePropertyBuffer( UpdateManager& manager, Render::PropertyBuffer& propertyBuffer )
1014 {
1015   typedef MessageValue1< UpdateManager, Render::PropertyBuffer*  > LocalType;
1016
1017   // Reserve some memory inside the message queue
1018   unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1019
1020   // Construct message in the message queue memory; note that delete should not be called on the return value
1021   new (slot) LocalType( &manager, &UpdateManager::RemovePropertyBuffer, &propertyBuffer );
1022 }
1023
1024 inline void SetPropertyBufferFormat( UpdateManager& manager, Render::PropertyBuffer& propertyBuffer, Render::PropertyBuffer::Format* format )
1025 {
1026   typedef MessageValue2< UpdateManager, Render::PropertyBuffer*, Render::PropertyBuffer::Format*  > LocalType;
1027
1028   // Reserve some memory inside the message queue
1029   unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1030
1031   // Construct message in the message queue memory; note that delete should not be called on the return value
1032   new (slot) LocalType( &manager, &UpdateManager::SetPropertyBufferFormat, &propertyBuffer, format );
1033 }
1034
1035 inline void SetPropertyBufferData( UpdateManager& manager, Render::PropertyBuffer& propertyBuffer, Vector<char>* data, size_t size )
1036 {
1037   typedef MessageValue3< UpdateManager, Render::PropertyBuffer*, Vector<char>*, size_t  > LocalType;
1038
1039   // Reserve some memory inside the message queue
1040   unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1041
1042   // Construct message in the message queue memory; note that delete should not be called on the return value
1043   new (slot) LocalType( &manager, &UpdateManager::SetPropertyBufferData, &propertyBuffer, data, size );
1044 }
1045
1046 inline void AddGeometry( UpdateManager& manager, Render::Geometry& geometry )
1047 {
1048   typedef MessageValue1< UpdateManager, Render::Geometry*  > LocalType;
1049
1050   // Reserve some memory inside the message queue
1051   unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1052
1053   // Construct message in the message queue memory; note that delete should not be called on the return value
1054   new (slot) LocalType( &manager, &UpdateManager::AddGeometry, &geometry );
1055 }
1056
1057 inline void RemoveGeometry( UpdateManager& manager, Render::Geometry& geometry )
1058 {
1059   typedef MessageValue1< UpdateManager, Render::Geometry*  > LocalType;
1060
1061   // Reserve some memory inside the message queue
1062   unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1063
1064   // Construct message in the message queue memory; note that delete should not be called on the return value
1065   new (slot) LocalType( &manager, &UpdateManager::RemoveGeometry, &geometry );
1066 }
1067
1068 inline void AddVertexBufferMessage( UpdateManager& manager, Render::Geometry& geometry, const Render::PropertyBuffer& vertexBuffer )
1069 {
1070   typedef MessageValue2< UpdateManager, Render::Geometry*, Render::PropertyBuffer* > LocalType;
1071
1072   // Reserve some memory inside the message queue
1073   unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1074
1075   // Construct message in the message queue memory; note that delete should not be called on the return value
1076   new (slot) LocalType( &manager, &UpdateManager::AddVertexBuffer, &geometry, const_cast<Render::PropertyBuffer*>(&vertexBuffer) );
1077 }
1078
1079 inline void RemoveVertexBufferMessage( UpdateManager& manager, Render::Geometry& geometry, const Render::PropertyBuffer& vertexBuffer )
1080 {
1081   typedef MessageValue2< UpdateManager, Render::Geometry*, Render::PropertyBuffer* > LocalType;
1082
1083   // Reserve some memory inside the message queue
1084   unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1085
1086   // Construct message in the message queue memory; note that delete should not be called on the return value
1087   new (slot) LocalType( &manager, &UpdateManager::RemoveVertexBuffer, &geometry, const_cast<Render::PropertyBuffer*>(&vertexBuffer) );
1088 }
1089
1090 // Custom message type for SetIndexBuffer() used to move data with Vector::Swap()
1091 template< typename T >
1092 class IndexBufferMessage : public MessageBase
1093 {
1094 public:
1095
1096   /**
1097    * Constructor which does a Vector::Swap()
1098    */
1099   IndexBufferMessage( T* manager, Render::Geometry* geometry, Dali::Vector<unsigned short>& indices )
1100   : MessageBase(),
1101     mManager( manager ),
1102     mRenderGeometry( geometry )
1103   {
1104     mIndices.Swap( indices );
1105   }
1106
1107   /**
1108    * Virtual destructor
1109    */
1110   virtual ~IndexBufferMessage()
1111   {
1112   }
1113
1114   /**
1115    * @copydoc MessageBase::Process
1116    */
1117   virtual void Process( BufferIndex /*bufferIndex*/ )
1118   {
1119     DALI_ASSERT_DEBUG( mManager && "Message does not have an object" );
1120     mManager->SetIndexBuffer( mRenderGeometry, mIndices );
1121   }
1122
1123 private:
1124
1125   T* mManager;
1126   Render::Geometry* mRenderGeometry;
1127   Dali::Vector<unsigned short> mIndices;
1128 };
1129
1130 inline void SetIndexBufferMessage( UpdateManager& manager, Render::Geometry& geometry, Dali::Vector<unsigned short>& indices )
1131 {
1132   typedef IndexBufferMessage< UpdateManager > LocalType;
1133
1134   // Reserve some memory inside the message queue
1135   unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1136
1137   // Construct message in the message queue memory; note that delete should not be called on the return value
1138   new (slot) LocalType( &manager, &geometry, indices );
1139 }
1140
1141 inline void SetGeometryTypeMessage( UpdateManager& manager, Render::Geometry& geometry, unsigned int geometryType )
1142 {
1143   typedef MessageValue2< UpdateManager, Render::Geometry*, unsigned int > LocalType;
1144
1145   // Reserve some memory inside the message queue
1146   unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1147
1148   // Construct message in the message queue memory; note that delete should not be called on the return value
1149   new (slot) LocalType( &manager, &UpdateManager::SetGeometryType, &geometry, geometryType );
1150 }
1151
1152 } // namespace SceneGraph
1153
1154 } // namespace Internal
1155
1156 } // namespace Dali
1157
1158 #endif // __DALI_INTERNAL_SCENE_GRAPH_UPDATE_MANAGER_H__