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