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