a big change with a little description...
[xonotic/darkplaces.git] / mathlib.h
1 /*
2 Copyright (C) 1996-1997 Id Software, Inc.
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.  
12
13 See the GNU General Public License for more details.
14
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
18
19 */
20 // mathlib.h
21
22 typedef float vec_t;
23 typedef vec_t vec2_t[2];
24 typedef vec_t vec3_t[3];
25 typedef vec_t vec4_t[4];
26 typedef vec_t vec5_t[5];
27 typedef vec_t vec6_t[6];
28 typedef vec_t vec7_t[7];
29 typedef vec_t vec8_t[8];
30
31 typedef int     fixed4_t;
32 typedef int     fixed8_t;
33 typedef int     fixed16_t;
34
35 #ifndef M_PI
36 #define M_PI            3.14159265358979323846  // matches value in gcc v2 math.h
37 #endif
38
39 #define DEG2RAD(a) ((a) * ((float) M_PI / 180.0f))
40 #define RAD2DEG(a) ((a) * (180.0f / (float) M_PI))
41 #define ANGLEMOD(a) (((int) ((a) * (65536.0f / 360.0f)) & 65535) * (360.0f / 65536.0f))
42
43 struct mplane_s;
44
45 extern vec3_t vec3_origin;
46 extern  int nanmask;
47
48 #define IS_NAN(x) (((*(int *)&x)&nanmask)==nanmask)
49
50 #define bound(min,num,max) (num >= min ? (num < max ? num : max) : min)
51
52 #define VectorNegate(a,b) {b[0] = -(a[0]);b[1] = -(a[1]);b[2] = -(a[2]);}
53 #define VectorSet(a,b,c,d) {d[0]=(a);d[1]=(b);d[2]=(c);}
54 #define VectorClear(a) {a[0]=a[1]=a[2]=0;}
55 #define DotProduct(x,y) (x[0]*y[0]+x[1]*y[1]+x[2]*y[2])
56 #define VectorSubtract(a,b,c) {c[0]=a[0]-b[0];c[1]=a[1]-b[1];c[2]=a[2]-b[2];}
57 #define VectorAdd(a,b,c) {c[0]=a[0]+b[0];c[1]=a[1]+b[1];c[2]=a[2]+b[2];}
58 #define VectorCopy(a,b) {b[0]=a[0];b[1]=a[1];b[2]=a[2];}
59 #define CrossProduct(v1,v2,cross) {cross[0] = v1[1]*v2[2] - v1[2]*v2[1];cross[1] = v1[2]*v2[0] - v1[0]*v2[2];cross[2] = v1[0]*v2[1] - v1[1]*v2[0];}
60 #define VectorNormalize(v) {float ilength = 1.0f / (float) sqrt(DotProduct(v,v));v[0] *= ilength;v[1] *= ilength;v[2] *= ilength;}
61 #define VectorNormalize2(v,dest) {float ilength = 1.0f / (float) sqrt(DotProduct(v,v));dest[0] = v[0] * ilength;dest[1] = v[1] * ilength;dest[2] = v[2] * ilength;}
62 #define VectorDistance2(a, b) ((a[0] - b[0]) * (a[0] - b[0]) + (a[1] - b[1]) * (a[1] - b[1]) + (a[2] - b[2]) * (a[2] - b[2]))
63 #define VectorDistance(a, b) (sqrt(VectorDistance2(a,b)))
64 #define VectorLength(a) sqrt(DotProduct(a, a))
65 #define VectorScaleQuick(in, scale, out) {(out)[0] = (in)[0] * (scale);(out)[1] = (in)[1] * (scale);(out)[2] = (in)[2] * (scale);}
66 #define VectorMAQuick(a, scale, b, c) {(c)[0] = (a)[0] + (scale) * (b)[0];(c)[1] = (a)[1] + (scale) * (b)[1];(c)[2] = (a)[2] + (scale) * (b)[2];}
67
68
69 void VectorMA (vec3_t veca, float scale, vec3_t vecb, vec3_t vecc);
70
71 vec_t _DotProduct (vec3_t v1, vec3_t v2);
72 void _VectorSubtract (vec3_t veca, vec3_t vecb, vec3_t out);
73 void _VectorAdd (vec3_t veca, vec3_t vecb, vec3_t out);
74 void _VectorCopy (vec3_t in, vec3_t out);
75
76 int VectorCompare (vec3_t v1, vec3_t v2);
77 vec_t Length (vec3_t v);
78 float VectorNormalizeLength (vec3_t v);         // returns vector length
79 float VectorNormalizeLength2 (vec3_t v, vec3_t dest);           // returns vector length
80 void VectorInverse (vec3_t v);
81 void VectorScale (vec3_t in, vec_t scale, vec3_t out);
82 int Q_log2(int val);
83
84 #define NUMVERTEXNORMALS        162
85 extern float m_bytenormals[NUMVERTEXNORMALS][3];
86
87 byte NormalToByte(vec3_t n);
88 void ByteToNormal(byte num, vec3_t n);
89
90 void R_ConcatRotations (float in1[3][3], float in2[3][3], float out[3][3]);
91 void R_ConcatTransforms (float in1[3][4], float in2[3][4], float out[3][4]);
92
93 void FloorDivMod (double numer, double denom, int *quotient, int *rem);
94 int GreatestCommonDivisor (int i1, int i2);
95
96 void AngleVectors (vec3_t angles, vec3_t forward, vec3_t right, vec3_t up);
97
98 // LordHavoc: like AngleVectors, but taking a forward vector instead of angles, useful!
99 void VectorVectors(const vec3_t forward, vec3_t right, vec3_t up);
100
101 void BoxOnPlaneSideClassify(struct mplane_s *p);
102
103 #define BOX_ON_PLANE_SIDE(emins, emaxs, p)      \
104         (((p)->type < 3)?                                               \
105         (                                                                               \
106                 ((p)->dist <= (emins)[(p)->type])?      \
107                         1                                                               \
108                 :                                                                       \
109                 (                                                                       \
110                         ((p)->dist >= (emaxs)[(p)->type])?\
111                                 2                                                       \
112                         :                                                               \
113                                 3                                                       \
114                 )                                                                       \
115         )                                                                               \
116         :                                                                               \
117                 (p)->BoxOnPlaneSideFunc( (emins), (emaxs), (p)))
118
119 #define PlaneDist(point,plane)  ((plane)->type < 3 ? (point)[(plane)->type] : DotProduct((point), (plane)->normal))
120 #define PlaneDiff(point,plane) (((plane)->type < 3 ? (point)[(plane)->type] : DotProduct((point), (plane)->normal)) - (plane)->dist)
121
122 #define lhrandom(MIN,MAX) ((rand() & 32767) * (((MAX)-(MIN)) * (1.0f / 32767.0f)) + (MIN))
123
124 #ifndef min
125 #define min(A,B) (A < B ? A : B)
126 #define max(A,B) (A > B ? A : B)
127 #endif