2 * Copyright (c) 2021 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 orientation)
46 ScenePtr scene = new Scene;
48 // Second-phase construction
49 scene->Initialize(size, orientation);
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)
67 if(EventThreadServices::IsCoreRunning() && mSceneObject)
69 ThreadLocalStorage* tls = ThreadLocalStorage::GetInternal();
70 RemoveSceneMessage(tls->GetUpdateManager(), *mSceneObject);
75 // its enough to release the handle so the object is released
76 // don't need to remove it from root actor as root actor will delete the object
77 mDefaultCamera.Reset();
82 // we are closing down so just delete the root, no point emit disconnect
83 // signals or send messages to update
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 orientation)
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, orientation);
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 LayerList& Scene::GetLayerList() const
181 uint32_t Scene::GetLayerCount() const
183 return mLayerList->GetLayerCount();
186 Dali::Layer Scene::GetLayer(uint32_t depth) const
188 return Dali::Layer(mLayerList->GetLayer(depth));
191 CameraActor& Scene::GetDefaultCameraActor() const
193 return *mDefaultCamera;
196 Actor& Scene::GetDefaultRootActor()
201 void Scene::SurfaceResized(float width, float height)
203 if((fabsf(mSize.width - width) > Math::MACHINE_EPSILON_1) || (fabsf(mSize.height - height) > Math::MACHINE_EPSILON_1))
205 ChangedSurface(width, height, mSurfaceOrientation);
209 void Scene::SurfaceReplaced()
213 ThreadLocalStorage* tls = ThreadLocalStorage::GetInternal();
214 SurfaceReplacedMessage(tls->GetUpdateManager(), *mSceneObject);
218 void Scene::Discard()
220 if(ThreadLocalStorage::Created())
222 ThreadLocalStorage* tls = ThreadLocalStorage::GetInternal();
223 tls->RemoveScene(this);
227 void Scene::RequestRebuildDepthTree()
229 mDepthTreeDirty = true;
232 void Scene::QueueEvent(const Integration::Event& event)
234 mEventProcessor.QueueEvent(event);
237 void Scene::ProcessEvents()
239 mEventProcessor.ProcessEvents();
242 void Scene::RebuildDepthTree()
244 // If the depth tree needs rebuilding, do it in this frame only.
247 ActorPtr actor(mRootLayer.Get());
248 actor->RebuildDepthTree();
249 mDepthTreeDirty = false;
253 void Scene::SetBackgroundColor(const Vector4& color)
255 mBackgroundColor = color;
257 mRenderTaskList->GetTask(0u)->SetClearColor(color);
258 mRenderTaskList->GetTask(0u)->SetClearEnabled(true);
261 Vector4 Scene::GetBackgroundColor() const
263 return mBackgroundColor;
266 SceneGraph::Scene* Scene::GetSceneObject() const
271 void Scene::EmitKeyEventSignal(const Dali::KeyEvent& event)
273 if(!mKeyEventSignal.Empty())
275 Dali::Integration::Scene handle(this);
276 mKeyEventSignal.Emit(event);
280 void Scene::SurfaceRotated(float width, float height, int32_t orientation)
282 mSurfaceOrientation = orientation;
283 ChangedSurface(width, height, orientation);
286 int32_t Scene::GetCurrentSurfaceOrientation() const
288 return mSceneObject->GetSurfaceOrientation();
291 const Rect<int32_t>& Scene::GetCurrentSurfaceRect() const
293 return mSceneObject->GetSurfaceRect();
296 void Scene::ChangedSurface(float width, float height, int32_t orientation)
298 Rect<int32_t> newSize(0, 0, static_cast<int32_t>(width), static_cast<int32_t>(height)); // truncated
300 mSize.height = height;
302 // Calculates the aspect ratio, near and far clipping planes, field of view and camera Z position.
303 mDefaultCamera->SetPerspectiveProjection(mSize);
304 // Set the surface orientation to Default camera for window/screen rotation
305 mDefaultCamera->RotateProjection(orientation);
307 mRootLayer->SetSize(width, height);
309 // Send the surface rectangle/orientation to SceneGraph::Scene for calculating glViewport/Scissor
310 ThreadLocalStorage* tls = ThreadLocalStorage::GetInternal();
311 SetSurfaceRectMessage(tls->GetEventThreadServices(), *mSceneObject, newSize);
312 SetSurfaceOrientationMessage(tls->GetEventThreadServices(), *mSceneObject, static_cast<int32_t>(orientation));
314 // set default render-task viewport parameters
315 RenderTaskPtr defaultRenderTask = mRenderTaskList->GetTask(0u);
316 defaultRenderTask->SetViewport(newSize);
319 bool Scene::IsSurfaceRectChanged() const
321 return mSceneObject->IsSurfaceRectChanged();
324 bool Scene::IsRotationCompletedAcknowledgementSet() const
326 return mSceneObject->IsRotationCompletedAcknowledgementSet();
329 void Scene::SetRotationCompletedAcknowledgement()
331 ThreadLocalStorage* tls = ThreadLocalStorage::GetInternal();
332 SetRotationCompletedAcknowledgementMessage(tls->GetEventThreadServices(), *mSceneObject);
335 void Scene::SetSurfaceRenderTarget(Graphics::RenderTarget* renderTarget)
337 // Send the surface render target to SceneGraph::Scene
338 ThreadLocalStorage* tls = ThreadLocalStorage::GetInternal();
339 SetSurfaceRenderTargetMessage(tls->GetEventThreadServices(), *mSceneObject, renderTarget);
342 bool Scene::EmitKeyEventGeneratedSignal(const Dali::KeyEvent& event)
344 // Emit the KeyEventGenerated signal when KeyEvent is generated
345 Dali::Integration::Scene handle(this);
346 return mKeyEventGeneratedSignal.Emit(event);
349 void Scene::EmitEventProcessingFinishedSignal()
351 if(!mEventProcessingFinishedSignal.Empty())
353 Dali::Integration::Scene handle(this);
354 mEventProcessingFinishedSignal.Emit();
358 void Scene::EmitTouchedSignal(const Dali::TouchEvent& touch)
360 Dali::Integration::Scene handle(this);
361 if(!mTouchedSignal.Empty())
363 mTouchedSignal.Emit(touch);
367 void Scene::EmitWheelEventSignal(const Dali::WheelEvent& event)
369 if(!mWheelEventSignal.Empty())
371 Dali::Integration::Scene handle(this);
372 mWheelEventSignal.Emit(event);
376 void Scene::AddFrameRenderedCallback(std::unique_ptr<CallbackBase> callback, int32_t frameId)
378 ThreadLocalStorage* tls = ThreadLocalStorage::GetInternal();
379 AddFrameRenderedCallbackMessage(tls->GetEventThreadServices(), *mSceneObject, callback.release(), frameId);
382 void Scene::AddFramePresentedCallback(std::unique_ptr<CallbackBase> callback, int32_t frameId)
384 ThreadLocalStorage* tls = ThreadLocalStorage::GetInternal();
385 AddFramePresentedCallbackMessage(tls->GetEventThreadServices(), *mSceneObject, callback.release(), frameId);
388 void Scene::GetFrameRenderedCallback(Dali::Integration::Scene::FrameCallbackContainer& callbacks)
390 mSceneObject->GetFrameRenderedCallback(callbacks);
393 void Scene::GetFramePresentedCallback(Dali::Integration::Scene::FrameCallbackContainer& callbacks)
395 mSceneObject->GetFramePresentedCallback(callbacks);
398 Integration::Scene::KeyEventSignalType& Scene::KeyEventSignal()
400 return mKeyEventSignal;
403 Integration::Scene::KeyEventGeneratedSignalType& Scene::KeyEventGeneratedSignal()
405 return mKeyEventGeneratedSignal;
408 Integration::Scene::EventProcessingFinishedSignalType& Scene::EventProcessingFinishedSignal()
410 return mEventProcessingFinishedSignal;
413 Integration::Scene::TouchEventSignalType& Scene::TouchedSignal()
415 return mTouchedSignal;
418 Integration::Scene::WheelEventSignalType& Scene::WheelEventSignal()
420 return mWheelEventSignal;
423 } // namespace Internal