copy of docs from 2.4x for python modules that have been kept
[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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, 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
29 #define BLI_MATH
30
31 /* Abbreviations:
32  *
33  * fl = float
34  * db = double
35  * v2 = vec2 = vector 2
36  * v3 = vec3 = vector 3
37  * v4 = vec4 = vector 4
38  * qt = quat = quaternion
39  * dq = dquat = dual quaternion
40  * m2 = mat2 = matrix 2x2
41  * m3 = mat3 = matrix 3x3
42  * m4 = mat4 = matrix 4x4
43  * eul = euler rotation
44  * eulO = euler with order
45  *
46  * Variable Names:
47  *
48  * f = single value
49  * a, b, c = vectors
50  * r = result vector
51  * A, B, C = matrices
52  * R = result matrix
53  *
54  */
55
56 #include "BLI_math_base.h"
57 #include "BLI_math_color.h"
58 #include "BLI_math_geom.h"
59 #include "BLI_math_matrix.h"
60 #include "BLI_math_rotation.h"
61 #include "BLI_math_vector.h"
62
63 #endif /* BLI_MATH */
64