[dali_2.0.7] Merge branch 'devel/master'
[platform/core/uifw/dali-toolkit.git] / 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   Matrix matrix = Matrix::IDENTITY;
39   Vector4 orthographicSize = Vector4{ -1.f, 1.f, 1.f, -1.f };
40   float yFov = 60.f;
41   float zNear = 0.1f;
42   float zFar = 1000.f;
43   bool isPerspective = true;
44
45   /**
46    * @return The view-projection matrix of the camera.
47    */
48   ViewProjection GetViewProjection() const;
49
50   /**
51    * @brief Calculates the @a position, @a orientation and @a scale that's defined
52    *        for this camera, and writes it into the respective variable.
53    */
54   void CalculateTransformComponents(Vector3& position, Quaternion& orientation, Vector3& scale) const;
55
56   /**
57    * @brief Configures the camera in the way that it is supposed to be used with
58    *        scene-loader scenes. This means inverted Y and a rotation of 180 degrees
59    *        along the Y axis, plus whatever the parameters define.
60    */
61   void ConfigureCamera(CameraActor& camera) const;
62 };
63
64 }
65 }
66
67 #endif // DALI_SCENE_LOADER_CAMERA_PARAMETERS_H