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