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

   1 #ifndef DALI_INTERNAL_SCENE_H
   2 #define DALI_INTERNAL_SCENE_H
   3
   4 /*
   5  * Copyright (c) 2021 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/internal/common/owner-pointer.h>
  24 #include <dali/internal/event/actors/layer-impl.h>
  25 #include <dali/internal/event/events/event-processor.h>
  26 #include <dali/internal/event/render-tasks/render-task-defaults.h>
  27 #include <dali/public-api/actors/layer.h>
  28 #include <dali/public-api/math/vector2.h>
  29 #include <dali/public-api/render-tasks/render-task-list.h>
  30
  31 namespace Dali
  32 {
  33 namespace Integration
  34 {
  35 struct Event;
  36
  37 }
  38
  39 namespace Internal
  40 {
  41 //@todo Break this dependence somehow.
  42 namespace Render
  43 {
  44 class Renderer;
  45 }
  46
  47 namespace SceneGraph
  48 {
  49 class Scene;
  50
  51 struct DirtyRect
  52 {
  53   DirtyRect(Node* node, Render::Renderer* renderer, int frame, Rect<int>& rect)
  54   : node(node),
  55     renderer(renderer),
  56     frame(frame),
  57     rect(rect),
  58     visited(true)
  59   {
  60   }
  61
  62   DirtyRect()
  63   : node(nullptr),
  64     renderer(nullptr),
  65     frame(0),
  66     rect(),
  67     visited(true)
  68   {
  69   }
  70
  71   bool operator<(const DirtyRect& rhs) const
  72   {
  73     if(node == rhs.node)
  74     {
  75       if(renderer == rhs.renderer)
  76       {
  77         return frame > rhs.frame; // Most recent rects come first
  78       }
  79       else
  80       {
  81         return renderer < rhs.renderer;
  82       }
  83     }
  84     else
  85     {
  86       return node < rhs.node;
  87     }
  88   }
  89
  90   Node*             node;
  91   Render::Renderer* renderer;
  92   int               frame;
  93
  94   Rect<int> rect;
  95   bool      visited;
  96 };
  97
  98 } // namespace SceneGraph
  99
 100 class EventProcessor;
 101 class Layer;
 102 class LayerList;
 103 class CameraActor;
 104 class RenderTaskList;
 105 class FrameBuffer;
 106
 107 using FrameBufferPtr = IntrusivePtr<FrameBuffer>;
 108 using ScenePtr       = IntrusivePtr<Scene>;
 109
 110 /**
 111  * @brief Scene creates a "world" that can be bound to a surface for rendering.
 112  */
 113 class Scene : public BaseObject, public RenderTaskDefaults
 114 {
 115 public:
 116   /**
 117    * @copydoc Dali::Integration::Scene::New
 118    */
 119   static ScenePtr New(Size size, int orientation = 0);
 120
 121   /**
 122    * virtual destructor
 123    */
 124   ~Scene() override;
 125
 126   /**
 127    * @copydoc Dali::Integration::Scene::Add
 128    */
 129   void Add(Actor& actor);
 130
 131   /**
 132    * @copydoc Dali::Integration::Scene::Remove
 133    */
 134   void Remove(Actor& actor);
 135
 136   /**
 137    * @copydoc Dali::Integration::Scene::GetSize
 138    */
 139   Size GetSize() const;
 140
 141   /**
 142    * @copydoc Dali::Integration::Scene::SetDpi
 143    */
 144   void SetDpi(Vector2 dpi);
 145
 146   /**
 147    * @copydoc Dali::Integration::Scene::GetDpi
 148    */
 149   Vector2 GetDpi() const;
 150
 151   /**
 152    * @copydoc Dali::Integration::Scene::GetRenderTaskList
 153    */
 154   RenderTaskList& GetRenderTaskList() const;
 155
 156   /**
 157    * @copydoc Dali::Integration::Scene::GetRootLayer
 158    */
 159   Dali::Layer GetRootLayer() const;
 160
 161   /**
 162    * @copydoc Dali::Integration::Scene::GetLayerCount
 163    */
 164   uint32_t GetLayerCount() const;
 165
 166   /**
 167    * @copydoc Dali::Integration::Scene::GetLayer
 168    */
 169   Dali::Layer GetLayer(uint32_t depth) const;
 170
 171   /**
 172    * Notify the surface has been resized.
 173    *
 174    * @param[in] width The new width of the set surface
 175    * @param[in] height The new height of the set surface
 176    */
 177   void SurfaceResized(float width, float height);
 178
 179   /**
 180    * @copydoc Dali::Integration::Scene::SurfaceReplaced
 181    */
 182   void SurfaceReplaced();
 183
 184   /**
 185    * @copydoc Dali::Integration::Scene::Discard
 186    */
 187   void Discard();
 188
 189   /**
 190    * Retrieve the ordered list of on-scene layers.
 191    * @return The layer-list.
 192    */
 193   LayerList& GetLayerList() const;
 194
 195   /**
 196    * Request that the depth tree is rebuilt
 197    */
 198   void RequestRebuildDepthTree();
 199
 200   /**
 201    * This function is called when an event is queued.
 202    * @param[in] event A event to queue.
 203    */
 204   void QueueEvent(const Integration::Event& event);
 205
 206   /**
 207    * This function is called by Core when events are processed.
 208    */
 209   void ProcessEvents();
 210
 211   /**
 212    * Rebuilds the depth tree at the end of the event frame if
 213    * it was requested this frame.
 214    */
 215   void RebuildDepthTree();
 216
 217   /**
 218    * @brief Sets the background color of the render surface.
 219    * @param[in] color The new background color
 220    */
 221   void SetBackgroundColor(const Vector4& color);
 222
 223   /**
 224    * @brief Gets the background color of the render　surface.
 225    * @return The background color
 226    */
 227   Vector4 GetBackgroundColor() const;
 228
 229   /**
 230    * @brief Get the Scene scene graph object
 231    *
 232    * @return the Scene scene graph object
 233    */
 234   SceneGraph::Scene* GetSceneObject() const;
 235
 236   /**
 237    * Notify the surface has been rotated.
 238    * When the device is rotated or the rotation event is received by display manager,
 239    * this function will be called by window implementation.
 240    *
 241    * @param[in] width The width of rotated surface
 242    * @param[in] height The height of rotated surface
 243    * @param[in] orientation The orientation of rotated surface
 244    */
 245   void SurfaceRotated(float width, float height, int orientation);
 246
 247   /**
 248    * @brief Get surface's current orientation
 249    *
 250    * @return surface orientation
 251    */
 252   int GetSurfaceOrientation();
 253
 254   /**
 255    * Used by the EventProcessor to emit key event signals.
 256    * @param[in] event The key event.
 257    */
 258   void EmitKeyEventSignal(const Dali::KeyEvent& event);
 259
 260   /**
 261    * Used by the KeyEventProcessor to emit KeyEventGenerated signals.
 262    * @param[in] event The key event.
 263    * @return The return is true if KeyEvent is consumed, otherwise false.
 264    */
 265   bool EmitKeyEventGeneratedSignal(const Dali::KeyEvent& event);
 266
 267   /**
 268    * Emits the event processing finished signal.
 269    *
 270    * @see Dali::Scene::SignalEventProcessingFinished()
 271    */
 272   void EmitEventProcessingFinishedSignal();
 273
 274   /**
 275    * Emits the touched signal.
 276    * @param[in] touch The touch event details.
 277    */
 278   void EmitTouchedSignal(const Dali::TouchEvent& touch);
 279
 280   /**
 281    * Used by the EventProcessor to emit wheel event signals.
 282    * @param[in] event The wheel event.
 283    */
 284   void EmitWheelEventSignal(const Dali::WheelEvent& event);
 285
 286   /**
 287    * @copydoc Dali::Integration::Scene::AddFrameRenderedCallback
 288    */
 289   void AddFrameRenderedCallback(std::unique_ptr<CallbackBase> callback, int32_t frameId);
 290
 291   /**
 292    * @copydoc Dali::Integration::Scene::AddFramePresentedCallback
 293    */
 294   void AddFramePresentedCallback(std::unique_ptr<CallbackBase> callback, int32_t frameId);
 295
 296   /**
 297    * @copydoc Dali::Integration::Scene::GetFrameRenderedCallback
 298    */
 299   void GetFrameRenderedCallback(Dali::Integration::Scene::FrameCallbackContainer& callbacks);
 300
 301   /**
 302    * @copydoc Dali::Integration::Scene::GetFramePresentedCallback
 303    */
 304   void GetFramePresentedCallback(Dali::Integration::Scene::FrameCallbackContainer& callbacks);
 305
 306   /**
 307    * @copydoc Integration::Scene::KeyEventSignal()
 308    */
 309   Integration::Scene::KeyEventSignalType& KeyEventSignal();
 310
 311   /**
 312    * @copydoc Integration::Scene::KeyEventGeneratedSignal()
 313    */
 314   Integration::Scene::KeyEventGeneratedSignalType& KeyEventGeneratedSignal();
 315
 316   /**
 317    * @copydoc Integration::Scene::SignalEventProcessingFinished()
 318    */
 319   Integration::Scene::EventProcessingFinishedSignalType& EventProcessingFinishedSignal();
 320
 321   /**
 322     * @copydoc Integration::Scene::TouchedSignal()
 323     */
 324   Integration::Scene::TouchEventSignalType& TouchedSignal();
 325
 326   /**
 327    * @copydoc Integration::Scene::sWheelEventSignal()
 328    */
 329   Integration::Scene::WheelEventSignalType& WheelEventSignal();
 330
 331   /**
 332    * @brief Get ItemsDirtyRects
 333    *
 334    * @return the ItemsDirtyRects
 335    */
 336   std::vector<Dali::Internal::SceneGraph::DirtyRect>& GetItemsDirtyRects();
 337
 338 public:
 339   /**
 340    * From RenderTaskDefaults; retrieve the default root actor.
 341    * @return The default root actor.
 342    */
 343   Actor& GetDefaultRootActor() override;
 344
 345   /**
 346    * From RenderTaskDefaults; retrieve the default camera actor.
 347    * @return The default camera actor.
 348    */
 349   CameraActor& GetDefaultCameraActor() override;
 350
 351 private:
 352   // Constructor
 353   Scene();
 354
 355   /**
 356    * Second-phase constructor.
 357    *
 358    * @param[in] size The size of the set surface
 359    * @param[in] orientation The orientation of the set surface for this scene
 360    */
 361   void Initialize(Size size, int orientation);
 362
 363   // Undefined
 364   Scene(const Scene&) = delete;
 365
 366   // Undefined
 367   Scene& operator=(const Scene& rhs) = delete;
 368
 369   /**
 370    * Informs the scene that the set surface has been resized or rotated.
 371    *
 372    * @param[in] width The width of rotated surface
 373    * @param[in] height The height of rotated surface
 374    * @param[in] orientation The orientation of rotated surface
 375    */
 376   void ChangedSurface(float width, float height, int orientation);
 377
 378 private:
 379   Internal::SceneGraph::Scene* mSceneObject;
 380
 381   Size mSize;
 382
 383   Vector2 mDpi;
 384
 385   Vector4 mBackgroundColor;
 386
 387   LayerPtr mRootLayer;
 388
 389   // Ordered list of currently on-stage layers
 390   OwnerPointer<LayerList> mLayerList;
 391
 392   IntrusivePtr<CameraActor> mDefaultCamera;
 393
 394   // The list of render-tasks
 395   IntrusivePtr<RenderTaskList> mRenderTaskList;
 396
 397   bool mDepthTreeDirty : 1; ///< True if the depth tree needs recalculating
 398
 399   EventProcessor mEventProcessor;
 400
 401   // The Surface's orientation
 402   int mSurfaceOrientation;
 403
 404   // The key event signal
 405   Integration::Scene::KeyEventSignalType          mKeyEventSignal;
 406   Integration::Scene::KeyEventGeneratedSignalType mKeyEventGeneratedSignal;
 407
 408   // The event processing finished signal
 409   Integration::Scene::EventProcessingFinishedSignalType mEventProcessingFinishedSignal;
 410
 411   // The touch signal
 412   Integration::Scene::TouchEventSignalType mTouchedSignal;
 413
 414   // The wheel event signal
 415   Integration::Scene::WheelEventSignalType mWheelEventSignal;
 416
 417   std::vector<Dali::Internal::SceneGraph::DirtyRect> mItemsDirtyRects;
 418 };
 419
 420 } // namespace Internal
 421
 422 // Get impl of handle
 423 inline Internal::Scene& GetImplementation(Dali::Integration::Scene& scene)
 424 {
 425   DALI_ASSERT_ALWAYS(scene && "Scene handle is empty");
 426   Dali::RefObject& object = scene.GetBaseObject();
 427   return static_cast<Internal::Scene&>(object);
 428 }
 429
 430 inline const Internal::Scene& GetImplementation(const Dali::Integration::Scene& scene)
 431 {
 432   DALI_ASSERT_ALWAYS(scene && "Scene handle is empty");
 433   const Dali::RefObject& object = scene.GetBaseObject();
 434   return static_cast<const Internal::Scene&>(object);
 435 }
 436
 437 } // namespace Dali
 438
 439 #endif // DALI_INTERNAL_SCENE_H