dali/internal/update/nodes/node.cpp

   1 /*
   2  * Copyright (c) 2024 Samsung Electronics Co., Ltd.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  *
  16  */
  17
  18 // CLASS HEADER
  19 #include <dali/internal/update/nodes/node.h>
  20
  21 // INTERNAL INCLUDES
  22 #include <dali/internal/common/internal-constants.h>
  23 #include <dali/internal/common/memory-pool-object-allocator.h>
  24 #include <dali/internal/update/common/discard-queue.h>
  25 #include <dali/public-api/common/constants.h>
  26 #include <dali/public-api/common/dali-common.h>
  27
  28 #include <dali/internal/update/common/resetter-manager.h> ///< For AddInitializeResetter
  29
  30 namespace
  31 {
  32 // Memory pool used to allocate new nodes. Memory used by this pool will be released when process dies
  33 //  or DALI library is unloaded
  34 Dali::Internal::MemoryPoolObjectAllocator<Dali::Internal::SceneGraph::Node>& GetNodeMemoryPool()
  35 {
  36   static Dali::Internal::MemoryPoolObjectAllocator<Dali::Internal::SceneGraph::Node> gNodeMemoryPool;
  37   return gNodeMemoryPool;
  38 }
  39 #ifdef DEBUG_ENABLED
  40 // keep track of nodes alive, to ensure we have 0 when the process exits or DALi library is unloaded
  41 int32_t gNodeCount = 0;
  42
  43 // Called when the process is about to exit, Node count should be zero at this point.
  44 void __attribute__((destructor)) ShutDown(void)
  45 {
  46   DALI_ASSERT_DEBUG((gNodeCount == 0) && "Node memory leak");
  47 }
  48 #endif
  49 } // Unnamed namespace
  50
  51 namespace Dali
  52 {
  53 namespace Internal
  54 {
  55 namespace SceneGraph
  56 {
  57 const ColorMode Node::DEFAULT_COLOR_MODE(USE_OWN_MULTIPLY_PARENT_ALPHA);
  58
  59 uint32_t Node::mNodeCounter = 0; ///< A counter to provide unique node ids, up-to 4 billion
  60
  61 Node* Node::New()
  62 {
  63   return new(GetNodeMemoryPool().AllocateRawThreadSafe()) Node;
  64 }
  65
  66 void Node::Delete(Node* node)
  67 {
  68   // check we have a node not a derived node
  69   if(!node->mIsLayer && !node->mIsCamera)
  70   {
  71     // Manually call the destructor
  72     node->~Node();
  73
  74     // Mark the memory it used as free in the memory pool
  75     GetNodeMemoryPool().FreeThreadSafe(node);
  76   }
  77   else
  78   {
  79     // not in the pool, just delete it.
  80     delete node;
  81   }
  82 }
  83
  84 void Node::ResetMemoryPool()
  85 {
  86   GetNodeMemoryPool().ResetMemoryPool();
  87 }
  88
  89 Node::Node()
  90 : mTransformManagerData(),                                                      // Initialized to use invalid id by default
  91   mOrientation(),                                                               // Initialized to identity by default
  92   mWorldPosition(TRANSFORM_PROPERTY_WORLD_POSITION, Vector3(0.0f, 0.0f, 0.0f)), // Zero initialized by default
  93   mWorldScale(TRANSFORM_PROPERTY_WORLD_SCALE, Vector3(1.0f, 1.0f, 1.0f)),
  94   mWorldOrientation(), // Initialized to identity by default
  95   mWorldMatrix(),
  96   mVisible(true),
  97   mCulled(false),
  98   mColor(Color::WHITE),
  99   mWorldColor(Color::WHITE),
 100   mUpdateAreaHint(Vector4::ZERO),
 101   mClippingSortModifier(0u),
 102   mId(++mNodeCounter),
 103   mParent(nullptr),
 104   mChildren(),
 105   mClippingDepth(0u),
 106   mScissorDepth(0u),
 107   mDepthIndex(0u),
 108   mDirtyFlags(NodePropertyFlags::ALL),
 109   mDrawMode(DrawMode::NORMAL),
 110   mColorMode(DEFAULT_COLOR_MODE),
 111   mClippingMode(ClippingMode::DISABLED),
 112   mIsRoot(false),
 113   mIsLayer(false),
 114   mIsCamera(false),
 115   mPositionUsesAnchorPoint(true),
 116   mTransparent(false),
 117   mUpdateAreaChanged(false),
 118   mUseTextureUpdateArea(false)
 119 {
 120 #ifdef DEBUG_ENABLED
 121   gNodeCount++;
 122 #endif
 123 }
 124
 125 Node::~Node()
 126 {
 127   if(mTransformManagerData.Id() != INVALID_TRANSFORM_ID)
 128   {
 129     mTransformManagerData.Manager()->RemoveTransform(mTransformManagerData.Id());
 130   }
 131
 132 #ifdef DEBUG_ENABLED
 133   gNodeCount--;
 134 #endif
 135 }
 136
 137 void Node::OnDestroy()
 138 {
 139   // Animators, Constraints etc. should be disconnected from the child's properties.
 140   PropertyOwner::Destroy();
 141 }
 142
 143 uint32_t Node::GetId() const
 144 {
 145   return mId;
 146 }
 147
 148 void Node::CreateTransform(SceneGraph::TransformManager* transformManager)
 149 {
 150   // Create a new transform
 151   mTransformManagerData.mManager = transformManager;
 152   TransformId createdTransformId = transformManager->CreateTransform();
 153
 154   // Set whether the position should use the anchor point
 155   transformManager->SetPositionUsesAnchorPoint(createdTransformId, mPositionUsesAnchorPoint);
 156
 157   // Set TransformId after initialize done.
 158   mTransformManagerData.mId = createdTransformId;
 159 }
 160
 161 void Node::SetRoot(bool isRoot)
 162 {
 163   DALI_ASSERT_DEBUG(!isRoot || mParent == NULL); // Root nodes cannot have a parent
 164
 165   mIsRoot = isRoot;
 166 }
 167
 168 bool Node::IsAnimationPossible() const
 169 {
 170   return mIsConnectedToSceneGraph;
 171 }
 172
 173 void Node::AddInitializeResetter(ResetterManager& manager) const
 174 {
 175   manager.AddNodeResetter(*this);
 176 }
 177
 178 void Node::ConnectChild(Node* childNode)
 179 {
 180   DALI_ASSERT_ALWAYS(this != childNode);
 181   DALI_ASSERT_ALWAYS(IsRoot() || nullptr != mParent);                            // Parent should be connected first
 182   DALI_ASSERT_ALWAYS(!childNode->IsRoot() && nullptr == childNode->GetParent()); // Child should be disconnected
 183
 184   childNode->SetParent(*this);
 185
 186   // Everything should be reinherited when reconnected to scene-graph
 187   childNode->SetAllDirtyFlags();
 188
 189   // Make sure the partial rendering data is invalidated.
 190   childNode->GetPartialRenderingData().MakeExpired();
 191
 192   // Add the node to the end of the child list.
 193   mChildren.PushBack(childNode);
 194
 195   // Inform property observers of new connection
 196   childNode->ConnectToSceneGraph();
 197 }
 198
 199 void Node::DisconnectChild(BufferIndex updateBufferIndex, Node& childNode)
 200 {
 201   DALI_ASSERT_ALWAYS(this != &childNode);
 202   DALI_ASSERT_ALWAYS(childNode.GetParent() == this);
 203
 204   // Find the childNode and remove it
 205   Node* found(nullptr);
 206
 207   const NodeIter endIter = mChildren.End();
 208   for(NodeIter iter = mChildren.Begin(); iter != endIter; ++iter)
 209   {
 210     Node* current = *iter;
 211     if(current == &childNode)
 212     {
 213       found = current;
 214       mChildren.Erase(iter); // order matters here
 215       break;                 // iter is no longer valid
 216     }
 217   }
 218   DALI_ASSERT_ALWAYS(nullptr != found);
 219
 220   found->RecursiveDisconnectFromSceneGraph(updateBufferIndex);
 221 }
 222
 223 void Node::AddRenderer(const RendererKey& renderer)
 224 {
 225   // If it is the first renderer added, make sure the world transform will be calculated
 226   // in the next update as world transform is not computed if node has no renderers.
 227   if(mRenderers.Empty())
 228   {
 229     mDirtyFlags |= NodePropertyFlags::TRANSFORM;
 230   }
 231   else
 232   {
 233     // Check that it has not been already added.
 234     for(auto&& existingRenderer : mRenderers)
 235     {
 236       if(existingRenderer == renderer)
 237       {
 238         // Renderer is already in the list.
 239         return;
 240       }
 241     }
 242   }
 243
 244   SetUpdated(true);
 245
 246   mRenderers.PushBack(renderer);
 247 }
 248
 249 void Node::RemoveRenderer(const RendererKey& renderer)
 250 {
 251   RendererContainer::SizeType rendererCount(mRenderers.Size());
 252   for(RendererContainer::SizeType i = 0; i < rendererCount; ++i)
 253   {
 254     if(mRenderers[i] == renderer)
 255     {
 256       renderer->DetachFromNodeDataProvider(*this);
 257
 258       SetUpdated(true);
 259       mRenderers.Erase(mRenderers.Begin() + i);
 260       return;
 261     }
 262   }
 263 }
 264
 265 NodePropertyFlags Node::GetDirtyFlags() const
 266 {
 267   // get initial dirty flags, they are reset ResetDefaultProperties, but setters may have made the node dirty already
 268   NodePropertyFlags flags = mDirtyFlags;
 269
 270   // Check whether the visible property has changed
 271   if(!mVisible.IsClean())
 272   {
 273     flags |= NodePropertyFlags::VISIBLE;
 274   }
 275
 276   // Check whether the color property has changed
 277   if(!mColor.IsClean())
 278   {
 279     flags |= NodePropertyFlags::COLOR;
 280   }
 281
 282   return flags;
 283 }
 284
 285 NodePropertyFlags Node::GetInheritedDirtyFlags(NodePropertyFlags parentFlags) const
 286 {
 287   // Size is not inherited. VisibleFlag is inherited
 288   static const NodePropertyFlags InheritedDirtyFlags = NodePropertyFlags::TRANSFORM | NodePropertyFlags::VISIBLE | NodePropertyFlags::COLOR;
 289   using UnderlyingType                               = typename std::underlying_type<NodePropertyFlags>::type;
 290
 291   return static_cast<NodePropertyFlags>(static_cast<UnderlyingType>(mDirtyFlags) |
 292                                         (static_cast<UnderlyingType>(parentFlags) & static_cast<UnderlyingType>(InheritedDirtyFlags)));
 293 }
 294
 295 void Node::ResetDirtyFlags(BufferIndex updateBufferIndex)
 296 {
 297   mDirtyFlags = NodePropertyFlags::NOTHING;
 298
 299   mUpdateAreaChanged = false;
 300 }
 301
 302 void Node::SetParent(Node& parentNode)
 303 {
 304   DALI_ASSERT_ALWAYS(this != &parentNode);
 305   DALI_ASSERT_ALWAYS(!mIsRoot);
 306   DALI_ASSERT_ALWAYS(mParent == nullptr);
 307
 308   mParent = &parentNode;
 309
 310   if(mTransformManagerData.Id() != INVALID_TRANSFORM_ID)
 311   {
 312     mTransformManagerData.Manager()->SetParent(mTransformManagerData.Id(), parentNode.GetTransformId());
 313   }
 314 }
 315
 316 void Node::RecursiveDisconnectFromSceneGraph(BufferIndex updateBufferIndex)
 317 {
 318   DALI_ASSERT_ALWAYS(!mIsRoot);
 319   DALI_ASSERT_ALWAYS(mParent != nullptr);
 320
 321   const NodeIter endIter = mChildren.End();
 322   for(NodeIter iter = mChildren.Begin(); iter != endIter; ++iter)
 323   {
 324     (*iter)->RecursiveDisconnectFromSceneGraph(updateBufferIndex);
 325   }
 326
 327   // Animators, Constraints etc. should be disconnected from the child's properties.
 328   PropertyOwner::DisconnectFromSceneGraph(updateBufferIndex);
 329
 330   // Remove back-pointer to parent
 331   mParent = nullptr;
 332
 333   // Remove all child pointers
 334   mChildren.Clear();
 335
 336   if(mTransformManagerData.Id() != INVALID_TRANSFORM_ID)
 337   {
 338     mTransformManagerData.Manager()->SetParent(mTransformManagerData.Id(), INVALID_TRANSFORM_ID);
 339   }
 340 }
 341
 342 uint32_t Node::GetMemoryPoolCapacity()
 343 {
 344   return GetNodeMemoryPool().GetCapacity();
 345 }
 346
 347 } // namespace SceneGraph
 348
 349 } // namespace Internal
 350
 351 } // namespace Dali