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   mVisible(true),
  81   mCulled(false),
  82   mColor(Color::WHITE),
  83   mUpdateAreaHint(Vector4::ZERO),
  84   mWorldPosition(TRANSFORM_PROPERTY_WORLD_POSITION, Vector3(0.0f, 0.0f, 0.0f)), // Zero initialized by default
  85   mWorldScale(TRANSFORM_PROPERTY_WORLD_SCALE, Vector3(1.0f, 1.0f, 1.0f)),
  86   mWorldOrientation(), // Initialized to identity by default
  87   mWorldMatrix(),
  88   mWorldColor(Color::WHITE),
  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   //Initialize all the animatable properties
 142   mPosition.Initialize(&mTransformManagerData);
 143   mScale.Initialize(&mTransformManagerData);
 144   mOrientation.Initialize(&mTransformManagerData);
 145   mSize.Initialize(&mTransformManagerData);
 146   mParentOrigin.Initialize(&mTransformManagerData);
 147   mAnchorPoint.Initialize(&mTransformManagerData);
 148
 149   //Initialize all the input properties
 150   mWorldPosition.Initialize(&mTransformManagerData);
 151   mWorldScale.Initialize(&mTransformManagerData);
 152   mWorldOrientation.Initialize(&mTransformManagerData);
 153   mWorldMatrix.Initialize(&mTransformManagerData);
 154
 155   //Set whether the position should use the anchor point
 156   transformManager->SetPositionUsesAnchorPoint(createdTransformId, mPositionUsesAnchorPoint);
 157
 158   //Set TransformId after initialize done.
 159   mTransformManagerData.mId = createdTransformId;
 160 }
 161
 162 void Node::SetRoot(bool isRoot)
 163 {
 164   DALI_ASSERT_DEBUG(!isRoot || mParent == NULL); // Root nodes cannot have a parent
 165
 166   mIsRoot = isRoot;
 167 }
 168
 169 bool Node::IsAnimationPossible() const
 170 {
 171   return mIsConnectedToSceneGraph;
 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(Renderer* 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(mRenderer.Empty())
 221   {
 222     mDirtyFlags |= NodePropertyFlags::TRANSFORM;
 223   }
 224   else
 225   {
 226     // Check that it has not been already added.
 227     for(auto&& existingRenderer : mRenderer)
 228     {
 229       if(existingRenderer == renderer)
 230       {
 231         // Renderer is already in the list.
 232         return;
 233       }
 234     }
 235   }
 236
 237   SetUpdated(true);
 238
 239   mRenderer.PushBack(renderer);
 240 }
 241
 242 void Node::RemoveRenderer(const Renderer* renderer)
 243 {
 244   RendererContainer::SizeType rendererCount(mRenderer.Size());
 245   for(RendererContainer::SizeType i = 0; i < rendererCount; ++i)
 246   {
 247     if(mRenderer[i] == renderer)
 248     {
 249       SetUpdated(true);
 250       mRenderer.Erase(mRenderer.Begin() + i);
 251       return;
 252     }
 253   }
 254 }
 255
 256 NodePropertyFlags Node::GetDirtyFlags() const
 257 {
 258   // get initial dirty flags, they are reset ResetDefaultProperties, but setters may have made the node dirty already
 259   NodePropertyFlags flags = mDirtyFlags;
 260
 261   // Check whether the visible property has changed
 262   if(!mVisible.IsClean())
 263   {
 264     flags |= NodePropertyFlags::VISIBLE;
 265   }
 266
 267   // Check whether the color property has changed
 268   if(!mColor.IsClean())
 269   {
 270     flags |= NodePropertyFlags::COLOR;
 271   }
 272
 273   // Check whether the update area property has changed
 274   if(!mUpdateAreaHint.IsClean())
 275   {
 276     flags |= NodePropertyFlags::TRANSFORM;
 277   }
 278
 279   return flags;
 280 }
 281
 282 NodePropertyFlags Node::GetInheritedDirtyFlags(NodePropertyFlags parentFlags) const
 283 {
 284   // Size is not inherited. VisibleFlag is inherited
 285   static const NodePropertyFlags InheritedDirtyFlags = NodePropertyFlags::TRANSFORM | NodePropertyFlags::VISIBLE | NodePropertyFlags::COLOR;
 286   using UnderlyingType                               = typename std::underlying_type<NodePropertyFlags>::type;
 287
 288   return static_cast<NodePropertyFlags>(static_cast<UnderlyingType>(mDirtyFlags) |
 289                                         (static_cast<UnderlyingType>(parentFlags) & static_cast<UnderlyingType>(InheritedDirtyFlags)));
 290 }
 291
 292 void Node::ResetDirtyFlags(BufferIndex updateBufferIndex)
 293 {
 294   mDirtyFlags = NodePropertyFlags::NOTHING;
 295 }
 296
 297 void Node::UpdateUniformHash(BufferIndex bufferIndex)
 298 {
 299   uint64_t hash = 0xc70f6907UL;
 300   for(uint32_t i = 0u, count = mUniformMaps.Count(); i < count; ++i)
 301   {
 302     hash = mUniformMaps[i].propertyPtr->Hash(bufferIndex, hash);
 303   }
 304   if(mUniformsHash != hash)
 305   {
 306     mUniformsHash = hash;
 307     SetUpdated(true);
 308   }
 309 }
 310
 311 void Node::SetParent(Node& parentNode)
 312 {
 313   DALI_ASSERT_ALWAYS(this != &parentNode);
 314   DALI_ASSERT_ALWAYS(!mIsRoot);
 315   DALI_ASSERT_ALWAYS(mParent == nullptr);
 316
 317   mParent = &parentNode;
 318
 319   if(mTransformManagerData.Id() != INVALID_TRANSFORM_ID)
 320   {
 321     mTransformManagerData.Manager()->SetParent(mTransformManagerData.Id(), parentNode.GetTransformId());
 322   }
 323 }
 324
 325 void Node::RecursiveDisconnectFromSceneGraph(BufferIndex updateBufferIndex)
 326 {
 327   DALI_ASSERT_ALWAYS(!mIsRoot);
 328   DALI_ASSERT_ALWAYS(mParent != nullptr);
 329
 330   const NodeIter endIter = mChildren.End();
 331   for(NodeIter iter = mChildren.Begin(); iter != endIter; ++iter)
 332   {
 333     (*iter)->RecursiveDisconnectFromSceneGraph(updateBufferIndex);
 334   }
 335
 336   // Animators, Constraints etc. should be disconnected from the child's properties.
 337   PropertyOwner::DisconnectFromSceneGraph(updateBufferIndex);
 338
 339   // Remove back-pointer to parent
 340   mParent = nullptr;
 341
 342   // Remove all child pointers
 343   mChildren.Clear();
 344
 345   if(mTransformManagerData.Id() != INVALID_TRANSFORM_ID)
 346   {
 347     mTransformManagerData.Manager()->SetParent(mTransformManagerData.Id(), INVALID_TRANSFORM_ID);
 348   }
 349 }
 350
 351 uint32_t Node::GetMemoryPoolCapacity()
 352 {
 353   return gNodeMemoryPool.GetCapacity();
 354 }
 355
 356 } // namespace SceneGraph
 357
 358 } // namespace Internal
 359
 360 } // namespace Dali