[Tizen] Clean up Scene3D namespace and header definition
[platform/core/uifw/dali-toolkit.git] / dali-scene3d / public-api / controls / scene-view / scene-view.h
index 0e4f10e..f64715d 100644 (file)
@@ -2,7 +2,7 @@
 #define DALI_SCENE3D_SCENE_VIEW_H
 
 /*
- * Copyright (c) 2022 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2023 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-scene3d/public-api/api.h>
-
 // EXTERNAL INCLUDES
 #include <dali-toolkit/public-api/controls/control.h>
 #include <dali/public-api/actors/camera-actor.h>
 #include <dali/public-api/common/dali-common.h>
 
+// INTERNAL INCLUDES
+#include <dali-scene3d/public-api/api.h>
+#include <dali-scene3d/public-api/common/environment-map.h>
+
 namespace Dali
 {
 namespace Scene3D
@@ -85,13 +86,14 @@ class SceneView;
  *
  * And since SceneView is a Control, it can be placed together with other 2D UI components in the DALi window.
  *
+ * @SINCE_2_1.38
  * @code
  *
  * Dali::Scene3D::SceneView sceneView = Dali::Scene3D::SceneView::New();
  * sceneView.SetProperty(Dali::Actor::Property::SIZE, Vector2(400, 400));
  * mWindow.Add(sceneView);
  *
- * Dali::Scene3D::ModelView model = Dali::Scene3D::ModelView::New(...);
+ * Dali::Scene3D::Model model = Dali::Scene3D::Model::New(...);
  * sceneView.Add(model);
  *
  * CameraActor cameraActor = CameraActor::New();
@@ -104,6 +106,8 @@ class DALI_SCENE3D_API SceneView : public Dali::Toolkit::Control
 public:
   /**
    * @brief Create an initialized SceneView.
+   *
+   * @SINCE_2_1.38
    * @return A handle to a newly allocated Dali resource
    */
   static SceneView New();
@@ -113,6 +117,8 @@ public:
    *
    * Only derived versions can be instantiated. Calling member
    * functions with an uninitialized Dali::Object is not allowed.
+   *
+   * @SINCE_2_1.38
    */
   SceneView();
 
@@ -120,11 +126,15 @@ public:
    * @brief Destructor.
    *
    * This is non-virtual since derived Handle types must not contain data or virtual methods.
+   *
+   * @SINCE_2_1.38
    */
   ~SceneView();
 
   /**
    * @brief Copy constructor.
+   *
+   * @SINCE_2_1.38
    * @param[in] sceneView Handle to an object
    */
   SceneView(const SceneView& sceneView);
@@ -132,12 +142,15 @@ public:
   /**
    * @brief Move constructor
    *
+   * @SINCE_2_1.38
    * @param[in] rhs A reference to the moved handle
    */
   SceneView(SceneView&& rhs);
 
   /**
    * @brief Assignment operator.
+   *
+   * @SINCE_2_1.38
    * @param[in] sceneView Handle to an object
    * @return reference to this
    */
@@ -146,6 +159,7 @@ public:
   /**
    * @brief Move assignment
    *
+   * @SINCE_2_1.38
    * @param[in] rhs A reference to the moved handle
    * @return A reference to this
    */
@@ -157,6 +171,7 @@ public:
    * If handle points to a SceneView, the downcast produces valid handle.
    * If not, the returned handle is left uninitialized.
    *
+   * @SINCE_2_1.38
    * @param[in] handle Handle to an object
    * @return Handle to a SceneView or an uninitialized handle
    */
@@ -166,6 +181,7 @@ public:
    * @brief Adds a CameraActor to the SceneView
    * The CameraActor can be used as a selected camera to render the scene by using SelectCamera(uint32_t) or SelectCamera(std::string)
    *
+   * @SINCE_2_1.38
    * @note
    * AspectRatio property of CameraActor will be changed depending on the Size of this SceneView.
    *
@@ -183,6 +199,8 @@ public:
 
   /**
    * @brief Removes a CameraActor from this SceneView.
+   *
+   * @SINCE_2_1.38
    * @note If removed CameraActor is selected CameraActor,
    * first camera in the list is set to selected CameraActor.
    *
@@ -193,6 +211,7 @@ public:
   /**
    * @brief Retrieves the number of cameras.
    *
+   * @SINCE_2_1.38
    * @return Number of cameras those currently the SceneView contains.
    */
   uint32_t GetCameraCount() const;
@@ -200,6 +219,7 @@ public:
   /**
    * @brief Retrieves selected CameraActor.
    *
+   * @SINCE_2_1.38
    * @return CameraActor currently used in SceneView as a selected CameraActor
    */
   CameraActor GetSelectedCamera() const;
@@ -207,6 +227,7 @@ public:
   /**
    * @brief Retrieves a CameraActor of the index.
    *
+   * @SINCE_2_1.38
    * @param[in] index Index of CameraActor to be retrieved.
    *
    * @return CameraActor of the index
@@ -216,6 +237,7 @@ public:
   /**
    * @brief Retrieves a CameraActor of the name.
    *
+   * @SINCE_2_1.38
    * @param[in] name string keyword of CameraActor to be retrieved.
    *
    * @return CameraActor that has the name as a Dali::Actor::Property::NAME
@@ -225,6 +247,7 @@ public:
   /**
    * @brief Makes SceneView use a CameraActor of index as a selected camera.
    *
+   * @SINCE_2_1.38
    * @param[in] index Index of CameraActor to be used as a selected camera.
    */
   void SelectCamera(uint32_t index);
