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