3588e9cc1e9f1b12c31f085b398483f55eb7867e
[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 #ifndef M_PI
23 #define M_PI            3.14159265358979323846  // matches value in gcc v2 math.h
24 #endif
25
26 typedef float vec_t;
27 typedef vec_t vec2_t[2];
28 typedef vec_t vec3_t[3];
29 typedef vec_t vec4_t[4];
30 typedef vec_t vec5_t[5];
31 typedef vec_t vec6_t[6];
32 typedef vec_t vec7_t[7];
33 typedef vec_t vec8_t[8];
34 struct mplane_s;
35 extern vec3_t vec3_origin;
36
37 extern int nanmask;
38 #define IS_NAN(x) (((*(int *)&x)&nanmask)==nanmask)
39
40 #define bound(min,num,max) (num >= min ? (num < max ? num : max) : min)
41
42 #ifndef min
43 #define min(A,B) (A < B ? A : B)
44 #define max(A,B) (A > B ? A : B)
45 #endif
46
47 #define lhrandom(MIN,MAX) ((rand() & 32767) * (((MAX)-(MIN)) * (1.0f / 32767.0f)) + (MIN))
48
49 #define DEG2RAD(a) ((a) * ((float) M_PI / 180.0f))
50 #define RAD2DEG(a) ((a) * (180.0f / (float) M_PI))
51 #define ANGLEMOD(a) (((int) ((a) * (65536.0f / 360.0f)) & 65535) * (360.0f / 65536.0f))
52
53 #define VectorNegate(a,b) {b[0] = -(a[0]);b[1] = -(a[1]);b[2] = -(a[2]);}
54 #define VectorSet(a,b,c,d) {d[0]=(a);d[1]=(b);d[2]=(c);}
55 #define VectorClear(a) {a[0]=a[1]=a[2]=0;}
56 #define DotProduct(x,y) (x[0]*y[0]+x[1]*y[1]+x[2]*y[2])
57 #define VectorSubtract(a,b,c) {c[0]=a[0]-b[0];c[1]=a[1]-b[1];c[2]=a[2]-b[2];}
58 #define VectorAdd(a,b,c) {c[0]=a[0]+b[0];c[1]=a[1]+b[1];c[2]=a[2]+b[2];}
59 #define VectorCopy(a,b) {b[0]=a[0];b[1]=a[1];b[2]=a[2];}
60 #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];}
61 #define VectorNormalize(v) {float ilength = 1.0f / (float) sqrt(DotProduct(v,v));v[0] *= ilength;v[1] *= ilength;v[2] *= ilength;}
62 #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;}
63 #define VectorNormalizeDouble(v) {double ilength = 1.0 / (float) sqrt(DotProduct(v,v));v[0] *= ilength;v[1] *= ilength;v[2] *= ilength;}
64 #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]))
65 #define VectorDistance(a, b) (sqrt(VectorDistance2(a,b)))
66 #define VectorLength(a) sqrt(DotProduct(a, a))
67 #define VectorScale(in, scale, out) {(out)[0] = (in)[0] * (scale);(out)[1] = (in)[1] * (scale);(out)[2] = (in)[2] * (scale);}
68 #define VectorMA(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];}
69 #define VectorNormalizeFast(_v)\
70 {\
71         float _y, _number;\
72         _number = DotProduct(_v, _v);\
73         if (_number != 0.0)\
74         {\
75                 *((long *)&_y) = 0x5f3759df - ((* (long *) &_number) >> 1);\
76                 _y = _y * (1.5f - (_number * 0.5f * _y * _y));\
77                 VectorScale(_v, _y, _v);\
78         }\
79 }
80 #define VectorRandom(v) {do{(v)[0] = lhrandom(-1, 1);(v)[1] = lhrandom(-1, 1);(v)[2] = lhrandom(-1, 1);}while(DotProduct(v, v) > 1);}
81
82 // LordHavoc: quaternion math, untested, don't know if these are correct,
83 // need to add conversion to/from matrices
84
85 // returns length of quaternion
86 #define qlen(a) ((float) sqrt(a[0]*a[0]+a[1]*a[1]+a[2]*a[2]+a[3]*a[3]))
87 // returns squared length of quaternion
88 #define qlen2(a) (a[0]*a[0]+a[1]*a[1]+a[2]*a[2]+a[3]*a[3])
89 // makes a quaternion from x, y, z, and a rotation angle
90 #define QuatMake(x,y,z,r,c) {if (r2 == 0) {(c)[0]=(float) ((x)*sin(r2));c[1]=(float) ((y)*sin(r2));c[2]=((float) (z)*sin(r2));c[3]=(float) 1;} else {float r2 = (r) * 0.5 * (M_PI / 180);(c)[0]=(float) ((x)*sin(r2));c[1]=(float) ((y)*sin(r2));c[2]=((float) (z)*sin(r2));c[3]=(float) (cos(r2));}}
91 // makes a quaternion from a vector and a rotation angle
92 #define QuatFromVec(a,r,c) QuatMake((a)[0],(a)[1],(a)[2],(r))
93 // copies a quaternion
94 #define QuatCopy(a,c) {c[0]=a[0];c[1]=a[1];c[2]=a[2];c[3]=a[3];}
95 #define QuatSubtract(a,b,c) {c[0]=a[0]-b[0];c[1]=a[1]-b[1];c[2]=a[2]-b[2];c[3]=a[3]-b[3];}
96 #define QuatAdd(a,b,c) {c[0]=a[0]+b[0];c[1]=a[1]+b[1];c[2]=a[2]+b[2];c[3]=a[3]+b[3];}
97 #define QuatScale(a,b,c) {c[0]=a[0]*b;c[1]=a[1]*b;c[2]=a[2]*b;c[3]=a[3]*b;}
98 // FIXME: this is wrong, do some more research on quaternions
99 //#define QuatMultiply(a,b,c) {c[0]=a[0]*b[0];c[1]=a[1]*b[1];c[2]=a[2]*b[2];c[3]=a[3]*b[3];}
100 // FIXME: this is wrong, do some more research on quaternions
101 //#define QuatMultiplyAdd(a,b,d,c) {c[0]=a[0]*b[0]+d[0];c[1]=a[1]*b[1]+d[1];c[2]=a[2]*b[2]+d[2];c[3]=a[3]*b[3]+d[3];}
102 #define qdist(a,b) ((float) sqrt((b[0]-a[0])*(b[0]-a[0])+(b[1]-a[1])*(b[1]-a[1])+(b[2]-a[2])*(b[2]-a[2])+(b[3]-a[3])*(b[3]-a[3])))
103 #define qdist2(a,b) ((b[0]-a[0])*(b[0]-a[0])+(b[1]-a[1])*(b[1]-a[1])+(b[2]-a[2])*(b[2]-a[2])+(b[3]-a[3])*(b[3]-a[3]))
104
105 #define VectorCopy4(a,b) {b[0]=a[0];b[1]=a[1];b[2]=a[2];b[3]=a[3];}
106
107 void VectorMASlow (vec3_t veca, float scale, vec3_t vecb, vec3_t vecc);
108
109 vec_t _DotProduct (vec3_t v1, vec3_t v2);
110 void _VectorSubtract (vec3_t veca, vec3_t vecb, vec3_t out);
111 void _VectorAdd (vec3_t veca, vec3_t vecb, vec3_t out);
112 void _VectorCopy (vec3_t in, vec3_t out);
113
114 int VectorCompare (vec3_t v1, vec3_t v2);
115 vec_t Length (vec3_t v);
116 float VectorNormalizeLength (vec3_t v);         // returns vector length
117 float VectorNormalizeLength2 (vec3_t v, vec3_t dest);           // returns vector length
118 void _VectorInverse (vec3_t v);
119 void _VectorScale (vec3_t in, vec_t scale, vec3_t out);
120 int Q_log2(int val);
121 void _VectorNormalizeFast (vec3_t v);
122
123 float Q_RSqrt(float number);
124
125 #define NUMVERTEXNORMALS        162
126 extern float m_bytenormals[NUMVERTEXNORMALS][3];
127
128 byte NormalToByte(vec3_t n);
129 void ByteToNormal(byte num, vec3_t n);
130
131 void R_ConcatRotations (float in1[3][3], float in2[3][3], float out[3][3]);
132 void R_ConcatTransforms (float in1[3][4], float in2[3][4], float out[3][4]);
133
134 void FloorDivMod (double numer, double denom, int *quotient, int *rem);
135 int GreatestCommonDivisor (int i1, int i2);
136
137 void AngleVectors (vec3_t angles, vec3_t forward, vec3_t right, vec3_t up);
138 // LordHavoc: proper matrix version of AngleVectors
139 void AngleVectorsFLU (vec3_t angles, vec3_t forward, vec3_t left, vec3_t up);
140 // LordHavoc: builds a [3][4] matrix
141 void AngleMatrix (vec3_t angles, vec3_t translate, vec_t matrix[][4]);
142
143 // LordHavoc: like AngleVectors, but taking a forward vector instead of angles, useful!
144 void VectorVectors(const vec3_t forward, vec3_t right, vec3_t up);
145 void VectorVectorsDouble(const double *forward, double *right, double *up);
146
147 void PlaneClassify(struct mplane_s *p);
148
149 #define BOX_ON_PLANE_SIDE(emins, emaxs, p)      \
150         (((p)->type < 3)?                                               \
151         (                                                                               \
152                 ((p)->dist <= (emins)[(p)->type])?      \
153                         1                                                               \
154                 :                                                                       \
155                 (                                                                       \
156                         ((p)->dist >= (emaxs)[(p)->type])?\
157                                 2                                                       \
158                         :                                                               \
159                                 3                                                       \
160                 )                                                                       \
161         )                                                                               \
162         :                                                                               \
163                 (p)->BoxOnPlaneSideFunc( (emins), (emaxs), (p)))
164
165 #define PlaneDist(point,plane)  ((plane)->type < 3 ? (point)[(plane)->type] : DotProduct((point), (plane)->normal))
166 #define PlaneDiff(point,plane) (((plane)->type < 3 ? (point)[(plane)->type] : DotProduct((point), (plane)->normal)) - (plane)->dist)
167 //#define PlaneDist(point,plane)  (DotProduct((point), (plane)->normal))
168 //#define PlaneDiff(point,plane) (DotProduct((point), (plane)->normal) - (plane)->dist)
169
170 // LordHavoc: minimal plane structure
171 typedef struct
172 {
173         float normal[3], dist;
174 }
175 tinyplane_t;
176
177 typedef struct
178 {
179         double normal[3], dist;
180 }
181 tinydoubleplane_t;
182
183 void RotatePointAroundVector(vec3_t dst, const vec3_t dir, const vec3_t point, float degrees);