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