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