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/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>
37 using Dali::Internal::SceneGraph::Node;
48 const Vector4 DEFAULT_BACKGROUND_COLOR(0.0f, 0.0f, 0.0f, 1.0f); // Default background color
52 ScenePtr Scene::New( Size size )
54 ScenePtr scene = new Scene;
56 // Second-phase construction
57 scene->Initialize( size );
63 : mSceneObject( nullptr ),
64 mSize(), // Don't set the proper value here, this will be set when the surface is set later
66 mBackgroundColor( DEFAULT_BACKGROUND_COLOR ),
67 mSurfaceOrientation( 0 ),
68 mDepthTreeDirty( false ),
69 mEventProcessor( *this, ThreadLocalStorage::GetInternal()->GetGestureEventProcessor() )
75 if( EventThreadServices::IsCoreRunning() && mSceneObject )
77 ThreadLocalStorage* tls = ThreadLocalStorage::GetInternal();
78 RemoveSceneMessage( tls->GetUpdateManager(), *mSceneObject );
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();
90 // we are closing down so just delete the root, no point emit disconnect
91 // signals or send messages to update
97 mRenderTaskList.Reset();
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
104 void Scene::Initialize( Size size )
106 ThreadLocalStorage* tls = ThreadLocalStorage::GetInternal();
108 DALI_ASSERT_ALWAYS( tls && "Attempt to create scene before core exists!" );
110 tls->AddScene( this );
112 SceneGraph::UpdateManager& updateManager = tls->GetUpdateManager();
114 // Create the ordered list of layers
115 mLayerList = LayerList::New( updateManager );
117 // The scene owns the default layer
118 mRootLayer = Layer::NewRoot( *mLayerList );
119 mRootLayer->SetName("RootLayer");
120 mRootLayer->SetScene( *this );
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 );
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()));
134 // Create the list of render-tasks
135 mRenderTaskList = RenderTaskList::New();
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);
141 SurfaceResized( size.width, size.height, mSurfaceOrientation, false );
143 // Create scene graph object
144 mSceneObject = new SceneGraph::Scene();
145 OwnerPointer< SceneGraph::Scene > transferOwnership( const_cast< SceneGraph::Scene* >( mSceneObject ) );
146 AddSceneMessage( updateManager, transferOwnership );
149 void Scene::Add(Actor& actor)
151 mRootLayer->Add( actor );
154 void Scene::Remove(Actor& actor)
156 mRootLayer->Remove( actor );
159 Size Scene::GetSize() const
164 void Scene::SetDpi(Vector2 dpi)
169 Vector2 Scene::GetDpi() const
174 RenderTaskList& Scene::GetRenderTaskList() const
176 return *mRenderTaskList;
179 Dali::Layer Scene::GetRootLayer() const
181 return Dali::Layer( mRootLayer.Get() );
184 LayerList& Scene::GetLayerList() const
189 uint32_t Scene::GetLayerCount() const
191 return mLayerList->GetLayerCount();
194 Dali::Layer Scene::GetLayer( uint32_t depth ) const
196 return Dali::Layer(mLayerList->GetLayer( depth ));
199 CameraActor& Scene::GetDefaultCameraActor()
201 return *mDefaultCamera;
204 Actor& Scene::GetDefaultRootActor()
209 void Scene::SurfaceResized( float width, float height, int orientation, bool forceUpdate )
211 if( ( fabsf( mSize.width - width ) > Math::MACHINE_EPSILON_1 ) || ( fabsf( mSize.height - height ) > Math::MACHINE_EPSILON_1 )
212 || ( orientation != mSurfaceOrientation ) || ( forceUpdate ) )
214 Rect< int32_t > newSize( 0, 0, static_cast< int32_t >( width ), static_cast< int32_t >( height ) ); // truncated
217 mSize.height = height;
218 mSurfaceOrientation = orientation;
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 );
224 mRootLayer->SetSize( mSize.width, mSize.height );
226 ThreadLocalStorage* tls = ThreadLocalStorage::GetInternal();
227 SceneGraph::UpdateManager& updateManager = tls->GetUpdateManager();
228 SetDefaultSurfaceRectMessage( updateManager, newSize );
229 SetDefaultSurfaceOrientationMessage( updateManager, mSurfaceOrientation );
231 // set default render-task viewport parameters
232 RenderTaskPtr defaultRenderTask = mRenderTaskList->GetTask( 0u );
233 defaultRenderTask->SetViewport( newSize );
237 void Scene::SurfaceReplaced()
241 ThreadLocalStorage* tls = ThreadLocalStorage::GetInternal();
242 SurfaceReplacedMessage( tls->GetUpdateManager(), *mSceneObject );
246 void Scene::Discard()
248 if( ThreadLocalStorage::Created() )
250 ThreadLocalStorage* tls = ThreadLocalStorage::GetInternal();
251 tls->RemoveScene( this );
255 void Scene::RequestRebuildDepthTree()
257 mDepthTreeDirty = true;
260 void Scene::QueueEvent( const Integration::Event& event )
262 mEventProcessor.QueueEvent( event );
265 void Scene::ProcessEvents()
267 mEventProcessor.ProcessEvents();
270 void Scene::RebuildDepthTree()
272 // If the depth tree needs rebuilding, do it in this frame only.
273 if( mDepthTreeDirty )
275 ActorPtr actor( mRootLayer.Get() );
276 actor->RebuildDepthTree();
277 mDepthTreeDirty = false;
281 void Scene::SetBackgroundColor( const Vector4& color )
283 mBackgroundColor = color;
285 mRenderTaskList->GetTask( 0u )->SetClearColor( color );
286 mRenderTaskList->GetTask( 0u )->SetClearEnabled( true );
289 Vector4 Scene::GetBackgroundColor() const
291 return mBackgroundColor;
294 SceneGraph::Scene* Scene::GetSceneObject() const
299 void Scene::EmitKeyEventSignal(const KeyEvent& event)
301 if ( !mKeyEventSignal.Empty() )
303 Dali::Integration::Scene handle( this );
304 mKeyEventSignal.Emit( event );
308 bool Scene::EmitKeyEventGeneratedSignal(const KeyEvent& event)
310 // Emit the KeyEventGenerated signal when KeyEvent is generated
311 return mKeyEventGeneratedSignal.Emit( event );
314 void Scene::EmitEventProcessingFinishedSignal()
316 if ( !mEventProcessingFinishedSignal.Empty() )
318 Dali::Integration::Scene handle( this );
319 mEventProcessingFinishedSignal.Emit();
323 void Scene::EmitTouchedSignal( const TouchEvent& touchEvent, const Dali::TouchData& touch )
325 Dali::Integration::Scene handle( this );
326 if ( !mTouchedSignal.Empty() )
328 mTouchedSignal.Emit( touchEvent );
330 if ( !mTouchSignal.Empty() )
332 mTouchSignal.Emit( touch );
336 void Scene::EmitWheelEventSignal(const WheelEvent& event)
338 if ( !mWheelEventSignal.Empty() )
340 Dali::Integration::Scene handle( this );
341 mWheelEventSignal.Emit( event );
345 Integration::Scene::KeyEventSignalType& Scene::KeyEventSignal()
347 return mKeyEventSignal;
350 Integration::Scene::KeyEventGeneratedSignalType& Scene::KeyEventGeneratedSignal()
352 return mKeyEventGeneratedSignal;
355 Integration::Scene::EventProcessingFinishedSignalType& Scene::EventProcessingFinishedSignal()
357 return mEventProcessingFinishedSignal;
360 Scene::TouchedSignalType& Scene::TouchedSignal()
362 return mTouchedSignal;
365 Integration::Scene::TouchSignalType& Scene::TouchSignal()
370 Integration::Scene::WheelEventSignalType& Scene::WheelEventSignal()
372 return mWheelEventSignal;