1 #ifndef DALI_INTEGRATION_INTERNAL_SCENEHOLDER_H
2 #define DALI_INTEGRATION_INTERNAL_SCENEHOLDER_H
5 * Copyright (c) 2022 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/graphics-api/graphics-controller.h>
23 #include <dali/integration-api/events/key-event-integ.h>
24 #include <dali/integration-api/events/point.h>
25 #include <dali/integration-api/events/touch-event-combiner.h>
26 #include <dali/integration-api/scene.h>
27 #include <dali/public-api/common/intrusive-ptr.h>
28 #include <dali/public-api/math/uint-16-pair.h>
29 #include <dali/public-api/object/base-object.h>
35 #include <dali/integration-api/adaptor-framework/render-surface-interface.h>
36 #include <dali/integration-api/adaptor-framework/scene-holder.h>
55 } // namespace Integration
63 using SceneHolderPtr = IntrusivePtr<SceneHolder>;
66 * @brief SceneHolder creates a Scene for rendering.
68 class DALI_ADAPTOR_API SceneHolder : public BaseObject
72 * @copydoc Dali::Integration::SceneHolder::Add
74 void Add(Dali::Actor actor);
77 * @copydoc Dali::Integration::SceneHolder::Remove
79 void Remove(Dali::Actor actor);
82 * @copydoc Dali::Integration::SceneHolder::GetRootLayer
84 Dali::Layer GetRootLayer() const;
87 * @brief Gets the window name.
88 * @return The name of the window
90 std::string GetName() const;
93 * @brief Retrieve the unique ID of the window.
96 uint32_t GetId() const;
99 * @brief Retrieve the Scene.
102 Dali::Integration::Scene GetScene();
105 * @brief Retrieves the DPI of this sceneholder.
108 Uint16Pair GetDpi() const;
111 * @brief Set the render surface
112 * @param[in] surface The render surface
114 void SetSurface(Dali::RenderSurfaceInterface* surface);
117 * @brief Called when the surface set is resized.
118 * @param[in] width the resized window's width
119 * @param[in] height the resized window's height
121 void SurfaceResized(float width, float height);
124 * @brief Get the render surface
125 * @return The render surface
127 Dali::RenderSurfaceInterface* GetSurface() const;
130 * @brief Set the adaptor to the scene holder
131 * @param[in] adaptor An initialized adaptor
133 void SetAdaptor(Dali::Adaptor& adaptor);
136 * @copydoc Dali::Integration::SceneHolder::SetBackgroundColor
138 void SetBackgroundColor(const Dali::Vector4& color);
141 * @copydoc Dali::Integration::SceneHolder::GetBackgroundColor
143 Vector4 GetBackgroundColor() const;
146 * @brief Pause the rendering of the scene holder.
151 * @brief Resume the rendering of the scene holder (from pause).
156 * @brief Checks whether this scene holder is being deleted in the event thread.
158 * @return true if this scene holder is being deleted in the event thread, or false if not.
160 bool IsBeingDeleted() const
162 return mIsBeingDeleted;
166 * @brief Informs the scene that the set surface has been rotated.
168 * @param[in] width The width of rotated surface
169 * @param[in] height The height of rotated surface
170 * @param[in] windowOrientation the current window orientation
171 * @param[in] screenOrientation the current screen orientation
173 void SurfaceRotated(float width, float height, int32_t windowOrientation, int32_t screenOrientation);
176 * @brief Send message to acknowledge window rotation with current window orientation.
177 * It is to send message to render thread for completing window rotation by user.
179 void SetRotationCompletedAcknowledgement();
182 * @copydoc Dali::Integration::SceneHolder::FeedTouchPoint
184 void FeedTouchPoint(Dali::Integration::Point& point, int timeStamp);
187 * @copydoc Dali::Integration::SceneHolder::FeedWheelEvent
189 void FeedWheelEvent(Dali::Integration::WheelEvent& wheelEvent);
192 * @copydoc Dali::Integration::SceneHolder::FeedKeyEvent
194 void FeedKeyEvent(Dali::Integration::KeyEvent& keyEvent);
197 * @brief Adds a callback that is called when the frame rendering is done by the graphics driver.
199 * @param[in] callback The function to call
200 * @param[in] frameId The Id to specify the frame. It will be passed when the callback is called.
202 * @note A callback of the following type may be used:
204 * void MyFunction( int frameId );
206 * This callback will be deleted once it is called.
208 * @note Ownership of the callback is passed onto this class.
210 void AddFrameRenderedCallback(std::unique_ptr<CallbackBase> callback, int32_t frameId);
213 * @brief Adds a callback that is called when the frame rendering is done by the graphics driver.
215 * @param[in] callback The function to call
216 * @param[in] frameId The Id to specify the frame. It will be passed when the callback is called.
218 * @note A callback of the following type may be used:
220 * void MyFunction( int frameId );
222 * This callback will be deleted once it is called.
224 * @note Ownership of the callback is passed onto this class.
226 void AddFramePresentedCallback(std::unique_ptr<CallbackBase> callback, int32_t frameId);
229 * @brief Creates the render target for the surface when the surface is created/resized/replaced.
231 void CreateRenderTarget();
234 * @copydoc Dali::Integration::SceneHolder::Get()
236 static Dali::Integration::SceneHolder Get(Dali::Actor actor);
239 * @copydoc Dali::Integration::SceneHolder::KeyEventSignal()
241 Dali::Integration::SceneHolder::KeyEventSignalType& KeyEventSignal()
243 return mScene.KeyEventSignal();
247 * @copydoc Dali::Integration::SceneHolder::KeyEventGeneratedSignal()
249 Dali::Integration::SceneHolder::KeyEventGeneratedSignalType& KeyEventGeneratedSignal()
251 return mScene.KeyEventGeneratedSignal();
255 * @copydoc Dali::Integration::SceneHolder::InterceptKeyEventSignal()
257 Dali::Integration::SceneHolder::KeyEventGeneratedSignalType& InterceptKeyEventSignal()
259 return mScene.InterceptKeyEventSignal();
263 * @copydoc Dali::Integration::SceneHolder::TouchedSignal()
265 Dali::Integration::SceneHolder::TouchEventSignalType& TouchedSignal()
267 return mScene.TouchedSignal();
271 * @copydoc Dali::Integration::SceneHolder::WheelEventSignal()
273 Dali::Integration::SceneHolder::WheelEventSignalType& WheelEventSignal()
275 return mScene.WheelEventSignal();
279 * @copydoc Dali::Integration::SceneHolder::WheelEventGeneratedSignal()
281 Dali::Integration::SceneHolder::WheelEventGeneratedSignalType& WheelEventGeneratedSignal()
283 return mScene.WheelEventGeneratedSignal();
286 public: // The following methods can be overridden if required
288 * @brief Returns whether the Scene is visible or not.
289 * @return True if the Scene is visible, false otherwise.
291 virtual bool IsVisible() const;
293 public: // The following methods must be overridden
295 * @copydoc Dali::Integration::SceneHolder::GetNativeHandle
297 virtual Dali::Any GetNativeHandle() const = 0;
304 SceneHolder(const SceneHolder&) = delete;
307 SceneHolder& operator=(const SceneHolder& rhs) = delete;
312 ~SceneHolder() override;
314 private: // The following methods can be overridden if required
316 * @brief Called by the base class to inform deriving classes that the adaptor has been set.
317 * @param[in] adaptor The adaptor
319 virtual void OnAdaptorSet(Dali::Adaptor& adaptor){};
322 * @brief Called by the base class to inform deriving classes that a new surface has been set.
323 * @param[in] surface The new render surface
325 virtual void OnSurfaceSet(Dali::RenderSurfaceInterface* surface){};
328 * @brief Called by the base class to inform deriving classes that we are being paused.
330 virtual void OnPause(){};
333 * @brief Called by the base class to inform deriving classes that we are resuming from a paused state.
335 virtual void OnResume(){};
338 * Recalculate the touch position if required
339 * @param[in,out] point The touch point
341 virtual void RecalculateTouchPosition(Integration::Point& point){};
345 * Resets the event handling.
350 * Initializes the DPI for this object.
352 void InitializeDpi();
355 static uint32_t mSceneHolderCounter; ///< A counter to track the SceneHolder creation
357 class SceneHolderLifeCycleObserver;
358 std::unique_ptr<SceneHolderLifeCycleObserver> mLifeCycleObserver; ///< The adaptor life cycle observer
361 uint32_t mId; ///< A unique ID to identify the SceneHolder starting from 0
362 Dali::Integration::Scene mScene; ///< The Scene
363 std::string mName; ///< The name of the SceneHolder
365 std::unique_ptr<Dali::RenderSurfaceInterface> mSurface; ///< The window rendering surface
366 Adaptor* mAdaptor; ///< The adaptor
368 Dali::Integration::TouchEventCombiner mCombiner; ///< Combines multi-touch events.
370 Uint16Pair mDpi; ///< The DPI for this SceneHolder.
372 std::atomic<bool> mIsBeingDeleted; ///< This is set only from the event thread and read only from the render thread
374 bool mAdaptorStarted : 1; ///< Whether the adaptor has started or not
375 bool mVisible : 1; ///< Whether the scene is visible or not
378 } // namespace Adaptor
380 } // namespace Internal
382 // Get impl of handle
383 inline Internal::Adaptor::SceneHolder& GetImplementation(Dali::Integration::SceneHolder& sceneHolder)
385 DALI_ASSERT_ALWAYS(sceneHolder && "SceneHolder handle is empty");
386 Dali::RefObject& object = sceneHolder.GetBaseObject();
387 return static_cast<Internal::Adaptor::SceneHolder&>(object);
390 inline const Internal::Adaptor::SceneHolder& GetImplementation(const Dali::Integration::SceneHolder& sceneHolder)
392 DALI_ASSERT_ALWAYS(sceneHolder && "SceneHolder handle is empty");
393 const Dali::RefObject& object = sceneHolder.GetBaseObject();
394 return static_cast<const Internal::Adaptor::SceneHolder&>(object);
399 #endif // DALI_INTEGRATION_INTERNAL_SCENEHOLDER_H