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     return mParentOrigin.Get(0);
 364   }
 365
 366   /**
 367    * Sets both the local & base parent-origins of the node.
 368    * @param[in] origin The new local & base parent-origins.
 369    */
 370   void SetParentOrigin(const Vector3& origin)
 371   {
 372     mParentOrigin.Set(0, origin);
 373   }
 374
 375   /**
 376    * Retrieve the anchor-point of the node.
 377    * @return The anchor-point.
 378    */
 379   const Vector3& GetAnchorPoint() const
 380   {
 381     return mAnchorPoint.Get(0);
 382   }
 383
 384   /**
 385    * Sets both the local & base anchor-points of the node.
 386    * @param[in] anchor The new local & base anchor-points.
 387    */
 388   void SetAnchorPoint(const Vector3& anchor)
 389   {
 390     mAnchorPoint.Set(0, anchor);
 391   }
 392
 393   /**
 394    * Retrieve the local position of the node, relative to its parent.
 395    * @param[in] bufferIndex The buffer to read from.
 396    * @return The local position.
 397    */
 398   const Vector3& GetPosition(BufferIndex bufferIndex) const
 399   {
 400     if(mTransformManagerData.Id() != INVALID_TRANSFORM_ID)
 401     {
 402       return mPosition.Get(bufferIndex);
 403     }
 404
 405     return Vector3::ZERO;
 406   }
 407
 408   /**
 409    * Retrieve the position of the node derived from the position of all its parents.
 410    * @return The world position.
 411    */
 412   const Vector3& GetWorldPosition(BufferIndex bufferIndex) const
 413   {
 414     return mWorldPosition.Get(bufferIndex);
 415   }
 416
 417   /**
 418    * Set whether the Node inherits position.
 419    * @param[in] inherit True if the parent position is inherited.
 420    */
 421   void SetInheritPosition(bool inherit)
 422   {
 423     if(mTransformManagerData.Id() != INVALID_TRANSFORM_ID)
 424     {
 425       mTransformManagerData.Manager()->SetInheritPosition(mTransformManagerData.Id(), inherit);
 426     }
 427   }
 428
 429   /**
 430    * Retrieve the local orientation of the node, relative to its parent.
 431    * @param[in] bufferIndex The buffer to read from.
 432    * @return The local orientation.
 433    */
 434   const Quaternion& GetOrientation(BufferIndex bufferIndex) const
 435   {
 436     if(mTransformManagerData.Id() != INVALID_TRANSFORM_ID)
 437     {
 438       return mOrientation.Get(0);
 439     }
 440
 441     return Quaternion::IDENTITY;
 442   }
 443
 444   /**
 445    * Retrieve the orientation of the node derived from the rotation of all its parents.
 446    * @param[in] bufferIndex The buffer to read from.
 447    * @return The world rotation.
 448    */
 449   const Quaternion& GetWorldOrientation(BufferIndex bufferIndex) const
 450   {
 451     return mWorldOrientation.Get(0);
 452   }
 453
 454   /**
 455    * Set whether the Node inherits orientation.
 456    * @param[in] inherit True if the parent orientation is inherited.
 457    */
 458   void SetInheritOrientation(bool inherit)
 459   {
 460     if(mTransformManagerData.Id() != INVALID_TRANSFORM_ID)
 461     {
 462       mTransformManagerData.Manager()->SetInheritOrientation(mTransformManagerData.Id(), inherit);
 463     }
 464   }
 465
 466   /**
 467    * Retrieve the local scale of the node, relative to its parent.
 468    * @param[in] bufferIndex The buffer to read from.
 469    * @return The local scale.
 470    */
 471   const Vector3& GetScale(BufferIndex bufferIndex) const
 472   {
 473     if(mTransformManagerData.Id() != INVALID_TRANSFORM_ID)
 474     {
 475       return mScale.Get(0);
 476     }
 477
 478     return Vector3::ONE;
 479   }
 480
 481   /**
 482    * Retrieve the scale of the node derived from the scale of all its parents.
 483    * @param[in] bufferIndex The buffer to read from.
 484    * @return The world scale.
 485    */
 486   const Vector3& GetWorldScale(BufferIndex bufferIndex) const
 487   {
 488     return mWorldScale.Get(0);
 489   }
 490
 491   /**
 492    * Set whether the Node inherits scale.
 493    * @param inherit True if the Node inherits scale.
 494    */
 495   void SetInheritScale(bool inherit)
 496   {
 497     if(mTransformManagerData.Id() != INVALID_TRANSFORM_ID)
 498     {
 499       mTransformManagerData.Manager()->SetInheritScale(mTransformManagerData.Id(), inherit);
 500     }
 501   }
 502
 503   /**
 504    * Retrieve the visibility of the node.
 505    * @param[in] bufferIndex The buffer to read from.
 506    * @return True if the node is visible.
 507    */
 508   bool IsVisible(BufferIndex bufferIndex) const
 509   {
 510     return mVisible[bufferIndex];
 511   }
 512
 513   /**
 514    * Retrieve the opacity of the node.
 515    * @param[in] bufferIndex The buffer to read from.
 516    * @return The opacity.
 517    */
 518   float GetOpacity(BufferIndex bufferIndex) const
 519   {
 520     return mColor[bufferIndex].a;
 521   }
 522
 523   /**
 524    * Retrieve the color of the node.
 525    * @param[in] bufferIndex The buffer to read from.
 526    * @return The color.
 527    */
 528   const Vector4& GetColor(BufferIndex bufferIndex) const
 529   {
 530     return mColor[bufferIndex];
 531   }
 532
 533   /**
 534    * Sets the color of the node derived from the color of all its parents.
 535    * @param[in] color The world color.
 536    * @param[in] updateBufferIndex The current update buffer index.
 537    */
 538   void SetWorldColor(const Vector4& color, BufferIndex updateBufferIndex)
 539   {
 540     mWorldColor.Set(updateBufferIndex, color);
 541   }
 542
 543   /**
 544    * Sets the color of the node derived from the color of all its parents.
 545    * This method should only be called when the parents world color is up-to-date.
 546    * @pre The node has a parent.
 547    * @param[in] updateBufferIndex The current update buffer index.
 548    */
 549   void InheritWorldColor(BufferIndex updateBufferIndex)
 550   {
 551     DALI_ASSERT_DEBUG(mParent != NULL);
 552
 553     // default first
 554     if(mColorMode == USE_OWN_MULTIPLY_PARENT_ALPHA)
 555     {
 556       const Vector4& ownColor = mColor[updateBufferIndex];
 557       mWorldColor.Set(updateBufferIndex, ownColor.r, ownColor.g, ownColor.b, ownColor.a * mParent->GetWorldColor(updateBufferIndex).a);
 558     }
 559     else if(mColorMode == USE_OWN_MULTIPLY_PARENT_COLOR)
 560     {
 561       mWorldColor.Set(updateBufferIndex, mParent->GetWorldColor(updateBufferIndex) * mColor[updateBufferIndex]);
 562     }
 563     else if(mColorMode == USE_PARENT_COLOR)
 564     {
 565       mWorldColor.Set(updateBufferIndex, mParent->GetWorldColor(updateBufferIndex));
 566     }
 567     else // USE_OWN_COLOR
 568     {
 569       mWorldColor.Set(updateBufferIndex, mColor[updateBufferIndex]);
 570     }
 571   }
 572
 573   /**
 574    * Copies the previous inherited scale, if this changed in the previous frame.
 575    * This method should be called instead of InheritWorldScale i.e. if the inherited scale
 576    * does not need to be recalculated in the current frame.
 577    * @param[in] updateBufferIndex The current update buffer index.
 578    */
 579   void CopyPreviousWorldColor(BufferIndex updateBufferIndex)
 580   {
 581     mWorldColor.CopyPrevious(updateBufferIndex);
 582   }
 583
 584   /**
 585    * Retrieve the color of the node, possibly derived from the color
 586    * of all its parents, depending on the value of mColorMode.
 587    * @param[in] bufferIndex The buffer to read from.
 588    * @return The world color.
 589    */
 590   const Vector4& GetWorldColor(BufferIndex bufferIndex) const
 591   {
 592     return mWorldColor[bufferIndex];
 593   }
 594
 595   /**
 596    * Set the color mode. This specifies whether the Node uses its own color,
 597    * or inherits its parent color.
 598    * @param[in] colorMode The new color mode.
 599    */
 600   void SetColorMode(ColorMode colorMode)
 601   {
 602     mColorMode = colorMode;
 603
 604     SetDirtyFlag(NodePropertyFlags::COLOR);
 605   }
 606
 607   /**
 608    * Retrieve the color mode.
 609    * @return The color mode.
 610    */
 611   ColorMode GetColorMode() const
 612   {
 613     return mColorMode;
 614   }
 615
 616   /**
 617    * Retrieve the size of the node.
 618    * @param[in] bufferIndex The buffer to read from.
 619    * @return The size.
 620    */
 621   const Vector3& GetSize(BufferIndex bufferIndex) const
 622   {
 623     if(mTransformManagerData.Id() != INVALID_TRANSFORM_ID)
 624     {
 625       DALI_LOG_RELEASE_INFO("id = %d, data = %p, manager = %p, id = %d, mSize data = %p, index = %x\n",
 626                             mId, &mTransformManagerData, mTransformManagerData.mManager, mTransformManagerData.mId, mSize.mTxManagerData, mDepthIndex);
 627
 628       return mSize.Get(0);
 629     }
 630
 631     return Vector3::ZERO;
 632   }
 633
 634   /**
 635    * Retrieve the update size hint of the node.
 636    * @return The update size hint.
 637    */
 638   const Vector3& GetUpdateSizeHint() const
 639   {
 640     if(mTransformManagerData.Id() != INVALID_TRANSFORM_ID)
 641     {
 642       return mUpdateSizeHint.Get(0);
 643     }
 644
 645     return Vector3::ZERO;
 646   }
 647
 648   /**
 649    * Retrieve the bounding sphere of the node
 650    * @return A vector4 describing the bounding sphere. XYZ is the center and W is the radius
 651    */
 652   const Vector4& GetBoundingSphere() const
 653   {
 654     if(mTransformManagerData.Id() != INVALID_TRANSFORM_ID)
 655     {
 656       return mTransformManagerData.Manager()->GetBoundingSphere(mTransformManagerData.Id());
 657     }
 658
 659     return Vector4::ZERO;
 660   }
 661
 662   /**
 663    * Retrieve world matrix and size of the node
 664    * @param[out] The local to world matrix of the node
 665    * @param[out] size The current size of the node
 666    */
 667   void GetWorldMatrixAndSize(Matrix& worldMatrix, Vector3& size) const
 668   {
 669     if(mTransformManagerData.Id() != INVALID_TRANSFORM_ID)
 670     {
 671       mTransformManagerData.Manager()->GetWorldMatrixAndSize(mTransformManagerData.Id(), worldMatrix, size);
 672     }
 673   }
 674
 675   /**
 676    * Checks if local matrix has changed since last update
 677    * @return true if local matrix has changed, false otherwise
 678    */
 679   bool IsLocalMatrixDirty() const
 680   {
 681     return (mTransformManagerData.Id() != INVALID_TRANSFORM_ID) &&
 682            (mTransformManagerData.Manager()->IsLocalMatrixDirty(mTransformManagerData.Id()));
 683   }
 684
 685   /**
 686    * Retrieve the cached world-matrix of a node.
 687    * @param[in] bufferIndex The buffer to read from.
 688    * @return The world-matrix.
 689    */
 690   const Matrix& GetWorldMatrix(BufferIndex bufferIndex) const
 691   {
 692     return mWorldMatrix.Get(bufferIndex);
 693   }
 694
 695   /**
 696    * Mark the node as exclusive to a single RenderTask.
 697    * @param[in] renderTask The render-task, or NULL if the Node is not exclusive to a single RenderTask.
 698    */
 699   void SetExclusiveRenderTask(RenderTask* renderTask)
 700   {
 701     mExclusiveRenderTask = renderTask;
 702   }
 703
 704   /**
 705    * Query whether the node is exclusive to a single RenderTask.
 706    * @return The render-task, or NULL if the Node is not exclusive to a single RenderTask.
 707    */
 708   RenderTask* GetExclusiveRenderTask() const
 709   {
 710     return mExclusiveRenderTask;
 711   }
 712
 713   /**
 714    * Set how the Node and its children should be drawn; see Dali::Actor::SetDrawMode() for more details.
 715    * @param[in] drawMode The new draw-mode to use.
 716    */
 717   void SetDrawMode(const DrawMode::Type& drawMode)
 718   {
 719     mDrawMode = drawMode;
 720   }
 721
 722   /**
 723    * Returns whether node is an overlay or not.
 724    * @return True if node is an overlay, false otherwise.
 725    */
 726   DrawMode::Type GetDrawMode() const
 727   {
 728     return mDrawMode;
 729   }
 730
 731   void SetTransparent(bool transparent)
 732   {
 733     mTransparent = transparent;
 734   }
 735
 736   bool IsTransparent() const
 737   {
 738     return mTransparent;
 739   }
 740
 741   /*
 742    * Returns the transform id of the node
 743    * @return The transform component id of the node
 744    */
 745   TransformId GetTransformId() const
 746   {
 747     return mTransformManagerData.Id();
 748   }
 749
 750   /**
 751    * Equality operator, checks for identity, not values.
 752    * @param[in]
 753    */
 754   bool operator==(const Node* rhs) const
 755   {
 756     return (this == rhs);
 757   }
 758
 759   /**
 760    * @brief Sets the sibling order of the node
 761    * @param[in] order The new order
 762    */
 763   void SetDepthIndex(uint32_t depthIndex)
 764   {
 765     mDepthIndex = depthIndex;
 766   }
 767
 768   /**
 769    * @brief Get the depth index of the node
 770    * @return Current depth index
 771    */
 772   uint32_t GetDepthIndex() const
 773   {
 774     return mDepthIndex;
 775   }
 776
 777   /**
 778    * @brief Sets the boolean which states whether the position should use the anchor-point.
 779    * @param[in] positionUsesAnchorPoint True if the position should use the anchor-point
 780    */
 781   void SetPositionUsesAnchorPoint(bool positionUsesAnchorPoint)
 782   {
 783     if(mTransformManagerData.Id() != INVALID_TRANSFORM_ID && mPositionUsesAnchorPoint != positionUsesAnchorPoint)
 784     {
 785       mPositionUsesAnchorPoint = positionUsesAnchorPoint;
 786       mTransformManagerData.Manager()->SetPositionUsesAnchorPoint(mTransformManagerData.Id(), mPositionUsesAnchorPoint);
 787     }
 788   }
 789
 790   /**
 791    * @brief Sets whether the node is culled or not.
 792    * @param[in] bufferIndex The buffer to read from.
 793    * @param[in] culled True if the node is culled.
 794    */
 795   void SetCulled(BufferIndex bufferIndex, bool culled)
 796   {
 797     mCulled[bufferIndex] = culled;
 798   }
 799
 800   /**
 801    * @brief Retrieves whether the node is culled or not.
 802    * @param[in] bufferIndex The buffer to read from.
 803    * @return True if the node is culled.
 804    */
 805   bool IsCulled(BufferIndex bufferIndex) const
 806   {
 807     return mCulled[bufferIndex];
 808   }
 809
 810 public:
 811   /**
 812    * @copydoc UniformMap::Add
 813    */
 814   void AddUniformMapping(const UniformPropertyMapping& map) override;
 815
 816   /**
 817    * @copydoc UniformMap::Remove
 818    */
 819   void RemoveUniformMapping(const ConstString& uniformName) override;
 820
 821   /**
 822    * @copydoc Dali::Internal::SceneGraph::PropertyOwner::IsAnimationPossible
 823    */
 824   bool IsAnimationPossible() const override;
 825
 826   /**
 827    * Prepare the node for rendering.
 828    * This is called by the UpdateManager when an object is due to be rendered in the current frame.
 829    * @param[in] updateBufferIndex The current update buffer index.
 830    */
 831   void PrepareRender(BufferIndex bufferIndex);
 832
 833   /**
 834    * Called by UpdateManager when the node is added.
 835    * Creates a new transform component in the transform manager and initialize all the properties
 836    * related to the transformation
 837    * @param[in] transformManager A pointer to the trnasform manager (Owned by UpdateManager)
 838    */
 839   void CreateTransform(SceneGraph::TransformManager* transformManager);
 840
 841   /**
 842    * Reset dirty flags
 843    */
 844   void ResetDirtyFlags(BufferIndex updateBufferIndex);
 845
 846 protected:
 847   /**
 848    * Set the parent of a Node.
 849    * @param[in] parentNode the new parent.
 850    */
 851   void SetParent(Node& parentNode);
 852
 853 protected:
 854   /**
 855    * Protected constructor; See also Node::New()
 856    */
 857   Node();
 858
 859   /**
 860    * Protected virtual destructor; See also Node::Delete( Node* )
 861    * Kept protected to allow destructor chaining from layer
 862    */
 863   ~Node() override;
 864
 865 private: // from NodeDataProvider
 866   /**
 867    * @copydoc NodeDataProvider::GetModelMatrix
 868    */
 869   const Matrix& GetModelMatrix(BufferIndex bufferIndex) const override
 870   {
 871     return GetWorldMatrix(bufferIndex);
 872   }
 873
 874   /**
 875    * @copydoc NodeDataProvider::GetRenderColor
 876    */
 877   const Vector4& GetRenderColor(BufferIndex bufferIndex) const override
 878   {
 879     return GetWorldColor(bufferIndex);
 880   }
 881
 882 public: // From UniformMapDataProvider
 883   /**
 884    * @copydoc UniformMapDataProvider::GetUniformMapChanged
 885    */
 886   bool GetUniformMapChanged(BufferIndex bufferIndex) const override
 887   {
 888     return mUniformMapChanged[bufferIndex];
 889   }
 890
 891   /**
 892    * @copydoc UniformMapDataProvider::GetUniformMap
 893    */
 894   const CollectedUniformMap& GetUniformMap(BufferIndex bufferIndex) const override
 895   {
 896     return mCollectedUniformMap[bufferIndex];
 897   }
 898
 899 private:
 900   // Undefined
 901   Node(const Node&);
 902
 903   // Undefined
 904   Node& operator=(const Node& rhs);
 905
 906   /**
 907    * Recursive helper to disconnect a Node and its children.
 908    * Disconnected Nodes have no parent or children.
 909    * @param[in] updateBufferIndex The current update buffer index.
 910    */
 911   void RecursiveDisconnectFromSceneGraph(BufferIndex updateBufferIndex);
 912
 913 public: // Default properties
 914   using TransformManagerParentsOrigin = TransformManagerPropertyVector3<TRANSFORM_PROPERTY_PARENT_ORIGIN>;
 915   using TransformManagerAnchorPoint   = TransformManagerPropertyVector3<TRANSFORM_PROPERTY_ANCHOR_POINT>;
 916   using TransformManagerSize          = TransformManagerPropertyVector3<TRANSFORM_PROPERTY_SIZE>;
 917   using TransformManagerPosition      = TransformManagerPropertyVector3<TRANSFORM_PROPERTY_POSITION>;
 918   using TransformManagerScale         = TransformManagerPropertyVector3<TRANSFORM_PROPERTY_SCALE>;
 919
 920   TransformManagerData               mTransformManagerData;
 921   TransformManagerParentsOrigin      mParentOrigin; ///< Local transform; the position is relative to this. Sets the Transform flag dirty when changed
 922   TransformManagerAnchorPoint        mAnchorPoint;  ///< Local transform; local center of rotation. Sets the Transform flag dirty when changed
 923   TransformManagerSize               mSize;         ///< Size is provided for layouting
 924   TransformManagerPosition           mPosition;     ///< Local transform; distance between parent-origin & anchor-point
 925   TransformManagerScale              mScale;        ///< Local transform; scale relative to parent node
 926   TransformManagerPropertyQuaternion mOrientation;  ///< Local transform; rotation relative to parent node
 927
 928   AnimatableProperty<bool>    mVisible;        ///< Visibility can be inherited from the Node hierachy
 929   AnimatableProperty<bool>    mCulled;         ///< True if the node is culled. This is not animatable. It is just double-buffered.
 930   AnimatableProperty<Vector4> mColor;          ///< Color can be inherited from the Node hierarchy
 931   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).
 932
 933   // Inherited properties; read-only from public API
 934
 935   TransformManagerVector3Input    mWorldPosition; ///< Full inherited position
 936   TransformManagerVector3Input    mWorldScale;
 937   TransformManagerQuaternionInput mWorldOrientation; ///< Full inherited orientation
 938   TransformManagerMatrixInput     mWorldMatrix;      ///< Full inherited world matrix
 939   InheritedColor                  mWorldColor;       ///< Full inherited color
 940
 941   uint32_t       mClippingSortModifier; ///< Contains bit-packed clipping information for quick access when sorting
 942   const uint32_t mId;                   ///< The Unique ID of the node.
 943
 944 protected:
 945   static uint32_t mNodeCounter; ///< count of total nodes, used for unique ids
 946
 947   Node*       mParent;              ///< Pointer to parent node (a child is owned by its parent)
 948   RenderTask* mExclusiveRenderTask; ///< Nodes can be marked as exclusive to a single RenderTask
 949
 950   RendererContainer mRenderer; ///< Container of renderers; not owned
 951
 952   NodeContainer mChildren; ///< Container of children; not owned
 953
 954   CollectedUniformMap mCollectedUniformMap[2]; ///< Uniform maps of the node
 955   uint32_t            mUniformMapChanged[2];   ///< Records if the uniform map has been altered this frame
 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   uint32_t           mRegenerateUniformMap : 2;    ///< Indicate if the uniform map has to be regenerated this frame
 964   DrawMode::Type     mDrawMode : 3;                ///< How the Node and its children should be drawn
 965   ColorMode          mColorMode : 3;               ///< Determines whether mWorldColor is inherited, 2 bits is enough
 966   ClippingMode::Type mClippingMode : 3;            ///< The clipping mode of this node
 967   bool               mIsRoot : 1;                  ///< True if the node cannot have a parent
 968   bool               mIsLayer : 1;                 ///< True if the node is a layer
 969   bool               mPositionUsesAnchorPoint : 1; ///< True if the node should use the anchor-point when calculating the position
 970   bool               mTransparent : 1;             ///< True if this node is transparent. This value do not affect children.
 971
 972   // Changes scope, should be at end of class
 973   DALI_LOG_OBJECT_STRING_DECLARATION;
 974 };
 975
 976 // Messages for Node
 977
 978 inline void SetInheritOrientationMessage(EventThreadServices& eventThreadServices, const Node& node, bool inherit)
 979 {
 980   using LocalType = MessageValue1<Node, bool>;
 981
 982   // Reserve some memory inside the message queue
 983   uint32_t* slot = eventThreadServices.ReserveMessageSlot(sizeof(LocalType));
 984
 985   // Construct message in the message queue memory; note that delete should not be called on the return value
 986   new(slot) LocalType(&node, &Node::SetInheritOrientation, inherit);
 987 }
 988
 989 inline void SetParentOriginMessage(EventThreadServices& eventThreadServices, const Node& node, const Vector3& origin)
 990 {
 991   using LocalType = MessageValue1<Node, Vector3>;
 992
 993   // Reserve some memory inside the message queue
 994   uint32_t* slot = eventThreadServices.ReserveMessageSlot(sizeof(LocalType));
 995
 996   // Construct message in the message queue memory; note that delete should not be called on the return value
 997   new(slot) LocalType(&node, &Node::SetParentOrigin, origin);
 998 }
 999
