mathutils rotate functions for Euler/Quaternion/Matrix/Vector types.
[blender.git] / source / blender / python / generic / mathutils.c
1 /* 
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * This is a new part of Blender.
24  *
25  * Contributor(s): Joseph Gilbert, Campbell Barton
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29
30 /* Note: Changes to Mathutils since 2.4x
31  * use radians rather then degrees
32  * - Mathutils.Vector/Euler/Quaternion(), now only take single sequence arguments.
33  * - Mathutils.MidpointVecs --> vector.lerp(other, fac)
34  * - Mathutils.AngleBetweenVecs --> vector.angle(other)
35  * - Mathutils.ProjectVecs --> vector.project(other)
36  * - Mathutils.DifferenceQuats --> quat.difference(other)
37  * - Mathutils.Slerp --> quat.slerp(other, fac)
38  * - Mathutils.Rand: removed, use pythons random module
39  * - Mathutils.RotationMatrix(angle, size, axis_flag, axis) --> Mathutils.RotationMatrix(angle, size, axis); merge axis & axis_flag args
40  * - Mathutils.OrthoProjectionMatrix(plane, size, axis) --> Mathutils.OrthoProjectionMatrix(axis, size); merge axis & plane args
41  * - Mathutils.ShearMatrix(plane, factor, size) --> Mathutils.ShearMatrix(plane, size, factor); swap size & factor args, match other constructors.
42  * - Matrix.scalePart --> Matrix.scale_part
43  * - Matrix.translationPart --> Matrix.translation_part
44  * - Matrix.rotationPart --> Matrix.rotation_part
45  * - mathutils.Matrix.Shear(plane, fac, size), now takes a pair of floats for 3x3 or 4x4 shear factor.
46  * - toMatrix --> to_matrix
47  * - toEuler --> to_euler
48  * - toQuat --> to_quat
49  * - Vector.toTrackQuat --> Vector.to_track_quat
50  * - Vector.rotate(axis, angle) --> rotate(other), where other can be Euler/Quaternion/Matrix.
51  * - Quaternion * Quaternion --> cross product (not dot product)
52  * - Euler.rotate(angle, axis) --> Euler.rotate_axis(axis, angle)
53  * - Euler.unique() *removed*, not a standard function only toggled different rotations.
54  * - Matrix.rotation_part() -> to_3x3()
55  * - Matrix.scale_part() -> to_scale()
56  * - Matrix.translation_part() -> to_translation()
57  * - Matrix.resize4x4() -> resize_4x4()
58  * - Euler.to_quat() -> to_quaternion()
59  * - Matrix.to_quat() -> to_quaternion()
60  * resizing nolonger returns the resized value.
61  * - Vector.resize2D -> resize_2d
62  * - Vector.resize3D -> resize_3d
63  * - Vector.resize4D -> resize_4d
64  * added new functions.
65  * - Vector.to_2d()
66  * - Vector.to_3d()
67  * - Vector.to_4d()
68  * moved into class functions.
69  * - Mathutils.RotationMatrix -> mathutils.Matrix.Rotation
70  * - Mathutils.ScaleMatrix -> mathutils.Matrix.Scale
71  * - Mathutils.ShearMatrix -> mathutils.Matrix.Shear
72  * - Mathutils.TranslationMatrix -> mathutils.Matrix.Translation
73  * - Mathutils.OrthoProjectionMatrix -> mathutils.Matrix.OrthoProjection
74  *
75  * Moved to Geometry module: Intersect, TriangleArea, TriangleNormal, QuadNormal, LineIntersect
76  * - geometry.Intersect -> intersect_ray_tri
77  * - geometry.ClosestPointOnLine -> intersect_point_line
78  * - geometry.PointInTriangle2D -> intersect_point_tri_2d
79  * - geometry.PointInQuad2D -> intersect_point_quad_2d
80  * - geometry.LineIntersect -> intersect_line_line
81  * - geometry.LineIntersect2D -> intersect_line_line_2d
82  * - geometry.BezierInterp -> interpolate_bezier
83  * - geometry.TriangleArea -> area_tri
84  * - geometry.QuadNormal, TriangleNormal -> normal
85  * - geometry.PolyFill -> tesselate_polygon
86  * - geometry.BoxPack2D -> box_pack_2d
87  * - geometry.BarycentricTransform -> barycentric_transform
88  */
89
90 #include "mathutils.h"
91
92 #include "BLI_math.h"
93 #include "BLI_utildefines.h"
94
95
96
97 //-------------------------DOC STRINGS ---------------------------
98 static char M_Mathutils_doc[] =
99 "This module provides access to matrices, eulers, quaternions and vectors."
100 ;
101 static int mathutils_array_parse_fast(float *array, int array_min, int array_max, PyObject *value, const char *error_prefix)
102 {
103         PyObject *value_fast= NULL;
104         PyObject *item;
105
106         int i, size;
107
108         /* non list/tuple cases */
109         if(!(value_fast=PySequence_Fast(value, error_prefix))) {
110                 /* PySequence_Fast sets the error */
111                 return -1;
112         }
113
114         size= PySequence_Fast_GET_SIZE(value_fast);
115
116         if(size > array_max || size < array_min) {
117                 if (array_max == array_min)     PyErr_Format(PyExc_ValueError, "%.200s: sequence size is %d, expected %d", error_prefix, size, array_max);
118                 else                                            PyErr_Format(PyExc_ValueError, "%.200s: sequence size is %d, expected [%d - %d]", error_prefix, size, array_min, array_max);
119                 Py_DECREF(value_fast);
120                 return -1;
121         }
122
123         i= size;
124         do {
125                 i--;
126                 if(((array[i]= PyFloat_AsDouble((item= PySequence_Fast_GET_ITEM(value_fast, i)))) == -1.0) && PyErr_Occurred()) {
127                         PyErr_Format(PyExc_ValueError, "%.200s: sequence index %d expected a number, found '%.200s' type, ", error_prefix, i, Py_TYPE(item)->tp_name);
128                         Py_DECREF(value_fast);
129                         return -1;
130                 }
131         } while(i);
132
133         Py_XDECREF(value_fast);
134         return size;
135 }
136
137 /* helper functionm returns length of the 'value', -1 on error */
138 int mathutils_array_parse(float *array, int array_min, int array_max, PyObject *value, const char *error_prefix)
139 {
140 #if 1 /* approx 6x speedup for mathutils types */
141         int size;
142
143         if(     (VectorObject_Check(value) && (size= ((VectorObject *)value)->size)) ||
144                 (EulerObject_Check(value) && (size= 3)) ||
145                 (QuaternionObject_Check(value) && (size= 4)) ||
146                 (ColorObject_Check(value) && (size= 3))
147         ) {
148                 if(!BaseMath_ReadCallback((BaseMathObject *)value)) {
149                         return -1;
150                 }
151
152                 if(size > array_max || size < array_min) {
153                         if (array_max == array_min)     PyErr_Format(PyExc_ValueError, "%.200s: sequence size is %d, expected %d", error_prefix, size, array_max);
154                         else                                            PyErr_Format(PyExc_ValueError, "%.200s: sequence size is %d, expected [%d - %d]", error_prefix, size, array_min, array_max);
155                         return -1;
156                 }
157
158                 memcpy(array, ((BaseMathObject *)value)->data, size * sizeof(float));
159                 return size;
160         }
161         else
162 #endif
163         {
164                 return mathutils_array_parse_fast(array, array_min, array_max, value, error_prefix);
165         }
166 }
167
168 int mathutils_any_to_rotmat(float rmat[3][3], PyObject *value, const char *error_prefix)
169 {
170         if(EulerObject_Check(value)) {
171                 if(!BaseMath_ReadCallback((BaseMathObject *)value)) {
172                         return -1;
173                 }
174                 else {
175                         eulO_to_mat3(rmat, ((EulerObject *)value)->eul, ((EulerObject *)value)->order);
176                         return 0;
177                 }
178         }
179         else if (QuaternionObject_Check(value)) {
180                 if(!BaseMath_ReadCallback((BaseMathObject *)value)) {
181                         return -1;
182                 }
183                 else {
184                         float tquat[4];
185                         normalize_qt_qt(tquat, ((QuaternionObject *)value)->quat);
186                         quat_to_mat3(rmat, tquat);
187                         return 0;
188                 }
189         }
190         else if (MatrixObject_Check(value)) {
191                 if(!BaseMath_ReadCallback((BaseMathObject *)value)) {
192                         return -1;
193                 }
194                 else if(((MatrixObject *)value)->colSize < 3 || ((MatrixObject *)value)->rowSize < 3) {
195                         PyErr_Format(PyExc_ValueError, "%.200s: matrix must have minimum 3x3 dimensions", error_prefix);
196                         return -1;
197                 }
198                 else {
199                         matrix_as_3x3(rmat, (MatrixObject *)value);
200                         normalize_m3(rmat);
201                         return 0;
202                 }
203         }
204         else {
205                 PyErr_Format(PyExc_TypeError, "%.200s: expected a Euler, Quaternion or Matrix type, found %.200s", error_prefix, Py_TYPE(value)->tp_name);
206                 return -1;
207         }
208 }
209
210
211 //----------------------------------MATRIX FUNCTIONS--------------------
212
213
214 /* Utility functions */
215
216 // LomontRRDCompare4, Ever Faster Float Comparisons by Randy Dillon
217 #define SIGNMASK(i) (-(int)(((unsigned int)(i))>>31))
218
219 int EXPP_FloatsAreEqual(float af, float bf, int maxDiff)
220 {       // solid, fast routine across all platforms
221         // with constant time behavior
222         int ai = *(int *)(&af);
223         int bi = *(int *)(&bf);
224         int test = SIGNMASK(ai^bi);
225         int diff, v1, v2;
226
227         assert((0 == test) || (0xFFFFFFFF == test));
228         diff = (ai ^ (test & 0x7fffffff)) - bi;
229         v1 = maxDiff + diff;
230         v2 = maxDiff - diff;
231         return (v1|v2) >= 0;
232 }
233
234 /*---------------------- EXPP_VectorsAreEqual -------------------------
235   Builds on EXPP_FloatsAreEqual to test vectors */
236 int EXPP_VectorsAreEqual(float *vecA, float *vecB, int size, int floatSteps)
237 {
238         int x;
239         for (x=0; x< size; x++){
240                 if (EXPP_FloatsAreEqual(vecA[x], vecB[x], floatSteps) == 0)
241                         return 0;
242         }
243         return 1;
244 }
245
246
247 /* Mathutils Callbacks */
248
249 /* for mathutils internal use only, eventually should re-alloc but to start with we only have a few users */
250 Mathutils_Callback *mathutils_callbacks[8] = {NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL};
251
252 int Mathutils_RegisterCallback(Mathutils_Callback *cb)
253 {
254         int i;
255         
256         /* find the first free slot */
257         for(i= 0; mathutils_callbacks[i]; i++) {
258                 if(mathutils_callbacks[i]==cb) /* already registered? */
259                         return i;
260         }
261         
262         mathutils_callbacks[i] = cb;
263         return i;
264 }
265
266 /* use macros to check for NULL */
267 int _BaseMathObject_ReadCallback(BaseMathObject *self)
268 {
269         Mathutils_Callback *cb= mathutils_callbacks[self->cb_type];
270         if(cb->get(self, self->cb_subtype))
271                 return 1;
272
273         if(!PyErr_Occurred())
274                 PyErr_Format(PyExc_SystemError, "%s user has become invalid", Py_TYPE(self)->tp_name);
275         return 0;
276 }
277
278 int _BaseMathObject_WriteCallback(BaseMathObject *self)
279 {
280         Mathutils_Callback *cb= mathutils_callbacks[self->cb_type];
281         if(cb->set(self, self->cb_subtype))
282                 return 1;
283
284         if(!PyErr_Occurred())
285                 PyErr_Format(PyExc_SystemError, "%s user has become invalid", Py_TYPE(self)->tp_name);
286         return 0;
287 }
288
289 int _BaseMathObject_ReadIndexCallback(BaseMathObject *self, int index)
290 {
291         Mathutils_Callback *cb= mathutils_callbacks[self->cb_type];
292         if(cb->get_index(self, self->cb_subtype, index))
293                 return 1;
294
295         if(!PyErr_Occurred())
296                 PyErr_Format(PyExc_SystemError, "%s user has become invalid", Py_TYPE(self)->tp_name);
297         return 0;
298 }
299
300 int _BaseMathObject_WriteIndexCallback(BaseMathObject *self, int index)
301 {
302         Mathutils_Callback *cb= mathutils_callbacks[self->cb_type];
303         if(cb->set_index(self, self->cb_subtype, index))
304                 return 1;
305
306         if(!PyErr_Occurred())
307                 PyErr_Format(PyExc_SystemError, "%s user has become invalid", Py_TYPE(self)->tp_name);
308         return 0;
309 }
310
311 /* BaseMathObject generic functions for all mathutils types */
312 char BaseMathObject_Owner_doc[] = "The item this is wrapping or None  (readonly).";
313 PyObject *BaseMathObject_getOwner(BaseMathObject *self, void *UNUSED(closure))
314 {
315         PyObject *ret= self->cb_user ? self->cb_user : Py_None;
316         Py_INCREF(ret);
317         return ret;
318 }
319
320 char BaseMathObject_Wrapped_doc[] = "True when this object wraps external data (readonly).\n\n:type: boolean";
321 PyObject *BaseMathObject_getWrapped(BaseMathObject *self, void *UNUSED(closure))
322 {
323         return PyBool_FromLong((self->wrapped == Py_WRAP) ? 1:0);
324 }
325
326 void BaseMathObject_dealloc(BaseMathObject * self)
327 {
328         /* only free non wrapped */
329         if(self->wrapped != Py_WRAP)
330                 PyMem_Free(self->data);
331
332         Py_XDECREF(self->cb_user);
333         Py_TYPE(self)->tp_free(self); // PyObject_DEL(self); // breaks subtypes
334 }
335
336 /*----------------------------MODULE INIT-------------------------*/
337 struct PyMethodDef M_Mathutils_methods[] = {
338         {NULL, NULL, 0, NULL}
339 };
340
341 static struct PyModuleDef M_Mathutils_module_def = {
342         PyModuleDef_HEAD_INIT,
343         "mathutils",  /* m_name */
344         M_Mathutils_doc,  /* m_doc */
345         0,  /* m_size */
346         M_Mathutils_methods,  /* m_methods */
347         0,  /* m_reload */
348         0,  /* m_traverse */
349         0,  /* m_clear */
350         0,  /* m_free */
351 };
352
353 PyMODINIT_FUNC BPyInit_mathutils(void)
354 {
355         PyObject *submodule;
356         PyObject *item;
357
358         if( PyType_Ready( &vector_Type ) < 0 )
359                 return NULL;
360         if( PyType_Ready( &matrix_Type ) < 0 )
361                 return NULL;    
362         if( PyType_Ready( &euler_Type ) < 0 )
363                 return NULL;
364         if( PyType_Ready( &quaternion_Type ) < 0 )
365                 return NULL;
366         if( PyType_Ready( &color_Type ) < 0 )
367                 return NULL;
368
369         submodule = PyModule_Create(&M_Mathutils_module_def);
370         
371         /* each type has its own new() function */
372         PyModule_AddObject( submodule, "Vector",                (PyObject *)&vector_Type );
373         PyModule_AddObject( submodule, "Matrix",                (PyObject *)&matrix_Type );
374         PyModule_AddObject( submodule, "Euler",                 (PyObject *)&euler_Type );
375         PyModule_AddObject( submodule, "Quaternion",    (PyObject *)&quaternion_Type );
376         PyModule_AddObject( submodule, "Color",                 (PyObject *)&color_Type );
377         
378         /* submodule */
379         PyModule_AddObject( submodule, "geometry",              (item=BPyInit_mathutils_geometry()));
380         /* XXX, python doesnt do imports with this usefully yet
381          * 'from mathutils.geometry import PolyFill'
382          * ...fails without this. */
383         PyDict_SetItemString(PyThreadState_GET()->interp->modules, "mathutils.geometry", item);
384         Py_INCREF(item);
385
386         mathutils_matrix_vector_cb_index= Mathutils_RegisterCallback(&mathutils_matrix_vector_cb);
387
388         return submodule;
389 }