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