25b1e458ae8ce29735cc3a5c361294304268653c
[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  * - Quaternion * Quaternion --> cross product (not dot product)
51  * - Euler.rotate(angle, axis) --> Euler.rotate_axis(axis, angle)
52  * - Euler.unique() *removed*, not a standard function only toggled different rotations.
53  * - Matrix.rotation_part() -> to_3x3()
54  * - Matrix.scale_part() -> to_scale()
55  * - Matrix.translation_part() -> to_translation()
56  * - Matrix.resize4x4() -> resize_4x4()
57  * - Euler.to_quat() -> to_quaternion()
58  * - Matrix.to_quat() -> to_quaternion()
59  * resizing nolonger returns the resized value.
60  * - Vector.resize2D -> resize_2d
61  * - Vector.resize3D -> resize_3d
62  * - Vector.resize4D -> resize_4d
63  * added new functions.
64  * - Vector.to_2d()
65  * - Vector.to_3d()
66  * - Vector.to_4d()
67  * moved into class functions.
68  * - Mathutils.RotationMatrix -> mathutils.Matrix.Rotation
69  * - Mathutils.ScaleMatrix -> mathutils.Matrix.Scale
70  * - Mathutils.ShearMatrix -> mathutils.Matrix.Shear
71  * - Mathutils.TranslationMatrix -> mathutils.Matrix.Translation
72  * - Mathutils.OrthoProjectionMatrix -> mathutils.Matrix.OrthoProjection
73  *
74  * Moved to Geometry module: Intersect, TriangleArea, TriangleNormal, QuadNormal, LineIntersect
75  * - geometry.Intersect -> intersect_ray_tri
76  * - geometry.ClosestPointOnLine -> intersect_point_line
77  * - geometry.PointInTriangle2D -> intersect_point_tri_2d
78  * - geometry.PointInQuad2D -> intersect_point_quad_2d
79  * - geometry.LineIntersect -> intersect_line_line
80  * - geometry.LineIntersect2D -> intersect_line_line_2d
81  * - geometry.BezierInterp -> interpolate_bezier
82  * - geometry.TriangleArea -> area_tri
83  * - geometry.QuadNormal, TriangleNormal -> normal
84  * - geometry.PolyFill -> tesselate_polygon
85  * - geometry.BoxPack2D -> box_pack_2d
86  * - geometry.BarycentricTransform -> barycentric_transform
87  */
88
89 #include "mathutils.h"
90
91 #include "BLI_math.h"
92 #include "BLI_utildefines.h"
93
94
95
96 //-------------------------DOC STRINGS ---------------------------
97 static char M_Mathutils_doc[] =
98 "This module provides access to matrices, eulers, quaternions and vectors."
99 ;
100 static int mathutils_array_parse_fast(float *array, int array_min, int array_max, PyObject *value, const char *error_prefix)
101 {
102         PyObject *value_fast= NULL;
103         PyObject *item;
104
105         int i, size;
106
107         /* non list/tuple cases */
108         if(!(value_fast=PySequence_Fast(value, error_prefix))) {
109                 /* PySequence_Fast sets the error */
110                 return -1;
111         }
112
113         size= PySequence_Fast_GET_SIZE(value_fast);
114
115         if(size > array_max || size < array_min) {
116                 if (array_max == array_min)     PyErr_Format(PyExc_ValueError, "%.200s: sequence size is %d, expected %d", error_prefix, size, array_max);
117                 else                                            PyErr_Format(PyExc_ValueError, "%.200s: sequence size is %d, expected [%d - %d]", error_prefix, size, array_min, array_max);
118                 Py_DECREF(value_fast);
119                 return -1;
120         }
121
122         i= size;
123         do {
124                 i--;
125                 if(((array[i]= PyFloat_AsDouble((item= PySequence_Fast_GET_ITEM(value_fast, i)))) == -1.0) && PyErr_Occurred()) {
126                         PyErr_Format(PyExc_ValueError, "%.200s: sequence index %d expected a number, found '%.200s' type, ", error_prefix, i, Py_TYPE(item)->tp_name);
127                         Py_DECREF(value_fast);
128                         return -1;
129                 }
130         } while(i);
131
132         Py_XDECREF(value_fast);
133         return size;
134 }
135
136 /* helper functionm returns length of the 'value', -1 on error */
137 int mathutils_array_parse(float *array, int array_min, int array_max, PyObject *value, const char *error_prefix)
138 {
139 #if 1 /* approx 6x speedup for mathutils types */
140         int size;
141
142         if(     (VectorObject_Check(value) && (size= ((VectorObject *)value)->size)) ||
143                 (EulerObject_Check(value) && (size= 3)) ||
144                 (QuaternionObject_Check(value) && (size= 4)) ||
145                 (ColorObject_Check(value) && (size= 3))
146         ) {
147                 if(!BaseMath_ReadCallback((BaseMathObject *)value)) {
148                         return -1;
149                 }
150
151                 if(size > array_max || size < array_min) {
152                         if (array_max == array_min)     PyErr_Format(PyExc_ValueError, "%.200s: sequence size is %d, expected %d", error_prefix, size, array_max);
153                         else                                            PyErr_Format(PyExc_ValueError, "%.200s: sequence size is %d, expected [%d - %d]", error_prefix, size, array_min, array_max);
154                         return -1;
155                 }
156
157                 memcpy(array, ((BaseMathObject *)value)->data, size * sizeof(float));
158                 return size;
159         }
160         else
161 #endif
162         {
163                 return mathutils_array_parse_fast(array, array_min, array_max, value, error_prefix);
164         }
165 }
166
167 //----------------------------------MATRIX FUNCTIONS--------------------
168
169
170 /* Utility functions */
171
172 // LomontRRDCompare4, Ever Faster Float Comparisons by Randy Dillon
173 #define SIGNMASK(i) (-(int)(((unsigned int)(i))>>31))
174
175 int EXPP_FloatsAreEqual(float af, float bf, int maxDiff)
176 {       // solid, fast routine across all platforms
177         // with constant time behavior
178         int ai = *(int *)(&af);
179         int bi = *(int *)(&bf);
180         int test = SIGNMASK(ai^bi);
181         int diff, v1, v2;
182
183         assert((0 == test) || (0xFFFFFFFF == test));
184         diff = (ai ^ (test & 0x7fffffff)) - bi;
185         v1 = maxDiff + diff;
186         v2 = maxDiff - diff;
187         return (v1|v2) >= 0;
188 }
189
190 /*---------------------- EXPP_VectorsAreEqual -------------------------
191   Builds on EXPP_FloatsAreEqual to test vectors */
192 int EXPP_VectorsAreEqual(float *vecA, float *vecB, int size, int floatSteps)
193 {
194         int x;
195         for (x=0; x< size; x++){
196                 if (EXPP_FloatsAreEqual(vecA[x], vecB[x], floatSteps) == 0)
197                         return 0;
198         }
199         return 1;
200 }
201
202
203 /* Mathutils Callbacks */
204
205 /* for mathutils internal use only, eventually should re-alloc but to start with we only have a few users */
206 Mathutils_Callback *mathutils_callbacks[8] = {NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL};
207
208 int Mathutils_RegisterCallback(Mathutils_Callback *cb)
209 {
210         int i;
211         
212         /* find the first free slot */
213         for(i= 0; mathutils_callbacks[i]; i++) {
214                 if(mathutils_callbacks[i]==cb) /* already registered? */
215                         return i;
216         }
217         
218         mathutils_callbacks[i] = cb;
219         return i;
220 }
221
222 /* use macros to check for NULL */
223 int _BaseMathObject_ReadCallback(BaseMathObject *self)
224 {
225         Mathutils_Callback *cb= mathutils_callbacks[self->cb_type];
226         if(cb->get(self, self->cb_subtype))
227                 return 1;
228
229         if(!PyErr_Occurred())
230                 PyErr_Format(PyExc_SystemError, "%s user has become invalid", Py_TYPE(self)->tp_name);
231         return 0;
232 }
233
234 int _BaseMathObject_WriteCallback(BaseMathObject *self)
235 {
236         Mathutils_Callback *cb= mathutils_callbacks[self->cb_type];
237         if(cb->set(self, self->cb_subtype))
238                 return 1;
239
240         if(!PyErr_Occurred())
241                 PyErr_Format(PyExc_SystemError, "%s user has become invalid", Py_TYPE(self)->tp_name);
242         return 0;
243 }
244
245 int _BaseMathObject_ReadIndexCallback(BaseMathObject *self, int index)
246 {
247         Mathutils_Callback *cb= mathutils_callbacks[self->cb_type];
248         if(cb->get_index(self, self->cb_subtype, index))
249                 return 1;
250
251         if(!PyErr_Occurred())
252                 PyErr_Format(PyExc_SystemError, "%s user has become invalid", Py_TYPE(self)->tp_name);
253         return 0;
254 }
255
256 int _BaseMathObject_WriteIndexCallback(BaseMathObject *self, int index)
257 {
258         Mathutils_Callback *cb= mathutils_callbacks[self->cb_type];
259         if(cb->set_index(self, self->cb_subtype, index))
260                 return 1;
261
262         if(!PyErr_Occurred())
263                 PyErr_Format(PyExc_SystemError, "%s user has become invalid", Py_TYPE(self)->tp_name);
264         return 0;
265 }
266
267 /* BaseMathObject generic functions for all mathutils types */
268 char BaseMathObject_Owner_doc[] = "The item this is wrapping or None  (readonly).";
269 PyObject *BaseMathObject_getOwner(BaseMathObject *self, void *UNUSED(closure))
270 {
271         PyObject *ret= self->cb_user ? self->cb_user : Py_None;
272         Py_INCREF(ret);
273         return ret;
274 }
275
276 char BaseMathObject_Wrapped_doc[] = "True when this object wraps external data (readonly).\n\n:type: boolean";
277 PyObject *BaseMathObject_getWrapped(BaseMathObject *self, void *UNUSED(closure))
278 {
279         return PyBool_FromLong((self->wrapped == Py_WRAP) ? 1:0);
280 }
281
282 void BaseMathObject_dealloc(BaseMathObject * self)
283 {
284         /* only free non wrapped */
285         if(self->wrapped != Py_WRAP)
286                 PyMem_Free(self->data);
287
288         Py_XDECREF(self->cb_user);
289         Py_TYPE(self)->tp_free(self); // PyObject_DEL(self); // breaks subtypes
290 }
291
292 /*----------------------------MODULE INIT-------------------------*/
293 struct PyMethodDef M_Mathutils_methods[] = {
294         {NULL, NULL, 0, NULL}
295 };
296
297 static struct PyModuleDef M_Mathutils_module_def = {
298         PyModuleDef_HEAD_INIT,
299         "mathutils",  /* m_name */
300         M_Mathutils_doc,  /* m_doc */
301         0,  /* m_size */
302         M_Mathutils_methods,  /* m_methods */
303         0,  /* m_reload */
304         0,  /* m_traverse */
305         0,  /* m_clear */
306         0,  /* m_free */
307 };
308
309 PyMODINIT_FUNC BPyInit_mathutils(void)
310 {
311         PyObject *submodule;
312         PyObject *item;
313
314         if( PyType_Ready( &vector_Type ) < 0 )
315                 return NULL;
316         if( PyType_Ready( &matrix_Type ) < 0 )
317                 return NULL;    
318         if( PyType_Ready( &euler_Type ) < 0 )
319                 return NULL;
320         if( PyType_Ready( &quaternion_Type ) < 0 )
321                 return NULL;
322         if( PyType_Ready( &color_Type ) < 0 )
323                 return NULL;
324
325         submodule = PyModule_Create(&M_Mathutils_module_def);
326         
327         /* each type has its own new() function */
328         PyModule_AddObject( submodule, "Vector",                (PyObject *)&vector_Type );
329         PyModule_AddObject( submodule, "Matrix",                (PyObject *)&matrix_Type );
330         PyModule_AddObject( submodule, "Euler",                 (PyObject *)&euler_Type );
331         PyModule_AddObject( submodule, "Quaternion",    (PyObject *)&quaternion_Type );
332         PyModule_AddObject( submodule, "Color",                 (PyObject *)&color_Type );
333         
334         /* submodule */
335         PyModule_AddObject( submodule, "geometry",              (item=BPyInit_mathutils_geometry()));
336         /* XXX, python doesnt do imports with this usefully yet
337          * 'from mathutils.geometry import PolyFill'
338          * ...fails without this. */
339         PyDict_SetItemString(PyThreadState_GET()->interp->modules, "mathutils.geometry", item);
340         Py_INCREF(item);
341
342         mathutils_matrix_vector_cb_index= Mathutils_RegisterCallback(&mathutils_matrix_vector_cb);
343
344         return submodule;
345 }