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