dali/internal/update/nodes/node.h

   1 #ifndef DALI_INTERNAL_SCENE_GRAPH_NODE_H
   2 #define DALI_INTERNAL_SCENE_GRAPH_NODE_H
   3
   4 /*
   5  * Copyright (c) 2021 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/integration-api/debug.h>
  23 #include <dali/internal/common/message.h>
  24 #include <dali/internal/event/common/event-thread-services.h>
  25 #include <dali/internal/render/data-providers/node-data-provider.h>
  26 #include <dali/internal/update/common/animatable-property.h>
  27 #include <dali/internal/update/common/inherited-property.h>
  28 #include <dali/internal/update/common/property-owner.h>
  29 #include <dali/internal/update/common/scene-graph-buffers.h>
  30 #include <dali/internal/update/manager/transform-manager-property.h>
  31 #include <dali/internal/update/manager/transform-manager.h>
  32 #include <dali/internal/update/nodes/node-declarations.h>
  33 #include <dali/internal/update/rendering/scene-graph-renderer.h>
  34 #include <dali/public-api/actors/actor-enumerations.h>
  35 #include <dali/public-api/actors/draw-mode.h>
  36 #include <dali/public-api/math/math-utils.h>
  37 #include <dali/public-api/math/quaternion.h>
  38 #include <dali/public-api/math/vector3.h>
  39
  40 namespace Dali
  41 {
  42 namespace Internal
  43 {
  44 // Value types used by messages.
  45 template<>
  46 struct ParameterType<ColorMode> : public BasicType<ColorMode>
  47 {
  48 };
  49 template<>
  50 struct ParameterType<ClippingMode::Type> : public BasicType<ClippingMode::Type>
  51 {
  52 };
  53
  54 namespace SceneGraph
  55 {
  56 class DiscardQueue;
  57 class Layer;
  58 class RenderTask;
  59 class UpdateManager;
  60
  61 // Flags which require the scene renderable lists to be updated
  62 static NodePropertyFlags RenderableUpdateFlags = NodePropertyFlags::TRANSFORM | NodePropertyFlags::CHILD_DELETED;
  63
  64 /**
  65  * Node is the base class for all nodes in the Scene Graph.
  66  *
  67  * Each node provides a transformation which applies to the node and
  68  * its children.  Node data is double-buffered. This allows an update
  69  * thread to modify node data, without interferring with another
  70  * thread reading the values from the previous update traversal.
  71  */
  72 class Node : public PropertyOwner, public NodeDataProvider
  73 {
  74 public:
  75   // Defaults
  76   static const ColorMode DEFAULT_COLOR_MODE;
  77
  78   // Creation methods
  79
  80   /**
  81    * Construct a new Node.
  82    */
  83   static Node* New();
  84
  85   /**
  86    * Deletes a Node.
  87    */
  88   static void Delete(Node* node);
  89
  90   /**
  91    * Called during UpdateManager::DestroyNode shortly before Node is destroyed.
  92    */
  93   void OnDestroy();
  94
  95   /**
  96    * @return the unique ID of the node
  97    */
  98   uint32_t GetId() const;
  99
 100   // Layer interface
 101
 102   /**
 103    * Query whether the node is a layer.
 104    * @return True if the node is a layer.
 105    */
 106   bool IsLayer()
 107   {
 108     return mIsLayer;
 109   }
 110
 111   /**
 112    * Convert a node to a layer.
 113    * @return A pointer to the layer, or NULL.
 114    */
 115   virtual Layer* GetLayer()
 116   {
 117     return nullptr;
 118   }
 119
 120   /**
 121    * Mark an node and its sub tree according to the updated flag.
 122    * @param[in] updated The updated flag
 123    * (used for partial rendering to mark an animating sub tree for example).
 124    */
 125   void SetUpdatedTree(bool updated)
 126   {
 127     mUpdated = updated;
 128
 129     for(Node* child : mChildren)
 130     {
 131       child->SetUpdatedTree(updated);
 132     }
 133   }
 134
 135   /**
 136    * This method sets clipping information on the node based on its hierarchy in the scene-graph.
 137    * A value is calculated that can be used during sorting to increase sort speed.
 138    * @param[in] clippingId The Clipping ID of the node to set
 139    * @param[in] clippingDepth The Clipping Depth of the node to set
 140    * @param[in] scissorDepth The Scissor Clipping Depth of the node to set
 141    */
 142   void SetClippingInformation(const uint32_t clippingId, const uint32_t clippingDepth, const uint32_t scissorDepth)
 143   {
 144     // We only set up the sort value if we have a stencil clipping depth, IE. At least 1 clipping node has been hit.
 145     // If not, if we traverse down a clipping tree and back up, and there is another
 146     // node on the parent, this will have a non-zero clipping ID that must be ignored
 147     if(clippingDepth > 0u)
 148     {
 149       mClippingDepth = clippingDepth;
 150
 151       // Calculate the sort value here on write, as when read (during sort) it may be accessed several times.
 152       // The items must be sorted by Clipping ID first (so the ID is kept in the most-significant bits).
 153       // For the same ID, the clipping nodes must be first, so we negate the
 154       // clipping enabled flag and set it as the least significant bit.
 155       mClippingSortModifier = (clippingId << 1u) | (mClippingMode == ClippingMode::DISABLED ? 1u : 0u);
 156     }
 157     else
 158     {
 159       // If we do not have a clipping depth, then set this to 0 so we do not have a Clipping ID either.
 160       mClippingSortModifier = 0u;
 161     }
 162
 163     // The scissor depth does not modify the clipping sort modifier (as scissor clips are 2D only).
 164     // For this reason we can always update the member variable.
 165     mScissorDepth = scissorDepth;
 166   }
 167
 168   /**
 169    * Gets the Clipping ID for this node.
 170    * @return The Clipping ID for this node.
 171    */
 172   uint32_t GetClippingId() const
 173   {
 174     return mClippingSortModifier >> 1u;
 175   }
 176
 177   /**
 178    * Gets the Clipping Depth for this node.
 179    * @return The Clipping Depth for this node.
 180    */
 181   uint32_t GetClippingDepth() const
 182   {
 183     return mClippingDepth;
 184   }
 185
 186   /**
 187    * Gets the Scissor Clipping Depth for this node.
 188    * @return The Scissor Clipping Depth for this node.
 189    */
 190   uint32_t GetScissorDepth() const
 191   {
 192     return mScissorDepth;
 193   }
 194
 195   /**
 196    * Sets the clipping mode for this node.
 197    * @param[in] clippingMode The ClippingMode to set
 198    */
 199   void SetClippingMode(const ClippingMode::Type clippingMode)
 200   {
 201     mClippingMode = clippingMode;
 202   }
 203
 204   /**
 205    * Gets the Clipping Mode for this node.
 206    * @return The ClippingMode of this node
 207    */
 208   ClippingMode::Type GetClippingMode() const
 209   {
 210     return mClippingMode;
 211   }
 212
 213   /**
 214    * Add a renderer to the node
 215    * @param[in] renderer The renderer added to the node
 216    */
 217   void AddRenderer(Renderer* renderer);
 218
 219   /**
 220    * Remove a renderer from the node
 221    * @param[in] renderer The renderer to be removed
 222    */
 223   void RemoveRenderer(const Renderer* renderer);
 224
 225   /*
 226    * Get the renderer at the given index
 227    * @param[in] index
 228    */
 229   Renderer* GetRendererAt(uint32_t index) const
 230   {
 231     return mRenderer[index];
 232   }
 233
 234   /**
 235    * Retrieve the number of renderers for the node
 236    */
 237   uint32_t GetRendererCount() const
 238   {
 239     return static_cast<uint32_t>(mRenderer.Size());
 240   }
 241
 242   // Containment methods
 243
 244   /**
 245    * Query whether a node is the root node. Root nodes cannot have a parent node.
 246    * A node becomes a root node, when it is installed by UpdateManager.
 247    * @return True if the node is a root node.
 248    */
 249   bool IsRoot() const
 250   {
 251     return mIsRoot;
 252   }
 253
 254   /**
 255    * Set whether a node is the root node. Root nodes cannot have a parent node.
 256    * This method should only be called by UpdateManager.
 257    * @pre When isRoot is true, the node must not have a parent.
 258    * @param[in] isRoot Whether the node is now a root node.
 259    */
 260   void SetRoot(bool isRoot);
 261
 262   /**
 263    * Retrieve the parent of a Node.
 264    * @return The parent node, or NULL if the Node has not been added to the scene-graph.
 265    */
 266   Node* GetParent()
 267   {
 268     return mParent;
 269   }
 270
 271   /**
 272    * Retrieve the parent of a Node.
 273    * @return The parent node, or NULL if the Node has not been added to the scene-graph.
 274    */
 275   const Node* GetParent() const
 276   {
 277     return mParent;
 278   }
 279
 280   /**
 281    * @return true if the node is connected to SceneGraph
 282    */
 283   bool ConnectedToScene()
 284   {
 285     return IsRoot() || GetParent();
 286   }
 287
 288   /**
 289    * Connect a node to the scene-graph.
 290    * @pre A node cannot be added to itself.
 291    * @pre The parent node is connected to the scene-graph.
 292    * @pre The childNode does not already have a parent.
 293    * @pre The childNode is not a root node.
 294    * @param[in] childNode The child to add.
 295    */
 296   void ConnectChild(Node* childNode);
 297
 298   /**
 299    * Disconnect a child (& its children) from the scene-graph.
 300    * @pre childNode is a child of this Node.
 301    * @param[in] updateBufferIndex The current update buffer index.
 302    * @param[in] childNode The node to disconnect.
 303    */
 304   void DisconnectChild(BufferIndex updateBufferIndex, Node& childNode);
 305
 306   /**
 307    * Retrieve the children a Node.
 308    * @return The container of children.
 309    */
 310   const NodeContainer& GetChildren() const
 311   {
 312     return mChildren;
 313   }
 314
 315   /**
 316    * Retrieve the children a Node.
 317    * @return The container of children.
 318    */
 319   NodeContainer& GetChildren()
 320   {
 321     return mChildren;
 322   }
 323
 324   // Update methods
 325
 326   /**
 327    * Flag that one of the node values has changed in the current frame.
 328    * @param[in] flag The flag to set.
 329    */
 330   void SetDirtyFlag(NodePropertyFlags flag)
 331   {
 332     mDirtyFlags |= flag;
 333   }
 334
 335   /**
 336    * Flag that all of the node values are dirty.
 337    */
 338   void SetAllDirtyFlags()
 339   {
 340     mDirtyFlags = NodePropertyFlags::ALL;
 341   }
 342
 343   /**
 344    * Query whether a node is dirty.
 345    * @return The dirty flags
 346    */
 347   NodePropertyFlags GetDirtyFlags() const;
 348
 349   /**
 350    * Query inherited dirty flags.
 351    *
 352    * @param The parentFlags to or with
 353    * @return The inherited dirty flags
 354    */
 355   NodePropertyFlags GetInheritedDirtyFlags(NodePropertyFlags parentFlags) const;
 356
 357   /**
 358    * Retrieve the parent-origin of the node.
 359    * @return The parent-origin.
 360    */
 361   const Vector3& GetParentOrigin() const
 362   {
 363     if(mTransformManagerData.Id() != INVALID_TRANSFORM_ID)
 364     {
 365       return mParentOrigin.Get(0);
 366     }
 367
 368     return Vector3::ZERO;
 369   }
 370
 371   /**
 372    * Sets both the local & base parent-origins of the node.
 373    * @param[in] origin The new local & base parent-origins.
 374    */
 375   void SetParentOrigin(const Vector3& origin)
 376   {
 377     mParentOrigin.Set(0, origin);
 378   }
 379
 380   /**
 381    * Retrieve the anchor-point of the node.
 382    * @return The anchor-point.
 383    */
 384   const Vector3& GetAnchorPoint() const
 385   {
 386     if(mTransformManagerData.Id() != INVALID_TRANSFORM_ID)
 387     {
 388       return mAnchorPoint.Get(0);
 389     }
 390
 391     return Vector3::ZERO;
 392   }
 393
 394   /**
 395    * Sets both the local & base anchor-points of the node.
 396    * @param[in] anchor The new local & base anchor-points.
 397    */
 398   void SetAnchorPoint(const Vector3& anchor)
 399   {
 400     mAnchorPoint.Set(0, anchor);
 401   }
 402
 403   /**
 404    * Retrieve the local position of the node, relative to its parent.
 405    * @param[in] bufferIndex The buffer to read from.
 406    * @return The local position.
 407    */
 408   const Vector3& GetPosition(BufferIndex bufferIndex) const
 409   {
 410     if(mTransformManagerData.Id() != INVALID_TRANSFORM_ID)
 411     {
 412       return mPosition.Get(bufferIndex);
 413     }
 414
 415     return Vector3::ZERO;
 416   }
 417
 418   /**
 419    * Retrieve the position of the node derived from the position of all its parents.
 420    * @return The world position.
 421    */
 422   const Vector3& GetWorldPosition(BufferIndex bufferIndex) const
 423   {
 424     if(mTransformManagerData.Id() != INVALID_TRANSFORM_ID)
 425     {
 426       return mWorldPosition.Get(bufferIndex);
 427     }
 428     return Vector3::ZERO;
 429   }
 430
 431   /**
 432    * Set whether the Node inherits position.
 433    * @param[in] inherit True if the parent position is inherited.
 434    */
 435   void SetInheritPosition(bool inherit)
 436   {
 437     if(mTransformManagerData.Id() != INVALID_TRANSFORM_ID)
 438     {
 439       mTransformManagerData.Manager()->SetInheritPosition(mTransformManagerData.Id(), inherit);
 440     }
 441   }
 442
 443   /**
 444    * Retrieve the local orientation of the node, relative to its parent.
 445    * @param[in] bufferIndex The buffer to read from.
 446    * @return The local orientation.
 447    */
 448   const Quaternion& GetOrientation(BufferIndex bufferIndex) const
 449   {
 450     if(mTransformManagerData.Id() != INVALID_TRANSFORM_ID)
 451     {
 452       return mOrientation.Get(0);
 453     }
 454
 455     return Quaternion::IDENTITY;
 456   }
 457
 458   /**
 459    * Retrieve the orientation of the node derived from the rotation of all its parents.
 460    * @param[in] bufferIndex The buffer to read from.
 461    * @return The world rotation.
 462    */
 463   const Quaternion& GetWorldOrientation(BufferIndex bufferIndex) const
 464   {
 465     if(mTransformManagerData.Id() != INVALID_TRANSFORM_ID)
 466     {
 467       return mWorldOrientation.Get(0);
 468     }
 469     return Quaternion::IDENTITY;
 470   }
 471
 472   /**
 473    * Set whether the Node inherits orientation.
 474    * @param[in] inherit True if the parent orientation is inherited.
 475    */
 476   void SetInheritOrientation(bool inherit)
 477   {
 478     if(mTransformManagerData.Id() != INVALID_TRANSFORM_ID)
 479     {
 480       mTransformManagerData.Manager()->SetInheritOrientation(mTransformManagerData.Id(), inherit);
 481     }
 482   }
 483
 484   /**
 485    * Retrieve the local scale of the node, relative to its parent.
 486    * @param[in] bufferIndex The buffer to read from.
 487    * @return The local scale.
 488    */
 489   const Vector3& GetScale(BufferIndex bufferIndex) const
 490   {
 491     if(mTransformManagerData.Id() != INVALID_TRANSFORM_ID)
 492     {
 493       return mScale.Get(0);
 494     }
 495
 496     return Vector3::ONE;
 497   }
 498
 499   /**
 500    * Retrieve the scale of the node derived from the scale of all its parents.
 501    * @param[in] bufferIndex The buffer to read from.
 502    * @return The world scale.
 503    */
 504   const Vector3& GetWorldScale(BufferIndex bufferIndex) const
 505   {
 506     if(mTransformManagerData.Id() != INVALID_TRANSFORM_ID)
 507     {
 508       return mWorldScale.Get(0);
 509     }
 510     return Vector3::ONE;
 511   }
 512
 513   /**
 514    * Set whether the Node inherits scale.
 515    * @param inherit True if the Node inherits scale.
 516    */
 517   void SetInheritScale(bool inherit)
 518   {
 519     if(mTransformManagerData.Id() != INVALID_TRANSFORM_ID)
 520     {
 521       mTransformManagerData.Manager()->SetInheritScale(mTransformManagerData.Id(), inherit);
 522     }
 523   }
 524
 525   /**
 526    * Retrieve the visibility of the node.
 527    * @param[in] bufferIndex The buffer to read from.
 528    * @return True if the node is visible.
 529    */
 530   bool IsVisible(BufferIndex bufferIndex) const
 531   {
 532     return mVisible[bufferIndex];
 533   }
 534
 535   /**
 536    * Retrieve the opacity of the node.
 537    * @param[in] bufferIndex The buffer to read from.
 538    * @return The opacity.
 539    */
 540   float GetOpacity(BufferIndex bufferIndex) const
 541   {
 542     return mColor[bufferIndex].a;
 543   }
 544
 545   /**
 546    * Retrieve the color of the node.
 547    * @param[in] bufferIndex The buffer to read from.
 548    * @return The color.
 549    */
 550   const Vector4& GetColor(BufferIndex bufferIndex) const
 551   {
 552     return mColor[bufferIndex];
 553   }
 554
 555   /**
 556    * Sets the color of the node derived from the color of all its parents.
 557    * @param[in] color The world color.
 558    * @param[in] updateBufferIndex The current update buffer index.
 559    */
 560   void SetWorldColor(const Vector4& color, BufferIndex updateBufferIndex)
 561   {
 562     mWorldColor.Set(updateBufferIndex, color);
 563   }
 564
 565   /**
 566    * Sets the color of the node derived from the color of all its parents.
 567    * This method should only be called when the parents world color is up-to-date.
 568    * @pre The node has a parent.
 569    * @param[in] updateBufferIndex The current update buffer index.
 570    */
 571   void InheritWorldColor(BufferIndex updateBufferIndex)
 572   {
 573     DALI_ASSERT_DEBUG(mParent != NULL);
 574
 575     // default first
 576     if(mColorMode == USE_OWN_MULTIPLY_PARENT_ALPHA)
 577     {
 578       const Vector4& ownColor = mColor[updateBufferIndex];
 579       mWorldColor.Set(updateBufferIndex, ownColor.r, ownColor.g, ownColor.b, ownColor.a * mParent->GetWorldColor(updateBufferIndex).a);
 580     }
 581     else if(mColorMode == USE_OWN_MULTIPLY_PARENT_COLOR)
 582     {
 583       mWorldColor.Set(updateBufferIndex, mParent->GetWorldColor(updateBufferIndex) * mColor[updateBufferIndex]);
 584     }
 585     else if(mColorMode == USE_PARENT_COLOR)
 586     {
 587       mWorldColor.Set(updateBufferIndex, mParent->GetWorldColor(updateBufferIndex));
 588     }
 589     else // USE_OWN_COLOR
 590     {
 591       mWorldColor.Set(updateBufferIndex, mColor[updateBufferIndex]);
 592     }
 593   }
 594
 595   /**
 596    * Copies the previous inherited scale, if this changed in the previous frame.
 597    * This method should be called instead of InheritWorldScale i.e. if the inherited scale
 598    * does not need to be recalculated in the current frame.
 599    * @param[in] updateBufferIndex The current update buffer index.
 600    */
 601   void CopyPreviousWorldColor(BufferIndex updateBufferIndex)
 602   {
 603     mWorldColor.CopyPrevious(updateBufferIndex);
 604   }
 605
 606   /**
 607    * Retrieve the color of the node, possibly derived from the color
 608    * of all its parents, depending on the value of mColorMode.
 609    * @param[in] bufferIndex The buffer to read from.
 610    * @return The world color.
 611    */
 612   const Vector4& GetWorldColor(BufferIndex bufferIndex) const
 613   {
 614     return mWorldColor[bufferIndex];
 615   }
 616
 617   /**
 618    * Set the color mode. This specifies whether the Node uses its own color,
 619    * or inherits its parent color.
 620    * @param[in] colorMode The new color mode.
 621    */
 622   void SetColorMode(ColorMode colorMode)
 623   {
 624     mColorMode = colorMode;
 625
 626     SetDirtyFlag(NodePropertyFlags::COLOR);
 627   }
 628
 629   /**
 630    * Retrieve the color mode.
 631    * @return The color mode.
 632    */
 633   ColorMode GetColorMode() const
 634   {
 635     return mColorMode;
 636   }
 637
 638   /**
 639    * Retrieve the size of the node.
 640    * @param[in] bufferIndex The buffer to read from.
 641    * @return The size.
 642    */
 643   const Vector3& GetSize(BufferIndex bufferIndex) const
 644   {
 645     if(mTransformManagerData.Id() != INVALID_TRANSFORM_ID)
 646     {
 647       return mSize.Get(0);
 648     }
 649
 650     return Vector3::ZERO;
 651   }
 652
 653   /**
 654    * Retrieve the update size hint of the node.
 655    * @return The update size hint.
 656    */
 657   const Vector3& GetUpdateSizeHint() const
 658   {
 659     if(mTransformManagerData.Id() != INVALID_TRANSFORM_ID)
 660     {
 661       return mUpdateSizeHint.Get(0);
 662     }
 663
 664     return Vector3::ZERO;
 665   }
 666
 667   /**
 668    * Retrieve the bounding sphere of the node
 669    * @return A vector4 describing the bounding sphere. XYZ is the center and W is the radius
 670    */
 671   const Vector4& GetBoundingSphere() const
 672   {
 673     if(mTransformManagerData.Id() != INVALID_TRANSFORM_ID)
 674     {
 675       return mTransformManagerData.Manager()->GetBoundingSphere(mTransformManagerData.Id());
 676     }
 677
 678     return Vector4::ZERO;
 679   }
 680
 681   /**
 682    * Retrieve world matrix and size of the node
 683    * @param[out] The local to world matrix of the node
 684    * @param[out] size The current size of the node
 685    */
 686   void GetWorldMatrixAndSize(Matrix& worldMatrix, Vector3& size) const
 687   {
 688     if(mTransformManagerData.Id() != INVALID_TRANSFORM_ID)
 689     {
 690       mTransformManagerData.Manager()->GetWorldMatrixAndSize(mTransformManagerData.Id(), worldMatrix, size);
 691     }
 692   }
 693
 694   /**
 695    * Checks if local matrix has changed since last update
 696    * @return true if local matrix has changed, false otherwise
 697    */
 698   bool IsLocalMatrixDirty() const
 699   {
 700     return (mTransformManagerData.Id() != INVALID_TRANSFORM_ID) &&
 701            (mTransformManagerData.Manager()->IsLocalMatrixDirty(mTransformManagerData.Id()));
 702   }
 703
 704   /**
 705    * Retrieve the cached world-matrix of a node.
 706    * @param[in] bufferIndex The buffer to read from.
 707    * @return The world-matrix.
 708    */
 709   const Matrix& GetWorldMatrix(BufferIndex bufferIndex) const
 710   {
 711     if(mTransformManagerData.Id() != INVALID_TRANSFORM_ID)
 712     {
 713       return mWorldMatrix.Get(bufferIndex);
 714     }
 715
 716     return Matrix::IDENTITY;
 717   }
 718
 719   /**
 720    * Mark the node as exclusive to a single RenderTask.
 721    * @param[in] renderTask The render-task, or NULL if the Node is not exclusive to a single RenderTask.
 722    */
 723   void SetExclusiveRenderTask(RenderTask* renderTask)
 724   {
 725     mExclusiveRenderTask = renderTask;
 726   }
 727
 728   /**
 729    * Query whether the node is exclusive to a single RenderTask.
 730    * @return The render-task, or NULL if the Node is not exclusive to a single RenderTask.
 731    */
 732   RenderTask* GetExclusiveRenderTask() const
 733   {
 734     return mExclusiveRenderTask;
 735   }
 736
 737   /**
 738    * Set how the Node and its children should be drawn; see Dali::Actor::SetDrawMode() for more details.
 739    * @param[in] drawMode The new draw-mode to use.
 740    */
 741   void SetDrawMode(const DrawMode::Type& drawMode)
 742   {
 743     mDrawMode = drawMode;
 744   }
 745
 746   /**
 747    * Returns whether node is an overlay or not.
 748    * @return True if node is an overlay, false otherwise.
 749    */
 750   DrawMode::Type GetDrawMode() const
 751   {
 752     return mDrawMode;
 753   }
 754
 755   void SetTransparent(bool transparent)
 756   {
 757     mTransparent = transparent;
 758   }
 759
 760   bool IsTransparent() const
 761   {
 762     return mTransparent;
 763   }
 764
 765   /*
 766    * Returns the transform id of the node
 767    * @return The transform component id of the node
 768    */
 769   TransformId GetTransformId() const
 770   {
 771     return mTransformManagerData.Id();
 772   }
 773
 774   /**
 775    * Equality operator, checks for identity, not values.
 776    * @param[in]
 777    */
 778   bool operator==(const Node* rhs) const
 779   {
 780     return (this == rhs);
 781   }
 782
 783   /**
 784    * @brief Sets the sibling order of the node
 785    * @param[in] order The new order
 786    */
 787   void SetDepthIndex(uint32_t depthIndex)
 788   {
 789     if(depthIndex != mDepthIndex)
 790     {
 791       SetDirtyFlag(NodePropertyFlags::DEPTH_INDEX);
 792       mDepthIndex = depthIndex;
 793     }
 794   }
 795
 796   /**
 797    * @brief Get the depth index of the node
 798    * @return Current depth index
 799    */
 800   uint32_t GetDepthIndex() const
 801   {
 802     return mDepthIndex;
 803   }
 804
 805   /**
 806    * @brief Sets the boolean which states whether the position should use the anchor-point.
 807    * @param[in] positionUsesAnchorPoint True if the position should use the anchor-point
 808    */
 809   void SetPositionUsesAnchorPoint(bool positionUsesAnchorPoint)
 810   {
 811     if(mTransformManagerData.Id() != INVALID_TRANSFORM_ID && mPositionUsesAnchorPoint != positionUsesAnchorPoint)
 812     {
 813       mPositionUsesAnchorPoint = positionUsesAnchorPoint;
 814       mTransformManagerData.Manager()->SetPositionUsesAnchorPoint(mTransformManagerData.Id(), mPositionUsesAnchorPoint);
 815     }
 816   }
 817
 818   /**
 819    * @brief Sets whether the node is culled or not.
 820    * @param[in] bufferIndex The buffer to read from.
 821    * @param[in] culled True if the node is culled.
 822    */
 823   void SetCulled(BufferIndex bufferIndex, bool culled)
 824   {
 825     mCulled[bufferIndex] = culled;
 826   }
 827
 828   /**
 829    * @brief Retrieves whether the node is culled or not.
 830    * @param[in] bufferIndex The buffer to read from.
 831    * @return True if the node is culled.
 832    */
 833   bool IsCulled(BufferIndex bufferIndex) const
 834   {
 835     return mCulled[bufferIndex];
 836   }
 837
 838 public:
 839   /**
 840    * @copydoc Dali::Internal::SceneGraph::PropertyOwner::IsAnimationPossible
 841    */
 842   bool IsAnimationPossible() const override;
 843
 844   /**
 845    * Called by UpdateManager when the node is added.
 846    * Creates a new transform component in the transform manager and initialize all the properties
 847    * related to the transformation
 848    * @param[in] transformManager A pointer to the trnasform manager (Owned by UpdateManager)
 849    */
 850   void CreateTransform(SceneGraph::TransformManager* transformManager);
 851
 852   /**
 853    * Reset dirty flags
 854    */
 855   void ResetDirtyFlags(BufferIndex updateBufferIndex);
 856
 857 protected:
 858   /**
 859    * Set the parent of a Node.
 860    * @param[in] parentNode the new parent.
 861    */
 862   void SetParent(Node& parentNode);
 863
 864 protected:
 865   /**
 866    * Protected constructor; See also Node::New()
 867    */
 868   Node();
 869
 870   /**
 871    * Protected virtual destructor; See also Node::Delete( Node* )
 872    * Kept protected to allow destructor chaining from layer
 873    */
 874   ~Node() override;
 875
 876 private: // from NodeDataProvider
 877   /**
 878    * @copydoc NodeDataProvider::GetModelMatrix
 879    */
 880   const Matrix& GetModelMatrix(BufferIndex bufferIndex) const override
 881   {
 882     return GetWorldMatrix(bufferIndex);
 883   }
 884
 885   /**
 886    * @copydoc NodeDataProvider::GetRenderColor
 887    */
 888   const Vector4& GetRenderColor(BufferIndex bufferIndex) const override
 889   {
 890     return GetWorldColor(bufferIndex);
 891   }
 892
 893   /**
 894    * @copydoc NodeDataProvider::GetNodeUniformMap
 895    */
 896   const UniformMap& GetNodeUniformMap() const override
 897   {
 898     return GetUniformMap();
 899   }
 900
 901 private:
 902   // Undefined
 903   Node(const Node&);
 904
 905   // Undefined
 906   Node& operator=(const Node& rhs);
 907
 908   /**
 909    * Recursive helper to disconnect a Node and its children.
 910    * Disconnected Nodes have no parent or children.
 911    * @param[in] updateBufferIndex The current update buffer index.
 912    */
 913   void RecursiveDisconnectFromSceneGraph(BufferIndex updateBufferIndex);
 914
 915 public: // Default properties
 916   using TransformManagerParentsOrigin = TransformManagerPropertyVector3<TRANSFORM_PROPERTY_PARENT_ORIGIN>;
 917   using TransformManagerAnchorPoint   = TransformManagerPropertyVector3<TRANSFORM_PROPERTY_ANCHOR_POINT>;
 918   using TransformManagerSize          = TransformManagerPropertyVector3<TRANSFORM_PROPERTY_SIZE>;
 919   using TransformManagerPosition      = TransformManagerPropertyVector3<TRANSFORM_PROPERTY_POSITION>;
 920   using TransformManagerScale         = TransformManagerPropertyVector3<TRANSFORM_PROPERTY_SCALE>;
 921
 922   TransformManagerData               mTransformManagerData;
 923   TransformManagerParentsOrigin      mParentOrigin; ///< Local transform; the position is relative to this. Sets the Transform flag dirty when changed
 924   TransformManagerAnchorPoint        mAnchorPoint;  ///< Local transform; local center of rotation. Sets the Transform flag dirty when changed
 925   TransformManagerSize               mSize;         ///< Size is provided for layouting
 926   TransformManagerPosition           mPosition;     ///< Local transform; distance between parent-origin & anchor-point
 927   TransformManagerScale              mScale;        ///< Local transform; scale relative to parent node
 928   TransformManagerPropertyQuaternion mOrientation;  ///< Local transform; rotation relative to parent node
 929
 930   AnimatableProperty<bool>    mVisible;        ///< Visibility can be inherited from the Node hierachy
 931   AnimatableProperty<bool>    mCulled;         ///< True if the node is culled. This is not animatable. It is just double-buffered.
 932   AnimatableProperty<Vector4> mColor;          ///< Color can be inherited from the Node hierarchy
 933   AnimatableProperty<Vector3> mUpdateSizeHint; ///< Update size hint is provided for damaged area calculation. This is not animatable. It is just double-buffered. (Because all these bloody properties are).
 934
 935   // Inherited properties; read-only from public API
 936
 937   TransformManagerVector3Input    mWorldPosition; ///< Full inherited position
 938   TransformManagerVector3Input    mWorldScale;
 939   TransformManagerQuaternionInput mWorldOrientation; ///< Full inherited orientation
 940   TransformManagerMatrixInput     mWorldMatrix;      ///< Full inherited world matrix
 941   InheritedColor                  mWorldColor;       ///< Full inherited color
 942
 943   uint32_t       mClippingSortModifier; ///< Contains bit-packed clipping information for quick access when sorting
 944   const uint32_t mId;                   ///< The Unique ID of the node.
 945
 946 protected:
 947   static uint32_t mNodeCounter; ///< count of total nodes, used for unique ids
 948
 949   Node*       mParent;              ///< Pointer to parent node (a child is owned by its parent)
 950   RenderTask* mExclusiveRenderTask; ///< Nodes can be marked as exclusive to a single RenderTask
 951
 952   RendererContainer mRenderer; ///< Container of renderers; not owned
 953
 954   NodeContainer mChildren; ///< Container of children; not owned
 955
 956   uint32_t mClippingDepth; ///< The number of stencil clipping nodes deep this node is
 957   uint32_t mScissorDepth;  ///< The number of scissor clipping nodes deep this node is
 958
 959   uint32_t mDepthIndex; ///< Depth index of the node
 960
 961   // flags, compressed to bitfield
 962   NodePropertyFlags  mDirtyFlags;                  ///< Dirty flags for each of the Node properties
 963   DrawMode::Type     mDrawMode : 3;                ///< How the Node and its children should be drawn
 964   ColorMode          mColorMode : 3;               ///< Determines whether mWorldColor is inherited, 2 bits is enough
 965   ClippingMode::Type mClippingMode : 3;            ///< The clipping mode of this node
 966   bool               mIsRoot : 1;                  ///< True if the node cannot have a parent
 967   bool               mIsLayer : 1;                 ///< True if the node is a layer
 968   bool               mPositionUsesAnchorPoint : 1; ///< True if the node should use the anchor-point when calculating the position
 969   bool               mTransparent : 1;             ///< True if this node is transparent. This value do not affect children.
 970
 971   // Changes scope, should be at end of class
 972   DALI_LOG_OBJECT_STRING_DECLARATION;
 973 };
 974
 975 // Messages for Node
 976
 977 inline void SetInheritOrientationMessage(EventThreadServices& eventThreadServices, const Node& node, bool inherit)
 978 {
 979   using LocalType = MessageValue1<Node, bool>;
 980
 981   // Reserve some memory inside the message queue
 982   uint32_t* slot = eventThreadServices.ReserveMessageSlot(sizeof(LocalType));
 983
 984   // Construct message in the message queue memory; note that delete should not be called on the return value
 985   new(slot) LocalType(&node, &Node::SetInheritOrientation, inherit);
 986 }
 987
 988 inline void SetParentOriginMessage(EventThreadServices& eventThreadServices, const Node& node, const Vector3& origin)
 989 {
 990   using LocalType = MessageValue1<Node, Vector3>;
 991
 992   // Reserve some memory inside the message queue
 993   uint32_t* slot = eventThreadServices.ReserveMessageSlot(sizeof(LocalType));
 994
 995   // Construct message in the message queue memory; note that delete should not be called on the return value
 996   new(slot) LocalType(&node, &Node::SetParentOrigin, origin);
 997 }
 998
 999 inline void SetAnchorPointMessage(EventThreadServices& eventThreadServices, const Node& node, const Vector3& anchor)
