dali/internal/event/common/scene-impl.h

   1 #ifndef DALI_INTERNAL_SCENE_H
   2 #define DALI_INTERNAL_SCENE_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 // INTERNAL INCLUDES
  22 #include <dali/integration-api/scene.h>
  23 #include <dali/public-api/math/vector2.h>
  24 #include <dali/public-api/actors/layer.h>
  25 #include <dali/public-api/render-tasks/render-task-list.h>
  26 #include <dali/integration-api/render-surface.h>
  27 #include <dali/internal/common/owner-pointer.h>
  28 #include <dali/internal/event/actors/layer-impl.h>
  29 #include <dali/internal/event/events/event-processor.h>
  30 #include <dali/internal/event/render-tasks/render-task-defaults.h>
  31
  32 namespace Dali
  33 {
  34
  35 namespace Integration
  36 {
  37
  38 class Event;
  39
  40 }
  41
  42 namespace Internal
  43 {
  44
  45 class EventProcessor;
  46 class Layer;
  47 class LayerList;
  48 class CameraActor;
  49 class RenderTaskList;
  50 class FrameBuffer;
  51
  52 using FrameBufferPtr = IntrusivePtr<FrameBuffer>;
  53 using ScenePtr = IntrusivePtr<Scene>;
  54
  55 /**
  56  * @brief Scene creates a "world" that can be bound to a surface for rendering.
  57  */
  58 class Scene : public BaseObject, public RenderTaskDefaults
  59 {
  60
  61 public:
  62   /**
  63    * @copydoc Dali::Integration::Scene::New
  64    */
  65   static ScenePtr New( const Size& size );
  66
  67   /**
  68    * virtual destructor
  69    */
  70   virtual ~Scene();
  71
  72   /**
  73    * @copydoc Dali::Integration::Scene::Add
  74    */
  75   void Add(Actor& actor);
  76
  77   /**
  78    * @copydoc Dali::Integration::Scene::Remove
  79    */
  80   void Remove(Actor& actor);
  81
  82   /**
  83    * @copydoc Dali::Integration::Scene::GetSize
  84    */
  85   Size GetSize() const;
  86
  87   /**
  88    * @copydoc Dali::Integration::Scene::SetDpi
  89    */
  90   void SetDpi( Vector2 dpi );
  91
  92   /**
  93    * @copydoc Dali::Integration::Scene::GetDpi
  94    */
  95   Vector2 GetDpi() const;
  96
  97   /**
  98    * @copydoc Dali::Integration::Scene::GetRenderTaskList
  99    */
 100   RenderTaskList& GetRenderTaskList() const;
 101
 102   /**
 103    * @copydoc Dali::Integration::Scene::GetRootLayer
 104    */
 105   Dali::Layer GetRootLayer() const;
 106
 107   /**
 108    * @copydoc Dali::Integration::Scene::GetLayerCount
 109    */
 110   uint32_t GetLayerCount() const;
 111
 112   /**
 113    * @copydoc Dali::Integration::Scene::GetLayer
 114    */
 115   Dali::Layer GetLayer(uint32_t depth) const;
 116
 117   /**
 118    * @copydoc Dali::Integration::Scene::SetSurface
 119    */
 120   void SetSurface( Integration::RenderSurface& surface );
 121
 122   /**
 123    * Retrieve the render surface the scene is binded to.
 124    * @return The render surface.
 125    */
 126   Integration::RenderSurface* GetSurface() const;
 127
 128   /**
 129    * Retrieve the ordered list of on-scene layers.
 130    * @return The layer-list.
 131    */
 132   LayerList& GetLayerList() const;
 133
 134   /**
 135    * Request that the depth tree is rebuilt
 136    */
 137   void RequestRebuildDepthTree();
 138
 139   /**
 140    * This function is called when an event is queued.
 141    * @param[in] event A event to queue.
 142    */
 143   void QueueEvent( const Integration::Event& event );
 144
 145   /**
 146    * This function is called by Core when events are processed.
 147    */
 148   void ProcessEvents();
 149
 150   /**
 151    * Rebuilds the depth tree at the end of the event frame if
 152    * it was requested this frame.
 153    */
 154   void RebuildDepthTree();
 155
 156   /**
 157    * @brief Sets the background color of the render　surface.
 158    * @param[in] color The new background color
 159    */
 160   void SetBackgroundColor(Vector4 color);
 161
 162   /**
 163    * @brief Gets the background color of the render　surface.
 164    * @return The background color
 165    */
 166   Vector4 GetBackgroundColor() const;
 167
 168   /**
 169    * Used by the EventProcessor to emit key event signals.
 170    * @param[in] event The key event.
 171    */
 172   void EmitKeyEventSignal(const KeyEvent& event);
 173
 174   /**
 175    * Used by the KeyEventProcessor to emit KeyEventGenerated signals.
 176    * @param[in] event The key event.
 177    * @return The return is true if KeyEvent is consumed, otherwise false.
 178    */
 179   bool EmitKeyEventGeneratedSignal(const KeyEvent& event);
 180
 181   /**
 182    * Emits the event processing finished signal.
 183    *
 184    * @see Dali::Scene::SignalEventProcessingFinished()
 185    */
 186   void EmitEventProcessingFinishedSignal();
 187
 188   /**
 189    * Emits the touched signal.
 190    * @param[in] touchEvent The touch event details (Old API).
 191    * @param[in] touch The touch event details.
 192    */
 193   void EmitTouchedSignal( const TouchEvent& touchEvent, const Dali::TouchData& touch );
 194
 195   /**
 196    * Used by the EventProcessor to emit wheel event signals.
 197    * @param[in] event The wheel event.
 198    */
 199   void EmitWheelEventSignal( const WheelEvent& event );
 200
 201   /**
 202    * @copydoc Integration::Scene::KeyEventSignal()
 203    */
 204   Integration::Scene::KeyEventSignalType& KeyEventSignal();
 205
 206     /**
 207    * @copydoc Integration::Scene::KeyEventGeneratedSignal()
 208    */
 209   Integration::Scene::KeyEventGeneratedSignalType& KeyEventGeneratedSignal();
 210
 211   /**
 212    * @copydoc Integration::Scene::SignalEventProcessingFinished()
 213    */
 214   Integration::Scene::EventProcessingFinishedSignalType& EventProcessingFinishedSignal();
 215
 216   // The touched signal, to support Stage touched signal, will be removed when deprecated in public Stage API
 217   using TouchedSignalType = Signal< void (const TouchEvent&) >;
 218
 219   /**
 220    * Touched signal to support deprecated stage touched signal.
 221    */
 222   TouchedSignalType& TouchedSignal();
 223
 224   /**
 225     * @copydoc Integration::Scene::TouchSignal()
 226     */
 227   Integration::Scene::TouchSignalType& TouchSignal();
 228
 229   /**
 230    * @copydoc Integration::Scene::sWheelEventSignal()
 231    */
 232   Integration::Scene::WheelEventSignalType& WheelEventSignal();
 233
 234 public:
 235
 236   /**
 237    * From RenderTaskDefaults; retrieve the default root actor.
 238    * @return The default root actor.
 239    */
 240   virtual Actor& GetDefaultRootActor();
 241
 242   /**
 243    * From RenderTaskDefaults; retrieve the default camera actor.
 244    * @return The default camera actor.
 245    */
 246   virtual CameraActor& GetDefaultCameraActor();
 247
 248 private:
 249
 250   // Constructor
 251   Scene( const Size& size );
 252
 253   /**
 254    * Second-phase constructor.
 255    */
 256   void Initialize();
 257
 258   // Undefined
 259   Scene(const Scene&) = delete;
 260
 261   // Undefined
 262   Scene& operator=(const Scene& rhs) = delete;
 263
 264 private:
 265   Integration::RenderSurface* mSurface;
 266
 267   // The scene-size may be different with the surface-size
 268   Size mSize;
 269   Size mSurfaceSize;
 270
 271   Vector2 mDpi;
 272
 273   LayerPtr mRootLayer;
 274
 275   // Ordered list of currently on-stage layers
 276   OwnerPointer<LayerList> mLayerList;
 277
 278   IntrusivePtr<CameraActor> mDefaultCamera;
 279
 280   // The list of render-tasks
 281   IntrusivePtr<RenderTaskList> mRenderTaskList;
 282
 283   // The frame buffer
 284   FrameBufferPtr mFrameBuffer;
 285
 286   bool mDepthTreeDirty:1;  ///< True if the depth tree needs recalculating
 287
 288   EventProcessor mEventProcessor;
 289
 290   // The key event signal
 291   Integration::Scene::KeyEventSignalType mKeyEventSignal;
 292   Integration::Scene::KeyEventGeneratedSignalType   mKeyEventGeneratedSignal;
 293
 294   // The event processing finished signal
 295   Integration::Scene::EventProcessingFinishedSignalType mEventProcessingFinishedSignal;
 296
 297   // The touch signal
 298   Integration::Scene::TouchSignalType mTouchSignal;
 299
 300   // The touched signal
 301   TouchedSignalType mTouchedSignal;
 302
 303   // The wheel event signal
 304   Integration::Scene::WheelEventSignalType mWheelEventSignal;
 305 };
 306
 307 } // Internal
 308
 309 // Get impl of handle
 310 inline Internal::Scene& GetImplementation(Dali::Integration::Scene& scene)
 311 {
 312   DALI_ASSERT_ALWAYS( scene && "Scene handle is empty" );
 313   Dali::RefObject& object = scene.GetBaseObject();
 314   return static_cast<Internal::Scene&>(object);
 315 }
 316
 317 inline const Internal::Scene& GetImplementation(const Dali::Integration::Scene& scene)
 318 {
 319   DALI_ASSERT_ALWAYS( scene && "Scene handle is empty" );
 320   const Dali::RefObject& object = scene.GetBaseObject();
 321   return static_cast<const Internal::Scene&>(object);
 322 }
 323
 324 } // Dali
 325
 326 #endif // DALI_INTERNAL_SCENE_H