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