dali/internal/update/nodes/node.cpp

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