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    * Notify the surface has been resized.
 124    */
 125   void SurfaceResized();
 126
 127   /**
 128    * @copydoc Dali::Integration::Scene::Discard
 129    */
 130   void Discard();
 131
 132   /**
 133    * Retrieve the render surface the scene is binded to.
 134    * @return The render surface.
 135    */
 136   Integration::RenderSurface* GetSurface() const;
 137
 138   /**
 139    * Retrieve the ordered list of on-scene layers.
 140    * @return The layer-list.
 141    */
 142   LayerList& GetLayerList() const;
 143
 144   /**
 145    * Request that the depth tree is rebuilt
 146    */
 147   void RequestRebuildDepthTree();
 148
 149   /**
 150    * This function is called when an event is queued.
 151    * @param[in] event A event to queue.
 152    */
 153   void QueueEvent( const Integration::Event& event );
 154
 155   /**
 156    * This function is called by Core when events are processed.
 157    */
 158   void ProcessEvents();
 159
 160   /**
 161    * Rebuilds the depth tree at the end of the event frame if
 162    * it was requested this frame.
 163    */
 164   void RebuildDepthTree();
 165
 166   /**
 167    * @brief Sets the background color of the render surface.
 168    * @param[in] color The new background color
 169    */
 170   void SetBackgroundColor( const Vector4& color );
 171
 172   /**
 173    * @brief Gets the background color of the render　surface.
 174    * @return The background color
 175    */
 176   Vector4 GetBackgroundColor() const;
 177
 178   /**
 179    * Used by the EventProcessor to emit key event signals.
 180    * @param[in] event The key event.
 181    */
 182   void EmitKeyEventSignal(const KeyEvent& event);
 183
 184   /**
 185    * Used by the KeyEventProcessor to emit KeyEventGenerated signals.
 186    * @param[in] event The key event.
 187    * @return The return is true if KeyEvent is consumed, otherwise false.
 188    */
 189   bool EmitKeyEventGeneratedSignal(const KeyEvent& event);
 190
 191   /**
 192    * Emits the event processing finished signal.
 193    *
 194    * @see Dali::Scene::SignalEventProcessingFinished()
 195    */
 196   void EmitEventProcessingFinishedSignal();
 197
 198   /**
 199    * Emits the touched signal.
 200    * @param[in] touchEvent The touch event details (Old API).
 201    * @param[in] touch The touch event details.
 202    */
 203   void EmitTouchedSignal( const TouchEvent& touchEvent, const Dali::TouchData& touch );
 204
 205   /**
 206    * Used by the EventProcessor to emit wheel event signals.
 207    * @param[in] event The wheel event.
 208    */
 209   void EmitWheelEventSignal( const WheelEvent& event );
 210
 211   /**
 212    * @copydoc Integration::Scene::KeyEventSignal()
 213    */
 214   Integration::Scene::KeyEventSignalType& KeyEventSignal();
 215
 216     /**
 217    * @copydoc Integration::Scene::KeyEventGeneratedSignal()
 218    */
 219   Integration::Scene::KeyEventGeneratedSignalType& KeyEventGeneratedSignal();
 220
 221   /**
 222    * @copydoc Integration::Scene::SignalEventProcessingFinished()
 223    */
 224   Integration::Scene::EventProcessingFinishedSignalType& EventProcessingFinishedSignal();
 225
 226   // The touched signal, to support Stage touched signal, will be removed when deprecated in public Stage API
 227   using TouchedSignalType = Signal< void (const TouchEvent&) >;
 228
 229   /**
 230    * Touched signal to support deprecated stage touched signal.
 231    */
 232   TouchedSignalType& TouchedSignal();
 233
 234   /**
 235     * @copydoc Integration::Scene::TouchSignal()
 236     */
 237   Integration::Scene::TouchSignalType& TouchSignal();
 238
 239   /**
 240    * @copydoc Integration::Scene::sWheelEventSignal()
 241    */
 242   Integration::Scene::WheelEventSignalType& WheelEventSignal();
 243
 244 public:
 245
 246   /**
 247    * From RenderTaskDefaults; retrieve the default root actor.
 248    * @return The default root actor.
 249    */
 250   virtual Actor& GetDefaultRootActor();
 251
 252   /**
 253    * From RenderTaskDefaults; retrieve the default camera actor.
 254    * @return The default camera actor.
 255    */
 256   virtual CameraActor& GetDefaultCameraActor();
 257
 258 private:
 259
 260   // Constructor
 261   Scene( const Size& size );
 262
 263   /**
 264    * Second-phase constructor.
 265    */
 266   void Initialize();
 267
 268   // Undefined
 269   Scene(const Scene&) = delete;
 270
 271   // Undefined
 272   Scene& operator=(const Scene& rhs) = delete;
 273
 274 private:
 275   Integration::RenderSurface* mSurface;
 276
 277   // The scene-size may be different with the surface-size
 278   Size mSize;
 279   Size mSurfaceSize;
 280
 281   Vector2 mDpi;
 282
 283   Vector4 mBackgroundColor;
 284
 285   LayerPtr mRootLayer;
 286
 287   // Ordered list of currently on-stage layers
 288   OwnerPointer<LayerList> mLayerList;
 289
 290   IntrusivePtr<CameraActor> mDefaultCamera;
 291
 292   // The list of render-tasks
 293   IntrusivePtr<RenderTaskList> mRenderTaskList;
 294
 295   // The frame buffer
 296   FrameBufferPtr mFrameBuffer;
 297
 298   bool mDepthTreeDirty:1;  ///< True if the depth tree needs recalculating
 299
 300   EventProcessor mEventProcessor;
 301
 302   // The key event signal
 303   Integration::Scene::KeyEventSignalType mKeyEventSignal;
 304   Integration::Scene::KeyEventGeneratedSignalType   mKeyEventGeneratedSignal;
 305
 306   // The event processing finished signal
 307   Integration::Scene::EventProcessingFinishedSignalType mEventProcessingFinishedSignal;
 308
 309   // The touch signal
 310   Integration::Scene::TouchSignalType mTouchSignal;
 311
 312   // The touched signal
 313   TouchedSignalType mTouchedSignal;
 314
 315   // The wheel event signal
 316   Integration::Scene::WheelEventSignalType mWheelEventSignal;
 317 };
 318
 319 } // Internal
 320
 321 // Get impl of handle
 322 inline Internal::Scene& GetImplementation(Dali::Integration::Scene& scene)
 323 {
 324   DALI_ASSERT_ALWAYS( scene && "Scene handle is empty" );
 325   Dali::RefObject& object = scene.GetBaseObject();
 326   return static_cast<Internal::Scene&>(object);
 327 }
 328
 329 inline const Internal::Scene& GetImplementation(const Dali::Integration::Scene& scene)
 330 {
 331   DALI_ASSERT_ALWAYS( scene && "Scene handle is empty" );
 332   const Dali::RefObject& object = scene.GetBaseObject();
 333   return static_cast<const Internal::Scene&>(object);
 334 }
 335
 336 } // Dali
 337
 338 #endif // DALI_INTERNAL_SCENE_H