dali/internal/update/nodes/node.cpp

   1 /*
   2  * Copyright (c) 2018 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/dali-common.h>
  26 #include <dali/public-api/common/constants.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
  48 namespace Internal
  49 {
  50
  51 namespace SceneGraph
  52 {
  53
  54 const ColorMode Node::DEFAULT_COLOR_MODE( USE_OWN_MULTIPLY_PARENT_ALPHA );
  55
  56 uint32_t Node::mNodeCounter = 0;        ///< A counter to provide unique node ids, up-to 4 billion
  57
  58 Node* Node::New()
  59 {
  60   return new ( gNodeMemoryPool.AllocateRawThreadSafe() ) Node;
  61 }
  62
  63 void Node::Delete( Node* node )
  64 {
  65   // check we have a node not a layer
  66   if( !node->mIsLayer )
  67   {
  68     // Manually call the destructor
  69     node->~Node();
  70
  71     // Mark the memory it used as free in the memory pool
  72     gNodeMemoryPool.FreeThreadSafe( node );
  73   }
  74   else
  75   {
  76     // not in the pool, just delete it.
  77     delete node;
  78   }
  79 }
  80
  81 Node::Node()
  82 : mTransformManager( NULL ),
  83   mTransformId( INVALID_TRANSFORM_ID ),
  84   mParentOrigin( TRANSFORM_PROPERTY_PARENT_ORIGIN ),
  85   mAnchorPoint( TRANSFORM_PROPERTY_ANCHOR_POINT ),
  86   mSize( TRANSFORM_PROPERTY_SIZE ),                                               // Zero initialized by default
  87   mPosition( TRANSFORM_PROPERTY_POSITION ),                                       // Zero initialized by default
  88   mOrientation(),                                                                 // Initialized to identity by default
  89   mScale( TRANSFORM_PROPERTY_SCALE ),
  90   mUpdateSizeHint( TRANSFORM_PROPERTY_UPDATE_SIZE_HINT ),
  91   mVisible( true ),
  92   mCulled( false ),
  93   mColor( Color::WHITE ),
  94   mWorldPosition( TRANSFORM_PROPERTY_WORLD_POSITION, Vector3( 0.0f,0.0f,0.0f ) ), // Zero initialized by default
  95   mWorldScale( TRANSFORM_PROPERTY_WORLD_SCALE, Vector3( 1.0f,1.0f,1.0f ) ),
  96   mWorldOrientation(),                                                            // Initialized to identity by default
  97   mWorldMatrix(),
  98   mWorldColor( Color::WHITE ),
  99   mClippingSortModifier( 0u ),
 100   mId( ++mNodeCounter ),
 101   mParent( NULL ),
 102   mExclusiveRenderTask( NULL ),
 103   mChildren(),
 104   mClippingDepth( 0u ),
 105   mScissorDepth( 0u ),
 106   mDepthIndex( 0u ),
 107   mDirtyFlags( NodePropertyFlags::ALL ),
 108   mRegenerateUniformMap( 0 ),
 109   mDrawMode( DrawMode::NORMAL ),
 110   mColorMode( DEFAULT_COLOR_MODE ),
 111   mClippingMode( ClippingMode::DISABLED ),
 112   mIsRoot( false ),
 113   mIsLayer( false ),
 114   mPositionUsesAnchorPoint( true )
 115 {
 116   mUniformMapChanged[0] = 0u;
 117   mUniformMapChanged[1] = 0u;
 118   mPropertyDirty = false;
 119
 120 #ifdef DEBUG_ENABLED
 121   gNodeCount++;
 122 #endif
 123
 124 }
 125
 126 Node::~Node()
 127 {
 128   if( mTransformId != INVALID_TRANSFORM_ID )
 129   {
 130     mTransformManager->RemoveTransform(mTransformId);
 131   }
 132
 133 #ifdef DEBUG_ENABLED
 134   gNodeCount--;
 135 #endif
 136 }
 137
 138 void Node::OnDestroy()
 139 {
 140   // Animators, Constraints etc. should be disconnected from the child's properties.
 141   PropertyOwner::Destroy();
 142 }
 143
 144 uint32_t Node::GetId() const
 145 {
 146   return mId;
 147 }
 148
 149 void Node::CreateTransform( SceneGraph::TransformManager* transformManager )
 150 {
 151   //Create a new transform
 152   mTransformManager = transformManager;
 153   mTransformId = transformManager->CreateTransform();
 154
 155   //Initialize all the animatable properties
 156   mPosition.Initialize( transformManager, mTransformId );
 157   mScale.Initialize( transformManager, mTransformId );
 158   mUpdateSizeHint.Initialize( transformManager, mTransformId );
 159   mOrientation.Initialize( transformManager, mTransformId );
 160   mSize.Initialize( transformManager, mTransformId );
 161   mParentOrigin.Initialize( transformManager, mTransformId );
 162   mAnchorPoint.Initialize( transformManager, mTransformId );
 163
 164   //Initialize all the input properties
 165   mWorldPosition.Initialize( transformManager, mTransformId );
 166   mWorldScale.Initialize( transformManager, mTransformId );
 167   mWorldOrientation.Initialize( transformManager, mTransformId );
 168   mWorldMatrix.Initialize( transformManager, mTransformId );
 169
 170   //Set whether the position should use the anchor point
 171   transformManager->SetPositionUsesAnchorPoint( mTransformId, mPositionUsesAnchorPoint );
 172 }
 173
 174 void Node::SetRoot(bool isRoot)
 175 {
 176   DALI_ASSERT_DEBUG(!isRoot || mParent == NULL); // Root nodes cannot have a parent
 177
 178   mIsRoot = isRoot;
 179 }
 180
 181 void Node::AddUniformMapping( OwnerPointer< UniformPropertyMapping >& map )
 182 {
 183   PropertyOwner::AddUniformMapping( map );
 184   mRegenerateUniformMap = 2;
 185 }
 186
 187 void Node::RemoveUniformMapping( const std::string& uniformName )
 188 {
 189   PropertyOwner::RemoveUniformMapping( uniformName );
 190   mRegenerateUniformMap = 2;
 191 }
 192
 193 void Node::PrepareRender( BufferIndex bufferIndex )
 194 {
 195   if( mRegenerateUniformMap != 0 )
 196   {
 197     if( mRegenerateUniformMap == 2 )
 198     {
 199       CollectedUniformMap& localMap = mCollectedUniformMap[ bufferIndex ];
 200       localMap.Resize(0);
 201
 202       for( UniformMap::SizeType i = 0, count=mUniformMaps.Count(); i<count; ++i )
 203       {
 204         localMap.PushBack( &mUniformMaps[i] );
 205       }
 206     }
 207     else if( mRegenerateUniformMap == 1 )
 208     {
 209       CollectedUniformMap& localMap = mCollectedUniformMap[ bufferIndex ];
 210       CollectedUniformMap& oldMap = mCollectedUniformMap[ 1-bufferIndex ];
 211
 212       localMap.Resize( oldMap.Count() );
 213
 214       CollectedUniformMap::SizeType index = 0;
 215       for( CollectedUniformMap::Iterator iter = oldMap.Begin(), end = oldMap.End() ; iter != end ; ++iter, ++index )
 216       {
 217         localMap[index] = *iter;
 218       }
 219     }
 220     --mRegenerateUniformMap;
 221     mUniformMapChanged[bufferIndex] = 1u;
 222   }
 223 }
 224
 225 void Node::ConnectChild( Node* childNode )
 226 {
 227   DALI_ASSERT_ALWAYS( this != childNode );
 228   DALI_ASSERT_ALWAYS( IsRoot() || NULL != mParent ); // Parent should be connected first
 229   DALI_ASSERT_ALWAYS( !childNode->IsRoot() && NULL == childNode->GetParent() ); // Child should be disconnected
 230
 231   childNode->SetParent( *this );
 232
 233   // Everything should be reinherited when reconnected to scene-graph
 234   childNode->SetAllDirtyFlags();
 235
 236   // Add the node to the end of the child list.
 237   mChildren.PushBack( childNode );
 238
 239   // Inform property observers of new connection
 240   childNode->ConnectToSceneGraph();
 241 }
 242
 243 void Node::DisconnectChild( BufferIndex updateBufferIndex, Node& childNode )
 244 {
 245   DALI_ASSERT_ALWAYS( this != &childNode );
 246   DALI_ASSERT_ALWAYS( childNode.GetParent() == this );
 247
 248   // Find the childNode and remove it
 249   Node* found( NULL );
 250
 251   const NodeIter endIter = mChildren.End();
 252   for ( NodeIter iter = mChildren.Begin(); iter != endIter; ++iter )
 253   {
 254     Node* current = *iter;
 255     if ( current == &childNode )
 256     {
 257       found = current;
 258       mChildren.Erase( iter ); // order matters here
 259       break; // iter is no longer valid
 260     }
 261   }
 262   DALI_ASSERT_ALWAYS( NULL != found );
 263
 264   found->RecursiveDisconnectFromSceneGraph( updateBufferIndex );
 265 }
 266
 267 void Node::AddRenderer( Renderer* renderer )
 268 {
 269   // If it is the first renderer added, make sure the world transform will be calculated
 270   // in the next update as world transform is not computed if node has no renderers.
 271   if( mRenderer.Empty() )
 272   {
 273     mDirtyFlags |= NodePropertyFlags::TRANSFORM;
 274   }
 275   else
 276   {
 277     // Check that it has not been already added.
 278     for( auto&& existingRenderer : mRenderer )
 279     {
 280       if( existingRenderer == renderer )
 281       {
 282         // Renderer is already in the list.
 283         return;
 284       }
 285     }
 286   }
 287
 288   mRenderer.PushBack( renderer );
 289   SetPropertyDirty( true );
 290 }
 291
 292 void Node::RemoveRenderer( const Renderer* renderer )
 293 {
 294   RendererContainer::SizeType rendererCount( mRenderer.Size() );
 295   for( RendererContainer::SizeType i = 0; i < rendererCount; ++i )
 296   {
 297     if( mRenderer[i] == renderer )
 298     {
 299       SetPropertyDirty( true );
 300       mRenderer.Erase( mRenderer.Begin()+i);
 301       return;
 302     }
 303   }
 304 }
 305
 306 NodePropertyFlags Node::GetDirtyFlags() const
 307 {
 308   // get initial dirty flags, they are reset ResetDefaultProperties, but setters may have made the node dirty already
 309   NodePropertyFlags flags = mDirtyFlags;
 310
 311   // Check whether the visible property has changed
 312   if ( !mVisible.IsClean() )
 313   {
 314     flags |= NodePropertyFlags::VISIBLE;
 315   }
 316
 317   // Check whether the color property has changed
 318   if ( !mColor.IsClean() )
 319   {
 320     flags |= NodePropertyFlags::COLOR;
 321   }
 322
 323   return flags;
 324 }
 325
 326 NodePropertyFlags Node::GetInheritedDirtyFlags( NodePropertyFlags parentFlags ) const
 327 {
 328   // Size is not inherited. VisibleFlag is inherited
 329   static const NodePropertyFlags InheritedDirtyFlags = NodePropertyFlags::TRANSFORM | NodePropertyFlags::VISIBLE | NodePropertyFlags::COLOR;
 330   using UnderlyingType = typename std::underlying_type<NodePropertyFlags>::type;
 331
 332   return static_cast<NodePropertyFlags>( static_cast<UnderlyingType>( mDirtyFlags ) |
 333                                          ( static_cast<UnderlyingType>( parentFlags ) & static_cast<UnderlyingType>( InheritedDirtyFlags ) ) );
 334 }
 335
 336 void Node::ResetDirtyFlags( BufferIndex updateBufferIndex )
 337 {
 338   mDirtyFlags = NodePropertyFlags::NOTHING;
 339
 340   SetPropertyDirty( false );
 341
 342   for( auto&& existingRenderer : mRenderer )
 343   {
 344     existingRenderer->SetDirty( false );
 345   }
 346
 347 }
 348
 349 void Node::SetParent( Node& parentNode )
 350 {
 351   DALI_ASSERT_ALWAYS(this != &parentNode);
 352   DALI_ASSERT_ALWAYS(!mIsRoot);
 353   DALI_ASSERT_ALWAYS(mParent == NULL);
 354
 355   mParent = &parentNode;
 356
 357   if( mTransformId != INVALID_TRANSFORM_ID )
 358   {
 359     mTransformManager->SetParent( mTransformId, parentNode.GetTransformId() );
 360   }
 361 }
 362
 363 void Node::RecursiveDisconnectFromSceneGraph( BufferIndex updateBufferIndex )
 364 {
 365   DALI_ASSERT_ALWAYS(!mIsRoot);
 366   DALI_ASSERT_ALWAYS(mParent != NULL);
 367
 368   const NodeIter endIter = mChildren.End();
 369   for ( NodeIter iter = mChildren.Begin(); iter != endIter; ++iter )
 370   {
 371     (*iter)->RecursiveDisconnectFromSceneGraph( updateBufferIndex );
 372   }
 373
 374   // Animators, Constraints etc. should be disconnected from the child's properties.
 375   PropertyOwner::DisconnectFromSceneGraph( updateBufferIndex );
 376
 377   // Remove back-pointer to parent
 378   mParent = NULL;
 379
 380   // Remove all child pointers
 381   mChildren.Clear();
 382
 383   if( mTransformId != INVALID_TRANSFORM_ID )
 384   {
 385     mTransformManager->SetParent( mTransformId, INVALID_TRANSFORM_ID );
 386   }
 387 }
 388
 389 void Node::SetPropertyDirty( bool value )
 390 {
 391   mPropertyDirty = value;
 392
 393   const NodeIter endIter = mChildren.End();
 394   for ( NodeIter iter = mChildren.Begin(); iter != endIter; ++iter )
 395   {
 396     Node* current = *iter;
 397     current->SetPropertyDirty( value );
 398   }
 399 }
 400
 401 bool Node::IsPropertyDirty() const
 402 {
 403   for( auto&& existingRenderer : mRenderer )
 404   {
 405     if( existingRenderer->IsDirty() )
 406     {
 407       return true;
 408     }
 409   }
 410
 411   return mPropertyDirty;
 412 }
 413
 414 } // namespace SceneGraph
 415
 416 } // namespace Internal
 417
 418 } // namespace Dali