dali/internal/update/nodes/node.cpp

   1 /*
   2  * Copyright (c) 2021 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 layer
  63   if(!node->mIsLayer)
  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   mUpdateSizeHint(Vector3::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   mRegenerateUniformMap(0),
  99   mDrawMode(DrawMode::NORMAL),
 100   mColorMode(DEFAULT_COLOR_MODE),
 101   mClippingMode(ClippingMode::DISABLED),
 102   mIsRoot(false),
 103   mIsLayer(false),
 104   mPositionUsesAnchorPoint(true),
 105   mTransparent(false)
 106 {
 107   mUniformMapChanged[0] = 0u;
 108   mUniformMapChanged[1] = 0u;
 109
 110 #ifdef DEBUG_ENABLED
 111   gNodeCount++;
 112 #endif
 113 }
 114
 115 Node::~Node()
 116 {
 117   if(mTransformManagerData.Id() != INVALID_TRANSFORM_ID)
 118   {
 119     mTransformManagerData.Manager()->RemoveTransform(mTransformManagerData.Id());
 120   }
 121
 122 #ifdef DEBUG_ENABLED
 123   gNodeCount--;
 124 #endif
 125 }
 126
 127 void Node::OnDestroy()
 128 {
 129   // Animators, Constraints etc. should be disconnected from the child's properties.
 130   PropertyOwner::Destroy();
 131 }
 132
 133 uint32_t Node::GetId() const
 134 {
 135   return mId;
 136 }
 137
 138 void Node::CreateTransform(SceneGraph::TransformManager* transformManager)
 139 {
 140   //Create a new transform
 141   mTransformManagerData.mManager = transformManager;
 142   mTransformManagerData.mId      = transformManager->CreateTransform();
 143
 144   //Initialize all the animatable properties
 145   mPosition.Initialize(&mTransformManagerData);
 146   mScale.Initialize(&mTransformManagerData);
 147   mOrientation.Initialize(&mTransformManagerData);
 148   mSize.Initialize(&mTransformManagerData);
 149   mParentOrigin.Initialize(&mTransformManagerData);
 150   mAnchorPoint.Initialize(&mTransformManagerData);
 151
 152   //Initialize all the input properties
 153   mWorldPosition.Initialize(&mTransformManagerData);
 154   mWorldScale.Initialize(&mTransformManagerData);
 155   mWorldOrientation.Initialize(&mTransformManagerData);
 156   mWorldMatrix.Initialize(&mTransformManagerData);
 157
 158   //Set whether the position should use the anchor point
 159   transformManager->SetPositionUsesAnchorPoint(mTransformManagerData.Id(), mPositionUsesAnchorPoint);
 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 void Node::AddUniformMapping(const UniformPropertyMapping& map)
 170 {
 171   PropertyOwner::AddUniformMapping(map);
 172   mRegenerateUniformMap = 2;
 173 }
 174
 175 void Node::RemoveUniformMapping(const ConstString& uniformName)
 176 {
 177   PropertyOwner::RemoveUniformMapping(uniformName);
 178   mRegenerateUniformMap = 2;
 179 }
 180
 181 bool Node::IsAnimationPossible() const
 182 {
 183   return mIsConnectedToSceneGraph;
 184 }
 185
 186 void Node::PrepareRender(BufferIndex bufferIndex)
 187 {
 188   if(mRegenerateUniformMap != 0)
 189   {
 190     if(mRegenerateUniformMap == 2)
 191     {
 192       CollectedUniformMap& localMap = mCollectedUniformMap[bufferIndex];
 193       localMap.Resize(0);
 194
 195       for(UniformMap::SizeType i = 0, count = mUniformMaps.Count(); i < count; ++i)
 196       {
 197         localMap.PushBack(mUniformMaps[i]);
 198       }
 199     }
 200     else if(mRegenerateUniformMap == 1)
 201     {
 202       CollectedUniformMap& localMap = mCollectedUniformMap[bufferIndex];
 203       CollectedUniformMap& oldMap   = mCollectedUniformMap[1 - bufferIndex];
 204
 205       localMap.Resize(oldMap.Count());
 206
 207       CollectedUniformMap::SizeType index = 0;
 208       for(CollectedUniformMap::Iterator iter = oldMap.Begin(), end = oldMap.End(); iter != end; ++iter, ++index)
 209       {
 210         localMap[index] = *iter;
 211       }
 212     }
 213     --mRegenerateUniformMap;
 214     mUniformMapChanged[bufferIndex] = 1u;
 215   }
 216 }
 217
 218 void Node::ConnectChild(Node* childNode)
 219 {
 220   DALI_ASSERT_ALWAYS(this != childNode);
 221   DALI_ASSERT_ALWAYS(IsRoot() || nullptr != mParent);                            // Parent should be connected first
 222   DALI_ASSERT_ALWAYS(!childNode->IsRoot() && nullptr == childNode->GetParent()); // Child should be disconnected
 223
 224   childNode->SetParent(*this);
 225
 226   // Everything should be reinherited when reconnected to scene-graph
 227   childNode->SetAllDirtyFlags();
 228
 229   // Add the node to the end of the child list.
 230   mChildren.PushBack(childNode);
 231
 232   // Inform property observers of new connection
 233   childNode->ConnectToSceneGraph();
 234 }
 235
 236 void Node::DisconnectChild(BufferIndex updateBufferIndex, Node& childNode)
 237 {
 238   DALI_ASSERT_ALWAYS(this != &childNode);
 239   DALI_ASSERT_ALWAYS(childNode.GetParent() == this);
 240
 241   // Find the childNode and remove it
 242   Node* found(nullptr);
 243
 244   const NodeIter endIter = mChildren.End();
 245   for(NodeIter iter = mChildren.Begin(); iter != endIter; ++iter)
 246   {
 247     Node* current = *iter;
 248     if(current == &childNode)
 249     {
 250       found = current;
 251       mChildren.Erase(iter); // order matters here
 252       break;                 // iter is no longer valid
 253     }
 254   }
 255   DALI_ASSERT_ALWAYS(nullptr != found);
 256
 257   found->RecursiveDisconnectFromSceneGraph(updateBufferIndex);
 258 }
 259
 260 void Node::AddRenderer(Renderer* renderer)
 261 {
 262   // If it is the first renderer added, make sure the world transform will be calculated
 263   // in the next update as world transform is not computed if node has no renderers.
 264   if(mRenderer.Empty())
 265   {
 266     mDirtyFlags |= NodePropertyFlags::TRANSFORM;
 267   }
 268   else
 269   {
 270     // Check that it has not been already added.
 271     for(auto&& existingRenderer : mRenderer)
 272     {
 273       if(existingRenderer == renderer)
 274       {
 275         // Renderer is already in the list.
 276         return;
 277       }
 278     }
 279   }
 280
 281   mRenderer.PushBack(renderer);
 282 }
 283
 284 void Node::RemoveRenderer(const Renderer* renderer)
 285 {
 286   RendererContainer::SizeType rendererCount(mRenderer.Size());
 287   for(RendererContainer::SizeType i = 0; i < rendererCount; ++i)
 288   {
 289     if(mRenderer[i] == renderer)
 290     {
 291       mRenderer.Erase(mRenderer.Begin() + i);
 292       return;
 293     }
 294   }
 295 }
 296
 297 NodePropertyFlags Node::GetDirtyFlags() const
 298 {
 299   // get initial dirty flags, they are reset ResetDefaultProperties, but setters may have made the node dirty already
 300   NodePropertyFlags flags = mDirtyFlags;
 301
 302   // Check whether the visible property has changed
 303   if(!mVisible.IsClean())
 304   {
 305     flags |= NodePropertyFlags::VISIBLE;
 306   }
 307
 308   // Check whether the color property has changed
 309   if(!mColor.IsClean())
 310   {
 311     flags |= NodePropertyFlags::COLOR;
 312   }
 313
 314   return flags;
 315 }
 316
 317 NodePropertyFlags Node::GetInheritedDirtyFlags(NodePropertyFlags parentFlags) const
 318 {
 319   // Size is not inherited. VisibleFlag is inherited
 320   static const NodePropertyFlags InheritedDirtyFlags = NodePropertyFlags::TRANSFORM | NodePropertyFlags::VISIBLE | NodePropertyFlags::COLOR;
 321   using UnderlyingType                               = typename std::underlying_type<NodePropertyFlags>::type;
 322
 323   return static_cast<NodePropertyFlags>(static_cast<UnderlyingType>(mDirtyFlags) |
 324                                         (static_cast<UnderlyingType>(parentFlags) & static_cast<UnderlyingType>(InheritedDirtyFlags)));
 325 }
 326
 327 void Node::ResetDirtyFlags(BufferIndex updateBufferIndex)
 328 {
 329   mDirtyFlags = NodePropertyFlags::NOTHING;
 330 }
 331
 332 void Node::SetParent(Node& parentNode)
 333 {
 334   DALI_ASSERT_ALWAYS(this != &parentNode);
 335   DALI_ASSERT_ALWAYS(!mIsRoot);
 336   DALI_ASSERT_ALWAYS(mParent == nullptr);
 337
 338   mParent = &parentNode;
 339
 340   if(mTransformManagerData.Id() != INVALID_TRANSFORM_ID)
 341   {
 342     mTransformManagerData.Manager()->SetParent(mTransformManagerData.Id(), parentNode.GetTransformId());
 343   }
 344 }
 345
 346 void Node::RecursiveDisconnectFromSceneGraph(BufferIndex updateBufferIndex)
 347 {
 348   DALI_ASSERT_ALWAYS(!mIsRoot);
 349   DALI_ASSERT_ALWAYS(mParent != nullptr);
 350
 351   const NodeIter endIter = mChildren.End();
 352   for(NodeIter iter = mChildren.Begin(); iter != endIter; ++iter)
 353   {
 354     (*iter)->RecursiveDisconnectFromSceneGraph(updateBufferIndex);
 355   }
 356
 357   // Animators, Constraints etc. should be disconnected from the child's properties.
 358   PropertyOwner::DisconnectFromSceneGraph(updateBufferIndex);
 359
 360   // Remove back-pointer to parent
 361   mParent = nullptr;
 362
 363   // Remove all child pointers
 364   mChildren.Clear();
 365
 366   if(mTransformManagerData.Id() != INVALID_TRANSFORM_ID)
 367   {
 368     mTransformManagerData.Manager()->SetParent(mTransformManagerData.Id(), INVALID_TRANSFORM_ID);
 369   }
 370 }
 371
 372 } // namespace SceneGraph
 373
 374 } // namespace Internal
 375
 376 } // namespace Dali