2 * Copyright (c) 2022 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/camera-actor-impl.h>
23 #include <dali/internal/event/actors/layer-impl.h>
24 #include <dali/internal/event/actors/layer-list.h>
25 #include <dali/internal/event/common/object-registry-impl.h>
26 #include <dali/internal/event/common/thread-local-storage.h>
27 #include <dali/internal/event/render-tasks/render-task-impl.h>
28 #include <dali/internal/event/render-tasks/render-task-list-impl.h>
29 #include <dali/internal/event/rendering/frame-buffer-impl.h>
30 #include <dali/internal/event/size-negotiation/relayout-controller-impl.h>
31 #include <dali/internal/update/common/scene-graph-scene.h>
32 #include <dali/internal/update/manager/update-manager.h>
33 #include <dali/internal/update/nodes/node.h>
34 #include <dali/public-api/common/constants.h>
35 #include <dali/public-api/object/type-registry.h>
36 #include <dali/public-api/render-tasks/render-task-list.h>
38 using Dali::Internal::SceneGraph::Node;
44 ScenePtr Scene::New(Size size, int32_t windowOrientation, int32_t screenOrientation)
46 ScenePtr scene = new Scene;
48 // Second-phase construction
49 scene->Initialize(size, windowOrientation, screenOrientation);
55 : mSceneObject(nullptr),
56 mSize(), // Don't set the proper value here, this will be set when the surface is set later
58 mBackgroundColor(DEFAULT_BACKGROUND_COLOR),
59 mDepthTreeDirty(false),
60 mEventProcessor(*this, ThreadLocalStorage::GetInternal()->GetGestureEventProcessor()),
61 mSurfaceOrientation(0),
68 if(EventThreadServices::IsCoreRunning() && mSceneObject)
70 ThreadLocalStorage* tls = ThreadLocalStorage::GetInternal();
71 RemoveSceneMessage(tls->GetUpdateManager(), *mSceneObject);
76 // its enough to release the handle so the object is released
77 // don't need to remove it from root actor as root actor will delete the object
78 mDefaultCamera.Reset();
83 // we are closing down so just delete the root, no point emit disconnect
84 // signals or send messages to update
90 mOverlayLayer.Reset();
95 mRenderTaskList.Reset();
98 // No need to discard this Scene from Core, as Core stores an intrusive_ptr to this scene
99 // When this destructor is called, the scene has either already been removed from Core or Core has already been destroyed
102 void Scene::Initialize(Size size, int32_t windowOrientation, int32_t screenOrientation)
104 ThreadLocalStorage* tls = ThreadLocalStorage::GetInternal();
106 DALI_ASSERT_ALWAYS(tls && "Attempt to create scene before core exists!");
110 SceneGraph::UpdateManager& updateManager = tls->GetUpdateManager();
112 // Create the ordered list of layers
113 mLayerList = LayerList::New(updateManager);
115 // The scene owns the default layer
116 mRootLayer = Layer::NewRoot(*mLayerList);
117 mRootLayer->SetName("RootLayer");
118 mRootLayer->SetScene(*this);
120 // The root layer needs to have a fixed resize policy (as opposed to the default USE_NATURAL_SIZE).
121 // This stops actors parented to the stage having their relayout requests propagating
122 // up to the root layer, and down through other children unnecessarily.
123 mRootLayer->SetResizePolicy(ResizePolicy::FIXED, Dimension::ALL_DIMENSIONS);
125 // Create the default camera actor first; this is needed by the RenderTaskList
126 // The default camera attributes and position is such that children of the default layer,
127 // can be positioned at (0,0) and be at the top-left of the viewport.
128 mDefaultCamera = CameraActor::New(size);
129 mDefaultCamera->SetParentOrigin(ParentOrigin::CENTER);
130 Add(*(mDefaultCamera.Get()));
132 // Create the list of render-tasks
133 mRenderTaskList = RenderTaskList::New();
135 // Create the default render-task and ensure clear is enabled on it to show the background color
136 RenderTaskPtr renderTask = mRenderTaskList->CreateTask(mRootLayer.Get(), mDefaultCamera.Get());
137 renderTask->SetClearEnabled(true);
139 // Create scene graph object
140 mSceneObject = new SceneGraph::Scene();
141 OwnerPointer<SceneGraph::Scene> transferOwnership(const_cast<SceneGraph::Scene*>(mSceneObject));
142 AddSceneMessage(updateManager, transferOwnership);
144 SurfaceRotated(size.width, size.height, windowOrientation, screenOrientation);
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 Dali::Layer Scene::GetOverlayLayer()
186 // Creates overlay layer.
187 mOverlayLayer = Layer::New();
188 mOverlayLayer->SetName("OverlayLayer");
189 mOverlayLayer->SetResizePolicy(ResizePolicy::FILL_TO_PARENT, Dimension::ALL_DIMENSIONS);
190 mOverlayLayer->SetParentOrigin(Dali::ParentOrigin::TOP_LEFT);
191 mOverlayLayer->SetAnchorPoint(Dali::AnchorPoint::TOP_LEFT);
192 mRootLayer->Add(*mOverlayLayer);
194 // Create the overlay render-task and set exclusive to true.
195 RenderTaskPtr renderTask = mRenderTaskList->CreateOverlayTask(mOverlayLayer.Get(), mDefaultCamera.Get());
196 renderTask->SetExclusive(true);
197 renderTask->SetInputEnabled(true);
199 return Dali::Layer(mOverlayLayer.Get());
202 LayerList& Scene::GetLayerList() const
207 uint32_t Scene::GetLayerCount() const
209 return mLayerList->GetLayerCount();
212 Dali::Layer Scene::GetLayer(uint32_t depth) const
214 return Dali::Layer(mLayerList->GetLayer(depth));
217 CameraActor& Scene::GetDefaultCameraActor() const
219 return *mDefaultCamera;
222 Actor& Scene::GetDefaultRootActor()
227 void Scene::SurfaceResized(float width, float height)
229 if((fabsf(mSize.width - width) > Math::MACHINE_EPSILON_1) || (fabsf(mSize.height - height) > Math::MACHINE_EPSILON_1))
231 ChangedSurface(width, height, mSurfaceOrientation, mScreenOrientation);
235 void Scene::SurfaceReplaced()
239 ThreadLocalStorage* tls = ThreadLocalStorage::GetInternal();
240 SurfaceReplacedMessage(tls->GetUpdateManager(), *mSceneObject);
244 void Scene::Discard()
246 if(ThreadLocalStorage::Created())
248 ThreadLocalStorage* tls = ThreadLocalStorage::GetInternal();
249 tls->RemoveScene(this);
253 void Scene::RequestRebuildDepthTree()
255 mDepthTreeDirty = true;
258 void Scene::QueueEvent(const Integration::Event& event)
260 mEventProcessor.QueueEvent(event);
263 void Scene::ProcessEvents()
265 mEventProcessor.ProcessEvents();
268 void Scene::RebuildDepthTree()
270 // If the depth tree needs rebuilding, do it in this frame only.
273 ActorPtr actor(mRootLayer.Get());
274 actor->RebuildDepthTree();
275 mDepthTreeDirty = false;
279 void Scene::SetBackgroundColor(const Vector4& color)
281 mBackgroundColor = color;
283 mRenderTaskList->GetTask(0u)->SetClearColor(color);
284 mRenderTaskList->GetTask(0u)->SetClearEnabled(true);
287 Vector4 Scene::GetBackgroundColor() const
289 return mBackgroundColor;
292 SceneGraph::Scene* Scene::GetSceneObject() const
297 void Scene::EmitKeyEventSignal(const Dali::KeyEvent& event)
299 if(!mKeyEventSignal.Empty())
301 Dali::Integration::Scene handle(this);
302 mKeyEventSignal.Emit(event);
306 void Scene::SurfaceRotated(float width, float height, int32_t windowOrientation, int32_t screenOrientation)
308 ChangedSurface(width, height, windowOrientation, screenOrientation);
311 int32_t Scene::GetCurrentSurfaceOrientation() const
313 return mSceneObject->GetSurfaceOrientation();
316 int32_t Scene::GetCurrentScreenOrientation() const
318 return mSceneObject->GetScreenOrientation();
321 const Rect<int32_t>& Scene::GetCurrentSurfaceRect() const
323 return mSceneObject->GetSurfaceRect();
326 void Scene::ChangedSurface(float width, float height, int32_t windowOrientation, int32_t screenOrientation)
328 bool changedOrientation = false;
329 Rect<int32_t> newSize(0, 0, static_cast<int32_t>(width), static_cast<int32_t>(height)); // truncated
331 mSize.height = height;
333 if(mSurfaceOrientation != windowOrientation || mScreenOrientation != screenOrientation)
335 changedOrientation = true;
338 mSurfaceOrientation = windowOrientation;
339 mScreenOrientation = screenOrientation;
341 // Calculates the aspect ratio, near and far clipping planes, field of view and camera Z position.
342 mDefaultCamera->SetPerspectiveProjection(mSize);
343 // Set the surface orientation to Default camera for window/screen rotation
344 if(changedOrientation)
346 int32_t orientation = (windowOrientation + screenOrientation) % 360;
347 mDefaultCamera->RotateProjection(orientation);
350 mRootLayer->SetSize(width, height);
352 // Send the surface rectangle/orientation to SceneGraph::Scene for calculating glViewport/Scissor
353 ThreadLocalStorage* tls = ThreadLocalStorage::GetInternal();
354 DALI_LOG_RELEASE_INFO("Send Surface Rect Message, width[%d], height[%d]\n", newSize.width, newSize.height);
355 SetSurfaceRectMessage(tls->GetEventThreadServices(), *mSceneObject, newSize);
356 if(changedOrientation)
358 DALI_LOG_RELEASE_INFO("Send Surface Orientation Message, surface orientation[%d], screen orientation[%d]\n", mSurfaceOrientation, mScreenOrientation);
359 SetSurfaceOrientationsMessage(tls->GetEventThreadServices(), *mSceneObject, mSurfaceOrientation, mScreenOrientation);
362 // set default render-task viewport parameters
363 RenderTaskPtr defaultRenderTask = mRenderTaskList->GetTask(0u);
364 defaultRenderTask->SetViewport(newSize);
365 // set overlay render-task viewport parameters
366 RenderTaskPtr overlayRenderTask = mRenderTaskList->GetOverlayTask();
367 if(overlayRenderTask)
369 overlayRenderTask->SetViewport(newSize);
373 bool Scene::IsSurfaceRectChanged() const
375 return mSceneObject->IsSurfaceRectChanged();
378 bool Scene::IsRotationCompletedAcknowledgementSet() const
380 return mSceneObject->IsRotationCompletedAcknowledgementSet();
383 void Scene::SetRotationCompletedAcknowledgement()
385 ThreadLocalStorage* tls = ThreadLocalStorage::GetInternal();
386 SetRotationCompletedAcknowledgementMessage(tls->GetEventThreadServices(), *mSceneObject);
389 void Scene::SetSurfaceRenderTarget(const Graphics::RenderTargetCreateInfo& renderTargetCreateInfo)
391 // Send the surface render target to SceneGraph::Scene
392 ThreadLocalStorage* tls = ThreadLocalStorage::GetInternal();
393 SetSurfaceRenderTargetCreateInfoMessage(tls->GetEventThreadServices(), *mSceneObject, renderTargetCreateInfo);
396 bool Scene::EmitKeyEventGeneratedSignal(const Dali::KeyEvent& event)
398 // Emit the KeyEventGenerated signal when KeyEvent is generated
399 Dali::Integration::Scene handle(this);
400 return mKeyEventGeneratedSignal.Emit(event);
403 bool Scene::EmitInterceptKeyEventSignal(const Dali::KeyEvent& event)
405 // Emit the InterceptKeyEvent signal
406 Dali::Integration::Scene handle(this);
407 return mInterceptKeyEventSignal.Emit(event);
410 void Scene::EmitEventProcessingFinishedSignal()
412 if(!mEventProcessingFinishedSignal.Empty())
414 Dali::Integration::Scene handle(this);
415 mEventProcessingFinishedSignal.Emit();
419 void Scene::EmitTouchedSignal(const Dali::TouchEvent& touch)
421 Dali::Integration::Scene handle(this);
422 if(!mTouchedSignal.Empty())
424 mTouchedSignal.Emit(touch);
428 void Scene::EmitWheelEventSignal(const Dali::WheelEvent& event)
430 if(!mWheelEventSignal.Empty())
432 Dali::Integration::Scene handle(this);
433 mWheelEventSignal.Emit(event);
437 bool Scene::EmitWheelEventGeneratedSignal(const Dali::WheelEvent& event)
439 // Emit the WheelEventGenerated signal when WheelEvent is generated
440 Dali::Integration::Scene handle(this);
441 return mWheelEventGeneratedSignal.Emit(event);
444 void Scene::AddFrameRenderedCallback(std::unique_ptr<CallbackBase> callback, int32_t frameId)
446 ThreadLocalStorage* tls = ThreadLocalStorage::GetInternal();
447 AddFrameRenderedCallbackMessage(tls->GetEventThreadServices(), *mSceneObject, callback.release(), frameId);
450 void Scene::AddFramePresentedCallback(std::unique_ptr<CallbackBase> callback, int32_t frameId)
452 ThreadLocalStorage* tls = ThreadLocalStorage::GetInternal();
453 AddFramePresentedCallbackMessage(tls->GetEventThreadServices(), *mSceneObject, callback.release(), frameId);
456 void Scene::GetFrameRenderedCallback(Dali::Integration::Scene::FrameCallbackContainer& callbacks)
458 mSceneObject->GetFrameRenderedCallback(callbacks);
461 void Scene::GetFramePresentedCallback(Dali::Integration::Scene::FrameCallbackContainer& callbacks)
463 mSceneObject->GetFramePresentedCallback(callbacks);
466 Integration::Scene::KeyEventSignalType& Scene::KeyEventSignal()
468 return mKeyEventSignal;
471 Integration::Scene::KeyEventGeneratedSignalType& Scene::KeyEventGeneratedSignal()
473 return mKeyEventGeneratedSignal;
476 Integration::Scene::KeyEventGeneratedSignalType& Scene::InterceptKeyEventSignal()
478 return mInterceptKeyEventSignal;
481 Integration::Scene::EventProcessingFinishedSignalType& Scene::EventProcessingFinishedSignal()
483 return mEventProcessingFinishedSignal;
486 Integration::Scene::TouchEventSignalType& Scene::TouchedSignal()
488 return mTouchedSignal;
491 Integration::Scene::WheelEventSignalType& Scene::WheelEventSignal()
493 return mWheelEventSignal;
496 Integration::Scene::WheelEventGeneratedSignalType& Scene::WheelEventGeneratedSignal()
498 return mWheelEventGeneratedSignal;
501 } // namespace Internal