dali/internal/event/common/scene-impl.cpp

   1 /*
   2  * Copyright (c) 2020 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/event/common/scene-impl.h>
  20
  21 // INTERNAL INCLUDES
  22 #include <dali/internal/event/actors/layer-impl.h>
  23 #include <dali/internal/event/actors/layer-list.h>
  24 #include <dali/internal/event/actors/camera-actor-impl.h>
  25 #include <dali/internal/event/common/thread-local-storage.h>
  26 #include <dali/internal/event/render-tasks/render-task-list-impl.h>
  27 #include <dali/internal/event/render-tasks/render-task-impl.h>
  28 #include <dali/internal/event/common/object-registry-impl.h>
  29 #include <dali/internal/update/nodes/node.h>
  30 #include <dali/internal/update/manager/update-manager.h>
  31 #include <dali/internal/update/common/scene-graph-scene.h>
  32 #include <dali/public-api/common/constants.h>
  33 #include <dali/public-api/object/type-registry.h>
  34 #include <dali/public-api/render-tasks/render-task-list.h>
  35 #include <dali/internal/event/rendering/frame-buffer-impl.h>
  36 #include <dali/internal/event/size-negotiation/relayout-controller-impl.h>
  37
  38 using Dali::Internal::SceneGraph::Node;
  39
  40 namespace Dali
  41 {
  42
  43 namespace Internal
  44 {
  45
  46 ScenePtr Scene::New( Size size )
  47 {
  48   ScenePtr scene = new Scene;
  49
  50   // Second-phase construction
  51   scene->Initialize( size, 0 );
  52
  53   return scene;
  54 }
  55
  56 ScenePtr Scene::New( Size size, int orientation )
  57 {
  58   ScenePtr scene = new Scene;
  59
  60   // Second-phase construction
  61   scene->Initialize( size, orientation );
  62
  63   return scene;
  64 }
  65
  66 Scene::Scene()
  67 : mSceneObject( nullptr ),
  68   mSize(), // Don't set the proper value here, this will be set when the surface is set later
  69   mDpi(),
  70   mBackgroundColor( DEFAULT_BACKGROUND_COLOR ),
  71   mDepthTreeDirty( false ),
  72   mEventProcessor( *this, ThreadLocalStorage::GetInternal()->GetGestureEventProcessor() )
  73 {
  74 }
  75
  76 Scene::~Scene()
  77 {
  78   if( EventThreadServices::IsCoreRunning() && mSceneObject )
  79   {
  80     ThreadLocalStorage* tls = ThreadLocalStorage::GetInternal();
  81     RemoveSceneMessage( tls->GetUpdateManager(), *mSceneObject );
  82   }
  83
  84   if( mDefaultCamera )
  85   {
  86     // its enough to release the handle so the object is released
  87     // don't need to remove it from root actor as root actor will delete the object
  88     mDefaultCamera.Reset();
  89   }
  90
  91   if( mRootLayer )
  92   {
  93     // we are closing down so just delete the root, no point emit disconnect
  94     // signals or send messages to update
  95     mRootLayer.Reset();
  96   }
  97
  98   if( mRenderTaskList )
  99   {
 100     mRenderTaskList.Reset();
 101   }
 102
 103   // No need to discard this Scene from Core, as Core stores an intrusive_ptr to this scene
 104   // When this destructor is called, the scene has either already been removed from Core or Core has already been destroyed
 105 }
 106
 107 void Scene::Initialize( Size size, int orientation )
 108 {
 109   ThreadLocalStorage* tls = ThreadLocalStorage::GetInternal();
 110
 111   DALI_ASSERT_ALWAYS( tls && "Attempt to create scene before core exists!" );
 112
 113   tls->AddScene( this );
 114
 115   SceneGraph::UpdateManager& updateManager = tls->GetUpdateManager();
 116
 117   // Create the ordered list of layers
 118   mLayerList = LayerList::New( updateManager );
 119
 120   // The scene owns the default layer
 121   mRootLayer = Layer::NewRoot( *mLayerList );
 122   mRootLayer->SetName("RootLayer");
 123   mRootLayer->SetScene( *this );
 124
 125   // The root layer needs to have a fixed resize policy (as opposed to the default USE_NATURAL_SIZE).
 126   // This stops actors parented to the stage having their relayout requests propagating
 127   // up to the root layer, and down through other children unnecessarily.
 128   mRootLayer->SetResizePolicy( ResizePolicy::FIXED, Dimension::ALL_DIMENSIONS );
 129
 130   // Create the default camera actor first; this is needed by the RenderTaskList
 131   // The default camera attributes and position is such that children of the default layer,
 132   // can be positioned at (0,0) and be at the top-left of the viewport.
 133   mDefaultCamera = CameraActor::New( size );
 134   mDefaultCamera->SetParentOrigin(ParentOrigin::CENTER);
 135   Add(*(mDefaultCamera.Get()));
 136
 137   // Create the list of render-tasks
 138   mRenderTaskList = RenderTaskList::New();
 139
 140   // Create the default render-task and ensure clear is enabled on it to show the background color
 141   RenderTaskPtr renderTask = mRenderTaskList->CreateTask( mRootLayer.Get(), mDefaultCamera.Get() );
 142   renderTask->SetClearEnabled(true);
 143   mSurfaceOrientation = orientation;
 144
 145   SurfaceResized( size.width, size.height );
 146
 147   // Create scene graph object
 148   mSceneObject = new SceneGraph::Scene();
 149   OwnerPointer< SceneGraph::Scene > transferOwnership( const_cast< SceneGraph::Scene* >( mSceneObject ) );
 150   AddSceneMessage( updateManager, transferOwnership );
 151 }
 152
 153 void Scene::Add(Actor& actor)
 154 {
 155   mRootLayer->Add( actor );
 156 }
 157
 158 void Scene::Remove(Actor& actor)
 159 {
 160   mRootLayer->Remove( actor );
 161 }
 162
 163 Size Scene::GetSize() const
 164 {
 165   return mSize;
 166 }
 167
 168 void Scene::SetDpi(Vector2 dpi)
 169 {
 170   mDpi = dpi;
 171 }
 172
 173 Vector2 Scene::GetDpi() const
 174 {
 175   return mDpi;
 176 }
 177
 178 RenderTaskList& Scene::GetRenderTaskList() const
 179 {
 180   return *mRenderTaskList;
 181 }
 182
 183 Dali::Layer Scene::GetRootLayer() const
 184 {
 185   return Dali::Layer( mRootLayer.Get() );
 186 }
 187
 188 LayerList& Scene::GetLayerList() const
 189 {
 190   return *mLayerList;
 191 }
 192
 193 uint32_t Scene::GetLayerCount() const
 194 {
 195   return mLayerList->GetLayerCount();
 196 }
 197
 198 Dali::Layer Scene::GetLayer( uint32_t depth ) const
 199 {
 200   return Dali::Layer(mLayerList->GetLayer( depth ));
 201 }
 202
 203 CameraActor& Scene::GetDefaultCameraActor()
 204 {
 205   return *mDefaultCamera;
 206 }
 207
 208 Actor& Scene::GetDefaultRootActor()
 209 {
 210   return *mRootLayer;
 211 }
 212
 213 void Scene::SurfaceResized( float width, float height )
 214 {
 215   if( ( fabsf( mSize.width - width ) > Math::MACHINE_EPSILON_1 ) || ( fabsf( mSize.height - height ) > Math::MACHINE_EPSILON_1 ) )
 216   {
 217     Rect< int32_t > newSize( 0, 0, static_cast< int32_t >( width ), static_cast< int32_t >( height ) ); // truncated
 218
 219     mSize.width = width;
 220     mSize.height = height;
 221
 222     // Calculates the aspect ratio, near and far clipping planes, field of view and camera Z position.
 223     mDefaultCamera->SetPerspectiveProjection( mSize );
 224
 225     mRootLayer->SetSize( mSize.width, mSize.height );
 226
 227     ThreadLocalStorage* tls = ThreadLocalStorage::GetInternal();
 228     SceneGraph::UpdateManager& updateManager = tls->GetUpdateManager();
 229     SetDefaultSurfaceRectMessage( updateManager, newSize );
 230
 231     // set default render-task viewport parameters
 232     RenderTaskPtr defaultRenderTask = mRenderTaskList->GetTask( 0u );
 233     defaultRenderTask->SetViewport( newSize );
 234   }
 235 }
 236
 237 void Scene::SurfaceReplaced()
 238 {
 239   if ( mSceneObject )
 240   {
 241     ThreadLocalStorage* tls = ThreadLocalStorage::GetInternal();
 242     SurfaceReplacedMessage( tls->GetUpdateManager(), *mSceneObject );
 243   }
 244 }
 245
 246 void Scene::Discard()
 247 {
 248   if( ThreadLocalStorage::Created() )
 249   {
 250     ThreadLocalStorage* tls = ThreadLocalStorage::GetInternal();
 251     tls->RemoveScene( this );
 252   }
 253 }
 254
 255 void Scene::RequestRebuildDepthTree()
 256 {
 257   mDepthTreeDirty = true;
 258 }
 259
 260 void Scene::QueueEvent( const Integration::Event& event )
 261 {
 262   mEventProcessor.QueueEvent( event );
 263 }
 264
 265 void Scene::ProcessEvents()
 266 {
 267   mEventProcessor.ProcessEvents();
 268 }
 269
 270 void Scene::RebuildDepthTree()
 271 {
 272   // If the depth tree needs rebuilding, do it in this frame only.
 273   if( mDepthTreeDirty )
 274   {
 275     ActorPtr actor( mRootLayer.Get() );
 276     actor->RebuildDepthTree();
 277     mDepthTreeDirty = false;
 278   }
 279 }
 280
 281 void Scene::SetBackgroundColor( const Vector4& color )
 282 {
 283   mBackgroundColor = color;
 284
 285   mRenderTaskList->GetTask( 0u )->SetClearColor( color );
 286   mRenderTaskList->GetTask( 0u )->SetClearEnabled( true );
 287 }
 288
 289 Vector4 Scene::GetBackgroundColor() const
 290 {
 291   return mBackgroundColor;
 292 }
 293
 294 SceneGraph::Scene* Scene::GetSceneObject() const
 295 {
 296   return mSceneObject;
 297 }
 298
 299 void Scene::EmitKeyEventSignal(const Dali::KeyEvent& event)
 300 {
 301   if ( !mKeyEventSignal.Empty() )
 302   {
 303     Dali::Integration::Scene handle( this );
 304     mKeyEventSignal.Emit( event );
 305   }
 306 }
 307
 308 bool Scene::EmitKeyEventGeneratedSignal(const Dali::KeyEvent& event)
 309 {
 310   // Emit the KeyEventGenerated signal when KeyEvent is generated
 311   Dali::Integration::Scene handle( this );
 312   return mKeyEventGeneratedSignal.Emit( event );
 313 }
 314
 315 void Scene::EmitEventProcessingFinishedSignal()
 316 {
 317   if ( !mEventProcessingFinishedSignal.Empty() )
 318   {
 319     Dali::Integration::Scene handle( this );
 320     mEventProcessingFinishedSignal.Emit();
 321   }
 322 }
 323
 324 void Scene::EmitTouchedSignal( const Dali::TouchEvent& touch )
 325 {
 326   Dali::Integration::Scene handle( this );
 327   if ( !mTouchedSignal.Empty() )
 328   {
 329     mTouchedSignal.Emit( touch );
 330   }
 331 }
 332
 333 void Scene::EmitWheelEventSignal(const Dali::WheelEvent& event)
 334 {
 335   if ( !mWheelEventSignal.Empty() )
 336   {
 337     Dali::Integration::Scene handle( this );
 338     mWheelEventSignal.Emit( event );
 339   }
 340 }
 341
 342 void Scene::AddFrameRenderedCallback( std::unique_ptr< CallbackBase > callback, int32_t frameId )
 343 {
 344   ThreadLocalStorage* tls = ThreadLocalStorage::GetInternal();
 345   AddFrameRenderedCallbackMessage( tls->GetEventThreadServices(), *mSceneObject, callback.release(), frameId );
 346 }
 347
 348 void Scene::AddFramePresentedCallback( std::unique_ptr< CallbackBase > callback, int32_t frameId )
 349 {
 350   ThreadLocalStorage* tls = ThreadLocalStorage::GetInternal();
 351   AddFramePresentedCallbackMessage( tls->GetEventThreadServices(), *mSceneObject, callback.release(), frameId );
 352 }
 353
 354 void Scene::GetFrameRenderedCallback( Dali::Integration::Scene::FrameCallbackContainer& callbacks )
 355 {
 356   mSceneObject->GetFrameRenderedCallback( callbacks );
 357 }
 358
 359 void Scene::GetFramePresentedCallback( Dali::Integration::Scene::FrameCallbackContainer& callbacks )
 360 {
 361   mSceneObject->GetFramePresentedCallback( callbacks );
 362 }
 363
 364 Integration::Scene::KeyEventSignalType& Scene::KeyEventSignal()
 365 {
 366   return mKeyEventSignal;
 367 }
 368
 369 Integration::Scene::KeyEventGeneratedSignalType& Scene::KeyEventGeneratedSignal()
 370 {
 371   return mKeyEventGeneratedSignal;
 372 }
 373
 374 Integration::Scene::EventProcessingFinishedSignalType& Scene::EventProcessingFinishedSignal()
 375 {
 376   return mEventProcessingFinishedSignal;
 377 }
 378
 379 Integration::Scene::TouchEventSignalType& Scene::TouchedSignal()
 380 {
 381   return mTouchedSignal;
 382 }
 383
 384 Integration::Scene::WheelEventSignalType& Scene::WheelEventSignal()
 385 {
 386   return mWheelEventSignal;
 387 }
 388
 389 std::vector<Dali::Internal::SceneGraph::DirtyRect>& Scene::GetItemsDirtyRects()
 390 {
 391   return mItemsDirtyRects;
 392 }
 393
 394 } // Internal
 395
 396 } // Dali