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 mDepthTreeDirty( false ),
68 mEventProcessor( *this, ThreadLocalStorage::GetInternal()->GetGestureEventProcessor() )
74 if( EventThreadServices::IsCoreRunning() && mSceneObject )
76 ThreadLocalStorage* tls = ThreadLocalStorage::GetInternal();
77 RemoveSceneMessage( tls->GetUpdateManager(), *mSceneObject );
82 // its enough to release the handle so the object is released
83 // don't need to remove it from root actor as root actor will delete the object
84 mDefaultCamera.Reset();
89 // we are closing down so just delete the root, no point emit disconnect
90 // signals or send messages to update
96 mRenderTaskList.Reset();
99 // No need to discard this Scene from Core, as Core stores an intrusive_ptr to this scene
100 // When this destructor is called, the scene has either already been removed from Core or Core has already been destroyed
103 void Scene::Initialize( Size size )
105 ThreadLocalStorage* tls = ThreadLocalStorage::GetInternal();
107 DALI_ASSERT_ALWAYS( tls && "Attempt to create scene before core exists!" );
109 tls->AddScene( this );
111 SceneGraph::UpdateManager& updateManager = tls->GetUpdateManager();
113 // Create the ordered list of layers
114 mLayerList = LayerList::New( updateManager );
116 // The scene owns the default layer
117 mRootLayer = Layer::NewRoot( *mLayerList );
118 mRootLayer->SetName("RootLayer");
119 mRootLayer->SetScene( *this );
121 // The root layer needs to have a fixed resize policy (as opposed to the default USE_NATURAL_SIZE).
122 // This stops actors parented to the stage having their relayout requests propagating
123 // up to the root layer, and down through other children unnecessarily.
124 mRootLayer->SetResizePolicy( ResizePolicy::FIXED, Dimension::ALL_DIMENSIONS );
126 // Create the default camera actor first; this is needed by the RenderTaskList
127 // The default camera attributes and position is such that children of the default layer,
128 // can be positioned at (0,0) and be at the top-left of the viewport.
129 mDefaultCamera = CameraActor::New( size );
130 mDefaultCamera->SetParentOrigin(ParentOrigin::CENTER);
131 Add(*(mDefaultCamera.Get()));
133 // Create the list of render-tasks
134 mRenderTaskList = RenderTaskList::New();
136 // Create the default render-task
137 mRenderTaskList->CreateTask( mRootLayer.Get(), mDefaultCamera.Get() );
139 SurfaceResized( size.width, size.height );
141 // Create scene graph object
142 mSceneObject = new SceneGraph::Scene();
143 OwnerPointer< SceneGraph::Scene > transferOwnership( const_cast< SceneGraph::Scene* >( mSceneObject ) );
144 AddSceneMessage( updateManager, transferOwnership );
147 void Scene::Add(Actor& actor)
149 mRootLayer->Add( actor );
152 void Scene::Remove(Actor& actor)
154 mRootLayer->Remove( actor );
157 Size Scene::GetSize() const
162 void Scene::SetDpi(Vector2 dpi)
167 Vector2 Scene::GetDpi() const
172 RenderTaskList& Scene::GetRenderTaskList() const
174 return *mRenderTaskList;
177 Dali::Layer Scene::GetRootLayer() const
179 return Dali::Layer( mRootLayer.Get() );
182 LayerList& Scene::GetLayerList() const
187 uint32_t Scene::GetLayerCount() const
189 return mLayerList->GetLayerCount();
192 Dali::Layer Scene::GetLayer( uint32_t depth ) const
194 return Dali::Layer(mLayerList->GetLayer( depth ));
197 CameraActor& Scene::GetDefaultCameraActor()
199 return *mDefaultCamera;
202 Actor& Scene::GetDefaultRootActor()
207 void Scene::SurfaceResized( float width, float height )
209 if( ( fabsf( mSize.width - width ) > Math::MACHINE_EPSILON_1 ) || ( fabsf( mSize.height - height ) > Math::MACHINE_EPSILON_1 ) )
211 Rect< int32_t > newSize( 0, 0, static_cast< int32_t >( width ), static_cast< int32_t >( height ) ); // truncated
214 mSize.height = height;
216 // Calculates the aspect ratio, near and far clipping planes, field of view and camera Z position.
217 mDefaultCamera->SetPerspectiveProjection( mSize );
219 mRootLayer->SetSize( mSize.width, mSize.height );
221 ThreadLocalStorage* tls = ThreadLocalStorage::GetInternal();
222 SceneGraph::UpdateManager& updateManager = tls->GetUpdateManager();
223 SetDefaultSurfaceRectMessage( updateManager, newSize );
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 KeyEvent& event)
295 if ( !mKeyEventSignal.Empty() )
297 Dali::Integration::Scene handle( this );
298 mKeyEventSignal.Emit( event );
302 bool Scene::EmitKeyEventGeneratedSignal(const KeyEvent& event)
304 // Emit the KeyEventGenerated signal when KeyEvent is generated
305 return mKeyEventGeneratedSignal.Emit( event );
308 void Scene::EmitEventProcessingFinishedSignal()
310 if ( !mEventProcessingFinishedSignal.Empty() )
312 Dali::Integration::Scene handle( this );
313 mEventProcessingFinishedSignal.Emit();
317 void Scene::EmitTouchedSignal( const TouchEvent& touchEvent, const Dali::TouchData& touch )
319 Dali::Integration::Scene handle( this );
320 if ( !mTouchedSignal.Empty() )
322 mTouchedSignal.Emit( touchEvent );
324 if ( !mTouchSignal.Empty() )
326 mTouchSignal.Emit( touch );
330 void Scene::EmitWheelEventSignal(const WheelEvent& event)
332 if ( !mWheelEventSignal.Empty() )
334 Dali::Integration::Scene handle( this );
335 mWheelEventSignal.Emit( event );
339 Integration::Scene::KeyEventSignalType& Scene::KeyEventSignal()
341 return mKeyEventSignal;
344 Integration::Scene::KeyEventGeneratedSignalType& Scene::KeyEventGeneratedSignal()
346 return mKeyEventGeneratedSignal;
349 Integration::Scene::EventProcessingFinishedSignalType& Scene::EventProcessingFinishedSignal()
351 return mEventProcessingFinishedSignal;
354 Scene::TouchedSignalType& Scene::TouchedSignal()
356 return mTouchedSignal;
359 Integration::Scene::TouchSignalType& Scene::TouchSignal()
364 Integration::Scene::WheelEventSignalType& Scene::WheelEventSignal()
366 return mWheelEventSignal;