[Tizen] Add screen and client rotation itself function
[platform/core/uifw/dali-core.git] / dali / integration-api / scene.h
index 4e44caf..5258eec 100755 (executable)
@@ -2,7 +2,7 @@
 #define DALI_SCENE_H
 
 /*
- * Copyright (c) 2019 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2020 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.
@@ -21,6 +21,7 @@
 // INTERNAL INCLUDES
 #include <dali/public-api/object/handle.h>
 #include <dali/public-api/math/vector2.h>
+#include <dali/public-api/math/vector4.h>
 
 namespace Dali
 {
@@ -40,7 +41,6 @@ namespace Internal DALI_INTERNAL
 namespace Integration
 {
 
-class RenderSurface;
 struct Event;
 
 /**
@@ -61,11 +61,11 @@ public:
   /**
    * @brief Create an initialized Scene handle.
    *
-   * @param[in] size The size of the scene in pixels as a Vector
+   * @param[in] size The size of the set surface for this scene
    *
    * @return a handle to a newly allocated Dali resource.
    */
-  static Scene New( const Size& size );
+  static Scene New( Size size );
 
   /**
    * @brief Downcast an Object handle to Scene handle.
@@ -150,6 +150,20 @@ public:
   Vector2 GetDpi() const;
 
   /**
+   * @brief Sets the background color.
+   *
+   * @param[in] color The new background color
+   */
+  void SetBackgroundColor( const Vector4& color );
+
+  /**
+   * @brief Gets the background color of the render surface.
+   *
+   * @return The background color
+   */
+  Vector4 GetBackgroundColor() const;
+
+  /**
    * @brief Retrieves the list of render-tasks.
    *
    * @return A valid handle to a RenderTaskList
@@ -181,18 +195,24 @@ public:
   Layer GetLayer( uint32_t depth ) const;
 
   /**
-   * @brief Binds the rendering surface to the scene
+   * @brief Informs the scene that the set surface has been resized.
    *
-   * @return The root layer
+   * @param[in] width The new width of the set surface
+   * @param[in] height The new height of the set surface
+   * @param[in] orientation The orientation of the surface
+   * @param[in] forceUpdate The flag to update force
    */
-  void SetSurface( Integration::RenderSurface& surface );
+  void SurfaceResized( float width, float height, int orientation, bool forceUpdate );
 
   /**
-   * @brief Gets the rendering surface bound to the scene
-   *
-   * @return The render surface
+   * @brief Informs the scene that the surface has been replaced.
    */
-  Integration::RenderSurface* GetSurface() const;
+  void SurfaceReplaced();
+
+  /**
+   * @brief Discards this Scene from the Core.
+   */
+  void Discard();
 
   /**
    * @brief Retrieve the Scene that the given actor belongs to.
@@ -232,6 +252,15 @@ public:
   /**
    * @brief The user would connect to this signal to get a KeyEvent when KeyEvent is generated.
    *
+   * If the control already consumed key event, KeyEventProcessor do not need to Emit keyEvent.
+   * Therefore, KeyinputManager first checks whether KeyEvent is generated as KeyEventGeneratedSignal.
+   * After that keyEventProcessor must invoke KeyEvent only if KeyEventGeneratedSignal () is not consumed.
+   *
+   * A callback of the following type may be connected:
+   * @code
+   *   bool YourCallbackName(const KeyEvent& event);
+   * @endcode
+   *
    * @return The return is true if KeyEvent is consumed, otherwise false.
    */
   KeyEventGeneratedSignalType& KeyEventGeneratedSignal();