synched with trunk at revision 32129
[blender.git] / source / gameengine / Ketsji / KX_PyMath.h
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  * The Original Code is: all of this file.
24  *
25  * Contributor(s): none yet.
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  * Initialize Python thingies.
29  */
30
31 #ifndef __KX_PYMATH_H__
32 #define __KX_PYMATH_H__
33
34 #include "MT_Point2.h"
35 #include "MT_Point3.h"
36 #include "MT_Vector2.h"
37 #include "MT_Vector3.h"
38 #include "MT_Vector4.h"
39 #include "MT_Matrix3x3.h"
40 #include "MT_Matrix4x4.h"
41
42 #include "KX_Python.h"
43 #include "PyObjectPlus.h"
44
45 #ifndef DISABLE_PYTHON
46 #ifdef USE_MATHUTILS
47 extern "C" {
48 #include "../../blender/python/generic/mathutils.h" /* so we can have mathutils callbacks */
49 }
50 #endif
51
52 inline unsigned int Size(const MT_Matrix4x4&)          { return 4; }
53 inline unsigned int Size(const MT_Matrix3x3&)          { return 3; }
54 inline unsigned int Size(const MT_Tuple2&)                { return 2; }
55 inline unsigned int Size(const MT_Tuple3&)                { return 3; }
56 inline unsigned int Size(const MT_Tuple4&)                { return 4; }
57
58 /**
59  *  Converts the given python matrix (column-major) to an MT class (row-major).
60  */
61 template<class T>
62 bool PyMatTo(PyObject* pymat, T& mat)
63 {
64         bool noerror = true;
65         mat.setIdentity();
66         if (PySequence_Check(pymat))
67         {
68                 unsigned int cols = PySequence_Size(pymat);
69                 if (cols != Size(mat))
70                         return false;
71                         
72                 for (unsigned int x = 0; noerror && x < cols; x++)
73                 {
74                         PyObject *pycol = PySequence_GetItem(pymat, x); /* new ref */
75                         if (!PyErr_Occurred() && PySequence_Check(pycol))
76                         {
77                                 unsigned int rows = PySequence_Size(pycol);
78                                 if (rows != Size(mat))
79                                         noerror = false;
80                                 else
81                                 {
82                                         for( unsigned int y = 0; y < rows; y++)
83                                         {
84                                                 PyObject *item = PySequence_GetItem(pycol, y); /* new ref */
85                                                 mat[y][x] = PyFloat_AsDouble(item);
86                                                 Py_DECREF(item);
87                                         }
88                                 }
89                         } else 
90                                 noerror = false;
91                         Py_DECREF(pycol);
92                 }
93         } else 
94                 noerror = false;
95         
96         if (noerror==false)
97                 PyErr_SetString(PyExc_TypeError, "could not be converted to a matrix (sequence of sequences)");
98         
99         return noerror;
100 }
101
102 /**
103  *  Converts a python sequence to a MT class.
104  */
105 template<class T>
106 bool PyVecTo(PyObject* pyval, T& vec)
107 {
108 #ifdef USE_MATHUTILS
109         /* no need for BaseMath_ReadCallback() here, reading the sequences will do this */
110         
111         if(VectorObject_Check(pyval)) {
112                 VectorObject *pyvec= (VectorObject *)pyval;
113                 BaseMath_ReadCallback(pyvec);
114                 if (pyvec->size != Size(vec)) {
115                         PyErr_Format(PyExc_AttributeError, "error setting vector, %d args, should be %d", pyvec->size, Size(vec));
116                         return false;
117                 }
118                 vec.setValue((float *) pyvec->vec);
119                 return true;
120         }
121         else if(QuaternionObject_Check(pyval)) {
122                 QuaternionObject *pyquat= (QuaternionObject *)pyval;
123                 BaseMath_ReadCallback(pyquat);
124                 if (4 != Size(vec)) {
125                         PyErr_Format(PyExc_AttributeError, "error setting vector, %d args, should be %d", 4, Size(vec));
126                         return false;
127                 }
128                 /* xyzw -> wxyz reordering is done by PyQuatTo */
129                 vec.setValue((float *) pyquat->quat);
130                 return true;
131         }
132         else if(EulerObject_Check(pyval)) {
133                 EulerObject *pyeul= (EulerObject *)pyval;
134                 BaseMath_ReadCallback(pyeul);
135                 if (3 != Size(vec)) {
136                         PyErr_Format(PyExc_AttributeError, "error setting vector, %d args, should be %d", 3, Size(vec));
137                         return false;
138                 }
139                 vec.setValue((float *) pyeul->eul);
140                 return true;
141         } else
142 #endif
143         if(PyTuple_Check(pyval))
144         {
145                 unsigned int numitems = PyTuple_GET_SIZE(pyval);
146                 if (numitems != Size(vec)) {
147                         PyErr_Format(PyExc_AttributeError, "error setting vector, %d args, should be %d", numitems, Size(vec));
148                         return false;
149                 }
150                 
151                 for (unsigned int x = 0; x < numitems; x++)
152                         vec[x] = PyFloat_AsDouble(PyTuple_GET_ITEM(pyval, x)); /* borrow ref */
153                 
154                 if (PyErr_Occurred()) {
155                         PyErr_SetString(PyExc_AttributeError, "one or more of the items in the sequence was not a float");
156                         return false;
157                 }
158                 
159                 return true;
160         }
161         else if (PyObject_TypeCheck(pyval, (PyTypeObject *)&PyObjectPlus::Type))
162         {       /* note, include this check because PySequence_Check does too much introspection
163                  * on the PyObject (like getting its __class__, on a BGE type this means searching up
164                  * the parent list each time only to discover its not a sequence.
165                  * GameObjects are often used as an alternative to vectors so this is a common case
166                  * better to do a quick check for it, likely the error below will be ignored.
167                  * 
168                  * This is not 'correct' since we have proxy type CListValues's which could
169                  * contain floats/ints but there no cases of CValueLists being this way
170                  */
171                 PyErr_Format(PyExc_AttributeError, "expected a sequence type");
172                 return false;
173         }
174         else if (PySequence_Check(pyval))
175         {
176                 unsigned int numitems = PySequence_Size(pyval);
177                 if (numitems != Size(vec)) {
178                         PyErr_Format(PyExc_AttributeError, "error setting vector, %d args, should be %d", numitems, Size(vec));
179                         return false;
180                 }
181                 
182                 for (unsigned int x = 0; x < numitems; x++)
183                 {
184                         PyObject *item = PySequence_GetItem(pyval, x); /* new ref */
185                         vec[x] = PyFloat_AsDouble(item);
186                         Py_DECREF(item);
187                 }
188                 
189                 if (PyErr_Occurred()) {
190                         PyErr_SetString(PyExc_AttributeError, "one or more of the items in the sequence was not a float");
191                         return false;
192                 }
193                 
194                 return true;
195         } else
196         {
197                 PyErr_Format(PyExc_AttributeError, "not a sequence type, expected a sequence of numbers size %d", Size(vec));
198         }
199         
200         return false;
201 }
202
203
204 bool PyQuatTo(PyObject* pyval, MT_Quaternion &qrot);
205
206 bool PyOrientationTo(PyObject* pyval, MT_Matrix3x3 &mat, const char *error_prefix);
207
208 /**
209  * Converts an MT_Matrix4x4 to a python object.
210  */
211 PyObject* PyObjectFrom(const MT_Matrix4x4 &mat);
212
213 /**
214  * Converts an MT_Matrix3x3 to a python object.
215  */
216 PyObject* PyObjectFrom(const MT_Matrix3x3 &mat);
217
218 /**
219  * Converts an MT_Tuple2 to a python object.
220  */
221 PyObject* PyObjectFrom(const MT_Tuple2 &vec);
222
223 /**
224  * Converts an MT_Tuple3 to a python object
225  */
226 PyObject* PyObjectFrom(const MT_Tuple3 &vec);
227
228 #ifdef USE_MATHUTILS
229 /**
230  * Converts an MT_Quaternion to a python object.
231  */
232 PyObject* PyObjectFrom(const MT_Quaternion &qrot);
233 #endif
234
235 /**
236  * Converts an MT_Tuple4 to a python object.
237  */
238 PyObject* PyObjectFrom(const MT_Tuple4 &pos);
239
240 #endif
241
242 #endif // DISABLE_PYTHON