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 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   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   mPositionUsesAnchorPoint(true),
 104   mTransparent(false)
 105 {
 106 #ifdef DEBUG_ENABLED
 107   gNodeCount++;
 108 #endif
 109 }
 110
 111 Node::~Node()
 112 {
 113   if(mTransformManagerData.Id() != INVALID_TRANSFORM_ID)
 114   {
 115     mTransformManagerData.Manager()->RemoveTransform(mTransformManagerData.Id());
 116   }
 117
 118 #ifdef DEBUG_ENABLED
 119   gNodeCount--;
 120 #endif
 121 }
 122
 123 void Node::OnDestroy()
 124 {
 125   // Animators, Constraints etc. should be disconnected from the child's properties.
 126   PropertyOwner::Destroy();
 127 }
 128
 129 uint32_t Node::GetId() const
 130 {
 131   return mId;
 132 }
 133
 134 void Node::CreateTransform(SceneGraph::TransformManager* transformManager)
 135 {
 136   //Create a new transform
 137   mTransformManagerData.mManager = transformManager;
 138   TransformId createdTransformId = transformManager->CreateTransform();
 139
 140   //Initialize all the animatable properties
 141   mPosition.Initialize(&mTransformManagerData);
 142   mScale.Initialize(&mTransformManagerData);
 143   mOrientation.Initialize(&mTransformManagerData);
 144   mSize.Initialize(&mTransformManagerData);
 145   mParentOrigin.Initialize(&mTransformManagerData);
 146   mAnchorPoint.Initialize(&mTransformManagerData);
 147
 148   //Initialize all the input properties
 149   mWorldPosition.Initialize(&mTransformManagerData);
 150   mWorldScale.Initialize(&mTransformManagerData);
 151   mWorldOrientation.Initialize(&mTransformManagerData);
 152   mWorldMatrix.Initialize(&mTransformManagerData);
 153
 154   //Set whether the position should use the anchor point
 155   transformManager->SetPositionUsesAnchorPoint(createdTransformId, mPositionUsesAnchorPoint);
 156
 157   //Set TransformId after initialize done.
 158   mTransformManagerData.mId = createdTransformId;
 159 }
 160
 161 void Node::SetRoot(bool isRoot)
 162 {
 163   DALI_ASSERT_DEBUG(!isRoot || mParent == NULL); // Root nodes cannot have a parent
 164
 165   mIsRoot = isRoot;
 166 }
 167
 168 bool Node::IsAnimationPossible() const
 169 {
 170   return mIsConnectedToSceneGraph;
 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(Renderer* 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(mRenderer.Empty())
 220   {
 221     mDirtyFlags |= NodePropertyFlags::TRANSFORM;
 222   }
 223   else
 224   {
 225     // Check that it has not been already added.
 226     for(auto&& existingRenderer : mRenderer)
 227     {
 228       if(existingRenderer == renderer)
 229       {
 230         // Renderer is already in the list.
 231         return;
 232       }
 233     }
 234   }
 235
 236   SetUpdated(true);
 237
 238   mRenderer.PushBack(renderer);
 239 }
 240
 241 void Node::RemoveRenderer(const Renderer* renderer)
 242 {
 243   RendererContainer::SizeType rendererCount(mRenderer.Size());
 244   for(RendererContainer::SizeType i = 0; i < rendererCount; ++i)
 245   {
 246     if(mRenderer[i] == renderer)
 247     {
 248       SetUpdated(true);
 249       mRenderer.Erase(mRenderer.Begin() + i);
 250       return;
 251     }
 252   }
 253 }
 254
 255 NodePropertyFlags Node::GetDirtyFlags() const
 256 {
 257   // get initial dirty flags, they are reset ResetDefaultProperties, but setters may have made the node dirty already
 258   NodePropertyFlags flags = mDirtyFlags;
 259
 260   // Check whether the visible property has changed
 261   if(!mVisible.IsClean())
 262   {
 263     flags |= NodePropertyFlags::VISIBLE;
 264   }
 265
 266   // Check whether the color property has changed
 267   if(!mColor.IsClean())
 268   {
 269     flags |= NodePropertyFlags::COLOR;
 270   }
 271
 272   return flags;
 273 }
 274
 275 NodePropertyFlags Node::GetInheritedDirtyFlags(NodePropertyFlags parentFlags) const
 276 {
 277   // Size is not inherited. VisibleFlag is inherited
 278   static const NodePropertyFlags InheritedDirtyFlags = NodePropertyFlags::TRANSFORM | NodePropertyFlags::VISIBLE | NodePropertyFlags::COLOR;
 279   using UnderlyingType                               = typename std::underlying_type<NodePropertyFlags>::type;
 280
 281   return static_cast<NodePropertyFlags>(static_cast<UnderlyingType>(mDirtyFlags) |
 282                                         (static_cast<UnderlyingType>(parentFlags) & static_cast<UnderlyingType>(InheritedDirtyFlags)));
 283 }
 284
 285 void Node::ResetDirtyFlags(BufferIndex updateBufferIndex)
 286 {
 287   mDirtyFlags = NodePropertyFlags::NOTHING;
 288 }
 289
 290 void Node::SetParent(Node& parentNode)
 291 {
 292   DALI_ASSERT_ALWAYS(this != &parentNode);
 293   DALI_ASSERT_ALWAYS(!mIsRoot);
 294   DALI_ASSERT_ALWAYS(mParent == nullptr);
 295
 296   mParent = &parentNode;
 297
 298   if(mTransformManagerData.Id() != INVALID_TRANSFORM_ID)
 299   {
 300     mTransformManagerData.Manager()->SetParent(mTransformManagerData.Id(), parentNode.GetTransformId());
 301   }
 302 }
 303
 304 void Node::RecursiveDisconnectFromSceneGraph(BufferIndex updateBufferIndex)
 305 {
 306   DALI_ASSERT_ALWAYS(!mIsRoot);
 307   DALI_ASSERT_ALWAYS(mParent != nullptr);
 308
 309   const NodeIter endIter = mChildren.End();
 310   for(NodeIter iter = mChildren.Begin(); iter != endIter; ++iter)
 311   {
 312     (*iter)->RecursiveDisconnectFromSceneGraph(updateBufferIndex);
 313   }
 314
 315   // Animators, Constraints etc. should be disconnected from the child's properties.
 316   PropertyOwner::DisconnectFromSceneGraph(updateBufferIndex);
 317
 318   // Remove back-pointer to parent
 319   mParent = nullptr;
 320
 321   // Remove all child pointers
 322   mChildren.Clear();
 323
 324   if(mTransformManagerData.Id() != INVALID_TRANSFORM_ID)
 325   {
 326     mTransformManagerData.Manager()->SetParent(mTransformManagerData.Id(), INVALID_TRANSFORM_ID);
 327   }
 328 }
 329
 330 } // namespace SceneGraph
 331
 332 } // namespace Internal
 333
 334 } // namespace Dali