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    * @param[in] width the resized window's width
 119    * @param[in] height the resized window's height
 120    */
 121   void SurfaceResized(float width, float height);
 122
 123   /**
 124    * @brief Get the render surface
 125    * @return The render surface
 126    */
 127   Dali::RenderSurfaceInterface* GetSurface() const;
 128
 129   /**
 130    * @brief Set the adaptor to the scene holder
 131    * @param[in] adaptor An initialized adaptor
 132    */
 133   void SetAdaptor(Dali::Adaptor& adaptor);
 134
 135   /**
 136    * @copydoc Dali::Integration::SceneHolder::SetBackgroundColor
 137    */
 138   void SetBackgroundColor(const Dali::Vector4& color);
 139
 140   /**
 141    * @copydoc Dali::Integration::SceneHolder::GetBackgroundColor
 142    */
 143   Vector4 GetBackgroundColor() const;
 144
 145   /**
 146    * @brief Pause the rendering of the scene holder.
 147    */
 148   void Pause();
 149
 150   /**
 151    * @brief Resume the rendering of the scene holder (from pause).
 152    */
 153   void Resume();
 154
 155   /**
 156    * @brief Checks whether this scene holder is being deleted in the event thread.
 157    *
 158    * @return true if this scene holder is being deleted in the event thread, or false if not.
 159    */
 160   bool IsBeingDeleted() const
 161   {
 162     return mIsBeingDeleted;
 163   }
 164
 165   /**
 166    * @brief Informs the scene that the set surface has been rotated.
 167    *
 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
 172    */
 173   void SurfaceRotated(float width, float height, int32_t windowOrientation, int32_t screenOrientation);
 174
 175   /**
 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.
 178    */
 179   void SetRotationCompletedAcknowledgement();
 180
 181   /**
 182    * @copydoc Dali::Integration::SceneHolder::FeedTouchPoint
 183    */
 184   void FeedTouchPoint(Dali::Integration::Point& point, int timeStamp);
 185
 186   /**
 187    * @copydoc Dali::Integration::SceneHolder::FeedWheelEvent
 188    */
 189   void FeedWheelEvent(Dali::Integration::WheelEvent& wheelEvent);
 190
 191   /**
 192    * @copydoc Dali::Integration::SceneHolder::FeedKeyEvent
 193    */
 194   void FeedKeyEvent(Dali::Integration::KeyEvent& keyEvent);
 195
 196   /**
 197    * @brief Adds a callback that is called when the frame rendering is done by the graphics driver.
 198    *
 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.
 201    *
 202    * @note A callback of the following type may be used:
 203    * @code
 204    *   void MyFunction( int frameId );
 205    * @endcode
 206    * This callback will be deleted once it is called.
 207    *
 208    * @note Ownership of the callback is passed onto this class.
 209    */
 210   void AddFrameRenderedCallback(std::unique_ptr<CallbackBase> callback, int32_t frameId);
 211
 212   /**
 213    * @brief Adds a callback that is called when the frame rendering is done by the graphics driver.
 214    *
 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.
 217    *
 218    * @note A callback of the following type may be used:
 219    * @code
 220    *   void MyFunction( int frameId );
 221    * @endcode
 222    * This callback will be deleted once it is called.
 223    *
 224    * @note Ownership of the callback is passed onto this class.
 225    */
 226   void AddFramePresentedCallback(std::unique_ptr<CallbackBase> callback, int32_t frameId);
 227
 228   /**
 229    * @brief Creates the render target for the surface when the surface is created/resized/replaced.
 230    */
 231   void CreateRenderTarget();
 232
 233   /**
 234    * @copydoc Dali::Integration::SceneHolder::Get()
 235    */
 236   static Dali::Integration::SceneHolder Get(Dali::Actor actor);
 237
 238   /**
 239    * @copydoc Dali::Integration::SceneHolder::KeyEventSignal()
 240    */
 241   Dali::Integration::SceneHolder::KeyEventSignalType& KeyEventSignal()
 242   {
 243     return mScene.KeyEventSignal();
 244   }
 245
 246   /**
 247    * @copydoc Dali::Integration::SceneHolder::KeyEventGeneratedSignal()
 248    */
 249   Dali::Integration::SceneHolder::KeyEventGeneratedSignalType& KeyEventGeneratedSignal()
 250   {
 251     return mScene.KeyEventGeneratedSignal();
 252   }
 253
 254   /**
 255    * @copydoc Dali::Integration::SceneHolder::InterceptKeyEventSignal()
 256    */
 257   Dali::Integration::SceneHolder::KeyEventGeneratedSignalType& InterceptKeyEventSignal()
 258   {
 259     return mScene.InterceptKeyEventSignal();
 260   }
 261
 262   /**
 263    * @copydoc Dali::Integration::SceneHolder::TouchedSignal()
 264    */
 265   Dali::Integration::SceneHolder::TouchEventSignalType& TouchedSignal()
 266   {
 267     return mScene.TouchedSignal();
 268   }
 269
 270   /**
 271    * @copydoc Dali::Integration::SceneHolder::WheelEventSignal()
 272    */
 273   Dali::Integration::SceneHolder::WheelEventSignalType& WheelEventSignal()
 274   {
 275     return mScene.WheelEventSignal();
 276   }
 277
 278   /**
 279    * @copydoc Dali::Integration::SceneHolder::WheelEventGeneratedSignal()
 280    */
 281   Dali::Integration::SceneHolder::WheelEventGeneratedSignalType& WheelEventGeneratedSignal()
 282   {
 283     return mScene.WheelEventGeneratedSignal();
 284   }
 285
 286 public: // The following methods can be overridden if required
 287   /**
 288    * @brief Returns whether the Scene is visible or not.
 289    * @return True if the Scene is visible, false otherwise.
 290    */
 291   virtual bool IsVisible() const;
 292
 293 public: // The following methods must be overridden
 294   /**
 295    * @copydoc Dali::Integration::SceneHolder::GetNativeHandle
 296    */
 297   virtual Dali::Any GetNativeHandle() const = 0;
 298
 299 protected:
 300   // Constructor
 301   SceneHolder();
 302
 303   // Undefined
 304   SceneHolder(const SceneHolder&) = delete;
 305
 306   // Undefined
 307   SceneHolder& operator=(const SceneHolder& rhs) = delete;
 308
 309   /**
 310    * virtual destructor
 311    */
 312   ~SceneHolder() override;
 313
 314 private: // The following methods can be overridden if required
 315   /**
 316    * @brief Called by the base class to inform deriving classes that the adaptor has been set.
 317    * @param[in] adaptor The adaptor
 318    */
 319   virtual void OnAdaptorSet(Dali::Adaptor& adaptor){};
 320
 321   /**
 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
 324    */
 325   virtual void OnSurfaceSet(Dali::RenderSurfaceInterface* surface){};
 326
 327   /**
 328    * @brief Called by the base class to inform deriving classes that we are being paused.
 329    */
 330   virtual void OnPause(){};
 331
 332   /**
 333    * @brief Called by the base class to inform deriving classes that we are resuming from a paused state.
 334    */
 335   virtual void OnResume(){};
 336
 337   /**
 338    * Recalculate the position if required
 339    * @param[in] position The screen position
 340    * @return converted position by oriention
 341    */
 342   virtual Vector2 RecalculatePosition(const Vector2& position)
 343   {
 344     return position;
 345   };
 346
 347 private:
 348   /**
 349    * Resets the event handling.
 350    */
 351   void Reset();
 352
 353   /**
 354    * Initializes the DPI for this object.
 355    */
 356   void InitializeDpi();
 357
 358 private:
 359   static uint32_t mSceneHolderCounter; ///< A counter to track the SceneHolder creation
 360
 361   class SceneHolderLifeCycleObserver;
 362   std::unique_ptr<SceneHolderLifeCycleObserver> mLifeCycleObserver; ///< The adaptor life cycle observer
 363
 364 protected:
 365   uint32_t                 mId;    ///< A unique ID to identify the SceneHolder starting from 0
 366   Dali::Integration::Scene mScene; ///< The Scene
 367   std::string              mName;  ///< The name of the SceneHolder
 368
 369   std::unique_ptr<Dali::RenderSurfaceInterface> mSurface; ///< The window rendering surface
 370   Adaptor*                                      mAdaptor; ///< The adaptor
 371
 372   Dali::Integration::TouchEventCombiner mCombiner; ///< Combines multi-touch events.
 373
 374   Uint16Pair mDpi; ///< The DPI for this SceneHolder.
 375
 376   std::atomic<bool> mIsBeingDeleted; ///< This is set only from the event thread and read only from the render thread
 377
 378   bool mAdaptorStarted : 1; ///< Whether the adaptor has started or not
 379   bool mVisible : 1;        ///< Whether the scene is visible or not
 380 };
 381
 382 } // namespace Adaptor
 383
 384 } // namespace Internal
 385
 386 // Get impl of handle
 387 inline Internal::Adaptor::SceneHolder& GetImplementation(Dali::Integration::SceneHolder& sceneHolder)
 388 {
 389   DALI_ASSERT_ALWAYS(sceneHolder && "SceneHolder handle is empty");
 390   Dali::RefObject& object = sceneHolder.GetBaseObject();
 391   return static_cast<Internal::Adaptor::SceneHolder&>(object);
 392 }
 393
 394 inline const Internal::Adaptor::SceneHolder& GetImplementation(const Dali::Integration::SceneHolder& sceneHolder)
 395 {
 396   DALI_ASSERT_ALWAYS(sceneHolder && "SceneHolder handle is empty");
 397   const Dali::RefObject& object = sceneHolder.GetBaseObject();
 398   return static_cast<const Internal::Adaptor::SceneHolder&>(object);
 399 }
 400
 401 } // namespace Dali
 402
 403 #endif // DALI_INTEGRATION_INTERNAL_SCENEHOLDER_H