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 );
57 : mSceneObject( nullptr ),
58 mSize(), // Don't set the proper value here, this will be set when the surface is set later
60 mBackgroundColor( DEFAULT_BACKGROUND_COLOR ),
61 mSurfaceOrientation( 0 ),
62 mDepthTreeDirty( false ),
63 mEventProcessor( *this, ThreadLocalStorage::GetInternal()->GetGestureEventProcessor() )
69 if( EventThreadServices::IsCoreRunning() && mSceneObject )
71 ThreadLocalStorage* tls = ThreadLocalStorage::GetInternal();
72 RemoveSceneMessage( tls->GetUpdateManager(), *mSceneObject );
77 // its enough to release the handle so the object is released
78 // don't need to remove it from root actor as root actor will delete the object
79 mDefaultCamera.Reset();
84 // we are closing down so just delete the root, no point emit disconnect
85 // signals or send messages to update
91 mRenderTaskList.Reset();
94 // No need to discard this Scene from Core, as Core stores an intrusive_ptr to this scene
95 // When this destructor is called, the scene has either already been removed from Core or Core has already been destroyed
98 void Scene::Initialize( Size size )
100 ThreadLocalStorage* tls = ThreadLocalStorage::GetInternal();
102 DALI_ASSERT_ALWAYS( tls && "Attempt to create scene before core exists!" );
104 tls->AddScene( this );
106 SceneGraph::UpdateManager& updateManager = tls->GetUpdateManager();
108 // Create the ordered list of layers
109 mLayerList = LayerList::New( updateManager );
111 // The scene owns the default layer
112 mRootLayer = Layer::NewRoot( *mLayerList );
113 mRootLayer->SetName("RootLayer");
114 mRootLayer->SetScene( *this );
116 // The root layer needs to have a fixed resize policy (as opposed to the default USE_NATURAL_SIZE).
117 // This stops actors parented to the stage having their relayout requests propagating
118 // up to the root layer, and down through other children unnecessarily.
119 mRootLayer->SetResizePolicy( ResizePolicy::FIXED, Dimension::ALL_DIMENSIONS );
121 // Create the default camera actor first; this is needed by the RenderTaskList
122 // The default camera attributes and position is such that children of the default layer,
123 // can be positioned at (0,0) and be at the top-left of the viewport.
124 mDefaultCamera = CameraActor::New( size );
125 mDefaultCamera->SetParentOrigin(ParentOrigin::CENTER);
126 Add(*(mDefaultCamera.Get()));
128 // Create the list of render-tasks
129 mRenderTaskList = RenderTaskList::New();
131 // Create the default render-task and ensure clear is enabled on it to show the background color
132 RenderTaskPtr renderTask = mRenderTaskList->CreateTask( mRootLayer.Get(), mDefaultCamera.Get() );
133 renderTask->SetClearEnabled(true);
135 SurfaceResized( size.width, size.height, mSurfaceOrientation, false );
137 // Create scene graph object
138 mSceneObject = new SceneGraph::Scene();
139 OwnerPointer< SceneGraph::Scene > transferOwnership( const_cast< SceneGraph::Scene* >( mSceneObject ) );
140 AddSceneMessage( updateManager, transferOwnership );
143 void Scene::Add(Actor& actor)
145 mRootLayer->Add( actor );
148 void Scene::Remove(Actor& actor)
150 mRootLayer->Remove( actor );
153 Size Scene::GetSize() const
158 void Scene::SetDpi(Vector2 dpi)
163 Vector2 Scene::GetDpi() const
168 RenderTaskList& Scene::GetRenderTaskList() const
170 return *mRenderTaskList;
173 Dali::Layer Scene::GetRootLayer() const
175 return Dali::Layer( mRootLayer.Get() );
178 LayerList& Scene::GetLayerList() const
183 uint32_t Scene::GetLayerCount() const
185 return mLayerList->GetLayerCount();
188 Dali::Layer Scene::GetLayer( uint32_t depth ) const
190 return Dali::Layer(mLayerList->GetLayer( depth ));
193 CameraActor& Scene::GetDefaultCameraActor()
195 return *mDefaultCamera;
198 Actor& Scene::GetDefaultRootActor()
203 void Scene::SurfaceResized( float width, float height, int orientation, bool forceUpdate )
205 if( ( fabsf( mSize.width - width ) > Math::MACHINE_EPSILON_1 ) || ( fabsf( mSize.height - height ) > Math::MACHINE_EPSILON_1 )
206 || ( orientation != mSurfaceOrientation ) || ( forceUpdate ) )
208 Rect< int32_t > newSize( 0, 0, static_cast< int32_t >( width ), static_cast< int32_t >( height ) ); // truncated
211 mSize.height = height;
212 mSurfaceOrientation = orientation;
214 // Calculates the aspect ratio, near and far clipping planes, field of view and camera Z position.
215 mDefaultCamera->SetPerspectiveProjection( mSize );
216 mDefaultCamera->RotateProjection( mSurfaceOrientation );
218 mRootLayer->SetSize( mSize.width, mSize.height );
220 ThreadLocalStorage* tls = ThreadLocalStorage::GetInternal();
221 SceneGraph::UpdateManager& updateManager = tls->GetUpdateManager();
222 SetDefaultSurfaceRectMessage( updateManager, newSize );
223 SetDefaultSurfaceOrientationMessage( updateManager, mSurfaceOrientation );
225 // set default render-task viewport parameters
226 RenderTaskPtr defaultRenderTask = mRenderTaskList->GetTask( 0u );
227 defaultRenderTask->SetViewport( newSize );
231 void Scene::SurfaceReplaced()
235 ThreadLocalStorage* tls = ThreadLocalStorage::GetInternal();
236 SurfaceReplacedMessage( tls->GetUpdateManager(), *mSceneObject );
240 void Scene::Discard()
242 if( ThreadLocalStorage::Created() )
244 ThreadLocalStorage* tls = ThreadLocalStorage::GetInternal();
245 tls->RemoveScene( this );
249 void Scene::RequestRebuildDepthTree()
251 mDepthTreeDirty = true;
254 void Scene::QueueEvent( const Integration::Event& event )
256 mEventProcessor.QueueEvent( event );
259 void Scene::ProcessEvents()
261 mEventProcessor.ProcessEvents();
264 void Scene::RebuildDepthTree()
266 // If the depth tree needs rebuilding, do it in this frame only.
267 if( mDepthTreeDirty )
269 ActorPtr actor( mRootLayer.Get() );
270 actor->RebuildDepthTree();
271 mDepthTreeDirty = false;
275 void Scene::SetBackgroundColor( const Vector4& color )
277 mBackgroundColor = color;
279 mRenderTaskList->GetTask( 0u )->SetClearColor( color );
280 mRenderTaskList->GetTask( 0u )->SetClearEnabled( true );
283 Vector4 Scene::GetBackgroundColor() const
285 return mBackgroundColor;
288 SceneGraph::Scene* Scene::GetSceneObject() const
293 void Scene::EmitKeyEventSignal(const Dali::KeyEvent& event)
295 if ( !mKeyEventSignal.Empty() )
297 Dali::Integration::Scene handle( this );
298 mKeyEventSignal.Emit( event );
302 bool Scene::EmitKeyEventGeneratedSignal(const Dali::KeyEvent& event)
304 // Emit the KeyEventGenerated signal when KeyEvent is generated
305 Dali::Integration::Scene handle( this );
306 return mKeyEventGeneratedSignal.Emit( event );
309 void Scene::EmitEventProcessingFinishedSignal()
311 if ( !mEventProcessingFinishedSignal.Empty() )
313 Dali::Integration::Scene handle( this );
314 mEventProcessingFinishedSignal.Emit();
318 void Scene::EmitTouchedSignal( const Dali::TouchEvent& touch )
320 Dali::Integration::Scene handle( this );
321 if ( !mTouchedSignal.Empty() )
323 mTouchedSignal.Emit( touch );
327 void Scene::EmitWheelEventSignal(const Dali::WheelEvent& event)
329 if ( !mWheelEventSignal.Empty() )
331 Dali::Integration::Scene handle( this );
332 mWheelEventSignal.Emit( event );
336 void Scene::AddFrameRenderedCallback( std::unique_ptr< CallbackBase > callback, int32_t frameId )
338 ThreadLocalStorage* tls = ThreadLocalStorage::GetInternal();
339 AddFrameRenderedCallbackMessage( tls->GetEventThreadServices(), *mSceneObject, callback.release(), frameId );
342 void Scene::AddFramePresentedCallback( std::unique_ptr< CallbackBase > callback, int32_t frameId )
344 ThreadLocalStorage* tls = ThreadLocalStorage::GetInternal();
345 AddFramePresentedCallbackMessage( tls->GetEventThreadServices(), *mSceneObject, callback.release(), frameId );
348 void Scene::GetFrameRenderedCallback( Dali::Integration::Scene::FrameCallbackContainer& callbacks )
350 mSceneObject->GetFrameRenderedCallback( callbacks );
353 void Scene::GetFramePresentedCallback( Dali::Integration::Scene::FrameCallbackContainer& callbacks )
355 mSceneObject->GetFramePresentedCallback( callbacks );
358 Integration::Scene::KeyEventSignalType& Scene::KeyEventSignal()
360 return mKeyEventSignal;
363 Integration::Scene::KeyEventGeneratedSignalType& Scene::KeyEventGeneratedSignal()
365 return mKeyEventGeneratedSignal;
368 Integration::Scene::EventProcessingFinishedSignalType& Scene::EventProcessingFinishedSignal()
370 return mEventProcessingFinishedSignal;
373 Integration::Scene::TouchEventSignalType& Scene::TouchedSignal()
375 return mTouchedSignal;
378 Integration::Scene::WheelEventSignalType& Scene::WheelEventSignal()
380 return mWheelEventSignal;
383 std::vector<Dali::Internal::SceneGraph::DirtyRect>& Scene::GetItemsDirtyRects()
385 return mItemsDirtyRects;