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 * @copydoc Dali::Integration::SceneHolder::GetOverlayLayer
89 Dali::Layer GetOverlayLayer();
92 * @brief Gets the window name.
93 * @return The name of the window
95 std::string GetName() const;
98 * @brief Retrieve the unique ID of the window.
101 uint32_t GetId() const;
104 * @brief Retrieve the Scene.
107 Dali::Integration::Scene GetScene();
110 * @brief Retrieves the DPI of this sceneholder.
113 Uint16Pair GetDpi() const;
116 * @brief Set the render surface
117 * @param[in] surface The render surface
119 void SetSurface(Dali::RenderSurfaceInterface* surface);
122 * @brief Called when the surface set is resized.
123 * @param[in] width the resized window's width
124 * @param[in] height the resized window's height
126 void SurfaceResized(float width, float height);
129 * @brief Get the render surface
130 * @return The render surface
132 Dali::RenderSurfaceInterface* GetSurface() const;
135 * @brief Set the adaptor to the scene holder
136 * @param[in] adaptor An initialized adaptor
138 void SetAdaptor(Dali::Adaptor& adaptor);
141 * @copydoc Dali::Integration::SceneHolder::SetBackgroundColor
143 void SetBackgroundColor(const Dali::Vector4& color);
146 * @copydoc Dali::Integration::SceneHolder::GetBackgroundColor
148 Vector4 GetBackgroundColor() const;
151 * @brief Pause the rendering of the scene holder.
156 * @brief Resume the rendering of the scene holder (from pause).
161 * @brief Checks whether this scene holder is being deleted in the event thread.
163 * @return true if this scene holder is being deleted in the event thread, or false if not.
165 bool IsBeingDeleted() const
167 return mIsBeingDeleted;
171 * @brief Informs the scene that the set surface has been rotated.
173 * @param[in] width The width of rotated surface
174 * @param[in] height The height of rotated surface
175 * @param[in] windowOrientation the current window orientation
176 * @param[in] screenOrientation the current screen orientation
178 void SurfaceRotated(float width, float height, int32_t windowOrientation, int32_t screenOrientation);
181 * @brief Send message to acknowledge window rotation with current window orientation.
182 * It is to send message to render thread for completing window rotation by user.
184 void SetRotationCompletedAcknowledgement();
187 * @copydoc Dali::Integration::SceneHolder::FeedTouchPoint
189 void FeedTouchPoint(Dali::Integration::Point& point, int timeStamp);
192 * @copydoc Dali::Integration::SceneHolder::FeedWheelEvent
194 void FeedWheelEvent(Dali::Integration::WheelEvent& wheelEvent);
197 * @copydoc Dali::Integration::SceneHolder::FeedKeyEvent
199 void FeedKeyEvent(Dali::Integration::KeyEvent& keyEvent);
202 * @brief Adds a callback that is called when the frame rendering is done by the graphics driver.
204 * @param[in] callback The function to call
205 * @param[in] frameId The Id to specify the frame. It will be passed when the callback is called.
207 * @note A callback of the following type may be used:
209 * void MyFunction( int frameId );
211 * This callback will be deleted once it is called.
213 * @note Ownership of the callback is passed onto this class.
215 void AddFrameRenderedCallback(std::unique_ptr<CallbackBase> callback, int32_t frameId);
218 * @brief Adds a callback that is called when the frame rendering is done by the graphics driver.
220 * @param[in] callback The function to call
221 * @param[in] frameId The Id to specify the frame. It will be passed when the callback is called.
223 * @note A callback of the following type may be used:
225 * void MyFunction( int frameId );
227 * This callback will be deleted once it is called.
229 * @note Ownership of the callback is passed onto this class.
231 void AddFramePresentedCallback(std::unique_ptr<CallbackBase> callback, int32_t frameId);
234 * @brief Creates the render target for the surface when the surface is created/resized/replaced.
236 void CreateRenderTarget();
239 * @copydoc Dali::Integration::SceneHolder::Get()
241 static Dali::Integration::SceneHolder Get(Dali::Actor actor);
244 * @copydoc Dali::Integration::SceneHolder::KeyEventSignal()
246 Dali::Integration::SceneHolder::KeyEventSignalType& KeyEventSignal()
248 return mScene.KeyEventSignal();
252 * @copydoc Dali::Integration::SceneHolder::KeyEventGeneratedSignal()
254 Dali::Integration::SceneHolder::KeyEventGeneratedSignalType& KeyEventGeneratedSignal()
256 return mScene.KeyEventGeneratedSignal();
260 * @copydoc Dali::Integration::SceneHolder::InterceptKeyEventSignal()
262 Dali::Integration::SceneHolder::KeyEventGeneratedSignalType& InterceptKeyEventSignal()
264 return mScene.InterceptKeyEventSignal();
268 * @copydoc Dali::Integration::SceneHolder::TouchedSignal()
270 Dali::Integration::SceneHolder::TouchEventSignalType& TouchedSignal()
272 return mScene.TouchedSignal();
276 * @copydoc Dali::Integration::SceneHolder::WheelEventSignal()
278 Dali::Integration::SceneHolder::WheelEventSignalType& WheelEventSignal()
280 return mScene.WheelEventSignal();
284 * @copydoc Dali::Integration::SceneHolder::WheelEventGeneratedSignal()
286 Dali::Integration::SceneHolder::WheelEventGeneratedSignalType& WheelEventGeneratedSignal()
288 return mScene.WheelEventGeneratedSignal();
291 public: // The following methods can be overridden if required
293 * @brief Returns whether the Scene is visible or not.
294 * @return True if the Scene is visible, false otherwise.
296 virtual bool IsVisible() const;
298 public: // The following methods must be overridden
300 * @copydoc Dali::Integration::SceneHolder::GetNativeHandle
302 virtual Dali::Any GetNativeHandle() const = 0;
309 SceneHolder(const SceneHolder&) = delete;
312 SceneHolder& operator=(const SceneHolder& rhs) = delete;
317 ~SceneHolder() override;
319 private: // The following methods can be overridden if required
321 * @brief Called by the base class to inform deriving classes that the adaptor has been set.
322 * @param[in] adaptor The adaptor
324 virtual void OnAdaptorSet(Dali::Adaptor& adaptor){};
327 * @brief Called by the base class to inform deriving classes that a new surface has been set.
328 * @param[in] surface The new render surface
330 virtual void OnSurfaceSet(Dali::RenderSurfaceInterface* surface){};
333 * @brief Called by the base class to inform deriving classes that we are being paused.
335 virtual void OnPause(){};
338 * @brief Called by the base class to inform deriving classes that we are resuming from a paused state.
340 virtual void OnResume(){};
343 * Recalculate the position if required
344 * @param[in] position The screen position
345 * @return converted position by oriention
347 virtual Vector2 RecalculatePosition(const Vector2& position)
354 * Resets the event handling.
359 * Initializes the DPI for this object.
361 void InitializeDpi();
364 static uint32_t mSceneHolderCounter; ///< A counter to track the SceneHolder creation
366 class SceneHolderLifeCycleObserver;
367 std::unique_ptr<SceneHolderLifeCycleObserver> mLifeCycleObserver; ///< The adaptor life cycle observer
370 uint32_t mId; ///< A unique ID to identify the SceneHolder starting from 0
371 Dali::Integration::Scene mScene; ///< The Scene
372 std::string mName; ///< The name of the SceneHolder
374 std::unique_ptr<Dali::RenderSurfaceInterface> mSurface; ///< The window rendering surface
375 Adaptor* mAdaptor; ///< The adaptor
377 Dali::Integration::TouchEventCombiner mCombiner; ///< Combines multi-touch events.
379 Uint16Pair mDpi; ///< The DPI for this SceneHolder.
381 std::atomic<bool> mIsBeingDeleted; ///< This is set only from the event thread and read only from the render thread
383 bool mAdaptorStarted : 1; ///< Whether the adaptor has started or not
384 bool mVisible : 1; ///< Whether the scene is visible or not
387 } // namespace Adaptor
389 } // namespace Internal
391 // Get impl of handle
392 inline Internal::Adaptor::SceneHolder& GetImplementation(Dali::Integration::SceneHolder& sceneHolder)
394 DALI_ASSERT_ALWAYS(sceneHolder && "SceneHolder handle is empty");
395 Dali::RefObject& object = sceneHolder.GetBaseObject();
396 return static_cast<Internal::Adaptor::SceneHolder&>(object);
399 inline const Internal::Adaptor::SceneHolder& GetImplementation(const Dali::Integration::SceneHolder& sceneHolder)
401 DALI_ASSERT_ALWAYS(sceneHolder && "SceneHolder handle is empty");
402 const Dali::RefObject& object = sceneHolder.GetBaseObject();
403 return static_cast<const Internal::Adaptor::SceneHolder&>(object);
408 #endif // DALI_INTEGRATION_INTERNAL_SCENEHOLDER_H