[dali_2.3.24] Merge branch 'devel/master'

[platform/core/uifw/dali-toolkit.git] / dali-scene3d / public-api / loader / camera-parameters.h

diff --git a/dali-scene3d/public-api/loader/camera-parameters.h b/dali-scene3d/public-api/loader/camera-parameters.h
index 74d6eec..17b3ea1 100644 (file)
--- a/dali-scene3d/public-api/loader/camera-parameters.h
+++ b/dali-scene3d/public-api/loader/camera-parameters.h
@@ -1,7 +1,7 @@
 #ifndef DALI_SCENE3D_LOADER_CAMERA_PARAMETERS_H
 #define DALI_SCENE3D_LOADER_CAMERA_PARAMETERS_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.
@@ -18,12 +18,14 @@
  */
 
 // INTERNAL INCLUDES
-#include "dali-scene3d/public-api/api.h"
-#include "dali-scene3d/public-api/loader/view-projection.h"
+#include <dali-scene3d/public-api/api.h>
+#include <dali-scene3d/public-api/loader/view-projection.h>
 
 // EXTERNAL INCLUDES
-#include "dali/public-api/math/matrix.h"
-#include "dali/public-api/math/vector3.h"
+#include <dali/public-api/math/degree.h>
+#include <dali/public-api/math/matrix.h>
+#include <dali/public-api/math/vector3.h>
+#include <string>
 
 namespace Dali
 {
@@ -35,30 +37,39 @@ namespace Loader
 {
 struct DALI_SCENE3D_API CameraParameters
 {
-  Matrix  matrix           = Matrix::IDENTITY;
-  Vector4 orthographicSize = Vector4{-1.f, 1.f, 1.f, -1.f};
-  float   yFov             = 60.f;
-  float   zNear            = 0.1f;
-  float   zFar             = 1000.f;
-  bool    isPerspective    = true;
+  std::string name;
+
+  // TODO : Is these default value has is meaning?
+  Matrix matrix           = Matrix::IDENTITY;
+  float  orthographicSize = 1.f;
+  float  aspectRatio      = 1.f;
+  Degree yFovDegree       = Degree(60.f);
+  float  zNear            = 0.1f;
+  float  zFar             = 1000.f;
+  bool   isPerspective    = true;
 
   /**
-   * @return The view-projection matrix of the camera.
+   * @brief Retrieves the view-projection of the camera.
+   * @SINCE_2_0.7
+   * @return The view-projection matrix of the camera
    */
   ViewProjection GetViewProjection() const;
 
   /**
-   * @brief Calculates the @a position, @a orientation and @a scale that's defined
-   *        for this camera, and writes it into the respective variable.
+   * @brief Calculates the @a position, @a orientation and @a scale that's defined for this camera,
+   * and writes it into the respective variable.
+   * @SINCE_2_0.7
    */
   void CalculateTransformComponents(Vector3& position, Quaternion& orientation, Vector3& scale) const;
 
   /**
-   * @brief Configures the camera in the way that it is supposed to be used with
-   *        scene3d scenes. This means inverted Y and a rotation of 180 degrees
-   *        along the Y axis, plus whatever the parameters define.
+   * @brief Configures the camera in the way that it is supposed to be used with scene3d scenes.
+   *
+   * This means inverted Y and a rotation of 180 degrees along the Y axis, plus whatever the parameters define.
+   * @SINCE_2_0.7
+   * @return True if success to generate camera. False otherwise.
    */
-  void ConfigureCamera(CameraActor& camera) const;
+  bool ConfigureCamera(CameraActor& camera, bool invertY = true) const;
 };
 
 } // namespace Loader