@@ -232,6 +255,7 @@ public:
   /**
    * @brief Makes SceneView use a CameraActor of a name as a selected camera.
    *
+   * @SINCE_2_1.38
    * @param[in] name string keyword of CameraActor to be used as a selected camera.
    */
   void SelectCamera(const std::string& name);
@@ -239,19 +263,21 @@ public:
   /**
    * @brief Sets Image Based Light Source to apply it on the all Models those added on this SceneView.
    *
+   * @SINCE_2_1.38
    * @note If any Models already have IBL, they are batch-overridden with the SceneView's IBL.
    * If SceneView has IBL, IBL of newly added Model is also overridden.
    * To set indivisual IBL for each Model, the Model's IBL should be set after the SceneView's IBL.
    *
-   * @param[in] diffuse cube map that can be used as a diffuse IBL source.
-   * @param[in] specular cube map that can be used as a specular IBL source.
+   * @param[in] diffuseUrl cube map that can be used as a diffuse IBL source.
+   * @param[in] specularUrl cube map that can be used as a specular IBL source.
    * @param[in] scaleFactor scale factor that controls light source intensity in [0.0f, 1.0f]. Default value is 1.0f.
    */
-  void SetImageBasedLightSource(const std::string& diffuse, const std::string& specular, float scaleFactor = 1.0f);
+  void SetImageBasedLightSource(const std::string& diffuseUrl, const std::string& specularUrl, float scaleFactor = 1.0f);
 
   /**
    * @brief Sets Scale Factor of Image Based Light Source.
    *
+   * @SINCE_2_1.41
    * @note If SetImageBasedLightSource() or SetImageBasedLightTexture() method is called after this method, scaleFactor is overriden.
    * @note Default value is 1.0f.
    *
@@ -263,6 +289,7 @@ public:
    * @brief Gets Scale Factor of Image Based Light Source.
    * Default value is 1.0f.
    *
+   * @SINCE_2_1.41
    * @return scale factor that controls light source intensity.
    */
   float GetImageBasedLightScaleFactor() const;
@@ -273,6 +300,7 @@ public:
    * If useFramebuffer is false, each item in SceneView is rendered on window directly.
    * Default is false.
    *
+   * @SINCE_2_1.38
    * @note If useFramebuffer is true, it could decrease performance but entire rendering order is satisfied.
    * If useFramebuffer is false, performance is become better but SceneView is rendered on top of the other 2D Actors regardless tree order.
    *
@@ -283,10 +311,89 @@ public:
   /**
    * @brief Gets whether this SceneView uses Framebuffer or not.
    *
+   * @SINCE_2_1.38
    * @return bool True if this SceneView uses Framebuffer.
    */
   bool IsUsingFramebuffer() const;
 
+  /**
+   * @brief Sets Multisampling level when we use Framebuffer.
+   * Default is 0.
+   *
+   * @SINCE_2_2.12
+   * @note Only applied if SceneView is using Framebuffer and Framebuffer Multisampling extension is supported.
+   *
+   * @param[in] multiSamplingLevel Level of multisampling if we use Framebuffer.
+   */
+  void SetFramebufferMultiSamplingLevel(uint8_t multiSamplingLevel);
+
+  /**
+   * @brief Gets Multisampling level that user set.
+   * Default is 0.
+   *
+   * @SINCE_2_2.12
+   * @note This API doesn't check whether Multisampling extension is supported or not.
+   *
+   * @return MultisamplingLevel that user set.
+   */
+  uint8_t GetFramebufferMultiSamplingLevel() const;
+
+  /**
+   * @brief Sets Skybox for this scene.
+   * Skybox texture starts to be loaded when SceneView is onScene.
+   * And Skybox texture is asynchronously loaded. When loading is finished, ResourceReady is emitted.
+   *
+   * @SINCE_2_2.0
+   * @param[in] skyboxUrl image url for skybox.
+   * @note Default SkyboxEnvironmentMapType is Cube Map. Use SetSkyboxEnvironmentMapType method to set type explicitly.
+   */
+  void SetSkybox(const std::string& skyboxUrl);
+
+  /**
+   * @brief Sets Skybox environment map type for this skybox.
+   * If skybox texture already starts to be loaded, when the type is changed, the load request is canceled and re-starts to load with new type.
+   *
+   * @SINCE_2_2.11
+   * @param[in] skyboxEnvironmentMapType The environment type of skybox (by default it is cubemap).
+   */
+  void SetSkyboxEnvironmentMapType(Scene3D::EnvironmentMapType skyboxEnvironmentMapType);
+
+  /**
+   * @brief Sets Skybox intensity.
+   * The skybox intensity is multiplied to the color of skybox texture.
+   * Default value is 1.0f.
+   *
+   * @SINCE_2_2.0
+   * @note Intensity should be positive value.
+   * @param[in] intensity Intensity value to be multiplied to the cube map color
+   */
+  void SetSkyboxIntensity(float intensity);
+
+  /**
+   * @brief Gets Skybox intensity.
+   * Default value is 1.0f.
+   *
+   * @SINCE_2_2.0
+   * @return skybox intensity
+   */
+  float GetSkyboxIntensity() const;
+
+  /**
+   * @brief Sets Orientation of Skybox.
+   *
+   * @SINCE_2_2.0
+   * @param[in] orientation Quaternion for orientation of Skybox.
+   */
+  void SetSkyboxOrientation(const Quaternion& orientation);
+
+  /**
+   * @brief Gets Skybox orientation.
+   *
+   * @SINCE_2_2.0
+   * @return skybox orientation
+   */
+  Quaternion GetSkyboxOrientation() const;
+
 public: // Not intended for application developers
   /// @cond internal
   /**