1 #ifndef DALI_INTEGRATION_INTERNAL_SCENEHOLDER_H
2 #define DALI_INTEGRATION_INTERNAL_SCENEHOLDER_H
5 * Copyright (c) 2020 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/events/key-event-integ.h>
23 #include <dali/integration-api/events/point.h>
24 #include <dali/integration-api/events/touch-event-combiner.h>
25 #include <dali/integration-api/scene.h>
26 #include <dali/public-api/common/intrusive-ptr.h>
27 #include <dali/public-api/math/uint-16-pair.h>
28 #include <dali/public-api/object/base-object.h>
34 #include <dali/integration-api/adaptor-framework/render-surface-interface.h>
35 #include <dali/integration-api/adaptor-framework/scene-holder.h>
54 } // namespace Integration
62 using SceneHolderPtr = IntrusivePtr<SceneHolder>;
65 * @brief SceneHolder creates a Scene for rendering.
67 class DALI_ADAPTOR_API SceneHolder : public BaseObject
71 * @copydoc Dali::Integration::SceneHolder::Add
73 void Add(Dali::Actor actor);
76 * @copydoc Dali::Integration::SceneHolder::Remove
78 void Remove(Dali::Actor actor);
81 * @copydoc Dali::Integration::SceneHolder::GetRootLayer
83 Dali::Layer GetRootLayer() const;
86 * @brief Gets the window name.
87 * @return The name of the window
89 std::string GetName() const;
92 * @brief Retrieve the unique ID of the window.
95 uint32_t GetId() const;
98 * @brief Retrieve the Scene.
101 Dali::Integration::Scene GetScene();
104 * @brief Retrieves the DPI of this sceneholder.
107 Uint16Pair GetDpi() const;
110 * @brief Set the render surface
111 * @param[in] surface The render surface
113 void SetSurface(Dali::RenderSurfaceInterface* surface);
116 * @brief Called when the surface set is resized.
118 void SurfaceResized();
121 * @brief Get the render surface
122 * @return The render surface
124 Dali::RenderSurfaceInterface* GetSurface() const;
127 * @brief Set the adaptor to the scene holder
128 * @param[in] adaptor An initialized adaptor
130 void SetAdaptor(Dali::Adaptor& adaptor);
133 * @copydoc Dali::Integration::SceneHolder::SetBackgroundColor
135 void SetBackgroundColor(const Dali::Vector4& color);
138 * @copydoc Dali::Integration::SceneHolder::GetBackgroundColor
140 Vector4 GetBackgroundColor() const;
143 * @brief Pause the rendering of the scene holder.
148 * @brief Resume the rendering of the scene holder (from pause).
153 * @brief Checks whether this scene holder is being deleted in the event thread.
155 * @return true if this scene holder is being deleted in the event thread, or false if not.
157 bool IsBeingDeleted() const
159 return mIsBeingDeleted;
163 * @brief Informs the scene that the set surface has been rotated.
165 * @param[in] width The width of rotated surface
166 * @param[in] height The height of rotated surface
167 * @param[in] orientation The orientation of rotated surface
169 void SurfaceRotated(float width, float height, int orientation);
172 * @copydoc Dali::Integration::SceneHolder::FeedTouchPoint
174 void FeedTouchPoint(Dali::Integration::Point& point, int timeStamp);
177 * @copydoc Dali::Integration::SceneHolder::FeedWheelEvent
179 void FeedWheelEvent(Dali::Integration::WheelEvent& wheelEvent);
182 * @copydoc Dali::Integration::SceneHolder::FeedKeyEvent
184 void FeedKeyEvent(Dali::Integration::KeyEvent& keyEvent);
187 * @brief Adds a callback that is called when the frame rendering is done by the graphics driver.
189 * @param[in] callback The function to call
190 * @param[in] frameId The Id to specify the frame. It will be passed when the callback is called.
192 * @note A callback of the following type may be used:
194 * void MyFunction( int frameId );
196 * This callback will be deleted once it is called.
198 * @note Ownership of the callback is passed onto this class.
200 void AddFrameRenderedCallback(std::unique_ptr<CallbackBase> callback, int32_t frameId);
203 * @brief Adds a callback that is called when the frame rendering is done by the graphics driver.
205 * @param[in] callback The function to call
206 * @param[in] frameId The Id to specify the frame. It will be passed when the callback is called.
208 * @note A callback of the following type may be used:
210 * void MyFunction( int frameId );
212 * This callback will be deleted once it is called.
214 * @note Ownership of the callback is passed onto this class.
216 void AddFramePresentedCallback(std::unique_ptr<CallbackBase> callback, int32_t frameId);
219 * @copydoc Dali::Integration::SceneHolder::Get()
221 static Dali::Integration::SceneHolder Get(Dali::Actor actor);
224 * @copydoc Dali::Integration::SceneHolder::KeyEventSignal()
226 Dali::Integration::SceneHolder::KeyEventSignalType& KeyEventSignal()
228 return mScene.KeyEventSignal();
232 * @copydoc Dali::Integration::SceneHolder::KeyEventGeneratedSignal()
234 Dali::Integration::SceneHolder::KeyEventGeneratedSignalType& KeyEventGeneratedSignal()
236 return mScene.KeyEventGeneratedSignal();
240 * @copydoc Dali::Integration::SceneHolder::TouchedSignal()
242 Dali::Integration::SceneHolder::TouchEventSignalType& TouchedSignal()
244 return mScene.TouchedSignal();
248 * @copydoc Dali::Integration::SceneHolder::WheelEventSignal()
250 Dali::Integration::SceneHolder::WheelEventSignalType& WheelEventSignal()
252 return mScene.WheelEventSignal();
255 public: // The following methods can be overridden if required
257 * @brief Returns whether the Scene is visible or not.
258 * @return True if the Scene is visible, false otherwise.
260 virtual bool IsVisible() const;
262 public: // The following methods must be overridden
264 * @copydoc Dali::Integration::SceneHolder::GetNativeHandle
266 virtual Dali::Any GetNativeHandle() const = 0;
273 SceneHolder(const SceneHolder&) = delete;
276 SceneHolder& operator=(const SceneHolder& rhs) = delete;
281 ~SceneHolder() override;
283 private: // The following methods can be overridden if required
285 * @brief Called by the base class to inform deriving classes that the adaptor has been set.
286 * @param[in] adaptor The adaptor
288 virtual void OnAdaptorSet(Dali::Adaptor& adaptor){};
291 * @brief Called by the base class to inform deriving classes that a new surface has been set.
292 * @param[in] surface The new render surface
294 virtual void OnSurfaceSet(Dali::RenderSurfaceInterface* surface){};
297 * @brief Called by the base class to inform deriving classes that we are being paused.
299 virtual void OnPause(){};
302 * @brief Called by the base class to inform deriving classes that we are resuming from a paused state.
304 virtual void OnResume(){};
307 * Recalculate the touch position if required
308 * @param[in,out] point The touch point
310 virtual void RecalculateTouchPosition(Integration::Point& point){};
314 * Resets the event handling.
319 * Initializes the DPI for this object.
321 void InitializeDpi();
324 static uint32_t mSceneHolderCounter; ///< A counter to track the SceneHolder creation
326 class SceneHolderLifeCycleObserver;
327 std::unique_ptr<SceneHolderLifeCycleObserver> mLifeCycleObserver; ///< The adaptor life cycle observer
330 uint32_t mId; ///< A unique ID to identify the SceneHolder starting from 0
331 Dali::Integration::Scene mScene; ///< The Scene
332 std::string mName; ///< The name of the SceneHolder
334 std::unique_ptr<Dali::RenderSurfaceInterface> mSurface; ///< The window rendering surface
335 Adaptor* mAdaptor; ///< The adaptor
337 Dali::Integration::TouchEventCombiner mCombiner; ///< Combines multi-touch events.
339 Uint16Pair mDpi; ///< The DPI for this SceneHolder.
341 std::atomic<bool> mIsBeingDeleted; ///< This is set only from the event thread and read only from the render thread
343 bool mAdaptorStarted : 1; ///< Whether the adaptor has started or not
344 bool mVisible : 1; ///< Whether the scene is visible or not
347 } // namespace Adaptor
349 } // namespace Internal
351 // Get impl of handle
352 inline Internal::Adaptor::SceneHolder& GetImplementation(Dali::Integration::SceneHolder& sceneHolder)
354 DALI_ASSERT_ALWAYS(sceneHolder && "SceneHolder handle is empty");
355 Dali::RefObject& object = sceneHolder.GetBaseObject();
356 return static_cast<Internal::Adaptor::SceneHolder&>(object);
359 inline const Internal::Adaptor::SceneHolder& GetImplementation(const Dali::Integration::SceneHolder& sceneHolder)
361 DALI_ASSERT_ALWAYS(sceneHolder && "SceneHolder handle is empty");
362 const Dali::RefObject& object = sceneHolder.GetBaseObject();
363 return static_cast<const Internal::Adaptor::SceneHolder&>(object);
368 #endif // DALI_INTEGRATION_INTERNAL_SCENEHOLDER_H