renamed makefile.bsd to BSDmakefile so that pmake will automatically find it (no...
[divverent/darkplaces.git] / matrixlib.h
1
2 #ifndef MATRIXLIB_H
3 #define MATRIXLIB_H
4
5 #ifndef M_PI
6 #define M_PI            3.14159265358979323846  // matches value in gcc v2 math.h
7 #endif
8
9 typedef struct matrix4x4_s
10 {
11         float m[4][4];
12 }
13 matrix4x4_t;
14
15 extern const matrix4x4_t identitymatrix;
16
17 // functions for manipulating 4x4 matrices
18
19 // copy a matrix4x4
20 void Matrix4x4_Copy (matrix4x4_t *out, const matrix4x4_t *in);
21 // copy only the rotation portion of a matrix4x4
22 void Matrix4x4_CopyRotateOnly (matrix4x4_t *out, const matrix4x4_t *in);
23 // copy only the translate portion of a matrix4x4
24 void Matrix4x4_CopyTranslateOnly (matrix4x4_t *out, const matrix4x4_t *in);
25 // multiply two matrix4x4 together, combining their transformations
26 // (warning: order matters - Concat(a, b, c) != Concat(a, c, b))
27 void Matrix4x4_Concat (matrix4x4_t *out, const matrix4x4_t *in1, const matrix4x4_t *in2);
28 // swaps the rows and columns of the matrix
29 // (is this useful for anything?)
30 void Matrix4x4_Transpose (matrix4x4_t *out, const matrix4x4_t *in1);
31 // swaps the rows and columns of the rotation matrix
32 // (inverting the rotation, but leaving everything else the same)
33 void Matrix4x4_Transpose3x3 (matrix4x4_t *out, const matrix4x4_t *in1);
34 // creates a matrix that does the opposite of the matrix provided
35 // only supports translate, rotate, scale (not scale3) matrices
36 void Matrix4x4_Invert_Simple (matrix4x4_t *out, const matrix4x4_t *in1);
37 // creates a matrix that does the same rotation and translation as the matrix
38 // provided, but no uniform scaling, does not support scale3 matrices
39 void Matrix4x4_Normalize (matrix4x4_t *out, matrix4x4_t *in1);
40
41 // creates an identity matrix
42 // (a matrix which does nothing)
43 void Matrix4x4_CreateIdentity (matrix4x4_t *out);
44 // creates a translate matrix
45 // (moves vectors)
46 void Matrix4x4_CreateTranslate (matrix4x4_t *out, float x, float y, float z);
47 // creates a rotate matrix
48 // (rotates vectors)
49 void Matrix4x4_CreateRotate (matrix4x4_t *out, float angle, float x, float y, float z);
50 // creates a scaling matrix
51 // (expands or contracts vectors)
52 // (warning: do not apply this kind of matrix to direction vectors)
53 void Matrix4x4_CreateScale (matrix4x4_t *out, float x);
54 // creates a squishing matrix
55 // (expands or contracts vectors differently in different axis)
56 // (warning: this is not reversed by Invert_Simple)
57 // (warning: do not apply this kind of matrix to direction vectors)
58 void Matrix4x4_CreateScale3 (matrix4x4_t *out, float x, float y, float z);
59 // creates a matrix for a quake entity
60 void Matrix4x4_CreateFromQuakeEntity(matrix4x4_t *out, float x, float y, float z, float pitch, float yaw, float roll, float scale);
61
62 // converts a matrix4x4 to a set of 3D vectors for the 3 axial directions, and the translate
63 void Matrix4x4_ToVectors(const matrix4x4_t *in, float vx[3], float vy[3], float vz[3], float t[3]);
64 // creates a matrix4x4 from a set of 3D vectors for axial directions, and translate
65 void Matrix4x4_FromVectors(matrix4x4_t *out, const float vx[3], const float vy[3], const float vz[3], const float t[3]);
66
67 // blends two matrices together, at a given percentage (blend controls percentage of in2)
68 void Matrix4x4_Blend (matrix4x4_t *out, const matrix4x4_t *in1, const matrix4x4_t *in2, float blend);
69
70 // transforms a 3D vector through a matrix4x4
71 void Matrix4x4_Transform (const matrix4x4_t *in, const float v[3], float out[3]);
72 // transforms a 4D vector through a matrix4x4
73 // (warning: if you don't know why you would need this, you don't need it)
74 // (warning: the 4th component of the vector should be 1.0)
75 void Matrix4x4_Transform4 (const matrix4x4_t *in, const float v[4], float out[4]);
76 // reverse transforms a 3D vector through a matrix4x4, at least for *simple*
77 // cases (rotation and translation *ONLY*), this attempts to undo the results
78 // of Transform
79 //void Matrix4x4_SimpleUntransform (const matrix4x4_t *in, const float v[3], float out[3]);
80 // transforms a direction vector through the rotation part of a matrix
81 void Matrix4x4_Transform3x3 (const matrix4x4_t *in, const float v[3], float out[3]);
82
83 // ease of use functions
84 // immediately applies a Translate to the matrix
85 void Matrix4x4_ConcatTranslate (matrix4x4_t *out, float x, float y, float z);
86 // immediately applies a Rotate to the matrix
87 void Matrix4x4_ConcatRotate (matrix4x4_t *out, float angle, float x, float y, float z);
88 // immediately applies a Scale to the matrix
89 void Matrix4x4_ConcatScale (matrix4x4_t *out, float x);
90 // immediately applies a Scale3 to the matrix
91 void Matrix4x4_ConcatScale3 (matrix4x4_t *out, float x, float y, float z);
92
93 // extracts origin vector (translate) from matrix
94 void Matrix4x4_OriginFromMatrix (const matrix4x4_t *in, float *out);
95 // extracts scaling factor from matrix (only works for uniform scaling)
96 float Matrix4x4_ScaleFromMatrix (const matrix4x4_t *in);
97
98 #endif