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   mUseTextureUpdateArea(false)
 114 {
 115 #ifdef DEBUG_ENABLED
 116   gNodeCount++;
 117 #endif
 118 }
 119
 120 Node::~Node()
 121 {
 122   if(mTransformManagerData.Id() != INVALID_TRANSFORM_ID)
 123   {
 124     mTransformManagerData.Manager()->RemoveTransform(mTransformManagerData.Id());
 125   }
 126
 127 #ifdef DEBUG_ENABLED
 128   gNodeCount--;
 129 #endif
 130 }
 131
 132 void Node::OnDestroy()
 133 {
 134   // Animators, Constraints etc. should be disconnected from the child's properties.
 135   PropertyOwner::Destroy();
 136 }
 137
 138 uint32_t Node::GetId() const
 139 {
 140   return mId;
 141 }
 142
 143 void Node::CreateTransform(SceneGraph::TransformManager* transformManager)
 144 {
 145   // Create a new transform
 146   mTransformManagerData.mManager = transformManager;
 147   TransformId createdTransformId = transformManager->CreateTransform();
 148
 149   // Set whether the position should use the anchor point
 150   transformManager->SetPositionUsesAnchorPoint(createdTransformId, mPositionUsesAnchorPoint);
 151
 152   // Set TransformId after initialize done.
 153   mTransformManagerData.mId = createdTransformId;
 154 }
 155
 156 void Node::SetRoot(bool isRoot)
 157 {
 158   DALI_ASSERT_DEBUG(!isRoot || mParent == NULL); // Root nodes cannot have a parent
 159
 160   mIsRoot = isRoot;
 161 }
 162
 163 bool Node::IsAnimationPossible() const
 164 {
 165   return mIsConnectedToSceneGraph;
 166 }
 167
 168 void Node::AddInitializeResetter(ResetterManager& manager) const
 169 {
 170   manager.AddNodeResetter(*this);
 171 }
 172
 173 void Node::ConnectChild(Node* childNode)
 174 {
 175   DALI_ASSERT_ALWAYS(this != childNode);
 176   DALI_ASSERT_ALWAYS(IsRoot() || nullptr != mParent);                            // Parent should be connected first
 177   DALI_ASSERT_ALWAYS(!childNode->IsRoot() && nullptr == childNode->GetParent()); // Child should be disconnected
 178
 179   childNode->SetParent(*this);
 180
 181   // Everything should be reinherited when reconnected to scene-graph
 182   childNode->SetAllDirtyFlags();
 183
 184   // Add the node to the end of the child list.
 185   mChildren.PushBack(childNode);
 186
 187   // Inform property observers of new connection
 188   childNode->ConnectToSceneGraph();
 189 }
 190
 191 void Node::DisconnectChild(BufferIndex updateBufferIndex, Node& childNode)
 192 {
 193   DALI_ASSERT_ALWAYS(this != &childNode);
 194   DALI_ASSERT_ALWAYS(childNode.GetParent() == this);
 195
 196   // Find the childNode and remove it
 197   Node* found(nullptr);
 198
 199   const NodeIter endIter = mChildren.End();
 200   for(NodeIter iter = mChildren.Begin(); iter != endIter; ++iter)
 201   {
 202     Node* current = *iter;
 203     if(current == &childNode)
 204     {
 205       found = current;
 206       mChildren.Erase(iter); // order matters here
 207       break;                 // iter is no longer valid
 208     }
 209   }
 210   DALI_ASSERT_ALWAYS(nullptr != found);
 211
 212   found->RecursiveDisconnectFromSceneGraph(updateBufferIndex);
 213 }
 214
 215 void Node::AddRenderer(const RendererKey& renderer)
 216 {
 217   // If it is the first renderer added, make sure the world transform will be calculated
 218   // in the next update as world transform is not computed if node has no renderers.
 219   if(mRenderers.Empty())
 220   {
 221     mDirtyFlags |= NodePropertyFlags::TRANSFORM;
 222   }
 223   else
 224   {
 225     // Check that it has not been already added.
 226     for(auto&& existingRenderer : mRenderers)
 227     {
 228       if(existingRenderer == renderer)
 229       {
 230         // Renderer is already in the list.
 231         return;
 232       }
 233     }
 234   }
 235
 236   SetUpdated(true);
 237
 238   mRenderers.PushBack(renderer);
 239 }
 240
 241 void Node::RemoveRenderer(const RendererKey& renderer)
 242 {
 243   RendererContainer::SizeType rendererCount(mRenderers.Size());
 244   for(RendererContainer::SizeType i = 0; i < rendererCount; ++i)
 245   {
 246     if(mRenderers[i] == renderer)
 247     {
 248       renderer->DetachFromNodeDataProvider(*this);
 249
 250       SetUpdated(true);
 251       mRenderers.Erase(mRenderers.Begin() + i);
 252       return;
 253     }
 254   }
 255 }
 256
 257 NodePropertyFlags Node::GetDirtyFlags() const
 258 {
 259   // get initial dirty flags, they are reset ResetDefaultProperties, but setters may have made the node dirty already
 260   NodePropertyFlags flags = mDirtyFlags;
 261
 262   // Check whether the visible property has changed
 263   if(!mVisible.IsClean())
 264   {
 265     flags |= NodePropertyFlags::VISIBLE;
 266   }
 267
 268   // Check whether the color property has changed
 269   if(!mColor.IsClean())
 270   {
 271     flags |= NodePropertyFlags::COLOR;
 272   }
 273
 274   return flags;
 275 }
 276
 277 NodePropertyFlags Node::GetInheritedDirtyFlags(NodePropertyFlags parentFlags) const
 278 {
 279   // Size is not inherited. VisibleFlag is inherited
 280   static const NodePropertyFlags InheritedDirtyFlags = NodePropertyFlags::TRANSFORM | NodePropertyFlags::VISIBLE | NodePropertyFlags::COLOR;
 281   using UnderlyingType                               = typename std::underlying_type<NodePropertyFlags>::type;
 282
 283   return static_cast<NodePropertyFlags>(static_cast<UnderlyingType>(mDirtyFlags) |
 284                                         (static_cast<UnderlyingType>(parentFlags) & static_cast<UnderlyingType>(InheritedDirtyFlags)));
 285 }
 286
 287 void Node::ResetDirtyFlags(BufferIndex updateBufferIndex)
 288 {
 289   mDirtyFlags = NodePropertyFlags::NOTHING;
 290
 291   mUpdateAreaChanged = false;
 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 GetNodeMemoryPool().GetCapacity();
 337 }
 338
 339 } // namespace SceneGraph
 340
 341 } // namespace Internal
 342
 343 } // namespace Dali