ce0183eee68ac6dc884e1140803bc1f95312abaf
[blender.git] / source / blender / blenlib / BLI_math.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: some of this file.
22  *
23  * ***** END GPL LICENSE BLOCK *****
24  * */
25
26 #ifndef __BLI_MATH_H__
27 #define __BLI_MATH_H__
28
29 /** \file BLI_math.h
30  *  \ingroup bli
31  *  \section mathabbrev Abbreviations
32  *
33  *  - ``fl`` = float
34  *  - ``db`` = double
35  *  - ``v2`` = vec2 = vector 2
36  *  - ``v3`` = vec3 = vector 3
37  *  - ``v4`` = vec4 = vector 4
38  *  - ``vn`` = vec4 = vector N dimensions, *passed as an arg, after the vector*.
39  *  - ``qt`` = quat = quaternion
40  *  - ``dq`` = dquat = dual quaternion
41  *  - ``m2`` = mat2 = matrix 2x2
42  *  - ``m3`` = mat3 = matrix 3x3
43  *  - ``m4`` = mat4 = matrix 4x4
44  *  - ``eul`` = euler rotation
45  *  - ``eulO`` = euler with order
46  *  - ``plane`` = plane 4, (vec3, distance)
47  *  - ``plane3`` = plane 3 (same as a ``plane`` with a zero 4th component)
48  *
49  * \subsection mathabbrev_all Function Type Abbreviations
50  *
51  * For non float versions of functions (which typically operate on floats),
52  * use single suffix abbreviations.
53  *
54  * - ``_d`` = double
55  * - ``_i`` = int
56  * - ``_u`` = unsigned int
57  * - ``_char`` = char
58  * - ``_uchar`` = unsigned char
59  *
60  *  \section mathvarnames Variable Names
61  *
62  *  - f = single value
63  *  - a, b, c = vectors
64  *  - r = result vector
65  *  - A, B, C = matrices
66  *  - R = result matrix
67  */
68
69 #include "BLI_math_base.h"
70 #include "BLI_math_color.h"
71 #include "BLI_math_matrix.h"
72 #include "BLI_math_rotation.h"
73 #include "BLI_math_vector.h"
74 #include "BLI_math_geom.h"
75 #include "BLI_math_interp.h"
76
77 #endif /* __BLI_MATH_H__ */