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) 2022 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/matrix.h"
  26 #include "dali/public-api/math/vector3.h"
  27
  28 namespace Dali
  29 {
  30 class CameraActor;
  31
  32 namespace Scene3D
  33 {
  34 namespace Loader
  35 {
  36 struct DALI_SCENE3D_API CameraParameters
  37 {
  38   Matrix matrix           = Matrix::IDENTITY;
  39   float  orthographicSize = 1.f;
  40   float  aspectRatio      = 1.f;
  41   float  yFov             = 60.f;
  42   float  zNear            = 0.1f;
  43   float  zFar             = 1000.f;
  44   bool   isPerspective    = true;
  45
  46   /**
  47    * @return The view-projection matrix of the camera.
  48    */
  49   ViewProjection GetViewProjection() const;
  50
  51   /**
  52    * @brief Calculates the @a position, @a orientation and @a scale that's defined
  53    *        for this camera, and writes it into the respective variable.
  54    */
  55   void CalculateTransformComponents(Vector3& position, Quaternion& orientation, Vector3& scale) const;
  56
  57   /**
  58    * @brief Configures the camera in the way that it is supposed to be used with
  59    *        scene3d scenes. This means inverted Y and a rotation of 180 degrees
  60    *        along the Y axis, plus whatever the parameters define.
  61    */
  62   void ConfigureCamera(CameraActor& camera) const;
  63 };
  64
  65 } // namespace Loader
  66 } // namespace Scene3D
  67 } // namespace Dali
  68
  69 #endif // DALI_SCENE3D_LOADER_CAMERA_PARAMETERS_H