1000 {
1001   using LocalType = MessageValue1<Node, Vector3>;
1002
1003   // Reserve some memory inside the message queue
1004   uint32_t* slot = eventThreadServices.ReserveMessageSlot(sizeof(LocalType));
1005
1006   // Construct message in the message queue memory; note that delete should not be called on the return value
1007   new(slot) LocalType(&node, &Node::SetAnchorPoint, anchor);
1008 }
1009
1010 inline void SetInheritPositionMessage(EventThreadServices& eventThreadServices, const Node& node, bool inherit)
1011 {
1012   using LocalType = MessageValue1<Node, bool>;
1013
1014   // Reserve some memory inside the message queue
1015   uint32_t* slot = eventThreadServices.ReserveMessageSlot(sizeof(LocalType));
1016
1017   // Construct message in the message queue memory; note that delete should not be called on the return value
1018   new(slot) LocalType(&node, &Node::SetInheritPosition, inherit);
1019 }
1020
1021 inline void SetInheritScaleMessage(EventThreadServices& eventThreadServices, const Node& node, bool inherit)
1022 {
1023   using LocalType = MessageValue1<Node, bool>;
1024
1025   // Reserve some memory inside the message queue
1026   uint32_t* slot = eventThreadServices.ReserveMessageSlot(sizeof(LocalType));
1027
1028   // Construct message in the message queue memory; note that delete should not be called on the return value
1029   new(slot) LocalType(&node, &Node::SetInheritScale, inherit);
1030 }
1031
1032 inline void SetColorModeMessage(EventThreadServices& eventThreadServices, const Node& node, ColorMode colorMode)
1033 {
1034   using LocalType = MessageValue1<Node, ColorMode>;
1035
1036   // Reserve some memory inside the message queue
1037   uint32_t* slot = eventThreadServices.ReserveMessageSlot(sizeof(LocalType));
1038
1039   // Construct message in the message queue memory; note that delete should not be called on the return value
1040   new(slot) LocalType(&node, &Node::SetColorMode, colorMode);
1041 }
1042
1043 inline void SetDrawModeMessage(EventThreadServices& eventThreadServices, const Node& node, DrawMode::Type drawMode)
1044 {
1045   using LocalType = MessageValue1<Node, DrawMode::Type>;
1046
1047   // Reserve some memory inside the message queue
1048   uint32_t* slot = eventThreadServices.ReserveMessageSlot(sizeof(LocalType));
1049
1050   // Construct message in the message queue memory; note that delete should not be called on the return value
1051   new(slot) LocalType(&node, &Node::SetDrawMode, drawMode);
1052 }
1053
1054 inline void SetTransparentMessage(EventThreadServices& eventThreadServices, const Node& node, bool transparent)
1055 {
1056   using LocalType = MessageValue1<Node, bool>;
1057
1058   // Reserve some memory inside the message queue
1059   uint32_t* slot = eventThreadServices.ReserveMessageSlot(sizeof(LocalType));
1060
1061   // Construct message in the message queue memory; note that delete should not be called on the return value
1062   new(slot) LocalType(&node, &Node::SetTransparent, transparent);
1063 }
1064
1065 inline void DetachRendererMessage(EventThreadServices& eventThreadServices, const Node& node, const Renderer& renderer)
1066 {
1067   using LocalType = MessageValue1<Node, const Renderer*>;
1068
1069   // Reserve some memory inside the message queue
1070   uint32_t* slot = eventThreadServices.ReserveMessageSlot(sizeof(LocalType));
1071
1072   // Construct message in the message queue memory; note that delete should not be called on the return value
1073   new(slot) LocalType(&node, &Node::RemoveRenderer, &renderer);
1074 }
1075
1076 inline void SetDepthIndexMessage(EventThreadServices& eventThreadServices, const Node& node, uint32_t depthIndex)
1077 {
1078   using LocalType = MessageValue1<Node, uint32_t>;
1079
1080   // Reserve some memory inside the message queue
1081   uint32_t* slot = eventThreadServices.ReserveMessageSlot(sizeof(LocalType));
1082
1083   // Construct message in the message queue memory; note that delete should not be called on the return value
1084   new(slot) LocalType(&node, &Node::SetDepthIndex, depthIndex);
1085 }
1086
1087 inline void SetClippingModeMessage(EventThreadServices& eventThreadServices, const Node& node, ClippingMode::Type clippingMode)
1088 {
1089   using LocalType = MessageValue1<Node, ClippingMode::Type>;
1090
1091   // Reserve some memory inside the message queue
1092   uint32_t* slot = eventThreadServices.ReserveMessageSlot(sizeof(LocalType));
1093
1094   // Construct message in the message queue memory; note that delete should not be called on the return value
1095   new(slot) LocalType(&node, &Node::SetClippingMode, clippingMode);
1096 }
1097
1098 inline void SetPositionUsesAnchorPointMessage(EventThreadServices& eventThreadServices, const Node& node, bool positionUsesAnchorPoint)
1099 {
1100   using LocalType = MessageValue1<Node, bool>;
1101
1102   // Reserve some memory inside the message queue
1103   uint32_t* slot = eventThreadServices.ReserveMessageSlot(sizeof(LocalType));
1104
1105   // Construct message in the message queue memory; note that delete should not be called on the return value
1106   new(slot) LocalType(&node, &Node::SetPositionUsesAnchorPoint, positionUsesAnchorPoint);
1107 }
1108
1109 } // namespace SceneGraph
1110
1111 // Template specialisation for OwnerPointer<Node>, because delete is protected
1112 template<>
1113 inline void OwnerPointer<Dali::Internal::SceneGraph::Node>::Reset()
1114 {
1115   if(mObject != nullptr)
1116   {
1117     Dali::Internal::SceneGraph::Node::Delete(mObject);
1118     mObject = nullptr;
1119   }
1120 }
1121 } // namespace Internal
1122
1123 // Template specialisations for OwnerContainer<Node*>, because delete is protected
1124 template<>
1125 inline void OwnerContainer<Dali::Internal::SceneGraph::Node*>::Delete(Dali::Internal::SceneGraph::Node* pointer)
1126 {
1127   Dali::Internal::SceneGraph::Node::Delete(pointer);
1128 }
1129 } // namespace Dali
1130
1131 #endif // DALI_INTERNAL_SCENE_GRAPH_NODE_H