Merge "Fixed SVACE errors" into devel/master
[platform/core/uifw/dali-core.git] / dali / internal / common / math.h
1 #ifndef DALI_INTERNAL_MATH_H
2 #define DALI_INTERNAL_MATH_H
3
4 /*
5  * Copyright (c) 2017 Samsung Electronics Co., Ltd.
6  *
7  * Licensed under the Apache License, Version 2.0 (the "License");
8  * you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at
10  *
11  * http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing, software
14  * distributed under the License is distributed on an "AS IS" BASIS,
15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  * See the License for the specific language governing permissions and
17  * limitations under the License.
18  *
19  */
20
21 namespace Dali
22 {
23
24 struct Vector2;
25 class Matrix;
26
27 namespace Internal
28 {
29
30 typedef float Vec3[3];
31 typedef float Vec4[4];
32 typedef float Mat4[16];
33
34 /**
35  * @brief Applies a transformation matrix to a Vector3
36  *
37  * @param[out] result The transformed vector
38  * @param[in] m The transformation matrix
39  * @param[in] v The vector to transform
40  */
41 void TransformVector3( Vec3 result, const Mat4 m, const Vec3 v );
42
43 /**
44  * @brief Applies a transformation matrix to a Vector2
45  * Note: This performs an optimized 2D transformation.
46  *
47  * @param[in] matrix      The matrix to transform by
48  * @param[in] x           The x coordinate to multiply the matrix by
49  * @param[in] y           The y coordinate to multiply the matrix by
50  * @return                A Vector2 containing the resulting coordinates
51  */
52 Vector2 Transform2D( const Matrix& matrix, const float x, const float y );
53
54 /**
55  * @brief Computes the length of a vector3
56  *
57  * @param[in] v The vector
58  * @return The lenght of the vector
59  */
60 float Length( const Vec3 v );
61
62 } // namespace Internal
63
64 } // namespace Dali
65
66 #endif  // DALI_INTERNAL_MATH_H