dali-scene3d/public-api/loader/camera-parameters.h

   1 #ifndef DALI_SCENE3D_LOADER_CAMERA_PARAMETERS_H
   2 #define DALI_SCENE3D_LOADER_CAMERA_PARAMETERS_H
   3 /*
   4  * Copyright (c) 2023 Samsung Electronics Co., Ltd.
   5  *
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at
   9  *
  10  * http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  *
  18  */
  19
  20 // INTERNAL INCLUDES
  21 #include <dali-scene3d/public-api/api.h>
  22 #include <dali-scene3d/public-api/loader/view-projection.h>
  23
  24 // EXTERNAL INCLUDES
  25 #include <dali/public-api/math/degree.h>
  26 #include <dali/public-api/math/matrix.h>
  27 #include <dali/public-api/math/vector3.h>
  28 #include <string>
  29
  30 namespace Dali
  31 {
  32 class CameraActor;
  33
  34 namespace Scene3D
  35 {
  36 namespace Loader
  37 {
  38 struct DALI_SCENE3D_API CameraParameters
  39 {
  40   std::string name;
  41
  42   // TODO : Is these default value has is meaning?
  43   Matrix matrix           = Matrix::IDENTITY;
  44   float  orthographicSize = 1.f;
  45   float  aspectRatio      = 1.f;
  46   Degree yFovDegree       = Degree(60.f);
  47   float  zNear            = 0.1f;
  48   float  zFar             = 1000.f;
  49   bool   isPerspective    = true;
  50
  51   /**
  52    * @brief Retrieves the view-projection of the camera.
  53    * @SINCE_2_0.7
  54    * @return The view-projection matrix of the camera
  55    */
  56   ViewProjection GetViewProjection() const;
  57
  58   /**
  59    * @brief Calculates the @a position, @a orientation and @a scale that's defined for this camera,
  60    * and writes it into the respective variable.
  61    * @SINCE_2_0.7
  62    */
  63   void CalculateTransformComponents(Vector3& position, Quaternion& orientation, Vector3& scale) const;
  64
  65   /**
  66    * @brief Configures the camera in the way that it is supposed to be used with scene3d scenes.
  67    *
  68    * This means inverted Y and a rotation of 180 degrees along the Y axis, plus whatever the parameters define.
  69    * @SINCE_2_0.7
  70    * @return True if success to generate camera. False otherwise.
  71    */
  72   bool ConfigureCamera(CameraActor& camera, bool invertY = true) const;
  73 };
  74
  75 } // namespace Loader
  76 } // namespace Scene3D
  77 } // namespace Dali
  78
  79 #endif // DALI_SCENE3D_LOADER_CAMERA_PARAMETERS_H