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