more cleaning of matrix4x4_t struct access
[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, double x, double y, double z);
47 // creates a rotate matrix
48 // (rotates vectors)
49 void Matrix4x4_CreateRotate (matrix4x4_t *out, double angle, double x, double y, double 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, double 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, double x, double y, double z);
59 // creates a matrix for a quake entity
60 void Matrix4x4_CreateFromQuakeEntity(matrix4x4_t *out, double x, double y, double z, double pitch, double yaw, double roll, double 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 // converts a matrix4x4 to a double[16] array in the OpenGL orientation
68 void Matrix4x4_ToArrayDoubleGL(const matrix4x4_t *in, double out[16]);
69 // creates a matrix4x4 from a double[16] array in the OpenGL orientation
70 void Matrix4x4_FromArrayDoubleGL(matrix4x4_t *out, const double in[16]);
71 // converts a matrix4x4 to a double[16] array in the Direct3D orientation
72 void Matrix4x4_ToArrayDoubleD3D(const matrix4x4_t *in, double out[16]);
73 // creates a matrix4x4 from a double[16] array in the Direct3D orientation
74 void Matrix4x4_FromArrayDoubleD3D(matrix4x4_t *out, const double in[16]);
75
76 // converts a matrix4x4 to a float[12] array in the OpenGL orientation
77 void Matrix4x4_ToArray12FloatGL(const matrix4x4_t *in, float out[12]);
78 // creates a matrix4x4 from a float[12] array in the OpenGL orientation
79 void Matrix4x4_FromArray12FloatGL(matrix4x4_t *out, const float in[12]);
80 // converts a matrix4x4 to a float[12] array in the Direct3D orientation
81 void Matrix4x4_ToArray12FloatD3D(const matrix4x4_t *in, float out[12]);
82 // creates a matrix4x4 from a float[12] array in the Direct3D orientation
83 void Matrix4x4_FromArray12FloatD3D(matrix4x4_t *out, const float in[12]);
84
85 // creates a matrix4x4 from an origin and quaternion (used mostly with skeletal model formats such as PSK)
86 void Matrix4x4_FromOriginQuat(matrix4x4_t *m, double ox, double oy, double oz, double x, double y, double z, double w);
87 // creates a matrix4x4 from an origin and canonical unit-length quaternion (used mostly with skeletal model formats such as MD5)
88 void Matrix4x4_FromDoom3Joint(matrix4x4_t *m, double ox, double oy, double oz, double x, double y, double z);
89
90 // blends two matrices together, at a given percentage (blend controls percentage of in2)
91 void Matrix4x4_Blend (matrix4x4_t *out, const matrix4x4_t *in1, const matrix4x4_t *in2, double blend);
92
93 // transforms a 3D vector through a matrix4x4
94 void Matrix4x4_Transform (const matrix4x4_t *in, const float v[3], float out[3]);
95 // transforms a 4D vector through a matrix4x4
96 // (warning: if you don't know why you would need this, you don't need it)
97 // (warning: the 4th component of the vector should be 1.0)
98 void Matrix4x4_Transform4 (const matrix4x4_t *in, const float v[4], float out[4]);
99 // reverse transforms a 3D vector through a matrix4x4, at least for *simple*
100 // cases (rotation and translation *ONLY*), this attempts to undo the results
101 // of Transform
102 //void Matrix4x4_SimpleUntransform (const matrix4x4_t *in, const float v[3], float out[3]);
103 // transforms a direction vector through the rotation part of a matrix
104 void Matrix4x4_Transform3x3 (const matrix4x4_t *in, const float v[3], float out[3]);
105
106 // ease of use functions
107 // immediately applies a Translate to the matrix
108 void Matrix4x4_ConcatTranslate (matrix4x4_t *out, double x, double y, double z);
109 // immediately applies a Rotate to the matrix
110 void Matrix4x4_ConcatRotate (matrix4x4_t *out, double angle, double x, double y, double z);
111 // immediately applies a Scale to the matrix
112 void Matrix4x4_ConcatScale (matrix4x4_t *out, double x);
113 // immediately applies a Scale3 to the matrix
114 void Matrix4x4_ConcatScale3 (matrix4x4_t *out, double x, double y, double z);
115
116 // extracts origin vector (translate) from matrix
117 void Matrix4x4_OriginFromMatrix (const matrix4x4_t *in, float *out);
118 // extracts scaling factor from matrix (only works for uniform scaling)
119 double Matrix4x4_ScaleFromMatrix (const matrix4x4_t *in);
120
121 // replaces origin vector (translate) in matrix
122 void Matrix4x4_SetOrigin (matrix4x4_t *out, double x, double y, double z);
123 // moves origin vector (translate) in matrix by a simple translate
124 void Matrix4x4_AdjustOrigin (matrix4x4_t *out, double x, double y, double z);
125 // scales vectors of a matrix in place and allows you to scale origin as well
126 void Matrix4x4_Scale (matrix4x4_t *out, double rotatescale, double originscale);
127
128 #endif