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