dali/internal/update/nodes/node.cpp

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