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   mSurfaceOrientation( 0 ),
  68   mDepthTreeDirty( false ),
  69   mEventProcessor( *this, ThreadLocalStorage::GetInternal()->GetGestureEventProcessor() )
  70 {
  71 }
  72
  73 Scene::~Scene()
  74 {
  75   if( EventThreadServices::IsCoreRunning() && mSceneObject )
  76   {
  77     ThreadLocalStorage* tls = ThreadLocalStorage::GetInternal();
  78     RemoveSceneMessage( tls->GetUpdateManager(), *mSceneObject );
  79   }
  80
  81   if( mDefaultCamera )
  82   {
  83     // its enough to release the handle so the object is released
  84     // don't need to remove it from root actor as root actor will delete the object
  85     mDefaultCamera.Reset();
  86   }
  87
  88   if( mRootLayer )
  89   {
  90     // we are closing down so just delete the root, no point emit disconnect
  91     // signals or send messages to update
  92     mRootLayer.Reset();
  93   }
  94
  95   if( mRenderTaskList )
  96   {
  97     mRenderTaskList.Reset();
  98   }
  99
 100   // No need to discard this Scene from Core, as Core stores an intrusive_ptr to this scene
 101   // When this destructor is called, the scene has either already been removed from Core or Core has already been destroyed
 102 }
 103
 104 void Scene::Initialize( Size size )
 105 {
 106   ThreadLocalStorage* tls = ThreadLocalStorage::GetInternal();
 107
 108   DALI_ASSERT_ALWAYS( tls && "Attempt to create scene before core exists!" );
 109
 110   tls->AddScene( this );
 111
 112   SceneGraph::UpdateManager& updateManager = tls->GetUpdateManager();
 113
 114   // Create the ordered list of layers
 115   mLayerList = LayerList::New( updateManager );
 116
 117   // The scene owns the default layer
 118   mRootLayer = Layer::NewRoot( *mLayerList );
 119   mRootLayer->SetName("RootLayer");
 120   mRootLayer->SetScene( *this );
 121
 122   // The root layer needs to have a fixed resize policy (as opposed to the default USE_NATURAL_SIZE).
 123   // This stops actors parented to the stage having their relayout requests propagating
 124   // up to the root layer, and down through other children unnecessarily.
 125   mRootLayer->SetResizePolicy( ResizePolicy::FIXED, Dimension::ALL_DIMENSIONS );
 126
 127   // Create the default camera actor first; this is needed by the RenderTaskList
 128   // The default camera attributes and position is such that children of the default layer,
 129   // can be positioned at (0,0) and be at the top-left of the viewport.
 130   mDefaultCamera = CameraActor::New( size );
 131   mDefaultCamera->SetParentOrigin(ParentOrigin::CENTER);
 132   Add(*(mDefaultCamera.Get()));
 133
 134   // Create the list of render-tasks
 135   mRenderTaskList = RenderTaskList::New();
 136
 137   // Create the default render-task
 138   mRenderTaskList->CreateTask( mRootLayer.Get(), mDefaultCamera.Get() );
 139
 140   SurfaceResized( size.width, size.height, mSurfaceOrientation, false );
 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, int orientation, bool forceUpdate )
 209 {
 210   if( ( fabsf( mSize.width - width ) > Math::MACHINE_EPSILON_1 ) || ( fabsf( mSize.height - height ) > Math::MACHINE_EPSILON_1 )
 211       || ( orientation != mSurfaceOrientation ) || ( forceUpdate ) )
 212   {
 213     Rect< int32_t > newSize( 0, 0, static_cast< int32_t >( width ), static_cast< int32_t >( height ) ); // truncated
 214
 215     mSize.width = width;
 216     mSize.height = height;
 217     mSurfaceOrientation = orientation;
 218
 219     // Calculates the aspect ratio, near and far clipping planes, field of view and camera Z position.
 220     mDefaultCamera->SetPerspectiveProjection( mSize );
 221     mDefaultCamera->RotateProjection( mSurfaceOrientation );
 222
 223     mRootLayer->SetSize( mSize.width, mSize.height );
 224
 225     ThreadLocalStorage* tls = ThreadLocalStorage::GetInternal();
 226     SceneGraph::UpdateManager& updateManager = tls->GetUpdateManager();
 227     SetDefaultSurfaceRectMessage( updateManager, newSize );
 228     SetDefaultSurfaceOrientationMessage( updateManager, mSurfaceOrientation );
 229
 230     // set default render-task viewport parameters
 231     RenderTaskPtr defaultRenderTask = mRenderTaskList->GetTask( 0u );
 232     defaultRenderTask->SetViewport( newSize );
 233   }
 234 }
 235
 236 void Scene::SurfaceReplaced()
 237 {
 238   if ( mSceneObject )
 239   {
 240     ThreadLocalStorage* tls = ThreadLocalStorage::GetInternal();
 241     SurfaceReplacedMessage( tls->GetUpdateManager(), *mSceneObject );
 242   }
 243 }
 244
 245 void Scene::Discard()
 246 {
 247   if( ThreadLocalStorage::Created() )
 248   {
 249     ThreadLocalStorage* tls = ThreadLocalStorage::GetInternal();
 250     tls->RemoveScene( this );
 251   }
 252 }
 253
 254 void Scene::RequestRebuildDepthTree()
 255 {
 256   mDepthTreeDirty = true;
 257 }
 258
 259 void Scene::QueueEvent( const Integration::Event& event )
 260 {
 261   mEventProcessor.QueueEvent( event );
 262 }
 263
 264 void Scene::ProcessEvents()
 265 {
 266   mEventProcessor.ProcessEvents();
 267 }
 268
 269 void Scene::RebuildDepthTree()
 270 {
 271   // If the depth tree needs rebuilding, do it in this frame only.
 272   if( mDepthTreeDirty )
 273   {
 274     ActorPtr actor( mRootLayer.Get() );
 275     actor->RebuildDepthTree();
 276     mDepthTreeDirty = false;
 277   }
 278 }
 279
 280 void Scene::SetBackgroundColor( const Vector4& color )
 281 {
 282   mBackgroundColor = color;
 283
 284   mRenderTaskList->GetTask( 0u )->SetClearColor( color );
 285   mRenderTaskList->GetTask( 0u )->SetClearEnabled( true );
 286 }
 287
 288 Vector4 Scene::GetBackgroundColor() const
 289 {
 290   return mBackgroundColor;
 291 }
 292
 293 SceneGraph::Scene* Scene::GetSceneObject() const
 294 {
 295   return mSceneObject;
 296 }
 297
 298 void Scene::EmitKeyEventSignal(const KeyEvent& event)
 299 {
 300   if ( !mKeyEventSignal.Empty() )
 301   {
 302     Dali::Integration::Scene handle( this );
 303     mKeyEventSignal.Emit( event );
 304   }
 305 }
 306
 307 bool Scene::EmitKeyEventGeneratedSignal(const KeyEvent& event)
 308 {
 309   // Emit the KeyEventGenerated signal when KeyEvent is generated
 310   return mKeyEventGeneratedSignal.Emit( event );
 311 }
 312
 313 void Scene::EmitEventProcessingFinishedSignal()
 314 {
 315   if ( !mEventProcessingFinishedSignal.Empty() )
 316   {
 317     Dali::Integration::Scene handle( this );
 318     mEventProcessingFinishedSignal.Emit();
 319   }
 320 }
 321
 322 void Scene::EmitTouchedSignal( const TouchEvent& touchEvent, const Dali::TouchData& touch )
 323 {
 324   Dali::Integration::Scene handle( this );
 325   if ( !mTouchedSignal.Empty() )
 326   {
 327     mTouchedSignal.Emit( touchEvent );
 328   }
 329   if ( !mTouchSignal.Empty() )
 330   {
 331     mTouchSignal.Emit( touch );
 332   }
 333 }
 334
 335 void Scene::EmitWheelEventSignal(const WheelEvent& event)
 336 {
 337   if ( !mWheelEventSignal.Empty() )
 338   {
 339     Dali::Integration::Scene handle( this );
 340     mWheelEventSignal.Emit( event );
 341   }
 342 }
 343
 344 Integration::Scene::KeyEventSignalType& Scene::KeyEventSignal()
 345 {
 346   return mKeyEventSignal;
 347 }
 348
 349 Integration::Scene::KeyEventGeneratedSignalType& Scene::KeyEventGeneratedSignal()
 350 {
 351   return mKeyEventGeneratedSignal;
 352 }
 353
 354 Integration::Scene::EventProcessingFinishedSignalType& Scene::EventProcessingFinishedSignal()
 355 {
 356   return mEventProcessingFinishedSignal;
 357 }
 358
 359 Scene::TouchedSignalType& Scene::TouchedSignal()
 360 {
 361   return mTouchedSignal;
 362 }
 363
 364 Integration::Scene::TouchSignalType& Scene::TouchSignal()
 365 {
 366   return mTouchSignal;
 367 }
 368
 369 Integration::Scene::WheelEventSignalType& Scene::WheelEventSignal()
 370 {
 371   return mWheelEventSignal;
 372 }
 373
 374 } // Internal
 375
 376 } // Dali