1 #ifndef DALI_INTERNAL_SCENE_H
2 #define DALI_INTERNAL_SCENE_H
5 * Copyright (c) 2023 Samsung Electronics Co., Ltd.
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
22 #include <dali/integration-api/scene.h>
23 #include <dali/internal/common/owner-pointer.h>
24 #include <dali/internal/event/actors/layer-impl.h>
25 #include <dali/internal/event/events/event-processor.h>
26 #include <dali/internal/event/render-tasks/render-task-defaults.h>
27 #include <dali/public-api/actors/layer.h>
28 #include <dali/public-api/math/vector2.h>
29 #include <dali/public-api/render-tasks/render-task-list.h>
44 } // namespace SceneGraph
53 using FrameBufferPtr = IntrusivePtr<FrameBuffer>;
54 using ScenePtr = IntrusivePtr<Scene>;
57 * @brief Scene creates a "world" that can be bound to a surface for rendering.
59 class Scene : public BaseObject, public RenderTaskDefaults
63 * @copydoc Dali::Integration::Scene::New
65 static ScenePtr New(Size size, int32_t windowOrientation = 0, int32_t screenOrientation = 0);
73 * @copydoc Dali::Integration::Scene::Add
75 void Add(Actor& actor);
78 * @copydoc Dali::Integration::Scene::Remove
80 void Remove(Actor& actor);
83 * @copydoc Dali::Integration::Scene::GetSize
88 * @copydoc Dali::Integration::Scene::SetDpi
90 void SetDpi(Vector2 dpi);
93 * @copydoc Dali::Integration::Scene::GetDpi
95 Vector2 GetDpi() const;
98 * @copydoc Dali::Integration::Scene::GetRenderTaskList
100 RenderTaskList& GetRenderTaskList() const;
103 * @copydoc Dali::Integration::Scene::GetRootLayer
105 Dali::Layer GetRootLayer() const;
108 * @copydoc Dali::Integration::Scene::GetOverlayLayer
110 Dali::Layer GetOverlayLayer();
113 * @copydoc Dali::Integration::Scene::GetLayerCount
115 uint32_t GetLayerCount() const;
118 * @copydoc Dali::Integration::Scene::GetLayer
120 Dali::Layer GetLayer(uint32_t depth) const;
123 * Notify the surface has been resized.
125 * @param[in] width The new width of the set surface
126 * @param[in] height The new height of the set surface
128 void SurfaceResized(float width, float height);
131 * @copydoc Dali::Integration::Scene::SurfaceReplaced
133 void SurfaceReplaced();
136 * @copydoc Dali::Integration::Scene::RemoveSceneObject
138 void RemoveSceneObject();
141 * @copydoc Dali::Integration::Scene::Discard
146 * Retrieve the ordered list of on-scene layers.
147 * @return The layer-list.
149 LayerList& GetLayerList() const;
152 * Request that the depth tree is rebuilt
154 void RequestRebuildDepthTree();
157 * This function is called when an event is queued.
158 * @param[in] event A event to queue.
160 void QueueEvent(const Integration::Event& event);
163 * This function is called by Core when events are processed.
165 void ProcessEvents();
168 * Rebuilds the depth tree at the end of the event frame if
169 * it was requested this frame.
171 void RebuildDepthTree();
174 * @brief Sets the background color of the render surface.
175 * @param[in] color The new background color
177 void SetBackgroundColor(const Vector4& color);
180 * @brief Gets the background color of the render surface.
181 * @return The background color
183 Vector4 GetBackgroundColor() const;
186 * @brief Get the Scene scene graph object
188 * @return the Scene scene graph object
190 SceneGraph::Scene* GetSceneObject() const;
193 * Notify the surface has been rotated.
194 * When the device is rotated or the rotation event is received by display manager,
195 * this function will be called by window implementation.
197 * @param[in] width The width of rotated surface
198 * @param[in] height The height of rotated surface
199 * @param[in] windowOrientation the current window orientation
200 * @param[in] screenOrientation the current screen orientation
202 void SurfaceRotated(float width, float height, int32_t windowOrientation, int32_t screenOrientation);
205 * @copydoc Dali::Integration::Scene::SetRotationCompletedAcknowledgement
207 void SetRotationCompletedAcknowledgement();
210 * @copydoc Dali::Integration::Scene::IsRotationCompletedAcknowledgementSet
212 bool IsRotationCompletedAcknowledgementSet() const;
215 * @copydoc Dali::Integration::Scene::GetCurrentSurfaceOrientation
217 int32_t GetCurrentSurfaceOrientation() const;
220 * @copydoc Dali::Integration::Scene::GetCurrentScreenOrientation
222 int32_t GetCurrentScreenOrientation() const;
225 * @copydoc Dali::Integration::Scene::GetCurrentSurfaceRect
227 const Rect<int32_t>& GetCurrentSurfaceRect() const;
230 * @copydoc Dali::Integration::Scene::IsSurfaceRectChanged
232 bool IsSurfaceRectChanged() const;
235 * @copydoc Dali::Integration::Scene::SetSurfaceRenderTarget
237 void SetSurfaceRenderTarget(const Graphics::RenderTargetCreateInfo& renderTargetCreateInfo);
240 * Used by the EventProcessor to emit key event signals.
241 * @param[in] event The key event.
243 void EmitKeyEventSignal(const Dali::KeyEvent& event);
246 * Used by the KeyEventProcessor to emit KeyEventGenerated signals.
247 * @param[in] event The key event.
248 * @return The return is true if KeyEvent is consumed, otherwise false.
250 bool EmitKeyEventGeneratedSignal(const Dali::KeyEvent& event);
253 * Used by the KeyEventProcessor to emit InterceptKeyEventSignal signals.
254 * @param[in] event The key event.
255 * @return The return is true if KeyEvent is consumed, otherwise false.
257 bool EmitInterceptKeyEventSignal(const Dali::KeyEvent& event);
260 * Emits the event processing finished signal.
262 * @see Dali::Scene::SignalEventProcessingFinished()
264 void EmitEventProcessingFinishedSignal();
267 * Emits the touched signal.
268 * @param[in] touch The touch event details.
270 void EmitTouchedSignal(const Dali::TouchEvent& touch);
273 * Used by the EventProcessor to emit wheel event signals.
274 * @param[in] event The wheel event.
276 void EmitWheelEventSignal(const Dali::WheelEvent& event);
279 * Used by the WheelEventProcessor to emit WheelEventGenerated signals.
280 * @param[in] event The wheel event.
281 * @return The return is true if WheelEvent is consumed, otherwise false.
283 bool EmitWheelEventGeneratedSignal(const Dali::WheelEvent& event);
286 * @copydoc Dali::Integration::Scene::AddFrameRenderedCallback
288 void AddFrameRenderedCallback(std::unique_ptr<CallbackBase> callback, int32_t frameId);
291 * @copydoc Dali::Integration::Scene::AddFramePresentedCallback
293 void AddFramePresentedCallback(std::unique_ptr<CallbackBase> callback, int32_t frameId);
296 * @copydoc Dali::Integration::Scene::GetFrameRenderedCallback
298 void GetFrameRenderedCallback(Dali::Integration::Scene::FrameCallbackContainer& callbacks);
301 * @copydoc Dali::Integration::Scene::GetFramePresentedCallback
303 void GetFramePresentedCallback(Dali::Integration::Scene::FrameCallbackContainer& callbacks);
306 * @copydoc Integration::Scene::KeyEventSignal()
308 Integration::Scene::KeyEventSignalType& KeyEventSignal();
311 * @copydoc Integration::Scene::KeyEventGeneratedSignal()
313 Integration::Scene::KeyEventGeneratedSignalType& KeyEventGeneratedSignal();
316 * @copydoc Integration::Scene::InterceptKeyEventSignal()
318 Integration::Scene::KeyEventGeneratedSignalType& InterceptKeyEventSignal();
321 * @copydoc Integration::Scene::SignalEventProcessingFinished()
323 Integration::Scene::EventProcessingFinishedSignalType& EventProcessingFinishedSignal();
326 * @copydoc Integration::Scene::TouchedSignal()
328 Integration::Scene::TouchEventSignalType& TouchedSignal();
331 * @copydoc Integration::Scene::sWheelEventSignal()
333 Integration::Scene::WheelEventSignalType& WheelEventSignal();
336 * @copydoc Integration::Scene::WheelEventGeneratedSignal()
338 Integration::Scene::WheelEventGeneratedSignalType& WheelEventGeneratedSignal();
342 * From RenderTaskDefaults; retrieve the default root actor.
343 * @return The default root actor.
345 Actor& GetDefaultRootActor() override;
348 * From RenderTaskDefaults; retrieve the default camera actor.
349 * @return The default camera actor.
351 CameraActor& GetDefaultCameraActor() const override;
358 * Second-phase constructor.
360 * @param[in] size The size of the set surface
361 * @param[in] windowOrientation The rotated angle of the set surface for this scene
362 * @param[in] screenOrientation The rotated angle of the screen
364 void Initialize(Size size, int32_t windowOrientation, int32_t screenOrientation);
367 Scene(const Scene&) = delete;
370 Scene& operator=(const Scene& rhs) = delete;
373 * Informs the scene that the set surface has been resized or rotated.
375 * @param[in] width The width of rotated surface
376 * @param[in] height The height of rotated surface
377 * @param[in] windowOrientation the current window orientation
378 * @param[in] screenOrientation the current screen orientation
380 void ChangedSurface(float width, float height, int32_t windowOrientation, int32_t screenOrientation);
383 Internal::SceneGraph::Scene* mSceneObject;
389 Vector4 mBackgroundColor;
393 LayerPtr mOverlayLayer;
395 // Ordered list of currently on-stage layers
396 OwnerPointer<LayerList> mLayerList;
398 IntrusivePtr<CameraActor> mDefaultCamera;
400 // The list of render-tasks
401 IntrusivePtr<RenderTaskList> mRenderTaskList;
403 bool mDepthTreeDirty : 1; ///< True if the depth tree needs recalculating
405 EventProcessor mEventProcessor;
407 // The Surface's orientation
408 int32_t mSurfaceOrientation;
410 // The Screen's orientation
411 int32_t mScreenOrientation;
413 // The key event signal
414 Integration::Scene::KeyEventSignalType mKeyEventSignal;
415 Integration::Scene::KeyEventGeneratedSignalType mKeyEventGeneratedSignal;
416 Integration::Scene::KeyEventGeneratedSignalType mInterceptKeyEventSignal;
418 // The event processing finished signal
419 Integration::Scene::EventProcessingFinishedSignalType mEventProcessingFinishedSignal;
422 Integration::Scene::TouchEventSignalType mTouchedSignal;
424 // The wheel event signal
425 Integration::Scene::WheelEventSignalType mWheelEventSignal;
426 Integration::Scene::WheelEventGeneratedSignalType mWheelEventGeneratedSignal;
429 } // namespace Internal
431 // Get impl of handle
432 inline Internal::Scene& GetImplementation(Dali::Integration::Scene& scene)
434 DALI_ASSERT_ALWAYS(scene && "Scene handle is empty");
435 Dali::RefObject& object = scene.GetBaseObject();
436 return static_cast<Internal::Scene&>(object);
439 inline const Internal::Scene& GetImplementation(const Dali::Integration::Scene& scene)
441 DALI_ASSERT_ALWAYS(scene && "Scene handle is empty");
442 const Dali::RefObject& object = scene.GetBaseObject();
443 return static_cast<const Internal::Scene&>(object);
448 #endif // DALI_INTERNAL_SCENE_H