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