2 * Copyright (c) 2023 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),
70 // its enough to release the handle so the object is released
71 // don't need to remove it from root actor as root actor will delete the object
72 mDefaultCamera.Reset();
77 // we are closing down so just delete the root, no point emit disconnect
78 // signals or send messages to update
84 mOverlayLayer.Reset();
89 mRenderTaskList.Reset();
92 // No need to discard this Scene from Core, as Core stores an intrusive_ptr to this scene
93 // When this destructor is called, the scene has either already been removed from Core or Core has already been destroyed
96 void Scene::Initialize(Size size, int32_t windowOrientation, int32_t screenOrientation)
98 ThreadLocalStorage* tls = ThreadLocalStorage::GetInternal();
100 DALI_ASSERT_ALWAYS(tls && "Attempt to create scene before core exists!");
104 SceneGraph::UpdateManager& updateManager = tls->GetUpdateManager();
106 // Create the ordered list of layers
107 mLayerList = LayerList::New(updateManager);
109 // The scene owns the default layer
110 mRootLayer = Layer::NewRoot(*mLayerList);
111 mRootLayer->SetName("RootLayer");
112 mRootLayer->SetScene(*this);
114 // The root layer needs to have a fixed resize policy (as opposed to the default USE_NATURAL_SIZE).
115 // This stops actors parented to the stage having their relayout requests propagating
116 // up to the root layer, and down through other children unnecessarily.
117 mRootLayer->SetResizePolicy(ResizePolicy::FIXED, Dimension::ALL_DIMENSIONS);
119 // Create the default camera actor first; this is needed by the RenderTaskList
120 // The default camera attributes and position is such that children of the default layer,
121 // can be positioned at (0,0) and be at the top-left of the viewport.
122 mDefaultCamera = CameraActor::New(size);
123 mDefaultCamera->SetParentOrigin(ParentOrigin::CENTER);
124 Add(*(mDefaultCamera.Get()));
126 // Create the list of render-tasks
127 mRenderTaskList = RenderTaskList::New();
129 // Create the default render-task and ensure clear is enabled on it to show the background color
130 RenderTaskPtr renderTask = mRenderTaskList->CreateTask(mRootLayer.Get(), mDefaultCamera.Get());
131 renderTask->SetClearEnabled(true);
133 // Create scene graph object
134 mSceneObject = new SceneGraph::Scene();
135 OwnerPointer<SceneGraph::Scene> transferOwnership(const_cast<SceneGraph::Scene*>(mSceneObject));
136 AddSceneMessage(updateManager, transferOwnership);
138 SurfaceRotated(size.width, size.height, windowOrientation, screenOrientation);
141 void Scene::Add(Actor& actor)
143 mRootLayer->Add(actor);
146 void Scene::Remove(Actor& actor)
148 mRootLayer->Remove(actor);
151 Size Scene::GetSize() const
156 void Scene::SetDpi(Vector2 dpi)
161 Vector2 Scene::GetDpi() const
166 RenderTaskList& Scene::GetRenderTaskList() const
168 return *mRenderTaskList;
171 Dali::Layer Scene::GetRootLayer() const
173 return Dali::Layer(mRootLayer.Get());
176 Dali::Layer Scene::GetOverlayLayer()
180 // Creates overlay layer.
181 mOverlayLayer = Layer::New();
182 mOverlayLayer->SetName("OverlayLayer");
183 mOverlayLayer->SetResizePolicy(ResizePolicy::FILL_TO_PARENT, Dimension::ALL_DIMENSIONS);
184 mOverlayLayer->SetParentOrigin(Dali::ParentOrigin::TOP_LEFT);
185 mOverlayLayer->SetAnchorPoint(Dali::AnchorPoint::TOP_LEFT);
186 mRootLayer->Add(*mOverlayLayer);
188 // Create the overlay render-task and set exclusive to true.
189 RenderTaskPtr renderTask = mRenderTaskList->CreateOverlayTask(mOverlayLayer.Get(), mDefaultCamera.Get());
190 renderTask->SetExclusive(true);
191 renderTask->SetInputEnabled(true);
193 return Dali::Layer(mOverlayLayer.Get());
196 LayerList& Scene::GetLayerList() const
201 uint32_t Scene::GetLayerCount() const
203 return mLayerList->GetLayerCount();
206 Dali::Layer Scene::GetLayer(uint32_t depth) const
208 return Dali::Layer(mLayerList->GetLayer(depth));
211 CameraActor& Scene::GetDefaultCameraActor() const
213 return *mDefaultCamera;
216 Actor& Scene::GetDefaultRootActor()
221 void Scene::SurfaceResized(float width, float height)
223 if((fabsf(mSize.width - width) > Math::MACHINE_EPSILON_1) || (fabsf(mSize.height - height) > Math::MACHINE_EPSILON_1))
225 ChangedSurface(width, height, mSurfaceOrientation, mScreenOrientation);
229 void Scene::SurfaceReplaced()
233 ThreadLocalStorage* tls = ThreadLocalStorage::GetInternal();
234 SurfaceReplacedMessage(tls->GetUpdateManager(), *mSceneObject);
238 void Scene::RemoveSceneObject()
240 if(EventThreadServices::IsCoreRunning() && mSceneObject)
242 ThreadLocalStorage* tls = ThreadLocalStorage::GetInternal();
243 RemoveSceneMessage(tls->GetUpdateManager(), *mSceneObject);
244 mSceneObject = nullptr;
248 void Scene::Discard()
250 if(EventThreadServices::IsCoreRunning())
252 ThreadLocalStorage* tls = ThreadLocalStorage::GetInternal();
253 tls->RemoveScene(this);
257 void Scene::RequestRebuildDepthTree()
259 mDepthTreeDirty = true;
262 void Scene::QueueEvent(const Integration::Event& event)
264 mEventProcessor.QueueEvent(event);
267 void Scene::ProcessEvents()
269 mEventProcessor.ProcessEvents();
272 void Scene::RebuildDepthTree()
274 // If the depth tree needs rebuilding, do it in this frame only.
277 ActorPtr actor(mRootLayer.Get());
278 actor->RebuildDepthTree();
279 mDepthTreeDirty = false;
283 void Scene::SetBackgroundColor(const Vector4& color)
285 mBackgroundColor = color;
287 mRenderTaskList->GetTask(0u)->SetClearColor(color);
288 mRenderTaskList->GetTask(0u)->SetClearEnabled(true);
291 Vector4 Scene::GetBackgroundColor() const
293 return mBackgroundColor;
296 SceneGraph::Scene* Scene::GetSceneObject() const
301 void Scene::EmitKeyEventSignal(const Dali::KeyEvent& event)
303 if(!mKeyEventSignal.Empty())
305 Dali::Integration::Scene handle(this);
306 mKeyEventSignal.Emit(event);
310 void Scene::SurfaceRotated(float width, float height, int32_t windowOrientation, int32_t screenOrientation)
312 ChangedSurface(width, height, windowOrientation, screenOrientation);
315 int32_t Scene::GetCurrentSurfaceOrientation() const
317 return mSceneObject ? mSceneObject->GetSurfaceOrientation() : 0;
320 int32_t Scene::GetCurrentScreenOrientation() const
322 return mSceneObject ? mSceneObject->GetScreenOrientation() : 0;
325 const Rect<int32_t>& Scene::GetCurrentSurfaceRect() const
327 static Rect<int32_t> emptyRect{};
328 return mSceneObject ? mSceneObject->GetSurfaceRect() : emptyRect;
331 void Scene::ChangedSurface(float width, float height, int32_t windowOrientation, int32_t screenOrientation)
333 bool changedOrientation = false;
334 Rect<int32_t> newSize(0, 0, static_cast<int32_t>(width), static_cast<int32_t>(height)); // truncated
336 mSize.height = height;
338 if(mSurfaceOrientation != windowOrientation || mScreenOrientation != screenOrientation)
340 changedOrientation = true;
343 mSurfaceOrientation = windowOrientation;
344 mScreenOrientation = screenOrientation;
346 // Calculates the aspect ratio, near and far clipping planes, field of view and camera Z position.
347 mDefaultCamera->SetPerspectiveProjection(mSize);
348 // Set the surface orientation to Default camera for window/screen rotation
349 if(changedOrientation)
351 int32_t orientation = (windowOrientation + screenOrientation) % 360;
352 mDefaultCamera->RotateProjection(orientation);
355 mRootLayer->SetSize(width, height);
357 // Send the surface rectangle/orientation to SceneGraph::Scene for calculating glViewport/Scissor
358 ThreadLocalStorage* tls = ThreadLocalStorage::GetInternal();
359 DALI_LOG_RELEASE_INFO("Send Surface Rect Message, width[%d], height[%d]\n", newSize.width, newSize.height);
360 SetSurfaceRectMessage(tls->GetEventThreadServices(), *mSceneObject, newSize);
361 if(changedOrientation)
363 DALI_LOG_RELEASE_INFO("Send Surface Orientation Message, surface orientation[%d], screen orientation[%d]\n", mSurfaceOrientation, mScreenOrientation);
364 SetSurfaceOrientationsMessage(tls->GetEventThreadServices(), *mSceneObject, mSurfaceOrientation, mScreenOrientation);
367 // set default render-task viewport parameters
368 RenderTaskPtr defaultRenderTask = mRenderTaskList->GetTask(0u);
369 defaultRenderTask->SetViewport(newSize);
370 // set overlay render-task viewport parameters
371 RenderTaskPtr overlayRenderTask = mRenderTaskList->GetOverlayTask();
372 if(overlayRenderTask)
374 overlayRenderTask->SetViewport(newSize);
378 bool Scene::IsSurfaceRectChanged() const
380 return mSceneObject ? mSceneObject->IsSurfaceRectChanged() : false;
383 bool Scene::IsRotationCompletedAcknowledgementSet() const
385 return mSceneObject ? mSceneObject->IsRotationCompletedAcknowledgementSet() : false;
388 void Scene::SetRotationCompletedAcknowledgement()
390 ThreadLocalStorage* tls = ThreadLocalStorage::GetInternal();
391 SetRotationCompletedAcknowledgementMessage(tls->GetEventThreadServices(), *mSceneObject);
394 void Scene::SetSurfaceRenderTarget(const Graphics::RenderTargetCreateInfo& renderTargetCreateInfo)
396 // Send the surface render target to SceneGraph::Scene
397 ThreadLocalStorage* tls = ThreadLocalStorage::GetInternal();
398 SetSurfaceRenderTargetCreateInfoMessage(tls->GetEventThreadServices(), *mSceneObject, renderTargetCreateInfo);
401 bool Scene::EmitKeyEventGeneratedSignal(const Dali::KeyEvent& event)
403 // Emit the KeyEventGenerated signal when KeyEvent is generated
404 Dali::Integration::Scene handle(this);
405 return mKeyEventGeneratedSignal.Emit(event);
408 bool Scene::EmitInterceptKeyEventSignal(const Dali::KeyEvent& event)
410 // Emit the InterceptKeyEvent signal
411 Dali::Integration::Scene handle(this);
412 return mInterceptKeyEventSignal.Emit(event);
415 void Scene::EmitEventProcessingFinishedSignal()
417 if(!mEventProcessingFinishedSignal.Empty())
419 Dali::Integration::Scene handle(this);
420 mEventProcessingFinishedSignal.Emit();
424 void Scene::EmitTouchedSignal(const Dali::TouchEvent& touch)
426 Dali::Integration::Scene handle(this);
427 if(!mTouchedSignal.Empty())
429 mTouchedSignal.Emit(touch);
433 void Scene::EmitWheelEventSignal(const Dali::WheelEvent& event)
435 if(!mWheelEventSignal.Empty())
437 Dali::Integration::Scene handle(this);
438 mWheelEventSignal.Emit(event);
442 bool Scene::EmitWheelEventGeneratedSignal(const Dali::WheelEvent& event)
444 // Emit the WheelEventGenerated signal when WheelEvent is generated
445 Dali::Integration::Scene handle(this);
446 return mWheelEventGeneratedSignal.Emit(event);
449 void Scene::AddFrameRenderedCallback(std::unique_ptr<CallbackBase> callback, int32_t frameId)
451 ThreadLocalStorage* tls = ThreadLocalStorage::GetInternal();
452 AddFrameRenderedCallbackMessage(tls->GetEventThreadServices(), *mSceneObject, callback.release(), frameId);
455 void Scene::AddFramePresentedCallback(std::unique_ptr<CallbackBase> callback, int32_t frameId)
457 ThreadLocalStorage* tls = ThreadLocalStorage::GetInternal();
458 AddFramePresentedCallbackMessage(tls->GetEventThreadServices(), *mSceneObject, callback.release(), frameId);
461 void Scene::GetFrameRenderedCallback(Dali::Integration::Scene::FrameCallbackContainer& callbacks)
465 mSceneObject->GetFrameRenderedCallback(callbacks);
469 void Scene::GetFramePresentedCallback(Dali::Integration::Scene::FrameCallbackContainer& callbacks)
473 mSceneObject->GetFramePresentedCallback(callbacks);
477 void Scene::KeepRendering(float durationSeconds)
479 ThreadLocalStorage* tls = ThreadLocalStorage::GetInternal();
480 KeepRenderingMessage(tls->GetEventThreadServices(), *mSceneObject, durationSeconds);
483 Integration::Scene::KeyEventSignalType& Scene::KeyEventSignal()
485 return mKeyEventSignal;
488 Integration::Scene::KeyEventGeneratedSignalType& Scene::KeyEventGeneratedSignal()
490 return mKeyEventGeneratedSignal;
493 Integration::Scene::KeyEventGeneratedSignalType& Scene::InterceptKeyEventSignal()
495 return mInterceptKeyEventSignal;
498 Integration::Scene::EventProcessingFinishedSignalType& Scene::EventProcessingFinishedSignal()
500 return mEventProcessingFinishedSignal;
503 Integration::Scene::TouchEventSignalType& Scene::TouchedSignal()
505 return mTouchedSignal;
508 Integration::Scene::WheelEventSignalType& Scene::WheelEventSignal()
510 return mWheelEventSignal;
513 Integration::Scene::WheelEventGeneratedSignalType& Scene::WheelEventGeneratedSignal()
515 return mWheelEventGeneratedSignal;
518 } // namespace Internal