1000 inline void SetAnchorPointMessage(EventThreadServices& eventThreadServices, const Node& node, const Vector3& anchor)
1001 {
1002   using LocalType = MessageValue1<Node, Vector3>;
1003
1004   // Reserve some memory inside the message queue
1005   uint32_t* slot = eventThreadServices.ReserveMessageSlot(sizeof(LocalType));
1006
1007   // Construct message in the message queue memory; note that delete should not be called on the return value
1008   new(slot) LocalType(&node, &Node::SetAnchorPoint, anchor);
1009 }
1010
1011 inline void SetInheritPositionMessage(EventThreadServices& eventThreadServices, const Node& node, bool inherit)
1012 {
1013   using LocalType = MessageValue1<Node, bool>;
1014
1015   // Reserve some memory inside the message queue
1016   uint32_t* slot = eventThreadServices.ReserveMessageSlot(sizeof(LocalType));
1017
1018   // Construct message in the message queue memory; note that delete should not be called on the return value
1019   new(slot) LocalType(&node, &Node::SetInheritPosition, inherit);
1020 }
1021
1022 inline void SetInheritScaleMessage(EventThreadServices& eventThreadServices, const Node& node, bool inherit)
1023 {
1024   using LocalType = MessageValue1<Node, bool>;
1025
1026   // Reserve some memory inside the message queue
1027   uint32_t* slot = eventThreadServices.ReserveMessageSlot(sizeof(LocalType));
1028
1029   // Construct message in the message queue memory; note that delete should not be called on the return value
1030   new(slot) LocalType(&node, &Node::SetInheritScale, inherit);
1031 }
1032
1033 inline void SetColorModeMessage(EventThreadServices& eventThreadServices, const Node& node, ColorMode colorMode)
1034 {
1035   using LocalType = MessageValue1<Node, ColorMode>;
1036
1037   // Reserve some memory inside the message queue
1038   uint32_t* slot = eventThreadServices.ReserveMessageSlot(sizeof(LocalType));
1039
1040   // Construct message in the message queue memory; note that delete should not be called on the return value
1041   new(slot) LocalType(&node, &Node::SetColorMode, colorMode);
1042 }
1043
1044 inline void SetDrawModeMessage(EventThreadServices& eventThreadServices, const Node& node, DrawMode::Type drawMode)
1045 {
1046   using LocalType = MessageValue1<Node, DrawMode::Type>;
1047
1048   // Reserve some memory inside the message queue
1049   uint32_t* slot = eventThreadServices.ReserveMessageSlot(sizeof(LocalType));
1050
1051   // Construct message in the message queue memory; note that delete should not be called on the return value
1052   new(slot) LocalType(&node, &Node::SetDrawMode, drawMode);
1053 }
1054
1055 inline void SetTransparentMessage(EventThreadServices& eventThreadServices, const Node& node, bool transparent)
1056 {
1057   using LocalType = MessageValue1<Node, bool>;
1058
1059   // Reserve some memory inside the message queue
1060   uint32_t* slot = eventThreadServices.ReserveMessageSlot(sizeof(LocalType));
1061
1062   // Construct message in the message queue memory; note that delete should not be called on the return value
1063   new(slot) LocalType(&node, &Node::SetTransparent, transparent);
1064 }
1065
1066 inline void DetachRendererMessage(EventThreadServices& eventThreadServices, const Node& node, const Renderer& renderer)
1067 {
1068   using LocalType = MessageValue1<Node, const Renderer*>;
1069
1070   // Reserve some memory inside the message queue
1071   uint32_t* slot = eventThreadServices.ReserveMessageSlot(sizeof(LocalType));
1072
1073   // Construct message in the message queue memory; note that delete should not be called on the return value
1074   new(slot) LocalType(&node, &Node::RemoveRenderer, &renderer);
1075 }
1076
1077 inline void SetDepthIndexMessage(EventThreadServices& eventThreadServices, const Node& node, uint32_t depthIndex)
1078 {
1079   using LocalType = MessageValue1<Node, uint32_t>;
1080
1081   // Reserve some memory inside the message queue
1082   uint32_t* slot = eventThreadServices.ReserveMessageSlot(sizeof(LocalType));
1083
1084   // Construct message in the message queue memory; note that delete should not be called on the return value
1085   new(slot) LocalType(&node, &Node::SetDepthIndex, depthIndex);
1086 }
1087
1088 inline void SetClippingModeMessage(EventThreadServices& eventThreadServices, const Node& node, ClippingMode::Type clippingMode)
1089 {
1090   using LocalType = MessageValue1<Node, ClippingMode::Type>;
1091
1092   // Reserve some memory inside the message queue
1093   uint32_t* slot = eventThreadServices.ReserveMessageSlot(sizeof(LocalType));
1094
1095   // Construct message in the message queue memory; note that delete should not be called on the return value
1096   new(slot) LocalType(&node, &Node::SetClippingMode, clippingMode);
1097 }
1098
1099 inline void SetPositionUsesAnchorPointMessage(EventThreadServices& eventThreadServices, const Node& node, bool positionUsesAnchorPoint)
1100 {
1101   using LocalType = MessageValue1<Node, bool>;
1102
1103   // Reserve some memory inside the message queue
1104   uint32_t* slot = eventThreadServices.ReserveMessageSlot(sizeof(LocalType));
1105
1106   // Construct message in the message queue memory; note that delete should not be called on the return value
1107   new(slot) LocalType(&node, &Node::SetPositionUsesAnchorPoint, positionUsesAnchorPoint);
1108 }
1109
1110 } // namespace SceneGraph
1111
1112 // Template specialisation for OwnerPointer<Node>, because delete is protected
1113 template<>
1114 inline void OwnerPointer<Dali::Internal::SceneGraph::Node>::Reset()
1115 {
1116   if(mObject != nullptr)
1117   {
1118     Dali::Internal::SceneGraph::Node::Delete(mObject);
1119     mObject = nullptr;
1120   }
1121 }
1122 } // namespace Internal
1123
1124 // Template specialisations for OwnerContainer<Node*>, because delete is protected
1125 template<>
1126 inline void OwnerContainer<Dali::Internal::SceneGraph::Node*>::Delete(Dali::Internal::SceneGraph::Node* pointer)
1127 {
1128   Dali::Internal::SceneGraph::Node::Delete(pointer);
1129 }
1130 } // namespace Dali
1131
1132 #endif // DALI_INTERNAL_SCENE_GRAPH_NODE_H