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) 2019 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 <memory>
  23 #include <vector>
  24 #include <dali/public-api/object/base-object.h>
  25 #include <dali/public-api/common/intrusive-ptr.h>
  26 #include <dali/integration-api/scene.h>
  27 #include <dali/integration-api/events/key-event-integ.h>
  28 #include <dali/integration-api/events/point.h>
  29 #include <dali/integration-api/events/touch-event-combiner.h>
  30
  31 // INTERNAL INCLUDES
  32 #include <dali/integration-api/adaptor-framework/render-surface-interface.h>
  33 #include <dali/integration-api/adaptor-framework/scene-holder.h>
  34
  35 namespace Dali
  36 {
  37
  38 class Any;
  39 class Adaptor;
  40 class Actor;
  41 class Layer;
  42 struct TouchPoint;
  43 struct WheelEvent;
  44 struct KeyEvent;
  45
  46 namespace Integration
  47 {
  48
  49 class Scene;
  50 struct Point;
  51 struct KeyEvent;
  52 struct WheelEvent;
  53
  54 }
  55
  56 namespace Internal
  57 {
  58
  59 namespace Adaptor
  60 {
  61
  62 class Adaptor;
  63 class SceneHolder;
  64 using SceneHolderPtr = IntrusivePtr< SceneHolder >;
  65
  66 /**
  67  * @brief SceneHolder creates a Scene for rendering.
  68  */
  69 class DALI_ADAPTOR_API SceneHolder : public BaseObject
  70 {
  71
  72 public:
  73
  74   /**
  75    * @copydoc Dali::Integration::SceneHolder::Add
  76    */
  77   void Add( Dali::Actor actor );
  78
  79   /**
  80    * @copydoc Dali::Integration::SceneHolder::Remove
  81    */
  82   void Remove( Dali::Actor actor );
  83
  84   /**
  85    * @copydoc Dali::Integration::SceneHolder::GetRootLayer
  86    */
  87   Dali::Layer GetRootLayer() const;
  88
  89   /**
  90    * @brief Gets the window name.
  91    * @return The name of the window
  92    */
  93   std::string GetName() const;
  94
  95   /**
  96    * @brief Retrieve the unique ID of the window.
  97    * @return The ID
  98    */
  99   uint32_t GetId() const;
 100
 101   /**
 102    * @brief Retrieve the Scene.
 103    * @return The Scene
 104    */
 105   Dali::Integration::Scene GetScene();
 106
 107   /**
 108    * @brief Set the render surface
 109    * @param[in] surface The render surface
 110    */
 111   void SetSurface( Dali::RenderSurfaceInterface* surface );
 112
 113   /**
 114    * @brief Called when the surface set is resized.
 115    */
 116   void SurfaceResized();
 117
 118   /**
 119    * @brief Get the render surface
 120    * @return The render surface
 121    */
 122   Dali::RenderSurfaceInterface* GetSurface() const;
 123
 124   /**
 125    * @brief Set the adaptor to the scene holder
 126    * @param[in] adaptor An initialized adaptor
 127    */
 128   void SetAdaptor( Dali::Adaptor& adaptor );
 129
 130   /**
 131    * @copydoc Dali::Integration::SceneHolder::SetBackgroundColor
 132    */
 133   void SetBackgroundColor( const Dali::Vector4& color );
 134
 135   /**
 136    * @copydoc Dali::Integration::SceneHolder::GetBackgroundColor
 137    */
 138   Vector4 GetBackgroundColor() const;
 139
 140   /**
 141    * @brief Pause the rendering of the scene holder.
 142    */
 143   void Pause();
 144
 145   /**
 146    * @brief Resume the rendering of the scene holder (from pause).
 147    */
 148   void Resume();
 149
 150   /**
 151    * @copydoc Dali::Integration::SceneHolder::FeedTouchPoint
 152    */
 153   void FeedTouchPoint( Dali::Integration::Point& point, int timeStamp );
 154
 155   /**
 156    * @copydoc Dali::Integration::SceneHolder::FeedWheelEvent
 157    */
 158   void FeedWheelEvent( Dali::Integration::WheelEvent& wheelEvent );
 159
 160   /**
 161    * @copydoc Dali::Integration::SceneHolder::FeedKeyEvent
 162    */
 163   void FeedKeyEvent( Dali::Integration::KeyEvent& keyEvent );
 164
 165   /**
 166    * @copydoc Dali::Integration::SceneHolder::Get()
 167    */
 168   static Dali::Integration::SceneHolder Get( Dali::Actor actor );
 169
 170   /**
 171    * @copydoc Dali::Integration::SceneHolder::KeyEventSignal()
 172    */
 173   Dali::Integration::SceneHolder::KeyEventSignalType& KeyEventSignal() { return mScene.KeyEventSignal(); }
 174
 175   /**
 176    * @copydoc Dali::Integration::SceneHolder::KeyEventGeneratedSignal()
 177    */
 178   Dali::Integration::SceneHolder::KeyEventGeneratedSignalType& KeyEventGeneratedSignal() { return mScene.KeyEventGeneratedSignal(); }
 179
 180   /**
 181    * @copydoc Dali::Integration::SceneHolder::TouchSignal()
 182    */
 183   Dali::Integration::SceneHolder::TouchSignalType& TouchSignal() { return mScene.TouchSignal(); }
 184
 185   /**
 186    * @copydoc Dali::Integration::SceneHolder::WheelEventSignal()
 187    */
 188   Dali::Integration::SceneHolder::WheelEventSignalType& WheelEventSignal() { return mScene.WheelEventSignal(); }
 189
 190 public: // The following methods can be overridden if required
 191
 192   /**
 193    * @brief Returns whether the Scene is visible or not.
 194    * @return True if the Scene is visible, false otherwise.
 195    */
 196   virtual bool IsVisible() const;
 197
 198 public: // The following methods must be overridden
 199
 200   /**
 201    * @copydoc Dali::Integration::SceneHolder::GetNativeHandle
 202    */
 203   virtual Dali::Any GetNativeHandle() const = 0;
 204
 205 protected:
 206
 207   // Constructor
 208   SceneHolder();
 209
 210   // Undefined
 211   SceneHolder(const SceneHolder&) = delete;
 212
 213   // Undefined
 214   SceneHolder& operator=(const SceneHolder& rhs) = delete;
 215
 216   /**
 217    * virtual destructor
 218    */
 219   virtual ~SceneHolder();
 220
 221 private: // The following methods can be overridden if required
 222
 223   /**
 224    * @brief Called by the base class to inform deriving classes that the adaptor has been set.
 225    * @param[in] adaptor The adaptor
 226    */
 227   virtual void OnAdaptorSet( Dali::Adaptor& adaptor ) {};
 228
 229   /**
 230    * @brief Called by the base class to inform deriving classes that a new surface has been set.
 231    * @param[in] surface The new render surface
 232    */
 233   virtual void OnSurfaceSet( Dali::RenderSurfaceInterface* surface ) {};
 234
 235   /**
 236    * @brief Called by the base class to inform deriving classes that we are being paused.
 237    */
 238   virtual void OnPause() {};
 239
 240   /**
 241    * @brief Called by the base class to inform deriving classes that we are resuming from a paused state.
 242    */
 243   virtual void OnResume() {};
 244
 245   /**
 246    * Recalculate the touch position if required
 247    * @param[in,out] point The touch point
 248    */
 249   virtual void RecalculateTouchPosition( Integration::Point& point ) {};
 250
 251 private:
 252
 253   /**
 254    * Resets the event handling.
 255    */
 256   void Reset();
 257
 258 private:
 259
 260   static uint32_t                                 mSceneHolderCounter; ///< A counter to track the SceneHolder creation
 261
 262   class SceneHolderLifeCycleObserver;
 263   std::unique_ptr< SceneHolderLifeCycleObserver > mLifeCycleObserver;  ///< The adaptor life cycle observer
 264
 265 protected:
 266
 267   uint32_t                                        mId;                 ///< A unique ID to identify the SceneHolder starting from 0
 268   Dali::Integration::Scene                        mScene;              ///< The Scene
 269   std::string                                     mName;               ///< The name of the SceneHolder
 270
 271   std::unique_ptr< Dali::RenderSurfaceInterface > mSurface;            ///< The window rendering surface
 272   Adaptor*                                        mAdaptor;            ///< The adaptor
 273
 274   Dali::Integration::TouchEventCombiner           mCombiner;           ///< Combines multi-touch events.
 275
 276   bool                                            mAdaptorStarted:1;   ///< Whether the adaptor has started or not
 277   bool                                            mVisible:1;          ///< Whether the scene is visible or not
 278 };
 279
 280 } // Adaptor
 281
 282 } // Internal
 283
 284 // Get impl of handle
 285 inline Internal::Adaptor::SceneHolder& GetImplementation( Dali::Integration::SceneHolder& sceneHolder )
 286 {
 287   DALI_ASSERT_ALWAYS( sceneHolder && "SceneHolder handle is empty" );
 288   Dali::RefObject& object = sceneHolder.GetBaseObject();
 289   return static_cast<Internal::Adaptor::SceneHolder&>( object );
 290 }
 291
 292 inline const Internal::Adaptor::SceneHolder& GetImplementation( const Dali::Integration::SceneHolder& sceneHolder )
 293 {
 294   DALI_ASSERT_ALWAYS( sceneHolder && "SceneHolder handle is empty" );
 295   const Dali::RefObject& object = sceneHolder.GetBaseObject();
 296   return static_cast<const Internal::Adaptor::SceneHolder&>( object );
 297 }
 298
 299 } // Dali
 300
 301 #endif // DALI_INTEGRATION_INTERNAL_SCENEHOLDER_H