Add WheelEventGeneratedSignal and add clockwise value
[platform/core/uifw/dali-adaptor.git] / dali / integration-api / adaptor-framework / scene-holder-impl.h
1 #ifndef DALI_INTEGRATION_INTERNAL_SCENEHOLDER_H
2 #define DALI_INTEGRATION_INTERNAL_SCENEHOLDER_H
3
4 /*
5  * Copyright (c) 2022 Samsung Electronics Co., Ltd.
6  *
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
10  *
11  * http://www.apache.org/licenses/LICENSE-2.0
12  *
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.
18  *
19  */
20
21 // EXTERNAL INCLUDES
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>
30 #include <atomic>
31 #include <memory>
32 #include <vector>
33
34 // INTERNAL INCLUDES
35 #include <dali/integration-api/adaptor-framework/render-surface-interface.h>
36 #include <dali/integration-api/adaptor-framework/scene-holder.h>
37
38 namespace Dali
39 {
40 class Any;
41 class Adaptor;
42 class Actor;
43 class Layer;
44 class WheelEvent;
45 struct TouchPoint;
46 class KeyEvent;
47
48 namespace Integration
49 {
50 class Scene;
51 struct Point;
52 struct KeyEvent;
53 struct WheelEvent;
54
55 } // namespace Integration
56
57 namespace Internal
58 {
59 namespace Adaptor
60 {
61 class Adaptor;
62 class SceneHolder;
63 using SceneHolderPtr = IntrusivePtr<SceneHolder>;
64
65 /**
66  * @brief SceneHolder creates a Scene for rendering.
67  */
68 class DALI_ADAPTOR_API SceneHolder : public BaseObject
69 {
70 public:
71   /**
72    * @copydoc Dali::Integration::SceneHolder::Add
73    */
74   void Add(Dali::Actor actor);
75
76   /**
77    * @copydoc Dali::Integration::SceneHolder::Remove
78    */
79   void Remove(Dali::Actor actor);
80
81   /**
82    * @copydoc Dali::Integration::SceneHolder::GetRootLayer
83    */
84   Dali::Layer GetRootLayer() const;
85
86   /**
87    * @brief Gets the window name.
88    * @return The name of the window
89    */
90   std::string GetName() const;
91
92   /**
93    * @brief Retrieve the unique ID of the window.
94    * @return The ID
95    */
96   uint32_t GetId() const;
97
98   /**
99    * @brief Retrieve the Scene.
100    * @return The Scene
101    */
102   Dali::Integration::Scene GetScene();
103
104   /**
105    * @brief Retrieves the DPI of this sceneholder.
106    * @return The DPI.
107    */
108   Uint16Pair GetDpi() const;
109
110   /**
111    * @brief Set the render surface
112    * @param[in] surface The render surface
113    */
114   void SetSurface(Dali::RenderSurfaceInterface* surface);
115
116   /**
117    * @brief Called when the surface set is resized.
118    */
119   void SurfaceResized();
120
121   /**
122    * @brief Get the render surface
123    * @return The render surface
124    */
125   Dali::RenderSurfaceInterface* GetSurface() const;
126
127   /**
128    * @brief Set the adaptor to the scene holder
129    * @param[in] adaptor An initialized adaptor
130    */
131   void SetAdaptor(Dali::Adaptor& adaptor);
132
133   /**
134    * @copydoc Dali::Integration::SceneHolder::SetBackgroundColor
135    */
136   void SetBackgroundColor(const Dali::Vector4& color);
137
138   /**
139    * @copydoc Dali::Integration::SceneHolder::GetBackgroundColor
140    */
141   Vector4 GetBackgroundColor() const;
142
143   /**
144    * @brief Pause the rendering of the scene holder.
145    */
146   void Pause();
147
148   /**
149    * @brief Resume the rendering of the scene holder (from pause).
150    */
151   void Resume();
152
153   /**
154    * @brief Checks whether this scene holder is being deleted in the event thread.
155    *
156    * @return true if this scene holder is being deleted in the event thread, or false if not.
157    */
158   bool IsBeingDeleted() const
159   {
160     return mIsBeingDeleted;
161   }
162
163   /**
164    * @brief Informs the scene that the set surface has been rotated.
165    *
166    * @param[in] width The width of rotated surface
167    * @param[in] height The height of rotated surface
168    * @param[in] orientation The orientation of rotated surface
169    */
170   void SurfaceRotated(float width, float height, int orientation);
171
172   /**
173    * @brief Send message to acknowledge window rotation with current window orientation.
174    * It is to send message to render thread for completing window rotation by user.
175    */
176   void SetRotationCompletedAcknowledgement();
177
178   /**
179    * @copydoc Dali::Integration::SceneHolder::FeedTouchPoint
180    */
181   void FeedTouchPoint(Dali::Integration::Point& point, int timeStamp);
182
183   /**
184    * @copydoc Dali::Integration::SceneHolder::FeedWheelEvent
185    */
186   void FeedWheelEvent(Dali::Integration::WheelEvent& wheelEvent);
187
188   /**
189    * @copydoc Dali::Integration::SceneHolder::FeedKeyEvent
190    */
191   void FeedKeyEvent(Dali::Integration::KeyEvent& keyEvent);
192
193   /**
194    * @brief Adds a callback that is called when the frame rendering is done by the graphics driver.
195    *
196    * @param[in] callback The function to call
197    * @param[in] frameId The Id to specify the frame. It will be passed when the callback is called.
198    *
199    * @note A callback of the following type may be used:
200    * @code
201    *   void MyFunction( int frameId );
202    * @endcode
203    * This callback will be deleted once it is called.
204    *
205    * @note Ownership of the callback is passed onto this class.
206    */
207   void AddFrameRenderedCallback(std::unique_ptr<CallbackBase> callback, int32_t frameId);
208
209   /**
210    * @brief Adds a callback that is called when the frame rendering is done by the graphics driver.
211    *
212    * @param[in] callback The function to call
213    * @param[in] frameId The Id to specify the frame. It will be passed when the callback is called.
214    *
215    * @note A callback of the following type may be used:
216    * @code
217    *   void MyFunction( int frameId );
218    * @endcode
219    * This callback will be deleted once it is called.
220    *
221    * @note Ownership of the callback is passed onto this class.
222    */
223   void AddFramePresentedCallback(std::unique_ptr<CallbackBase> callback, int32_t frameId);
224
225   /**
226    * @brief Creates the render target for the surface when the surface is created/resized/replaced.
227    */
228   void CreateRenderTarget();
229
230   /**
231    * @copydoc Dali::Integration::SceneHolder::Get()
232    */
233   static Dali::Integration::SceneHolder Get(Dali::Actor actor);
234
235   /**
236    * @copydoc Dali::Integration::SceneHolder::KeyEventSignal()
237    */
238   Dali::Integration::SceneHolder::KeyEventSignalType& KeyEventSignal()
239   {
240     return mScene.KeyEventSignal();
241   }
242
243   /**
244    * @copydoc Dali::Integration::SceneHolder::KeyEventGeneratedSignal()
245    */
246   Dali::Integration::SceneHolder::KeyEventGeneratedSignalType& KeyEventGeneratedSignal()
247   {
248     return mScene.KeyEventGeneratedSignal();
249   }
250
251   /**
252    * @copydoc Dali::Integration::SceneHolder::TouchedSignal()
253    */
254   Dali::Integration::SceneHolder::TouchEventSignalType& TouchedSignal()
255   {
256     return mScene.TouchedSignal();
257   }
258
259   /**
260    * @copydoc Dali::Integration::SceneHolder::WheelEventSignal()
261    */
262   Dali::Integration::SceneHolder::WheelEventSignalType& WheelEventSignal()
263   {
264     return mScene.WheelEventSignal();
265   }
266
267   /**
268    * @copydoc Dali::Integration::SceneHolder::WheelEventGeneratedSignal()
269    */
270   Dali::Integration::SceneHolder::WheelEventGeneratedSignalType& WheelEventGeneratedSignal()
271   {
272     return mScene.WheelEventGeneratedSignal();
273   }
274
275 public: // The following methods can be overridden if required
276   /**
277    * @brief Returns whether the Scene is visible or not.
278    * @return True if the Scene is visible, false otherwise.
279    */
280   virtual bool IsVisible() const;
281
282 public: // The following methods must be overridden
283   /**
284    * @copydoc Dali::Integration::SceneHolder::GetNativeHandle
285    */
286   virtual Dali::Any GetNativeHandle() const = 0;
287
288 protected:
289   // Constructor
290   SceneHolder();
291
292   // Undefined
293   SceneHolder(const SceneHolder&) = delete;
294
295   // Undefined
296   SceneHolder& operator=(const SceneHolder& rhs) = delete;
297
298   /**
299    * virtual destructor
300    */
301   ~SceneHolder() override;
302
303 private: // The following methods can be overridden if required
304   /**
305    * @brief Called by the base class to inform deriving classes that the adaptor has been set.
306    * @param[in] adaptor The adaptor
307    */
308   virtual void OnAdaptorSet(Dali::Adaptor& adaptor){};
309
310   /**
311    * @brief Called by the base class to inform deriving classes that a new surface has been set.
312    * @param[in] surface The new render surface
313    */
314   virtual void OnSurfaceSet(Dali::RenderSurfaceInterface* surface){};
315
316   /**
317    * @brief Called by the base class to inform deriving classes that we are being paused.
318    */
319   virtual void OnPause(){};
320
321   /**
322    * @brief Called by the base class to inform deriving classes that we are resuming from a paused state.
323    */
324   virtual void OnResume(){};
325
326   /**
327    * Recalculate the touch position if required
328    * @param[in,out] point The touch point
329    */
330   virtual void RecalculateTouchPosition(Integration::Point& point){};
331
332 private:
333   /**
334    * Resets the event handling.
335    */
336   void Reset();
337
338   /**
339    * Initializes the DPI for this object.
340    */
341   void InitializeDpi();
342
343 private:
344   static uint32_t mSceneHolderCounter; ///< A counter to track the SceneHolder creation
345
346   class SceneHolderLifeCycleObserver;
347   std::unique_ptr<SceneHolderLifeCycleObserver> mLifeCycleObserver; ///< The adaptor life cycle observer
348
349 protected:
350   uint32_t                 mId;    ///< A unique ID to identify the SceneHolder starting from 0
351   Dali::Integration::Scene mScene; ///< The Scene
352   std::string              mName;  ///< The name of the SceneHolder
353
354   std::unique_ptr<Dali::RenderSurfaceInterface> mSurface; ///< The window rendering surface
355   Adaptor*                                      mAdaptor; ///< The adaptor
356
357   Dali::Integration::TouchEventCombiner mCombiner; ///< Combines multi-touch events.
358
359   Uint16Pair mDpi; ///< The DPI for this SceneHolder.
360
361   std::atomic<bool> mIsBeingDeleted; ///< This is set only from the event thread and read only from the render thread
362
363   bool mAdaptorStarted : 1; ///< Whether the adaptor has started or not
364   bool mVisible : 1;        ///< Whether the scene is visible or not
365 };
366
367 } // namespace Adaptor
368
369 } // namespace Internal
370
371 // Get impl of handle
372 inline Internal::Adaptor::SceneHolder& GetImplementation(Dali::Integration::SceneHolder& sceneHolder)
373 {
374   DALI_ASSERT_ALWAYS(sceneHolder && "SceneHolder handle is empty");
375   Dali::RefObject& object = sceneHolder.GetBaseObject();
376   return static_cast<Internal::Adaptor::SceneHolder&>(object);
377 }
378
379 inline const Internal::Adaptor::SceneHolder& GetImplementation(const Dali::Integration::SceneHolder& sceneHolder)
380 {
381   DALI_ASSERT_ALWAYS(sceneHolder && "SceneHolder handle is empty");
382   const Dali::RefObject& object = sceneHolder.GetBaseObject();
383   return static_cast<const Internal::Adaptor::SceneHolder&>(object);
384 }
385
386 } // namespace Dali
387
388 #endif // DALI_INTEGRATION_INTERNAL_SCENEHOLDER_H