1 #ifndef DALI_INTERNAL_SCENE_GRAPH_NODE_H
2 #define DALI_INTERNAL_SCENE_GRAPH_NODE_H
5 * Copyright (c) 2021 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
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>
44 // Value types used by messages.
46 struct ParameterType<ColorMode> : public BasicType<ColorMode>
50 struct ParameterType<ClippingMode::Type> : public BasicType<ClippingMode::Type>
61 // Flags which require the scene renderable lists to be updated
62 static NodePropertyFlags RenderableUpdateFlags = NodePropertyFlags::TRANSFORM | NodePropertyFlags::CHILD_DELETED;
65 * Node is the base class for all nodes in the Scene Graph.
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.
72 class Node : public PropertyOwner, public NodeDataProvider
76 static const ColorMode DEFAULT_COLOR_MODE;
81 * Construct a new Node.
88 static void Delete(Node* node);
91 * Called during UpdateManager::DestroyNode shortly before Node is destroyed.
96 * @return the unique ID of the node
98 uint32_t GetId() const;
103 * Query whether the node is a layer.
104 * @return True if the node is a layer.
112 * Convert a node to a layer.
113 * @return A pointer to the layer, or NULL.
115 virtual Layer* GetLayer()
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).
125 void SetUpdated(bool updated) override
129 for(Node* child : mChildren)
131 child->SetUpdated(updated);
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
142 void SetClippingInformation(const uint32_t clippingId, const uint32_t clippingDepth, const uint32_t scissorDepth)
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)
149 mClippingDepth = clippingDepth;
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);
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;
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;
169 * Gets the Clipping ID for this node.
170 * @return The Clipping ID for this node.
172 uint32_t GetClippingId() const
174 return mClippingSortModifier >> 1u;
178 * Gets the Clipping Depth for this node.
179 * @return The Clipping Depth for this node.
181 uint32_t GetClippingDepth() const
183 return mClippingDepth;
187 * Gets the Scissor Clipping Depth for this node.
188 * @return The Scissor Clipping Depth for this node.
190 uint32_t GetScissorDepth() const
192 return mScissorDepth;
196 * Sets the clipping mode for this node.
197 * @param[in] clippingMode The ClippingMode to set
199 void SetClippingMode(const ClippingMode::Type clippingMode)
201 mClippingMode = clippingMode;
205 * Gets the Clipping Mode for this node.
206 * @return The ClippingMode of this node
208 ClippingMode::Type GetClippingMode() const
210 return mClippingMode;
214 * Add a renderer to the node
215 * @param[in] renderer The renderer added to the node
217 void AddRenderer(Renderer* renderer);
220 * Remove a renderer from the node
221 * @param[in] renderer The renderer to be removed
223 void RemoveRenderer(const Renderer* renderer);
226 * Get the renderer at the given index
229 Renderer* GetRendererAt(uint32_t index) const
231 return mRenderer[index];
235 * Retrieve the number of renderers for the node
237 uint32_t GetRendererCount() const
239 return static_cast<uint32_t>(mRenderer.Size());
242 // Containment methods
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.
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.
260 void SetRoot(bool isRoot);
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.
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.
275 const Node* GetParent() const
281 * @return true if the node is connected to SceneGraph
283 bool ConnectedToScene()
285 return IsRoot() || GetParent();
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.
296 void ConnectChild(Node* childNode);
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.
304 void DisconnectChild(BufferIndex updateBufferIndex, Node& childNode);
307 * Retrieve the children a Node.
308 * @return The container of children.
310 const NodeContainer& GetChildren() const
316 * Retrieve the children a Node.
317 * @return The container of children.
319 NodeContainer& GetChildren()
327 * Flag that one of the node values has changed in the current frame.
328 * @param[in] flag The flag to set.
330 void SetDirtyFlag(NodePropertyFlags flag)
336 * Flag that all of the node values are dirty.
338 void SetAllDirtyFlags()
340 mDirtyFlags = NodePropertyFlags::ALL;
344 * Query whether a node is dirty.
345 * @return The dirty flags
347 NodePropertyFlags GetDirtyFlags() const;
350 * Query inherited dirty flags.
352 * @param The parentFlags to or with
353 * @return The inherited dirty flags
355 NodePropertyFlags GetInheritedDirtyFlags(NodePropertyFlags parentFlags) const;
358 * Retrieve the parent-origin of the node.
359 * @return The parent-origin.
361 const Vector3& GetParentOrigin() const
363 return mParentOrigin.Get(0);
367 * Sets both the local & base parent-origins of the node.
368 * @param[in] origin The new local & base parent-origins.
370 void SetParentOrigin(const Vector3& origin)
372 mParentOrigin.Set(0, origin);
376 * Retrieve the anchor-point of the node.
377 * @return The anchor-point.
379 const Vector3& GetAnchorPoint() const
381 return mAnchorPoint.Get(0);
385 * Sets both the local & base anchor-points of the node.
386 * @param[in] anchor The new local & base anchor-points.
388 void SetAnchorPoint(const Vector3& anchor)
390 mAnchorPoint.Set(0, anchor);
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.
398 const Vector3& GetPosition(BufferIndex bufferIndex) const
400 if(mTransformManagerData.Id() != INVALID_TRANSFORM_ID)
402 return mPosition.Get(bufferIndex);
405 return Vector3::ZERO;
409 * Retrieve the position of the node derived from the position of all its parents.
410 * @return The world position.
412 const Vector3& GetWorldPosition(BufferIndex bufferIndex) const
414 return mWorldPosition.Get(bufferIndex);
418 * Set whether the Node inherits position.
419 * @param[in] inherit True if the parent position is inherited.
421 void SetInheritPosition(bool inherit)
423 if(mTransformManagerData.Id() != INVALID_TRANSFORM_ID)
425 mTransformManagerData.Manager()->SetInheritPosition(mTransformManagerData.Id(), inherit);
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.
434 const Quaternion& GetOrientation(BufferIndex bufferIndex) const
436 if(mTransformManagerData.Id() != INVALID_TRANSFORM_ID)
438 return mOrientation.Get(0);
441 return Quaternion::IDENTITY;
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.
449 const Quaternion& GetWorldOrientation(BufferIndex bufferIndex) const
451 return mWorldOrientation.Get(0);
455 * Set whether the Node inherits orientation.
456 * @param[in] inherit True if the parent orientation is inherited.
458 void SetInheritOrientation(bool inherit)
460 if(mTransformManagerData.Id() != INVALID_TRANSFORM_ID)
462 mTransformManagerData.Manager()->SetInheritOrientation(mTransformManagerData.Id(), inherit);
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.
471 const Vector3& GetScale(BufferIndex bufferIndex) const
473 if(mTransformManagerData.Id() != INVALID_TRANSFORM_ID)
475 return mScale.Get(0);
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.
486 const Vector3& GetWorldScale(BufferIndex bufferIndex) const
488 return mWorldScale.Get(0);
492 * Set whether the Node inherits scale.
493 * @param inherit True if the Node inherits scale.
495 void SetInheritScale(bool inherit)
497 if(mTransformManagerData.Id() != INVALID_TRANSFORM_ID)
499 mTransformManagerData.Manager()->SetInheritScale(mTransformManagerData.Id(), inherit);
504 * Retrieve the visibility of the node.
505 * @param[in] bufferIndex The buffer to read from.
506 * @return True if the node is visible.
508 bool IsVisible(BufferIndex bufferIndex) const
510 return mVisible[bufferIndex];
514 * Retrieve the opacity of the node.
515 * @param[in] bufferIndex The buffer to read from.
516 * @return The opacity.
518 float GetOpacity(BufferIndex bufferIndex) const
520 return mColor[bufferIndex].a;
524 * Retrieve the color of the node.
525 * @param[in] bufferIndex The buffer to read from.
528 const Vector4& GetColor(BufferIndex bufferIndex) const
530 return mColor[bufferIndex];
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.
538 void SetWorldColor(const Vector4& color, BufferIndex updateBufferIndex)
540 mWorldColor.Set(updateBufferIndex, color);
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.
549 void InheritWorldColor(BufferIndex updateBufferIndex)
551 DALI_ASSERT_DEBUG(mParent != NULL);
554 if(mColorMode == USE_OWN_MULTIPLY_PARENT_ALPHA)
556 const Vector4& ownColor = mColor[updateBufferIndex];
557 mWorldColor.Set(updateBufferIndex, ownColor.r, ownColor.g, ownColor.b, ownColor.a * mParent->GetWorldColor(updateBufferIndex).a);
559 else if(mColorMode == USE_OWN_MULTIPLY_PARENT_COLOR)
561 mWorldColor.Set(updateBufferIndex, mParent->GetWorldColor(updateBufferIndex) * mColor[updateBufferIndex]);
563 else if(mColorMode == USE_PARENT_COLOR)
565 mWorldColor.Set(updateBufferIndex, mParent->GetWorldColor(updateBufferIndex));
567 else // USE_OWN_COLOR
569 mWorldColor.Set(updateBufferIndex, mColor[updateBufferIndex]);
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.
579 void CopyPreviousWorldColor(BufferIndex updateBufferIndex)
581 mWorldColor.CopyPrevious(updateBufferIndex);
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.
590 const Vector4& GetWorldColor(BufferIndex bufferIndex) const
592 return mWorldColor[bufferIndex];
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.
600 void SetColorMode(ColorMode colorMode)
602 mColorMode = colorMode;
604 SetDirtyFlag(NodePropertyFlags::COLOR);
608 * Retrieve the color mode.
609 * @return The color mode.
611 ColorMode GetColorMode() const
617 * Retrieve the size of the node.
618 * @param[in] bufferIndex The buffer to read from.
621 const Vector3& GetSize(BufferIndex bufferIndex) const
623 if(mTransformManagerData.Id() != INVALID_TRANSFORM_ID)
628 return Vector3::ZERO;
632 * Retrieve the update size hint of the node.
633 * @return The update size hint.
635 const Vector3& GetUpdateSizeHint() const
637 if(mTransformManagerData.Id() != INVALID_TRANSFORM_ID)
639 return mUpdateSizeHint.Get(0);
642 return Vector3::ZERO;
646 * Retrieve the bounding sphere of the node
647 * @return A vector4 describing the bounding sphere. XYZ is the center and W is the radius
649 const Vector4& GetBoundingSphere() const
651 if(mTransformManagerData.Id() != INVALID_TRANSFORM_ID)
653 return mTransformManagerData.Manager()->GetBoundingSphere(mTransformManagerData.Id());
656 return Vector4::ZERO;
660 * Retrieve world matrix and size of the node
661 * @param[out] The local to world matrix of the node
662 * @param[out] size The current size of the node
664 void GetWorldMatrixAndSize(Matrix& worldMatrix, Vector3& size) const
666 if(mTransformManagerData.Id() != INVALID_TRANSFORM_ID)
668 mTransformManagerData.Manager()->GetWorldMatrixAndSize(mTransformManagerData.Id(), worldMatrix, size);
673 * Checks if local matrix has changed since last update
674 * @return true if local matrix has changed, false otherwise
676 bool IsLocalMatrixDirty() const
678 return (mTransformManagerData.Id() != INVALID_TRANSFORM_ID) &&
679 (mTransformManagerData.Manager()->IsLocalMatrixDirty(mTransformManagerData.Id()));
683 * Retrieve the cached world-matrix of a node.
684 * @param[in] bufferIndex The buffer to read from.
685 * @return The world-matrix.
687 const Matrix& GetWorldMatrix(BufferIndex bufferIndex) const
689 return mWorldMatrix.Get(bufferIndex);
693 * Mark the node as exclusive to a single RenderTask.
694 * @param[in] renderTask The render-task, or NULL if the Node is not exclusive to a single RenderTask.
696 void SetExclusiveRenderTask(RenderTask* renderTask)
698 mExclusiveRenderTask = renderTask;
702 * Query whether the node is exclusive to a single RenderTask.
703 * @return The render-task, or NULL if the Node is not exclusive to a single RenderTask.
705 RenderTask* GetExclusiveRenderTask() const
707 return mExclusiveRenderTask;
711 * Set how the Node and its children should be drawn; see Dali::Actor::SetDrawMode() for more details.
712 * @param[in] drawMode The new draw-mode to use.
714 void SetDrawMode(const DrawMode::Type& drawMode)
716 mDrawMode = drawMode;
720 * Returns whether node is an overlay or not.
721 * @return True if node is an overlay, false otherwise.
723 DrawMode::Type GetDrawMode() const
728 void SetTransparent(bool transparent)
730 mTransparent = transparent;
733 bool GetTransparent() const
739 * Returns the transform id of the node
740 * @return The transform component id of the node
742 TransformId GetTransformId() const
744 return mTransformManagerData.Id();
748 * Equality operator, checks for identity, not values.
751 bool operator==(const Node* rhs) const
753 return (this == rhs);
757 * @brief Sets the sibling order of the node
758 * @param[in] order The new order
760 void SetDepthIndex(uint32_t depthIndex)
762 mDepthIndex = depthIndex;
766 * @brief Get the depth index of the node
767 * @return Current depth index
769 uint32_t GetDepthIndex() const
775 * @brief Sets the boolean which states whether the position should use the anchor-point.
776 * @param[in] positionUsesAnchorPoint True if the position should use the anchor-point
778 void SetPositionUsesAnchorPoint(bool positionUsesAnchorPoint)
780 if(mTransformManagerData.Id() != INVALID_TRANSFORM_ID && mPositionUsesAnchorPoint != positionUsesAnchorPoint)
782 mPositionUsesAnchorPoint = positionUsesAnchorPoint;
783 mTransformManagerData.Manager()->SetPositionUsesAnchorPoint(mTransformManagerData.Id(), mPositionUsesAnchorPoint);
788 * @brief Sets whether the node is culled or not.
789 * @param[in] bufferIndex The buffer to read from.
790 * @param[in] culled True if the node is culled.
792 void SetCulled(BufferIndex bufferIndex, bool culled)
794 mCulled[bufferIndex] = culled;
798 * @brief Retrieves whether the node is culled or not.
799 * @param[in] bufferIndex The buffer to read from.
800 * @return True if the node is culled.
802 bool IsCulled(BufferIndex bufferIndex) const
804 return mCulled[bufferIndex];
809 * @copydoc UniformMap::Add
811 void AddUniformMapping(const UniformPropertyMapping& map) override;
814 * @copydoc UniformMap::Remove
816 void RemoveUniformMapping(const ConstString& uniformName) override;
819 * @copydoc Dali::Internal::SceneGraph::PropertyOwner::IsAnimationPossible
821 bool IsAnimationPossible() const override;
824 * Prepare the node for rendering.
825 * This is called by the UpdateManager when an object is due to be rendered in the current frame.
826 * @param[in] updateBufferIndex The current update buffer index.
828 void PrepareRender(BufferIndex bufferIndex);
831 * Called by UpdateManager when the node is added.
832 * Creates a new transform component in the transform manager and initialize all the properties
833 * related to the transformation
834 * @param[in] transformManager A pointer to the trnasform manager (Owned by UpdateManager)
836 void CreateTransform(SceneGraph::TransformManager* transformManager);
841 void ResetDirtyFlags(BufferIndex updateBufferIndex);
845 * Set the parent of a Node.
846 * @param[in] parentNode the new parent.
848 void SetParent(Node& parentNode);
852 * Protected constructor; See also Node::New()
857 * Protected virtual destructor; See also Node::Delete( Node* )
858 * Kept protected to allow destructor chaining from layer
862 private: // from NodeDataProvider
864 * @copydoc NodeDataProvider::GetModelMatrix
866 const Matrix& GetModelMatrix(BufferIndex bufferIndex) const override
868 return GetWorldMatrix(bufferIndex);
872 * @copydoc NodeDataProvider::GetRenderColor
874 const Vector4& GetRenderColor(BufferIndex bufferIndex) const override
876 return GetWorldColor(bufferIndex);
879 public: // From UniformMapDataProvider
881 * @copydoc UniformMapDataProvider::GetUniformMapChanged
883 bool GetUniformMapChanged(BufferIndex bufferIndex) const override
885 return mUniformMapChanged[bufferIndex];
889 * @copydoc UniformMapDataProvider::GetUniformMap
891 const CollectedUniformMap& GetUniformMap(BufferIndex bufferIndex) const override
893 return mCollectedUniformMap[bufferIndex];
901 Node& operator=(const Node& rhs);
904 * Recursive helper to disconnect a Node and its children.
905 * Disconnected Nodes have no parent or children.
906 * @param[in] updateBufferIndex The current update buffer index.
908 void RecursiveDisconnectFromSceneGraph(BufferIndex updateBufferIndex);
910 public: // Default properties
911 using TransformManagerParentsOrigin = TransformManagerPropertyVector3<TRANSFORM_PROPERTY_PARENT_ORIGIN>;
912 using TransformManagerAnchorPoint = TransformManagerPropertyVector3<TRANSFORM_PROPERTY_ANCHOR_POINT>;
913 using TransformManagerSize = TransformManagerPropertyVector3<TRANSFORM_PROPERTY_SIZE>;
914 using TransformManagerPosition = TransformManagerPropertyVector3<TRANSFORM_PROPERTY_POSITION>;
915 using TransformManagerScale = TransformManagerPropertyVector3<TRANSFORM_PROPERTY_SCALE>;
917 TransformManagerData mTransformManagerData;
918 TransformManagerParentsOrigin mParentOrigin; ///< Local transform; the position is relative to this. Sets the Transform flag dirty when changed
919 TransformManagerAnchorPoint mAnchorPoint; ///< Local transform; local center of rotation. Sets the Transform flag dirty when changed
920 TransformManagerSize mSize; ///< Size is provided for layouting
921 TransformManagerPosition mPosition; ///< Local transform; distance between parent-origin & anchor-point
922 TransformManagerScale mScale; ///< Local transform; scale relative to parent node
923 TransformManagerPropertyQuaternion mOrientation; ///< Local transform; rotation relative to parent node
925 AnimatableProperty<bool> mVisible; ///< Visibility can be inherited from the Node hierachy
926 AnimatableProperty<bool> mCulled; ///< True if the node is culled. This is not animatable. It is just double-buffered.
927 AnimatableProperty<Vector4> mColor; ///< Color can be inherited from the Node hierarchy
928 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).
930 // Inherited properties; read-only from public API
932 TransformManagerVector3Input mWorldPosition; ///< Full inherited position
933 TransformManagerVector3Input mWorldScale;
934 TransformManagerQuaternionInput mWorldOrientation; ///< Full inherited orientation
935 TransformManagerMatrixInput mWorldMatrix; ///< Full inherited world matrix
936 InheritedColor mWorldColor; ///< Full inherited color
938 uint32_t mClippingSortModifier; ///< Contains bit-packed clipping information for quick access when sorting
939 const uint32_t mId; ///< The Unique ID of the node.
942 static uint32_t mNodeCounter; ///< count of total nodes, used for unique ids
944 Node* mParent; ///< Pointer to parent node (a child is owned by its parent)
945 RenderTask* mExclusiveRenderTask; ///< Nodes can be marked as exclusive to a single RenderTask
947 RendererContainer mRenderer; ///< Container of renderers; not owned
949 NodeContainer mChildren; ///< Container of children; not owned
951 CollectedUniformMap mCollectedUniformMap[2]; ///< Uniform maps of the node
952 uint32_t mUniformMapChanged[2]; ///< Records if the uniform map has been altered this frame
953 uint32_t mClippingDepth; ///< The number of stencil clipping nodes deep this node is
954 uint32_t mScissorDepth; ///< The number of scissor clipping nodes deep this node is
956 uint32_t mDepthIndex; ///< Depth index of the node
958 // flags, compressed to bitfield
959 NodePropertyFlags mDirtyFlags; ///< Dirty flags for each of the Node properties
960 uint32_t mRegenerateUniformMap : 2; ///< Indicate if the uniform map has to be regenerated this frame
961 DrawMode::Type mDrawMode : 3; ///< How the Node and its children should be drawn
962 ColorMode mColorMode : 3; ///< Determines whether mWorldColor is inherited, 2 bits is enough
963 ClippingMode::Type mClippingMode : 3; ///< The clipping mode of this node
964 bool mIsRoot : 1; ///< True if the node cannot have a parent
965 bool mIsLayer : 1; ///< True if the node is a layer
966 bool mPositionUsesAnchorPoint : 1; ///< True if the node should use the anchor-point when calculating the position
967 bool mTransparent : 1;
969 // Changes scope, should be at end of class
970 DALI_LOG_OBJECT_STRING_DECLARATION;
975 inline void SetInheritOrientationMessage(EventThreadServices& eventThreadServices, const Node& node, bool inherit)
977 using LocalType = MessageValue1<Node, bool>;
979 // Reserve some memory inside the message queue
980 uint32_t* slot = eventThreadServices.ReserveMessageSlot(sizeof(LocalType));
982 // Construct message in the message queue memory; note that delete should not be called on the return value
983 new(slot) LocalType(&node, &Node::SetInheritOrientation, inherit);
986 inline void SetParentOriginMessage(EventThreadServices& eventThreadServices, const Node& node, const Vector3& origin)
988 using LocalType = MessageValue1<Node, Vector3>;
990 // Reserve some memory inside the message queue
991 uint32_t* slot = eventThreadServices.ReserveMessageSlot(sizeof(LocalType));
993 // Construct message in the message queue memory; note that delete should not be called on the return value
994 new(slot) LocalType(&node, &Node::SetParentOrigin, origin);
997 inline void SetAnchorPointMessage(EventThreadServices& eventThreadServices, const Node& node, const Vector3& anchor)
999 using LocalType = MessageValue1<Node, Vector3>;
1001 // Reserve some memory inside the message queue
1002 uint32_t* slot = eventThreadServices.ReserveMessageSlot(sizeof(LocalType));
1004 // Construct message in the message queue memory; note that delete should not be called on the return value
1005 new(slot) LocalType(&node, &Node::SetAnchorPoint, anchor);
1008 inline void SetInheritPositionMessage(EventThreadServices& eventThreadServices, const Node& node, bool inherit)
1010 using LocalType = MessageValue1<Node, bool>;
1012 // Reserve some memory inside the message queue
1013 uint32_t* slot = eventThreadServices.ReserveMessageSlot(sizeof(LocalType));
1015 // Construct message in the message queue memory; note that delete should not be called on the return value
1016 new(slot) LocalType(&node, &Node::SetInheritPosition, inherit);
1019 inline void SetInheritScaleMessage(EventThreadServices& eventThreadServices, const Node& node, bool inherit)
1021 using LocalType = MessageValue1<Node, bool>;
1023 // Reserve some memory inside the message queue
1024 uint32_t* slot = eventThreadServices.ReserveMessageSlot(sizeof(LocalType));
1026 // Construct message in the message queue memory; note that delete should not be called on the return value
1027 new(slot) LocalType(&node, &Node::SetInheritScale, inherit);
1030 inline void SetColorModeMessage(EventThreadServices& eventThreadServices, const Node& node, ColorMode colorMode)
1032 using LocalType = MessageValue1<Node, ColorMode>;
1034 // Reserve some memory inside the message queue
1035 uint32_t* slot = eventThreadServices.ReserveMessageSlot(sizeof(LocalType));
1037 // Construct message in the message queue memory; note that delete should not be called on the return value
1038 new(slot) LocalType(&node, &Node::SetColorMode, colorMode);
1041 inline void SetDrawModeMessage(EventThreadServices& eventThreadServices, const Node& node, DrawMode::Type drawMode)
1043 using LocalType = MessageValue1<Node, DrawMode::Type>;
1045 // Reserve some memory inside the message queue
1046 uint32_t* slot = eventThreadServices.ReserveMessageSlot(sizeof(LocalType));
1048 // Construct message in the message queue memory; note that delete should not be called on the return value
1049 new(slot) LocalType(&node, &Node::SetDrawMode, drawMode);
1052 inline void SetTransparentMessage(EventThreadServices& eventThreadServices, const Node& node, bool transparent)
1054 using LocalType = MessageValue1<Node, bool>;
1056 // Reserve some memory inside the message queue
1057 uint32_t* slot = eventThreadServices.ReserveMessageSlot(sizeof(LocalType));
1059 // Construct message in the message queue memory; note that delete should not be called on the return value
1060 new(slot) LocalType(&node, &Node::SetTransparent, transparent);
1063 inline void DetachRendererMessage(EventThreadServices& eventThreadServices, const Node& node, const Renderer& renderer)
1065 using LocalType = MessageValue1<Node, const Renderer*>;
1067 // Reserve some memory inside the message queue
1068 uint32_t* slot = eventThreadServices.ReserveMessageSlot(sizeof(LocalType));
1070 // Construct message in the message queue memory; note that delete should not be called on the return value
1071 new(slot) LocalType(&node, &Node::RemoveRenderer, &renderer);
1074 inline void SetDepthIndexMessage(EventThreadServices& eventThreadServices, const Node& node, uint32_t depthIndex)
1076 using LocalType = MessageValue1<Node, uint32_t>;
1078 // Reserve some memory inside the message queue
1079 uint32_t* slot = eventThreadServices.ReserveMessageSlot(sizeof(LocalType));
1081 // Construct message in the message queue memory; note that delete should not be called on the return value
1082 new(slot) LocalType(&node, &Node::SetDepthIndex, depthIndex);
1085 inline void SetClippingModeMessage(EventThreadServices& eventThreadServices, const Node& node, ClippingMode::Type clippingMode)
1087 using LocalType = MessageValue1<Node, ClippingMode::Type>;
1089 // Reserve some memory inside the message queue
1090 uint32_t* slot = eventThreadServices.ReserveMessageSlot(sizeof(LocalType));
1092 // Construct message in the message queue memory; note that delete should not be called on the return value
1093 new(slot) LocalType(&node, &Node::SetClippingMode, clippingMode);
1096 inline void SetPositionUsesAnchorPointMessage(EventThreadServices& eventThreadServices, const Node& node, bool positionUsesAnchorPoint)
1098 using LocalType = MessageValue1<Node, bool>;
1100 // Reserve some memory inside the message queue
1101 uint32_t* slot = eventThreadServices.ReserveMessageSlot(sizeof(LocalType));
1103 // Construct message in the message queue memory; note that delete should not be called on the return value
1104 new(slot) LocalType(&node, &Node::SetPositionUsesAnchorPoint, positionUsesAnchorPoint);
1107 } // namespace SceneGraph
1109 // Template specialisation for OwnerPointer<Node>, because delete is protected
1111 inline void OwnerPointer<Dali::Internal::SceneGraph::Node>::Reset()
1113 if(mObject != nullptr)
1115 Dali::Internal::SceneGraph::Node::Delete(mObject);
1119 } // namespace Internal
1121 // Template specialisations for OwnerContainer<Node*>, because delete is protected
1123 inline void OwnerContainer<Dali::Internal::SceneGraph::Node*>::Delete(Dali::Internal::SceneGraph::Node* pointer)
1125 Dali::Internal::SceneGraph::Node::Delete(pointer);
1129 #endif // DALI_INTERNAL_SCENE_GRAPH_NODE_H