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