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
 137   mRenderTaskList->CreateTask( mRootLayer.Get(), mDefaultCamera.Get() );
 138
 139   SurfaceResized( size.width, size.height );
 140
 141   // Create scene graph object
 142   mSceneObject = new SceneGraph::Scene();
 143   OwnerPointer< SceneGraph::Scene > transferOwnership( const_cast< SceneGraph::Scene* >( mSceneObject ) );
 144   AddSceneMessage( updateManager, transferOwnership );
 145 }
 146
 147 void Scene::Add(Actor& actor)
 148 {
 149   mRootLayer->Add( actor );
 150 }
 151
 152 void Scene::Remove(Actor& actor)
 153 {
 154   mRootLayer->Remove( actor );
 155 }
 156
 157 Size Scene::GetSize() const
 158 {
 159   return mSize;
 160 }
 161
 162 void Scene::SetDpi(Vector2 dpi)
 163 {
 164   mDpi = dpi;
 165 }
 166
 167 Vector2 Scene::GetDpi() const
 168 {
 169   return mDpi;
 170 }
 171
 172 RenderTaskList& Scene::GetRenderTaskList() const
 173 {
 174   return *mRenderTaskList;
 175 }
 176
 177 Dali::Layer Scene::GetRootLayer() const
 178 {
 179   return Dali::Layer( mRootLayer.Get() );
 180 }
 181
 182 LayerList& Scene::GetLayerList() const
 183 {
 184   return *mLayerList;
 185 }
 186
 187 uint32_t Scene::GetLayerCount() const
 188 {
 189   return mLayerList->GetLayerCount();
 190 }
 191
 192 Dali::Layer Scene::GetLayer( uint32_t depth ) const
 193 {
 194   return Dali::Layer(mLayerList->GetLayer( depth ));
 195 }
 196
 197 CameraActor& Scene::GetDefaultCameraActor()
 198 {
 199   return *mDefaultCamera;
 200 }
 201
 202 Actor& Scene::GetDefaultRootActor()
 203 {
 204   return *mRootLayer;
 205 }
 206
 207 void Scene::SurfaceResized( float width, float height )
 208 {
 209   if( ( fabsf( mSize.width - width ) > Math::MACHINE_EPSILON_1 ) || ( fabsf( mSize.height - height ) > Math::MACHINE_EPSILON_1 ) )
 210   {
 211     Rect< int32_t > newSize( 0, 0, static_cast< int32_t >( width ), static_cast< int32_t >( height ) ); // truncated
 212
 213     mSize.width = width;
 214     mSize.height = height;
 215
 216     // Calculates the aspect ratio, near and far clipping planes, field of view and camera Z position.
 217     mDefaultCamera->SetPerspectiveProjection( mSize );
 218
 219     mRootLayer->SetSize( mSize.width, mSize.height );
 220
 221     ThreadLocalStorage* tls = ThreadLocalStorage::GetInternal();
 222     SceneGraph::UpdateManager& updateManager = tls->GetUpdateManager();
 223     SetDefaultSurfaceRectMessage( updateManager, newSize );
 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 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 KeyEvent& event)
 303 {
 304   // Emit the KeyEventGenerated signal when KeyEvent is generated
 305   return mKeyEventGeneratedSignal.Emit( event );
 306 }
 307
 308 void Scene::EmitEventProcessingFinishedSignal()
 309 {
 310   if ( !mEventProcessingFinishedSignal.Empty() )
 311   {
 312     Dali::Integration::Scene handle( this );
 313     mEventProcessingFinishedSignal.Emit();
 314   }
 315 }
 316
 317 void Scene::EmitTouchedSignal( const TouchEvent& touchEvent, const Dali::TouchData& touch )
 318 {
 319   Dali::Integration::Scene handle( this );
 320   if ( !mTouchedSignal.Empty() )
 321   {
 322     mTouchedSignal.Emit( touchEvent );
 323   }
 324   if ( !mTouchSignal.Empty() )
 325   {
 326     mTouchSignal.Emit( touch );
 327   }
 328 }
 329
 330 void Scene::EmitWheelEventSignal(const WheelEvent& event)
 331 {
 332   if ( !mWheelEventSignal.Empty() )
 333   {
 334     Dali::Integration::Scene handle( this );
 335     mWheelEventSignal.Emit( event );
 336   }
 337 }
 338
 339 Integration::Scene::KeyEventSignalType& Scene::KeyEventSignal()
 340 {
 341   return mKeyEventSignal;
 342 }
 343
 344 Integration::Scene::KeyEventGeneratedSignalType& Scene::KeyEventGeneratedSignal()
 345 {
 346   return mKeyEventGeneratedSignal;
 347 }
 348
 349 Integration::Scene::EventProcessingFinishedSignalType& Scene::EventProcessingFinishedSignal()
 350 {
 351   return mEventProcessingFinishedSignal;
 352 }
 353
 354 Scene::TouchedSignalType& Scene::TouchedSignal()
 355 {
 356   return mTouchedSignal;
 357 }
 358
 359 Integration::Scene::TouchSignalType& Scene::TouchSignal()
 360 {
 361   return mTouchSignal;
 362 }
 363
 364 Integration::Scene::WheelEventSignalType& Scene::WheelEventSignal()
 365 {
 366   return mWheelEventSignal;
 367 }
 368
 369 } // Internal
 370
 371 } // Dali