Filling in branch from trunk
[blender.git] / source / blender / blenlib / MTC_matrixops.h
1 /*
2  * matrixops.h
3  *
4  * $Id$
5  *
6  * ***** BEGIN GPL/BL DUAL LICENSE BLOCK *****
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * as published by the Free Software Foundation; either version 2
11  * of the License, or (at your option) any later version. The Blender
12  * Foundation also sells licenses for use in proprietary software under
13  * the Blender License.  See http://www.blender.org/BL/ for information
14  * about this.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program; if not, write to the Free Software Foundation,
23  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
24  *
25  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
26  * All rights reserved.
27  *
28  * The Original Code is: all of this file.
29  *
30  * Contributor(s): none yet.
31  *
32  * ***** END GPL/BL DUAL LICENSE BLOCK *****
33  */
34
35 #ifndef MATRIXOPS_H
36 #define MATRIXOPS_H 
37
38 #ifdef __cplusplus
39 extern "C" { 
40 #endif
41
42 /* ------------------------------------------------------------------------- */
43 /* need rewriting: */
44 /**
45  * copy the left upp3 3 by 3 of m2 to m1
46  */
47 void MTC_Mat3CpyMat4(float m1[][3], float m2[][4]);
48
49 /* ------------------------------------------------------------------------- */
50 /* operations based on 4 by 4 matrices */
51
52 /**
53  * Copy m1 to m2
54  */
55 void MTC_Mat4CpyMat4(float m1[][4], float m2[][4]);
56
57 /**
58  * Multiply all matrices after the first, leave the result in the
59  * first argument
60  */
61 void MTC_Mat4MulSerie(float answ[][4],
62                                           float m1[][4], float m2[][4], float m3[][4],
63                                           float m4[][4], float m5[][4], float m6[][4],
64                                           float m7[][4], float m8[][4]);
65
66 /**
67  * m1 = m2 matprod m3
68  */
69 void MTC_Mat4MulMat4(float m1[][4], float m2[][4], float m3[][4]);
70
71 /**
72  * Do vec^t prod mat, result in vec. Ignore vec[3] (vec is a
73  * float[3])
74  */
75 void MTC_Mat4MulVecfl(float mat[][4], float *vec);
76
77 /**
78  * Invert mat, result in inverse. Always returns 1
79  */
80 int MTC_Mat4Invert(float inverse[][4], float mat[][4]);
81
82 /**
83  * Make the set of mat orthonormal (mat should already be orthogonal)?
84  * (doesn't appear to normalize properly?)
85  */
86 void MTC_Mat4Ortho(float mat[][4]);
87
88 /**
89  * vec = mat prod vec, result in vec, ignore fourth component entirely
90  * (4th component is _not_ accessed!!! vec is 3d)
91  */
92 void MTC_Mat4Mul3Vecfl(float mat[][4], float *vec);
93
94 /**
95  * vec = mat prod vec, result in vec
96  */
97 void MTC_Mat4MulVec4fl(float mat[][4], float *vec);
98
99 /**
100  * Set <m> to the 4-D unity matrix
101  */
102 void MTC_Mat4One(float m[][4]);
103
104 /**
105  * Swap matrices m1 and m2
106  */
107 void MTC_Mat4SwapMat4(float m1[][4], float m2[][4]);
108
109 /**
110  * Copy m2 to the top-left 3x3 of m1, don't touch the remaining elements.
111  */
112 void MTC_Mat4CpyMat3nc(float m1[][4], float m2[][3]);
113
114 /**
115  * m1 = m2 * m3, but only the top-left 3x3
116  */
117 void MTC_Mat4MulMat33(float m1[][3], float m2[][4], float m3[][3]); 
118
119 /* ------------------------------------------------------------------------- */
120 /* Operations based on 3 by 3 matrices */
121 /**
122  * Do vec^t prod mat, result in vec.(vex is 3d)
123  */
124 void MTC_Mat3MulVecfl(float mat[][3], float *vec);
125
126 /**
127  * Copy m1 to m2
128  */
129 void MTC_Mat3CpyMat3(float m1[][3], float m2[][3]);
130
131 /**
132  * m1 = m2 prod m3
133  */
134 void MTC_Mat3MulMat3(float m1[][3], float m3[][3], float m2[][3]);
135
136 /**
137  * vec = vec prod mat
138  */
139 void MTC_Mat3MulVecd(float mat[][3], double *vec);
140
141 /**
142  * Guess: invert matrix
143  * result goes to m1
144  */
145 void MTC_Mat3Inv(float m1[][3], float m2[][3]);
146
147 /**
148  * Sort of a determinant matrix? Doesn't seem very adjoint to me...
149  * result goes to m1
150  */
151 void MTC_Mat3Adj(float m1[][3], float m[][3]);
152
153 /**
154  * Set <m> to the 3D unity matrix
155  */
156 void MTC_Mat3One(float m[][3]);
157
158 /* ------------------------------------------------------------------------- */
159
160 #ifdef __cplusplus
161 }
162 #endif
163
164 #endif /* MATRIXOPS_H */
165