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