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

   1 #ifndef DALI_SCENE_LOADER_CAMERA_PARAMETERS_H
   2 #define DALI_SCENE_LOADER_CAMERA_PARAMETERS_H
   3 /*
   4  * Copyright (c) 2021 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-scene-loader/public-api/api.h"
  22 #include "dali-scene-loader/public-api/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 SceneLoader
  33 {
  34 struct DALI_SCENE_LOADER_API CameraParameters
  35 {
  36   Matrix  matrix           = Matrix::IDENTITY;
  37   Vector4 orthographicSize = Vector4{-1.f, 1.f, 1.f, -1.f};
  38   float   yFov             = 60.f;
  39   float   zNear            = 0.1f;
  40   float   zFar             = 1000.f;
  41   bool    isPerspective    = true;
  42
  43   /**
  44    * @return The view-projection matrix of the camera.
  45    */
  46   ViewProjection GetViewProjection() const;
  47
  48   /**
  49    * @brief Calculates the @a position, @a orientation and @a scale that's defined
  50    *        for this camera, and writes it into the respective variable.
  51    */
  52   void CalculateTransformComponents(Vector3& position, Quaternion& orientation, Vector3& scale) const;
  53
  54   /**
  55    * @brief Configures the camera in the way that it is supposed to be used with
  56    *        scene-loader scenes. This means inverted Y and a rotation of 180 degrees
  57    *        along the Y axis, plus whatever the parameters define.
  58    */
  59   void ConfigureCamera(CameraActor& camera) const;
  60 };
  61
  62 } // namespace SceneLoader
  63 } // namespace Dali
  64
  65 #endif // DALI_SCENE_LOADER_CAMERA_PARAMETERS_H