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 //Unnamed 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 created / deleted, to ensure we have 0 when the process exits or DALi library is unloaded
  35 int 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 }
  44
  45 namespace Dali
  46 {
  47
  48 namespace Internal
  49 {
  50
  51 namespace SceneGraph
  52 {
  53
  54 const PositionInheritanceMode Node::DEFAULT_POSITION_INHERITANCE_MODE( INHERIT_PARENT_POSITION );
  55 const ColorMode Node::DEFAULT_COLOR_MODE( USE_OWN_MULTIPLY_PARENT_ALPHA );
  56
  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   mVisible( true ),
  91   mColor( Color::WHITE ),
  92   mWorldPosition( TRANSFORM_PROPERTY_WORLD_POSITION, Vector3( 0.0f,0.0f,0.0f ) ), // Zero initialized by default
  93   mWorldScale( TRANSFORM_PROPERTY_WORLD_SCALE, Vector3( 1.0f,1.0f,1.0f ) ),
  94   mWorldOrientation(),                                                            // Initialized to identity by default
  95   mWorldMatrix(),
  96   mWorldColor( Color::WHITE ),
  97   mClippingSortModifier( 0u ),
  98   mParent( NULL ),
  99   mExclusiveRenderTask( NULL ),
 100   mChildren(),
 101   mClippingDepth( 0u ),
 102   mScissorDepth( 0u ),
 103   mDepthIndex( 0u ),
 104   mRegenerateUniformMap( 0 ),
 105   mDirtyFlags( AllFlags ),
 106   mDrawMode( DrawMode::NORMAL ),
 107   mColorMode( DEFAULT_COLOR_MODE ),
 108   mClippingMode( ClippingMode::DISABLED ),
 109   mIsRoot( false ),
 110   mIsLayer( false ),
 111   mPositionUsesAnchorPoint( true )
 112 {
 113   mUniformMapChanged[0] = 0u;
 114   mUniformMapChanged[1] = 0u;
 115
 116 #ifdef DEBUG_ENABLED
 117   gNodeCount++;
 118 #endif
 119
 120 }
 121
 122 Node::~Node()
 123 {
 124   if( mTransformId != INVALID_TRANSFORM_ID )
 125   {
 126     mTransformManager->RemoveTransform(mTransformId);
 127   }
 128
 129 #ifdef DEBUG_ENABLED
 130   gNodeCount--;
 131 #endif
 132 }
 133
 134 void Node::OnDestroy()
 135 {
 136   // Animators, Constraints etc. should be disconnected from the child's properties.
 137   PropertyOwner::Destroy();
 138 }
 139
 140 void Node::CreateTransform( SceneGraph::TransformManager* transformManager )
 141 {
 142   //Create a new transform
 143   mTransformManager = transformManager;
 144   mTransformId = transformManager->CreateTransform();
 145
 146   //Initialize all the animatable properties
 147   mPosition.Initialize( transformManager, mTransformId );
 148   mScale.Initialize( transformManager, mTransformId );
 149   mOrientation.Initialize( transformManager, mTransformId );
 150   mSize.Initialize( transformManager, mTransformId );
 151   mParentOrigin.Initialize( transformManager, mTransformId );
 152   mAnchorPoint.Initialize( transformManager, mTransformId );
 153
 154   //Initialize all the input properties
 155   mWorldPosition.Initialize( transformManager, mTransformId );
 156   mWorldScale.Initialize( transformManager, mTransformId );
 157   mWorldOrientation.Initialize( transformManager, mTransformId );
 158   mWorldMatrix.Initialize( transformManager, mTransformId );
 159
 160   //Set whether the position should use the anchor point
 161   transformManager->SetPositionUsesAnchorPoint( mTransformId, mPositionUsesAnchorPoint );
 162 }
 163
 164 void Node::SetRoot(bool isRoot)
 165 {
 166   DALI_ASSERT_DEBUG(!isRoot || mParent == NULL); // Root nodes cannot have a parent
 167
 168   mIsRoot = isRoot;
 169 }
 170
 171 void Node::AddUniformMapping( OwnerPointer< UniformPropertyMapping >& map )
 172 {
 173   PropertyOwner::AddUniformMapping( map );
 174   mRegenerateUniformMap = 2;
 175 }
 176
 177 void Node::RemoveUniformMapping( const std::string& uniformName )
 178 {
 179   PropertyOwner::RemoveUniformMapping( uniformName );
 180   mRegenerateUniformMap = 2;
 181 }
 182
 183 void Node::PrepareRender( BufferIndex bufferIndex )
 184 {
 185   if(mRegenerateUniformMap != 0 )
 186   {
 187     if( mRegenerateUniformMap == 2 )
 188     {
 189       CollectedUniformMap& localMap = mCollectedUniformMap[ bufferIndex ];
 190       localMap.Resize(0);
 191
 192       for( unsigned int i=0, count=mUniformMaps.Count(); i<count; ++i )
 193       {
 194         localMap.PushBack( &mUniformMaps[i] );
 195       }
 196     }
 197     else if( mRegenerateUniformMap == 1 )
 198     {
 199       CollectedUniformMap& localMap = mCollectedUniformMap[ bufferIndex ];
 200       CollectedUniformMap& oldMap = mCollectedUniformMap[ 1-bufferIndex ];
 201
 202       localMap.Resize( oldMap.Count() );
 203
 204       unsigned int index=0;
 205       for( CollectedUniformMap::Iterator iter = oldMap.Begin(), end = oldMap.End() ; iter != end ; ++iter, ++index )
 206       {
 207         localMap[index] = *iter;
 208       }
 209     }
 210     --mRegenerateUniformMap;
 211     mUniformMapChanged[bufferIndex] = 1u;
 212   }
 213 }
 214
 215 void Node::ConnectChild( Node* childNode )
 216 {
 217   DALI_ASSERT_ALWAYS( this != childNode );
 218   DALI_ASSERT_ALWAYS( IsRoot() || NULL != mParent ); // Parent should be connected first
 219   DALI_ASSERT_ALWAYS( !childNode->IsRoot() && NULL == childNode->GetParent() ); // Child should be disconnected
 220
 221   childNode->SetParent( *this );
 222
 223   // Everything should be reinherited when reconnected to scene-graph
 224   childNode->SetAllDirtyFlags();
 225
 226   // Add the node to the end of the child list.
 227   mChildren.PushBack( childNode );
 228
 229   // Inform property observers of new connection
 230   childNode->ConnectToSceneGraph();
 231 }
 232
 233 void Node::DisconnectChild( BufferIndex updateBufferIndex, Node& childNode )
 234 {
 235   DALI_ASSERT_ALWAYS( this != &childNode );
 236   DALI_ASSERT_ALWAYS( childNode.GetParent() == this );
 237
 238   // Find the childNode and remove it
 239   Node* found( NULL );
 240
 241   const NodeIter endIter = mChildren.End();
 242   for ( NodeIter iter = mChildren.Begin(); iter != endIter; ++iter )
 243   {
 244     Node* current = *iter;
 245     if ( current == &childNode )
 246     {
 247       found = current;
 248       mChildren.Erase( iter ); // order matters here
 249       break; // iter is no longer valid
 250     }
 251   }
 252   DALI_ASSERT_ALWAYS( NULL != found );
 253
 254   found->RecursiveDisconnectFromSceneGraph( updateBufferIndex );
 255 }
 256
 257 void Node::AddRenderer( Renderer* renderer )
 258 {
 259   // Check that it has not been already added.
 260   unsigned int rendererCount( mRenderer.Size() );
 261   for( unsigned int i(0); i < rendererCount; ++i )
 262   {
 263     if( mRenderer[i] == renderer )
 264     {
 265       // Renderer is already in the list.
 266       return;
 267     }
 268   }
 269
 270   // If it is the first renderer added, make sure the world transform will be calculated
 271   // in the next update as world transform is not computed if node has no renderers.
 272   if( rendererCount == 0 )
 273   {
 274     mDirtyFlags |= TransformFlag;
 275   }
 276
 277   mRenderer.PushBack( renderer );
 278 }
 279
 280 void Node::RemoveRenderer( Renderer* renderer )
 281 {
 282   unsigned int rendererCount( mRenderer.Size() );
 283   for( unsigned int i(0); i<rendererCount; ++i )
 284   {
 285     if( mRenderer[i] == renderer )
 286     {
 287       mRenderer.Erase( mRenderer.Begin()+i);
 288       return;
 289     }
 290   }
 291 }
 292
 293 int Node::GetDirtyFlags() const
 294 {
 295   // get initial dirty flags, they are reset ResetDefaultProperties, but setters may have made the node dirty already
 296   int flags = mDirtyFlags;
 297
 298   // Check whether the visible property has changed
 299   if ( !mVisible.IsClean() )
 300   {
 301     flags |= VisibleFlag;
 302   }
 303
 304   // Check whether the color property has changed
 305   if ( !mColor.IsClean() )
 306   {
 307     flags |= ColorFlag;
 308   }
 309
 310   return flags;
 311 }
 312
 313 void Node::ResetDirtyFlags( BufferIndex updateBufferIndex )
 314 {
 315   mDirtyFlags = NothingFlag;
 316 }
 317
 318 void Node::SetParent( Node& parentNode )
 319 {
 320   DALI_ASSERT_ALWAYS(this != &parentNode);
 321   DALI_ASSERT_ALWAYS(!mIsRoot);
 322   DALI_ASSERT_ALWAYS(mParent == NULL);
 323
 324   mParent = &parentNode;
 325
 326   if( mTransformId != INVALID_TRANSFORM_ID )
 327   {
 328     mTransformManager->SetParent( mTransformId, parentNode.GetTransformId() );
 329   }
 330 }
 331
 332 void Node::RecursiveDisconnectFromSceneGraph( BufferIndex updateBufferIndex )
 333 {
 334   DALI_ASSERT_ALWAYS(!mIsRoot);
 335   DALI_ASSERT_ALWAYS(mParent != NULL);
 336
 337   const NodeIter endIter = mChildren.End();
 338   for ( NodeIter iter = mChildren.Begin(); iter != endIter; ++iter )
 339   {
 340     (*iter)->RecursiveDisconnectFromSceneGraph( updateBufferIndex );
 341   }
 342
 343   // Animators, Constraints etc. should be disconnected from the child's properties.
 344   PropertyOwner::DisconnectFromSceneGraph( updateBufferIndex );
 345
 346   // Remove back-pointer to parent
 347   mParent = NULL;
 348
 349   // Remove all child pointers
 350   mChildren.Clear();
 351
 352   if( mTransformId != INVALID_TRANSFORM_ID )
 353   {
 354     mTransformManager->SetParent( mTransformId, INVALID_TRANSFORM_ID );
 355   }
 356 }
 357
 358 } // namespace SceneGraph
 359
 360 } // namespace Internal
 361
 362 } // namespace Dali