Add methods to get current size and orientation to Scene
[platform/core/uifw/dali-core.git] / dali / internal / event / common / scene-impl.h
index 01766df..51550cf 100644 (file)
@@ -2,7 +2,7 @@
 #define DALI_INTERNAL_SCENE_H
 
 /*
- * Copyright (c) 2019 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2021 Samsung Electronics Co., Ltd.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
 
 // INTERNAL INCLUDES
 #include <dali/integration-api/scene.h>
-#include <dali/public-api/math/vector2.h>
-#include <dali/public-api/actors/layer.h>
-#include <dali/public-api/render-tasks/render-task-list.h>
-#include <dali/integration-api/render-surface.h>
 #include <dali/internal/common/owner-pointer.h>
 #include <dali/internal/event/actors/layer-impl.h>
 #include <dali/internal/event/events/event-processor.h>
 #include <dali/internal/event/render-tasks/render-task-defaults.h>
+#include <dali/public-api/actors/layer.h>
+#include <dali/public-api/math/vector2.h>
+#include <dali/public-api/render-tasks/render-task-list.h>
 
 namespace Dali
 {
-
 namespace Integration
 {
-
 struct Event;
 
 }
 
 namespace Internal
 {
+//@todo Break this dependence somehow.
+namespace Render
+{
+class Renderer;
+}
+
+namespace SceneGraph
+{
+class Scene;
+
+struct DirtyRect
+{
+  DirtyRect(Node* node, Render::Renderer* renderer, int32_t frame, Rect<int>& rect)
+  : node(node),
+    renderer(renderer),
+    frame(frame),
+    rect(rect),
+    visited(true)
+  {
+  }
+
+  DirtyRect()
+  : node(nullptr),
+    renderer(nullptr),
+    frame(0),
+    rect(),
+    visited(true)
+  {
+  }
+
+  bool operator<(const DirtyRect& rhs) const
+  {
+    if(node == rhs.node)
+    {
+      if(renderer == rhs.renderer)
+      {
+        return frame > rhs.frame; // Most recent rects come first
+      }
+      else
+      {
+        return renderer < rhs.renderer;
+      }
+    }
+    else
+    {
+      return node < rhs.node;
+    }
+  }
+
+  Node*             node;
+  Render::Renderer* renderer;
+  int32_t           frame;
+
+  Rect<int32_t> rect;
+  bool          visited;
+};
+
+} // namespace SceneGraph
 
 class EventProcessor;
 class Layer;
@@ -50,24 +105,23 @@ class RenderTaskList;
 class FrameBuffer;
 
 using FrameBufferPtr = IntrusivePtr<FrameBuffer>;
-using ScenePtr = IntrusivePtr<Scene>;
+using ScenePtr       = IntrusivePtr<Scene>;
 
 /**
  * @brief Scene creates a "world" that can be bound to a surface for rendering.
  */
 class Scene : public BaseObject, public RenderTaskDefaults
 {
-
 public:
   /**
    * @copydoc Dali::Integration::Scene::New
    */
-  static ScenePtr New( Integration::RenderSurface& surface );
+  static ScenePtr New(Size size, int32_t orientation = 0);
 
   /**
    * virtual destructor
    */
-  virtual ~Scene();
+  ~Scene() override;
 
   /**
    * @copydoc Dali::Integration::Scene::Add
@@ -87,7 +141,7 @@ public:
   /**
    * @copydoc Dali::Integration::Scene::SetDpi
    */
-  void SetDpi( Vector2 dpi );
+  void SetDpi(Vector2 dpi);
 
   /**
    * @copydoc Dali::Integration::Scene::GetDpi
@@ -115,19 +169,17 @@ public:
   Dali::Layer GetLayer(uint32_t depth) const;
 
   /**
-   * @copydoc Dali::Integration::Scene::SetSurface
-   */
-  void SetSurface( Integration::RenderSurface& surface );
-
-  /**
    * Notify the surface has been resized.
+   *
+   * @param[in] width The new width of the set surface
+   * @param[in] height The new height of the set surface
    */
-  void SurfaceResized();
+  void SurfaceResized(float width, float height);
 
   /**
-   * Notify the surface has been deleted.
+   * @copydoc Dali::Integration::Scene::SurfaceReplaced
    */
-  void SurfaceDeleted();
+  void SurfaceReplaced();
 
   /**
    * @copydoc Dali::Integration::Scene::Discard
@@ -135,12 +187,6 @@ public:
   void Discard();
 
   /**
-   * Retrieve the render surface the scene is binded to.
-   * @return The render surface.
-   */
-  Integration::RenderSurface* GetSurface() const;
-
-  /**
    * Retrieve the ordered list of on-scene layers.
    * @return The layer-list.
    */
@@ -155,7 +201,7 @@ public:
    * This function is called when an event is queued.
    * @param[in] event A event to queue.
    */
-  void QueueEvent( const Integration::Event& event );
+  void QueueEvent(const Integration::Event& event);
 
   /**
    * This function is called by Core when events are processed.
@@ -172,7 +218,7 @@ public:
    * @brief Sets the background color of the render surface.
    * @param[in] color The new background color
    */
-  void SetBackgroundColor( const Vector4& color );
+  void SetBackgroundColor(const Vector4& color);
 
   /**
    * @brief Gets the background color of the render surface.
@@ -181,17 +227,50 @@ public:
   Vector4 GetBackgroundColor() const;
 
   /**
+   * @brief Get the Scene scene graph object
+   *
+   * @return the Scene scene graph object
+   */
+  SceneGraph::Scene* GetSceneObject() const;
+
+  /**
+   * Notify the surface has been rotated.
+   * When the device is rotated or the rotation event is received by display manager,
+   * this function will be called by window implementation.
+   *
+   * @param[in] width The width of rotated surface
+   * @param[in] height The height of rotated surface
+   * @param[in] orientation The orientation of rotated surface
+   */
+  void SurfaceRotated(float width, float height, int32_t orientation);
+
+  /**
+   * @copydoc Dali::Integration::Scene::GetCurrentSurfaceOrientation
+   */
+  int32_t GetCurrentSurfaceOrientation() const;
+
+  /**
+   * @copydoc Dali::Integration::Scene::GetCurrentSurfaceRect
+   */
+  const Rect<int32_t>& GetCurrentSurfaceRect() const;
+
+  /**
+   * @copydoc Dali::Integration::Scene::IsSurfaceRectChanged
+   */
+  bool IsSurfaceRectChanged() const;
+
+  /**
    * Used by the EventProcessor to emit key event signals.
    * @param[in] event The key event.
    */
-  void EmitKeyEventSignal(const KeyEvent& event);
+  void EmitKeyEventSignal(const Dali::KeyEvent& event);
 
   /**
    * Used by the KeyEventProcessor to emit KeyEventGenerated signals.
    * @param[in] event The key event.
    * @return The return is true if KeyEvent is consumed, otherwise false.
    */
-  bool EmitKeyEventGeneratedSignal(const KeyEvent& event);
+  bool EmitKeyEventGeneratedSignal(const Dali::KeyEvent& event);
 
   /**
    * Emits the event processing finished signal.
@@ -202,23 +281,42 @@ public:
 
   /**
    * Emits the touched signal.
-   * @param[in] touchEvent The touch event details (Old API).
    * @param[in] touch The touch event details.
    */
-  void EmitTouchedSignal( const TouchEvent& touchEvent, const Dali::TouchData& touch );
+  void EmitTouchedSignal(const Dali::TouchEvent& touch);
 
   /**
    * Used by the EventProcessor to emit wheel event signals.
    * @param[in] event The wheel event.
    */
-  void EmitWheelEventSignal( const WheelEvent& event );
+  void EmitWheelEventSignal(const Dali::WheelEvent& event);
+
+  /**
+   * @copydoc Dali::Integration::Scene::AddFrameRenderedCallback
+   */
+  void AddFrameRenderedCallback(std::unique_ptr<CallbackBase> callback, int32_t frameId);
+
+  /**
+   * @copydoc Dali::Integration::Scene::AddFramePresentedCallback
+   */
+  void AddFramePresentedCallback(std::unique_ptr<CallbackBase> callback, int32_t frameId);
+
+  /**
+   * @copydoc Dali::Integration::Scene::GetFrameRenderedCallback
+   */
+  void GetFrameRenderedCallback(Dali::Integration::Scene::FrameCallbackContainer& callbacks);
+
+  /**
+   * @copydoc Dali::Integration::Scene::GetFramePresentedCallback
+   */
+  void GetFramePresentedCallback(Dali::Integration::Scene::FrameCallbackContainer& callbacks);
 
   /**
    * @copydoc Integration::Scene::KeyEventSignal()
    */
   Integration::Scene::KeyEventSignalType& KeyEventSignal();
 
-    /**
+  /**
    * @copydoc Integration::Scene::KeyEventGeneratedSignal()
    */
   Integration::Scene::KeyEventGeneratedSignalType& KeyEventGeneratedSignal();
@@ -228,47 +326,47 @@ public:
    */
   Integration::Scene::EventProcessingFinishedSignalType& EventProcessingFinishedSignal();
 
-  // The touched signal, to support Stage touched signal, will be removed when deprecated in public Stage API
-  using TouchedSignalType = Signal< void (const TouchEvent&) >;
-
   /**
-   * Touched signal to support deprecated stage touched signal.
-   */
-  TouchedSignalType& TouchedSignal();
-
-  /**
-    * @copydoc Integration::Scene::TouchSignal()
+    * @copydoc Integration::Scene::TouchedSignal()
     */
-  Integration::Scene::TouchSignalType& TouchSignal();
+  Integration::Scene::TouchEventSignalType& TouchedSignal();
 
   /**
    * @copydoc Integration::Scene::sWheelEventSignal()
    */
   Integration::Scene::WheelEventSignalType& WheelEventSignal();
 
-public:
+  /**
+   * @brief Get ItemsDirtyRects
+   *
+   * @return the ItemsDirtyRects
+   */
+  std::vector<Dali::Internal::SceneGraph::DirtyRect>& GetItemsDirtyRects();
 
+public:
   /**
    * From RenderTaskDefaults; retrieve the default root actor.
    * @return The default root actor.
    */
-  virtual Actor& GetDefaultRootActor();
+  Actor& GetDefaultRootActor() override;
 
   /**
    * From RenderTaskDefaults; retrieve the default camera actor.
    * @return The default camera actor.
    */
-  virtual CameraActor& GetDefaultCameraActor();
+  CameraActor& GetDefaultCameraActor() override;
 
 private:
-
   // Constructor
   Scene();
 
   /**
    * Second-phase constructor.
+   *
+   * @param[in] size The size of the set surface
+   * @param[in] orientation The orientation of the set surface for this scene
    */
-  void Initialize( Integration::RenderSurface& surface );
+  void Initialize(Size size, int32_t orientation);
 
   // Undefined
   Scene(const Scene&) = delete;
@@ -276,8 +374,17 @@ private:
   // Undefined
   Scene& operator=(const Scene& rhs) = delete;
 
+  /**
+   * Informs the scene that the set surface has been resized or rotated.
+   *
+   * @param[in] width The width of rotated surface
+   * @param[in] height The height of rotated surface
+   * @param[in] orientation The orientation of rotated surface
+   */
+  void ChangedSurface(float width, float height, int32_t orientation);
+
 private:
-  Integration::RenderSurface* mSurface;
+  Internal::SceneGraph::Scene* mSceneObject;
 
   Size mSize;
 
@@ -295,47 +402,46 @@ private:
   // The list of render-tasks
   IntrusivePtr<RenderTaskList> mRenderTaskList;
 
-  // The frame buffer
-  FrameBufferPtr mFrameBuffer;
-
-  bool mDepthTreeDirty:1;  ///< True if the depth tree needs recalculating
+  bool mDepthTreeDirty : 1; ///< True if the depth tree needs recalculating
 
   EventProcessor mEventProcessor;
 
+  // The Surface's orientation
+  int32_t mSurfaceOrientation;
+
   // The key event signal
-  Integration::Scene::KeyEventSignalType mKeyEventSignal;
-  Integration::Scene::KeyEventGeneratedSignalType   mKeyEventGeneratedSignal;
+  Integration::Scene::KeyEventSignalType          mKeyEventSignal;
+  Integration::Scene::KeyEventGeneratedSignalType mKeyEventGeneratedSignal;
 
   // The event processing finished signal
   Integration::Scene::EventProcessingFinishedSignalType mEventProcessingFinishedSignal;
 
   // The touch signal
-  Integration::Scene::TouchSignalType mTouchSignal;
-
-  // The touched signal
-  TouchedSignalType mTouchedSignal;
+  Integration::Scene::TouchEventSignalType mTouchedSignal;
 
   // The wheel event signal
   Integration::Scene::WheelEventSignalType mWheelEventSignal;
+
+  std::vector<Dali::Internal::SceneGraph::DirtyRect> mItemsDirtyRects;
 };
 
-} // Internal
+} // namespace Internal
 
 // Get impl of handle
 inline Internal::Scene& GetImplementation(Dali::Integration::Scene& scene)
 {
-  DALI_ASSERT_ALWAYS( scene && "Scene handle is empty" );
+  DALI_ASSERT_ALWAYS(scene && "Scene handle is empty");
   Dali::RefObject& object = scene.GetBaseObject();
   return static_cast<Internal::Scene&>(object);
 }
 
 inline const Internal::Scene& GetImplementation(const Dali::Integration::Scene& scene)
 {
-  DALI_ASSERT_ALWAYS( scene && "Scene handle is empty" );
+  DALI_ASSERT_ALWAYS(scene && "Scene handle is empty");
   const Dali::RefObject& object = scene.GetBaseObject();
   return static_cast<const Internal::Scene&>(object);
 }
 
-} // Dali
+} // namespace Dali
 
 #endif // DALI_INTERNAL_SCENE_H