2 * Copyright (c) 2020 Samsung Electronics Co., Ltd.
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
19 #include <dali/internal/event/common/scene-impl.h>
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>
38 using Dali::Internal::SceneGraph::Node;
46 ScenePtr Scene::New( Size size )
48 ScenePtr scene = new Scene;
50 // Second-phase construction
51 scene->Initialize( size, 0 );
56 ScenePtr Scene::New( Size size, int orientation )
58 ScenePtr scene = new Scene;
60 // Second-phase construction
61 scene->Initialize( size, orientation );
67 : mSceneObject( nullptr ),
68 mSize(), // Don't set the proper value here, this will be set when the surface is set later
70 mBackgroundColor( DEFAULT_BACKGROUND_COLOR ),
71 mSurfaceOrientation( 0 ),
72 mDepthTreeDirty( false ),
73 mEventProcessor( *this, ThreadLocalStorage::GetInternal()->GetGestureEventProcessor() )
79 if( EventThreadServices::IsCoreRunning() && mSceneObject )
81 ThreadLocalStorage* tls = ThreadLocalStorage::GetInternal();
82 RemoveSceneMessage( tls->GetUpdateManager(), *mSceneObject );
87 // its enough to release the handle so the object is released
88 // don't need to remove it from root actor as root actor will delete the object
89 mDefaultCamera.Reset();
94 // we are closing down so just delete the root, no point emit disconnect
95 // signals or send messages to update
101 mRenderTaskList.Reset();
104 // No need to discard this Scene from Core, as Core stores an intrusive_ptr to this scene
105 // When this destructor is called, the scene has either already been removed from Core or Core has already been destroyed
108 void Scene::Initialize( Size size, int orientation )
110 ThreadLocalStorage* tls = ThreadLocalStorage::GetInternal();
112 DALI_ASSERT_ALWAYS( tls && "Attempt to create scene before core exists!" );
114 tls->AddScene( this );
116 SceneGraph::UpdateManager& updateManager = tls->GetUpdateManager();
118 // Create the ordered list of layers
119 mLayerList = LayerList::New( updateManager );
121 // The scene owns the default layer
122 mRootLayer = Layer::NewRoot( *mLayerList );
123 mRootLayer->SetName("RootLayer");
124 mRootLayer->SetScene( *this );
126 // The root layer needs to have a fixed resize policy (as opposed to the default USE_NATURAL_SIZE).
127 // This stops actors parented to the stage having their relayout requests propagating
128 // up to the root layer, and down through other children unnecessarily.
129 mRootLayer->SetResizePolicy( ResizePolicy::FIXED, Dimension::ALL_DIMENSIONS );
131 // Create the default camera actor first; this is needed by the RenderTaskList
132 // The default camera attributes and position is such that children of the default layer,
133 // can be positioned at (0,0) and be at the top-left of the viewport.
134 mDefaultCamera = CameraActor::New( size );
135 mDefaultCamera->SetParentOrigin(ParentOrigin::CENTER);
136 Add(*(mDefaultCamera.Get()));
138 // Create the list of render-tasks
139 mRenderTaskList = RenderTaskList::New();
141 // Create the default render-task and ensure clear is enabled on it to show the background color
142 RenderTaskPtr renderTask = mRenderTaskList->CreateTask( mRootLayer.Get(), mDefaultCamera.Get() );
143 renderTask->SetClearEnabled(true);
144 mSurfaceOrientation = orientation;
146 SurfaceResized( size.width, size.height, mSurfaceOrientation, false );
148 // Create scene graph object
149 mSceneObject = new SceneGraph::Scene();
150 OwnerPointer< SceneGraph::Scene > transferOwnership( const_cast< SceneGraph::Scene* >( mSceneObject ) );
151 AddSceneMessage( updateManager, transferOwnership );
154 void Scene::Add(Actor& actor)
156 mRootLayer->Add( actor );
159 void Scene::Remove(Actor& actor)
161 mRootLayer->Remove( actor );
164 Size Scene::GetSize() const
169 void Scene::SetDpi(Vector2 dpi)
174 Vector2 Scene::GetDpi() const
179 RenderTaskList& Scene::GetRenderTaskList() const
181 return *mRenderTaskList;
184 Dali::Layer Scene::GetRootLayer() const
186 return Dali::Layer( mRootLayer.Get() );
189 LayerList& Scene::GetLayerList() const
194 uint32_t Scene::GetLayerCount() const
196 return mLayerList->GetLayerCount();
199 Dali::Layer Scene::GetLayer( uint32_t depth ) const
201 return Dali::Layer(mLayerList->GetLayer( depth ));
204 CameraActor& Scene::GetDefaultCameraActor()
206 return *mDefaultCamera;
209 Actor& Scene::GetDefaultRootActor()
214 void Scene::SurfaceResized( float width, float height, int orientation, bool forceUpdate )
216 if( ( fabsf( mSize.width - width ) > Math::MACHINE_EPSILON_1 ) || ( fabsf( mSize.height - height ) > Math::MACHINE_EPSILON_1 )
217 || ( orientation != mSurfaceOrientation ) || ( forceUpdate ) )
219 Rect< int32_t > newSize( 0, 0, static_cast< int32_t >( width ), static_cast< int32_t >( height ) ); // truncated
222 mSize.height = height;
223 mSurfaceOrientation = orientation;
225 // Calculates the aspect ratio, near and far clipping planes, field of view and camera Z position.
226 mDefaultCamera->SetPerspectiveProjection( mSize );
227 mDefaultCamera->RotateProjection( mSurfaceOrientation );
229 mRootLayer->SetSize( mSize.width, mSize.height );
231 ThreadLocalStorage* tls = ThreadLocalStorage::GetInternal();
232 SceneGraph::UpdateManager& updateManager = tls->GetUpdateManager();
233 SetDefaultSurfaceRectMessage( updateManager, newSize );
234 SetDefaultSurfaceOrientationMessage( updateManager, mSurfaceOrientation );
236 // set default render-task viewport parameters
237 RenderTaskPtr defaultRenderTask = mRenderTaskList->GetTask( 0u );
238 defaultRenderTask->SetViewport( newSize );
242 void Scene::SurfaceReplaced()
246 ThreadLocalStorage* tls = ThreadLocalStorage::GetInternal();
247 SurfaceReplacedMessage( tls->GetUpdateManager(), *mSceneObject );
251 void Scene::Discard()
253 if( ThreadLocalStorage::Created() )
255 ThreadLocalStorage* tls = ThreadLocalStorage::GetInternal();
256 tls->RemoveScene( this );
260 void Scene::RequestRebuildDepthTree()
262 mDepthTreeDirty = true;
265 void Scene::QueueEvent( const Integration::Event& event )
267 mEventProcessor.QueueEvent( event );
270 void Scene::ProcessEvents()
272 mEventProcessor.ProcessEvents();
275 void Scene::RebuildDepthTree()
277 // If the depth tree needs rebuilding, do it in this frame only.
278 if( mDepthTreeDirty )
280 ActorPtr actor( mRootLayer.Get() );
281 actor->RebuildDepthTree();
282 mDepthTreeDirty = false;
286 void Scene::SetBackgroundColor( const Vector4& color )
288 mBackgroundColor = color;
290 mRenderTaskList->GetTask( 0u )->SetClearColor( color );
291 mRenderTaskList->GetTask( 0u )->SetClearEnabled( true );
294 Vector4 Scene::GetBackgroundColor() const
296 return mBackgroundColor;
299 SceneGraph::Scene* Scene::GetSceneObject() const
304 void Scene::EmitKeyEventSignal(const Dali::KeyEvent& event)
306 if ( !mKeyEventSignal.Empty() )
308 Dali::Integration::Scene handle( this );
309 mKeyEventSignal.Emit( event );
313 bool Scene::EmitKeyEventGeneratedSignal(const Dali::KeyEvent& event)
315 // Emit the KeyEventGenerated signal when KeyEvent is generated
316 Dali::Integration::Scene handle( this );
317 return mKeyEventGeneratedSignal.Emit( event );
320 void Scene::EmitEventProcessingFinishedSignal()
322 if ( !mEventProcessingFinishedSignal.Empty() )
324 Dali::Integration::Scene handle( this );
325 mEventProcessingFinishedSignal.Emit();
329 void Scene::EmitTouchedSignal( const Dali::TouchEvent& touch )
331 Dali::Integration::Scene handle( this );
332 if ( !mTouchedSignal.Empty() )
334 mTouchedSignal.Emit( touch );
338 void Scene::EmitWheelEventSignal(const Dali::WheelEvent& event)
340 if ( !mWheelEventSignal.Empty() )
342 Dali::Integration::Scene handle( this );
343 mWheelEventSignal.Emit( event );
347 void Scene::AddFrameRenderedCallback( std::unique_ptr< CallbackBase > callback, int32_t frameId )
349 ThreadLocalStorage* tls = ThreadLocalStorage::GetInternal();
350 AddFrameRenderedCallbackMessage( tls->GetEventThreadServices(), *mSceneObject, callback.release(), frameId );
353 void Scene::AddFramePresentedCallback( std::unique_ptr< CallbackBase > callback, int32_t frameId )
355 ThreadLocalStorage* tls = ThreadLocalStorage::GetInternal();
356 AddFramePresentedCallbackMessage( tls->GetEventThreadServices(), *mSceneObject, callback.release(), frameId );
359 void Scene::GetFrameRenderedCallback( Dali::Integration::Scene::FrameCallbackContainer& callbacks )
361 mSceneObject->GetFrameRenderedCallback( callbacks );
364 void Scene::GetFramePresentedCallback( Dali::Integration::Scene::FrameCallbackContainer& callbacks )
366 mSceneObject->GetFramePresentedCallback( callbacks );
369 Integration::Scene::KeyEventSignalType& Scene::KeyEventSignal()
371 return mKeyEventSignal;
374 Integration::Scene::KeyEventGeneratedSignalType& Scene::KeyEventGeneratedSignal()
376 return mKeyEventGeneratedSignal;
379 Integration::Scene::EventProcessingFinishedSignalType& Scene::EventProcessingFinishedSignal()
381 return mEventProcessingFinishedSignal;
384 Integration::Scene::TouchEventSignalType& Scene::TouchedSignal()
386 return mTouchedSignal;
389 Integration::Scene::WheelEventSignalType& Scene::WheelEventSignal()
391 return mWheelEventSignal;
394 std::vector<Dali::Internal::SceneGraph::DirtyRect>& Scene::GetItemsDirtyRects()
396 return mItemsDirtyRects;