patch from Tomaz adding a proper matrix inverter, it should be able to invert any...
[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 //#define MATRIX4x4_OPENGLORIENTATION
10
11 typedef struct matrix4x4_s
12 {
13         float m[4][4];
14 }
15 matrix4x4_t;
16
17 extern const matrix4x4_t identitymatrix;
18
19 // functions for manipulating 4x4 matrices
20
21 // copy a matrix4x4
22 void Matrix4x4_Copy (matrix4x4_t *out, const matrix4x4_t *in);
23 // copy only the rotation portion of a matrix4x4
24 void Matrix4x4_CopyRotateOnly (matrix4x4_t *out, const matrix4x4_t *in);
25 // copy only the translate portion of a matrix4x4
26 void Matrix4x4_CopyTranslateOnly (matrix4x4_t *out, const matrix4x4_t *in);
27 // multiply two matrix4x4 together, combining their transformations
28 // (warning: order matters - Concat(a, b, c) != Concat(a, c, b))
29 void Matrix4x4_Concat (matrix4x4_t *out, const matrix4x4_t *in1, const matrix4x4_t *in2);
30 // swaps the rows and columns of the matrix
31 // (is this useful for anything?)
32 void Matrix4x4_Transpose (matrix4x4_t *out, const matrix4x4_t *in1);
33 // creates a matrix that does the opposite of the matrix provided
34 // this is a full matrix inverter, it should be able to invert any matrix that
35 // is possible to invert
36 // (non-uniform scaling, rotation, shearing, and translation, possibly others)
37 // warning: this function is SLOW
38 int Matrix4x4_Invert_Full (matrix4x4_t *out, const matrix4x4_t *in1);
39 // creates a matrix that does the opposite of the matrix provided
40 // only supports translate, rotate, scale (not scale3) matrices
41 void Matrix4x4_Invert_Simple (matrix4x4_t *out, const matrix4x4_t *in1);
42 // creates a matrix that does the same rotation and translation as the matrix
43 // provided, but no uniform scaling, does not support scale3 matrices
44 void Matrix4x4_Normalize (matrix4x4_t *out, matrix4x4_t *in1);
45
46 // creates an identity matrix
47 // (a matrix which does nothing)
48 void Matrix4x4_CreateIdentity (matrix4x4_t *out);
49 // creates a translate matrix
50 // (moves vectors)
51 void Matrix4x4_CreateTranslate (matrix4x4_t *out, double x, double y, double z);
52 // creates a rotate matrix
53 // (rotates vectors)
54 void Matrix4x4_CreateRotate (matrix4x4_t *out, double angle, double x, double y, double z);
55 // creates a scaling matrix
56 // (expands or contracts vectors)
57 // (warning: do not apply this kind of matrix to direction vectors)
58 void Matrix4x4_CreateScale (matrix4x4_t *out, double x);
59 // creates a squishing matrix
60 // (expands or contracts vectors differently in different axis)
61 // (warning: this is not reversed by Invert_Simple)
62 // (warning: do not apply this kind of matrix to direction vectors)
63 void Matrix4x4_CreateScale3 (matrix4x4_t *out, double x, double y, double z);
64 // creates a matrix for a quake entity
65 void Matrix4x4_CreateFromQuakeEntity(matrix4x4_t *out, double x, double y, double z, double pitch, double yaw, double roll, double scale);
66
67 // converts a matrix4x4 to a set of 3D vectors for the 3 axial directions, and the translate
68 void Matrix4x4_ToVectors(const matrix4x4_t *in, float vx[3], float vy[3], float vz[3], float t[3]);
69 // creates a matrix4x4 from a set of 3D vectors for axial directions, and translate
70 void Matrix4x4_FromVectors(matrix4x4_t *out, const float vx[3], const float vy[3], const float vz[3], const float t[3]);
71
72 // converts a matrix4x4 to a double[16] array in the OpenGL orientation
73 void Matrix4x4_ToArrayDoubleGL(const matrix4x4_t *in, double out[16]);
74 // creates a matrix4x4 from a double[16] array in the OpenGL orientation
75 void Matrix4x4_FromArrayDoubleGL(matrix4x4_t *out, const double in[16]);
76 // converts a matrix4x4 to a double[16] array in the Direct3D orientation
77 void Matrix4x4_ToArrayDoubleD3D(const matrix4x4_t *in, double out[16]);
78 // creates a matrix4x4 from a double[16] array in the Direct3D orientation
79 void Matrix4x4_FromArrayDoubleD3D(matrix4x4_t *out, const double in[16]);
80
81 // converts a matrix4x4 to a float[12] array in the OpenGL orientation
82 void Matrix4x4_ToArray12FloatGL(const matrix4x4_t *in, float out[12]);
83 // creates a matrix4x4 from a float[12] array in the OpenGL orientation
84 void Matrix4x4_FromArray12FloatGL(matrix4x4_t *out, const float in[12]);
85 // converts a matrix4x4 to a float[12] array in the Direct3D orientation
86 void Matrix4x4_ToArray12FloatD3D(const matrix4x4_t *in, float out[12]);
87 // creates a matrix4x4 from a float[12] array in the Direct3D orientation
88 void Matrix4x4_FromArray12FloatD3D(matrix4x4_t *out, const float in[12]);
89
90 // creates a matrix4x4 from an origin and quaternion (used mostly with skeletal model formats such as PSK)
91 void Matrix4x4_FromOriginQuat(matrix4x4_t *m, double ox, double oy, double oz, double x, double y, double z, double w);
92 // creates a matrix4x4 from an origin and canonical unit-length quaternion (used mostly with skeletal model formats such as MD5)
93 void Matrix4x4_FromDoom3Joint(matrix4x4_t *m, double ox, double oy, double oz, double x, double y, double z);
94
95 // blends two matrices together, at a given percentage (blend controls percentage of in2)
96 void Matrix4x4_Blend (matrix4x4_t *out, const matrix4x4_t *in1, const matrix4x4_t *in2, double blend);
97
98 // transforms a 3D vector through a matrix4x4
99 void Matrix4x4_Transform (const matrix4x4_t *in, const float v[3], float out[3]);
100 // transforms a 4D vector through a matrix4x4
101 // (warning: if you don't know why you would need this, you don't need it)
102 // (warning: the 4th component of the vector should be 1.0)
103 void Matrix4x4_Transform4 (const matrix4x4_t *in, const float v[4], float out[4]);
104 // reverse transforms a 3D vector through a matrix4x4, at least for *simple*
105 // cases (rotation and translation *ONLY*), this attempts to undo the results
106 // of Transform
107 //void Matrix4x4_SimpleUntransform (const matrix4x4_t *in, const float v[3], float out[3]);
108 // transforms a direction vector through the rotation part of a matrix
109 void Matrix4x4_Transform3x3 (const matrix4x4_t *in, const float v[3], float out[3]);
110
111 // ease of use functions
112 // immediately applies a Translate to the matrix
113 void Matrix4x4_ConcatTranslate (matrix4x4_t *out, double x, double y, double z);
114 // immediately applies a Rotate to the matrix
115 void Matrix4x4_ConcatRotate (matrix4x4_t *out, double angle, double x, double y, double z);
116 // immediately applies a Scale to the matrix
117 void Matrix4x4_ConcatScale (matrix4x4_t *out, double x);
118 // immediately applies a Scale3 to the matrix
119 void Matrix4x4_ConcatScale3 (matrix4x4_t *out, double x, double y, double z);
120
121 // extracts origin vector (translate) from matrix
122 void Matrix4x4_OriginFromMatrix (const matrix4x4_t *in, float *out);
123 // extracts scaling factor from matrix (only works for uniform scaling)
124 double Matrix4x4_ScaleFromMatrix (const matrix4x4_t *in);
125
126 // replaces origin vector (translate) in matrix
127 void Matrix4x4_SetOrigin (matrix4x4_t *out, double x, double y, double z);
128 // moves origin vector (translate) in matrix by a simple translate
129 void Matrix4x4_AdjustOrigin (matrix4x4_t *out, double x, double y, double z);
130 // scales vectors of a matrix in place and allows you to scale origin as well
131 void Matrix4x4_Scale (matrix4x4_t *out, double rotatescale, double originscale);
132
133 #endif