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