need string.h for strcasecmp
[btb/d2x.git] / include / vecmat.h
1 /* $ Id: $ */
2 /*
3    THE COMPUTER CODE CONTAINED HEREIN IS THE SOLE PROPERTY OF PARALLAX
4    SOFTWARE CORPORATION ("PARALLAX").  PARALLAX, IN DISTRIBUTING THE CODE TO
5    END-USERS, AND SUBJECT TO ALL OF THE TERMS AND CONDITIONS HEREIN, GRANTS A
6    ROYALTY-FREE, PERPETUAL LICENSE TO SUCH END-USERS FOR USE BY SUCH END-USERS
7    IN USING, DISPLAYING,  AND CREATING DERIVATIVE WORKS THEREOF, SO LONG AS
8    SUCH USE, DISPLAY OR CREATION IS FOR NON-COMMERCIAL, ROYALTY OR REVENUE
9    FREE PURPOSES.  IN NO EVENT SHALL THE END-USER USE THE COMPUTER CODE
10    CONTAINED HEREIN FOR REVENUE-BEARING PURPOSES.  THE END-USER UNDERSTANDS
11    AND AGREES TO THE TERMS HEREIN AND ACCEPTS THE SAME BY USE OF THIS FILE.  
12    COPYRIGHT 1993-1998 PARALLAX SOFTWARE CORPORATION.  ALL RIGHTS RESERVED.
13  */  
14 /*
15  *
16  * Header file for vector/matrix library
17  *
18  * Old Log:
19  *
20  * Revision 1.1  1995/04/17  16:18:05  allender
21  * Initial revision
22  *
23  *
24  * --- PC RCS Information ---
25  * Revision 1.37  1995/02/22  13:23:22  john
26  * Added the vms_vector_array structure, to access a vms_vector
27  * with an array.
28  * 
29  * Revision 1.36  1995/02/22  12:34:33  john
30  * Took out anonymous unions.
31  * 
32  * Revision 1.35  1994/12/13  14:44:20  matt
33  * Added vm_vector_2_matrix_norm()
34  * 
35  * Revision 1.34  1994/09/11  19:22:55  matt
36  * Added vm_vec_normalized_dir_quick()
37  * 
38  * Revision 1.33  1994/08/04  19:45:38  matt
39  * Added option to make a bunch of functions (add, sub, dotprod) inline
40  * 
41  * Revision 1.32  1994/07/19  18:52:36  matt
42  * Added vm_vec_normalize_quick() and vm_vec_copy_normalize_quick()
43  * 
44  * Revision 1.31  1994/06/16  18:24:30  matt
45  * Added vm_vec_mag_quick()
46  * 
47  * Revision 1.30  1994/06/10  23:19:00  matt
48  * New register usage for vm_vec_ang_2_matrix()
49  * 
50  * Revision 1.29  1994/06/01  17:32:06  matt
51  * Fixed modify list for vm_vec_normalized_dir()
52  * 
53  * Revision 1.28  1994/05/19  12:07:20  matt
54  * Fixed globals and macros and added a constant
55  * 
56  * Revision 1.27  1994/05/19  09:19:15  matt
57  * Made vm_vec_normalized_dir() return mag of vector
58  * 
59  * Revision 1.26  1994/05/18  22:28:57  matt
60  * Added function vm_vec_normalized_dir()
61  * Added C macros IS_ZERO_VEC(), vm_vec_zero(), and vm_set_identity()
62  * Added C global static vars vmd_zero_vector & vmd_identity_matrix
63  * 
64  * Revision 1.25  1994/05/18  21:45:06  matt
65  * Added functions:
66  *   vm_extract_angles_vector()
67  *   vm_extract_angles_vector_normalized()
68  *   vm_vec_copy_normalize()
69  * 
70  * Revision 1.24  1994/05/13  12:42:16  matt
71  * Added new function, vm_vec_dist_quick(), which does an approximation.
72  * 
73  * Revision 1.23  1994/03/30  13:37:34  matt
74  * Added prototype for vm_vec_scale_add(), and fixed typos
75  * 
76  * Revision 1.22  1994/03/30  13:29:42  matt
77  * Header for vm_vec_scale_add2()
78  * 
79  * Revision 1.21  1994/01/31  19:45:13  matt
80  * Added function vm_extract_angles_matrix()
81  * 
82  * Revision 1.20  1993/12/21  19:46:14  matt
83  * Added function vm_dist_to_plane()
84  * 
85  * Revision 1.19  1993/12/13  17:26:41  matt
86  * Added vm_vec_dist()
87  * 
88  * Revision 1.18  1993/12/02  12:45:11  matt
89  * New functions: vm_vec_copy_scale(), vm_vec_scale2()
90  * Aliases: vm_transpose(), vm_vec_dot(), vm_vec_cross(), vm_copy_transpose()
91  * 
92  * Revision 1.17  1993/10/29  22:38:36  matt
93  * Changed matrix order, making direction vectors the rows
94  * 
95  * Revision 1.16  1993/10/25  11:49:57  matt
96  * Made vm_vec_delta_ang() take optional forward vector to return signed delta
97  * 
98  * Revision 1.15  1993/10/20  01:10:05  matt
99  * Added vm_vec_delta_ang(), vm_vec_delta_ang_norm(), and vm_vec_ang_2_matrix()
100  * 
101  * Revision 1.14  1993/10/17  17:02:52  matt
102  * vm_vector_2_matrix() now takes optional right vector
103  * 
104  * Revision 1.13  1993/10/12  19:31:39  matt
105  * Added IDENTITY_MATRIX constant
106  * 
107  * Revision 1.12  1993/10/08  18:10:16  matt
108  * Changed vm_vec_make() and vm_angvec_make() to be inline assembly 
109  * functions, to get rid of compiler warnings.  Did not change vm_mat_make(),
110  * which could still get warnings if the return value is unused.
111  * 
112  * Revision 1.11  1993/09/29  12:10:07  matt
113  * Changed modified regs in pragmas to include return register
114  * 
115  * Revision 1.10  1993/09/28  12:15:41  matt
116  * Added func vm_vector_2_matrix()
117  * 
118  * Revision 1.9  1993/09/24  21:18:38  matt
119  * Added vm_vec_avg(), vm_vec_avg4(), and vm_angvec_make().
120  * Documented which functions could have dest==source
121  * 
122  * Revision 1.8  1993/09/20  14:56:11  matt
123  * Added new function, vm_vec_perp()
124  * 
125  * Revision 1.7  1993/09/20  14:27:42  mike
126  * unfix last fix which introduced a bug
127  * 
128  * Revision 1.6  1993/09/20  10:11:53  mike
129  * no changes
130  * 
131  * Revision 1.5  1993/09/20  09:58:58  mike
132  * Re-fix vm_vec_make
133  * 
134  * Revision 1.4  1993/09/20  09:41:21  mike
135  * Correct vm_vec_make and vm_mat_make macros to return the destination
136  * as the value of the macro.
137  * 
138  * Revision 1.3  1993/09/17  11:23:47  matt
139  * Added row access (via xrow,yrow,zrow) to vms_matrix
140  * Added macro vm_mat_make(), like vm_vec_make()
141  * 
142  * Revision 1.2  1993/09/17  11:10:32  matt
143  * Added vm_vec_add2() and vm_vec_sub2(), which take 2 args (dest==src0)
144  * 
145  * Revision 1.1  1993/09/16  20:10:01  matt
146  * Initial revision
147  * 
148  *
149  */ 
150
151 #ifndef _VECMAT_H
152 #define _VECMAT_H
153
154 #include "maths.h"
155
156 //#define INLINE 1              //are some of these functions inline?
157
158 //The basic fixed-point vector.  Access elements by name or position
159 typedef struct vms_vector
160   {
161     
162     fix x, y, z;
163     
164   }
165 __pack__ vms_vector;
166
167
168 typedef struct vms_vector_array
169   {
170     
171     fix xyz[3];
172     
173   }
174 __pack__ vms_vector_array;
175
176
177 //Short vector, used for pre-rotation points. 
178 //Access elements by name or position
179 typedef struct vms_svec
180   {
181     
182     short sv_x, sv_y, sv_z;
183      
184   }
185 __pack__ vms_svec;
186
187
188 //Angle vector.  Used to store orientations
189 typedef struct vms_angvec
190   {
191     
192     fixang p, b, h;
193     
194   }
195 __pack__ vms_angvec;
196
197
198 //A 3x3 rotation matrix.  Sorry about the numbering starting with one.
199 //Ordering is across then down, so <m1,m2,m3> is the first row
200 typedef struct vms_matrix
201   {
202     
203     vms_vector rvec, uvec, fvec;
204     
205   }
206 __pack__ vms_matrix;
207
208
209 //Macros/functions to fill in fields of structures
210
211 //macro to check if vector is zero
212 #define IS_VEC_NULL(v) (v->x == 0 && v->y == 0 && v->z == 0)
213
214 //macro to set a vector to zero.  we could do this with an in-line assembly 
215 //macro, but it's probably better to let the compiler optimize it.
216 //Note: NO RETURN VALUE
217 #define vm_vec_zero(v) (v)->x=(v)->y=(v)->z=0
218
219 //macro set set a matrix to the identity. Note: NO RETURN VALUE
220
221 // DPH (18/9/98): Begin mod to fix linefeed problem under linux. Uses an
222 // inline function instead of a multi-line macro to fix CR/LF problems.
223
224 #ifdef __unix__
225 static inline void vm_set_identity(vms_matrix *m)
226 {
227   m->rvec.x = m->uvec.y = m->fvec.z = f1_0;
228   m->rvec.y = m->rvec.z = m->uvec.x = m->uvec.z = m->fvec.x = m->fvec.y = 0;
229 }
230 #else
231 #define vm_set_identity(m) do {m->rvec.x = m->uvec.y = m->fvec.z = f1_0; \
232         m->rvec.y = m->rvec.z = \
233         m->uvec.x = m->uvec.z = \
234         m->fvec.x = m->fvec.y = 0;} while (0)
235 #endif
236
237 // DPH (19/8/98): End changes.
238
239 vms_vector * vm_vec_make (vms_vector * v, fix x, fix y, fix z);
240
241
242 #ifdef __WATCOMC__
243 #pragma aux vm_vec_make "*_" parm [eax] [edx] [ebx] [ecx] value [eax] modify exact [] = \
244 "mov 0[eax],edx" \
245 "mov 4[eax],ebx" \
246 "mov 8[eax],ecx";
247
248 #endif
249
250 vms_angvec * vm_angvec_make (vms_angvec * v, fixang p, fixang b, fixang h);
251
252
253 #ifdef __WATCOMC__
254 #pragma aux vm_angvec_make "*_" parm [eax] [dx] [bx] [cx] value [eax] modify exact [] = \
255 "mov 0[eax],dx" \
256 "mov 2[eax],bx" \
257 "mov 4[eax],cx";
258
259 #endif
260
261 //Global constants
262
263 extern vms_vector vmd_zero_vector;
264
265 extern vms_matrix vmd_identity_matrix;
266
267
268 //Here's a handy constant
269
270 #define ZERO_VECTOR {0,0,0}
271 #define IDENTITY_MATRIX { {f1_0,0,0}, {0,f1_0,0}, {0,0,f1_0} }
272
273 //#define vm_vec_make(v,_x,_y,_z) (((v)->x=(_x), (v)->y=(_y), (v)->z=(_z)), (v))
274
275 //#pragma off (unreferenced)
276 ////make this local, so compiler can in-line it
277 //static vms_vector *vm_vec_make(vms_vector *v,fix x,fix y,fix z)
278 //{
279 //      v->x = x;
280 //      v->y = y;
281 //      v->z = z;
282 //
283 //      return v;
284 //}
285 //#pragma on (unreferenced)
286
287
288 ////macro to fill in elements of a matrix, also for Mike
289 /*
290    #define vm_mat_make(m,_m1,_m2,_m3,_m4,_m5,_m6,_m7,_m8,_m9) \
291    do { (m)->m1=(_m1); (m)->m2=(_m2); (m)->m3=(_m3); \
292    (m)->m4=(_m4); (m)->m5=(_m5); (m)->m6=(_m6); \
293    (m)->m7=(_m7); (m)->m8=(_m8); (m)->m9=(_m9);} while (0)
294  */ 
295
296 #if 0                           //kill this, since bogus with new matrix ordering
297
298 //macro to fill in elements of a matrix, also for Mike
299 #define vm_mat_make(m,_m1,_m2,_m3,_m4,_m5,_m6,_m7,_m8,_m9) \
300 (((m)->m1 = (_m1), (m)->m2 = (_m2), (m)->m3 = (_m3), \
301   (m)->m4 = (_m4), (m)->m5 = (_m5), (m)->m6 = (_m6), \
302   (m)->m7 = (_m7), (m)->m8 = (_m8), (m)->m9 = (_m9)), (m)) 
303
304 #endif  /* 
305  */
306
307 ////fills in fields of an angle vector
308 //#define vm_angvec_make(v,_p,_b,_h) (((v)->p=(_p), (v)->b=(_b), (v)->h=(_h)), (v))
309
310 //negate a vector
311 #define vm_vec_negate(v) do {(v)->x = - (v)->x; (v)->y = - (v)->y; (v)->z = - (v)->z;} while (0);
312
313 //Functions in library
314
315 #ifndef INLINE
316
317 //adds two vectors, fills in dest, returns ptr to dest
318 //ok for dest to equal either source, but should use vm_vec_add2() if so
319 vms_vector * vm_vec_add (vms_vector * dest, vms_vector * src0, vms_vector * src1);
320
321
322 //subs two vectors, fills in dest, returns ptr to dest
323 //ok for dest to equal either source, but should use vm_vec_sub2() if so
324 vms_vector * vm_vec_sub (vms_vector * dest, vms_vector * src0, vms_vector * src1);
325
326
327 //adds one vector to another. returns ptr to dest
328 //dest can equal source
329 vms_vector * vm_vec_add2 (vms_vector * dest, vms_vector * src);
330
331
332 //subs one vector from another, returns ptr to dest
333 //dest can equal source
334 vms_vector * vm_vec_sub2 (vms_vector * dest, vms_vector * src);
335
336
337 #else   /* 
338  */
339
340 #define vm_vec_add(dest,src0,src1) do { \
341 (dest)->x = (src0)->x + (src1)->x;
342 \
343 (dest)->y = (src0)->y + (src1)->y;
344 \
345 (dest)->z = (src0)->z + (src1)->z;
346 \
347 }
348 while (0);
349
350
351 #define vm_vec_sub(dest,src0,src1) do { \
352 (dest)->x = (src0)->x - (src1)->x;
353 \
354 (dest)->y = (src0)->y - (src1)->y;
355 \
356 (dest)->z = (src0)->z - (src1)->z;
357 \
358 }
359 while (0);
360
361
362 #define vm_vec_add2(dest,src) do {              \
363 (dest)->x += (src)->x;
364 \
365 (dest)->y += (src)->y;
366 \
367 (dest)->z += (src)->z;
368 \
369 }
370 while (0);
371
372
373 #define vm_vec_sub2(dest,src) do {              \
374 (dest)->x -= (src)->x;
375 \
376 (dest)->y -= (src)->y;
377 \
378 (dest)->z -= (src)->z;
379 \
380 }
381 while (0);
382
383
384 #endif  /* 
385  */
386
387 //averages two vectors. returns ptr to dest
388 //dest can equal either source
389 vms_vector * vm_vec_avg (vms_vector * dest, vms_vector * src0, vms_vector * src1);
390
391
392 //averages four vectors. returns ptr to dest
393 //dest can equal any source
394 vms_vector * vm_vec_avg4 (vms_vector * dest, vms_vector * src0, vms_vector * src1, vms_vector * src2, vms_vector * src3);
395
396
397 //scales a vector in place.  returns ptr to vector
398 vms_vector * vm_vec_scale (vms_vector * dest, fix s);
399
400
401 //scales and copies a vector.  returns ptr to dest
402 vms_vector * vm_vec_copy_scale (vms_vector * dest, vms_vector * src, fix s);
403
404
405 //scales a vector, adds it to another, and stores in a 3rd vector
406 //dest = src1 + k * src2
407 vms_vector * vm_vec_scale_add (vms_vector * dest, vms_vector * src1, vms_vector * src2, fix k);
408
409
410 //scales a vector and adds it to another
411 //dest += k * src
412 vms_vector * vm_vec_scale_add2 (vms_vector * dest, vms_vector * src, fix k);
413
414
415 //scales a vector in place, taking n/d for scale.  returns ptr to vector
416 //dest *= n/d
417 vms_vector * vm_vec_scale2 (vms_vector * dest, fix n, fix d);
418
419
420 //returns magnitude of a vector
421 fix vm_vec_mag (vms_vector * v);
422
423
424 //computes the distance between two points. (does sub and mag)
425 fix vm_vec_dist (vms_vector * v0, vms_vector * v1);
426
427
428 //computes an approximation of the magnitude of the vector
429 //uses dist = largest + next_largest*3/8 + smallest*3/16
430 fix vm_vec_mag_quick (vms_vector * v);
431
432
433 //computes an approximation of the distance between two points.
434 //uses dist = largest + next_largest*3/8 + smallest*3/16
435 fix vm_vec_dist_quick (vms_vector * v0, vms_vector * v1);
436
437
438
439 //normalize a vector. returns mag of source vec
440 fix vm_vec_copy_normalize (vms_vector * dest, vms_vector * src);
441
442 fix vm_vec_normalize (vms_vector * v);
443
444
445 //normalize a vector. returns mag of source vec. uses approx mag
446 fix vm_vec_copy_normalize_quick (vms_vector * dest, vms_vector * src);
447
448 fix vm_vec_normalize_quick (vms_vector * v);
449
450
451 //return the normalized direction vector between two points
452 //dest = normalized(end - start).  Returns mag of direction vector
453 //NOTE: the order of the parameters matches the vector subtraction
454 fix vm_vec_normalized_dir (vms_vector * dest, vms_vector * end, vms_vector * start);
455
456 fix vm_vec_normalized_dir_quick (vms_vector * dest, vms_vector * end, vms_vector * start);
457
458
459 ////returns dot product of two vectors
460 fix vm_vec_dotprod (vms_vector * v0, vms_vector * v1);
461
462 #define vm_vec_dot(v0,v1) vm_vec_dotprod((v0),(v1))
463
464 #ifdef INLINE
465 #ifdef __WATCOMC__
466 #pragma aux vm_vec_dotprod parm [esi] [edi] value [eax] modify exact [eax ebx ecx edx] = \
467 "mov    eax,[esi]" \
468 "imul   dword ptr [edi]" \
469 "mov    ebx,eax" \
470 "mov    ecx,edx" \
471 \
472 "mov    eax,4[esi]" \
473 "imul   dword ptr 4[edi]" \
474 "add    ebx,eax" \
475 "adc    ecx,edx" \
476 \
477 "mov    eax,8[esi]" \
478 "imul   dword ptr 8[edi]" \
479 "add    eax,ebx" \
480 "adc    edx,ecx" \
481 \
482 "shrd   eax,edx,16";
483
484 #endif
485 #endif  /* 
486  */
487
488 //computes cross product of two vectors. returns ptr to dest
489 //dest CANNOT equal either source
490 vms_vector * vm_vec_crossprod (vms_vector * dest, vms_vector * src0, vms_vector * src1);
491
492 #define vm_vec_cross(dest,src0,src1) vm_vec_crossprod((dest),(src0),(src1))
493
494 //computes surface normal from three points. result is normalized
495 //returns ptr to dest
496 //dest CANNOT equal either source
497 vms_vector * vm_vec_normal (vms_vector * dest, vms_vector * p0, vms_vector * p1, vms_vector * p2);
498
499
500 //computes non-normalized surface normal from three points. 
501 //returns ptr to dest
502 //dest CANNOT equal either source
503 vms_vector * vm_vec_perp (vms_vector * dest, vms_vector * p0, vms_vector * p1, vms_vector * p2);
504
505
506 //computes the delta angle between two vectors. 
507 //vectors need not be normalized. if they are, call vm_vec_delta_ang_norm()
508 //the forward vector (third parameter) can be NULL, in which case the absolute
509 //value of the angle in returned.  Otherwise the angle around that vector is
510 //returned.
511 fixang vm_vec_delta_ang (vms_vector * v0, vms_vector * v1, vms_vector * fvec);
512
513
514 //computes the delta angle between two normalized vectors. 
515 fixang vm_vec_delta_ang_norm (vms_vector * v0, vms_vector * v1, vms_vector * fvec);
516
517
518 //computes a matrix from a set of three angles.  returns ptr to matrix
519 vms_matrix * vm_angles_2_matrix (vms_matrix * m, vms_angvec * a);
520
521
522 //computes a matrix from a forward vector and an angle
523 vms_matrix * vm_vec_ang_2_matrix (vms_matrix * m, vms_vector * v, fixang a);
524
525
526 //computes a matrix from one or more vectors. The forward vector is required,
527 //with the other two being optional.  If both up & right vectors are passed,
528 //the up vector is used.  If only the forward vector is passed, a bank of
529 //zero is assumed
530 //returns ptr to matrix
531 vms_matrix * vm_vector_2_matrix (vms_matrix * m, vms_vector * fvec, vms_vector * uvec, vms_vector * rvec);
532
533
534 //this version of vector_2_matrix requires that the vectors be more-or-less
535 //normalized and close to perpendicular
536 vms_matrix * vm_vector_2_matrix_norm (vms_matrix * m, vms_vector * fvec, vms_vector * uvec, vms_vector * rvec);
537
538
539 //rotates a vector through a matrix. returns ptr to dest vector
540 //dest CANNOT equal either source
541 vms_vector * vm_vec_rotate (vms_vector * dest, vms_vector * src, vms_matrix * m);
542
543
544 //transpose a matrix in place. returns ptr to matrix
545 vms_matrix * vm_transpose_matrix (vms_matrix * m);
546
547 #define vm_transpose(m) vm_transpose_matrix(m)
548
549 //copy and transpose a matrix. returns ptr to matrix
550 //dest CANNOT equal source. use vm_transpose_matrix() if this is the case
551 vms_matrix * vm_copy_transpose_matrix (vms_matrix * dest, vms_matrix * src);
552
553 #define vm_copy_transpose(dest,src) vm_copy_transpose_matrix((dest),(src))
554
555 //mulitply 2 matrices, fill in dest.  returns ptr to dest
556 //dest CANNOT equal either source
557 vms_matrix * vm_matrix_x_matrix (vms_matrix * dest, vms_matrix * src0, vms_matrix * src1);
558
559
560 //extract angles from a matrix 
561 vms_angvec * vm_extract_angles_matrix (vms_angvec * a, vms_matrix * m);
562
563
564 //extract heading and pitch from a vector, assuming bank==0
565 vms_angvec * vm_extract_angles_vector (vms_angvec * a, vms_vector * v);
566
567
568 //compute the distance from a point to a plane.  takes the normalized normal
569 //of the plane (ebx), a point on the plane (edi), and the point to check (esi).
570 //returns distance in eax
571 //distance is signed, so negative dist is on the back of the plane
572 fix vm_dist_to_plane (vms_vector * checkp, vms_vector * norm, vms_vector * planep);
573
574
575 //fills in fields of an angle vector
576 #define vm_angvec_make(v,_p,_b,_h) (((v)->p=(_p), (v)->b=(_b), (v)->h=(_h)), (v))
577 #endif  /* 
578  */
579