BGE PyAPI fixes
[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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, 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 inline unsigned int Size(const MT_Matrix4x4&)          { return 4; }
46 inline unsigned int Size(const MT_Matrix3x3&)          { return 3; }
47 inline unsigned int Size(const MT_Tuple2&)                { return 2; }
48 inline unsigned int Size(const MT_Tuple3&)                { return 3; }
49 inline unsigned int Size(const MT_Tuple4&)                { return 4; }
50
51 /**
52  *  Converts the given python matrix to an MT class.
53  */
54 template<class T>
55 bool PyMatTo(PyObject* pymat, T& mat)
56 {
57         bool noerror = true;
58         mat.setIdentity();
59         if (PySequence_Check(pymat))
60         {
61                 unsigned int rows = PySequence_Size(pymat);
62                 if (rows != Size(mat))
63                         return false;
64                         
65                 for (unsigned int y = 0; noerror && y < Size(mat); y++)
66                 {
67                         PyObject *pyrow = PySequence_GetItem(pymat, y); /* new ref */
68                         if (!PyErr_Occurred() && PySequence_Check(pyrow))
69                         {
70                                 unsigned int cols = PySequence_Size(pyrow);
71                                 if (cols != Size(mat))
72                                         noerror = false;
73                                 else
74                                 {
75                                         for( unsigned int x = 0; x < Size(mat); x++)
76                                         {
77                                                 PyObject *item = PySequence_GetItem(pyrow, x); /* new ref */
78                                                 mat[y][x] = PyFloat_AsDouble(item);
79                                                 Py_DECREF(item);
80                                         }
81                                 }
82                         } else 
83                                 noerror = false;
84                         Py_DECREF(pyrow);
85                 }
86         } else 
87                 noerror = false;
88         
89         if (noerror==false)
90                 PyErr_SetString(PyExc_TypeError, "could not be converted to a matrix (sequence of sequences)");
91         
92         return noerror;
93 }
94
95 /**
96  *  Converts a python sequence to a MT class.
97  */
98 template<class T>
99 bool PyVecTo(PyObject* pyval, T& vec)
100 {
101
102         if(PyTuple_Check(pyval))
103         {
104                 unsigned int numitems = PyTuple_GET_SIZE(pyval);
105                 if (numitems != Size(vec)) {
106                         PyErr_Format(PyExc_AttributeError, "error setting vector, %d args, should be %d", numitems, Size(vec));
107                         return false;
108                 }
109                 
110                 for (unsigned int x = 0; x < numitems; x++)
111                         vec[x] = PyFloat_AsDouble(PyTuple_GET_ITEM(pyval, x)); /* borrow ref */
112                 
113                 if (PyErr_Occurred()) {
114                         PyErr_SetString(PyExc_AttributeError, "one or more of the items in the sequence was not a float");
115                         return false;
116                 }
117                 
118                 return true;
119         }
120         else if (BGE_PROXY_CHECK_TYPE(pyval))
121         {       /* note, include this check because PySequence_Check does too much introspection
122                  * on the PyObject (like getting its __class__, on a BGE type this means searching up
123                  * the parent list each time only to discover its not a sequence.
124                  * GameObjects are often used as an alternative to vectors so this is a common case
125                  * better to do a quick check for it, likely the error below will be ignored.
126                  * 
127                  * This is not 'correct' since we have proxy type CListValues's which could
128                  * contain floats/ints but there no cases of CValueLists being this way
129                  */
130                 PyErr_Format(PyExc_AttributeError, "expected a sequence type");
131                 return false;
132         }
133         else if (PySequence_Check(pyval))
134         {
135                 unsigned int numitems = PySequence_Size(pyval);
136                 if (numitems != Size(vec)) {
137                         PyErr_Format(PyExc_AttributeError, "error setting vector, %d args, should be %d", numitems, Size(vec));
138                         return false;
139                 }
140                 
141                 for (unsigned int x = 0; x < numitems; x++)
142                 {
143                         PyObject *item = PySequence_GetItem(pyval, x); /* new ref */
144                         vec[x] = PyFloat_AsDouble(item);
145                         Py_DECREF(item);
146                 }
147                 
148                 if (PyErr_Occurred()) {
149                         PyErr_SetString(PyExc_AttributeError, "one or more of the items in the sequence was not a float");
150                         return false;
151                 }
152                 
153                 return true;
154         } else
155         {
156                 PyErr_Format(PyExc_AttributeError, "not a sequence type, expected a sequence of numbers size %d", Size(vec));
157         }
158         
159         return false;
160 }
161
162 bool PyOrientationTo(PyObject* pyval, MT_Matrix3x3 &mat, const char *error_prefix);
163
164 /**
165  * Converts an MT_Matrix4x4 to a python object.
166  */
167 PyObject* PyObjectFrom(const MT_Matrix4x4 &mat);
168
169 /**
170  * Converts an MT_Matrix3x3 to a python object.
171  */
172 PyObject* PyObjectFrom(const MT_Matrix3x3 &mat);
173
174 /**
175  * Converts an MT_Tuple2 to a python object.
176  */
177 PyObject* PyObjectFrom(const MT_Tuple2 &vec);
178
179 /**
180  * Converts an MT_Tuple3 to a python object
181  */
182 PyObject* PyObjectFrom(const MT_Tuple3 &vec);
183
184 /**
185  * Converts an MT_Tuple4 to a python object.
186  */
187 PyObject* PyObjectFrom(const MT_Tuple4 &pos);
188
189 /**
190  * True if the given PyObject can be converted to an MT_Matrix
191  * @param rank = 3 (for MT_Matrix3x3) or 4 (for MT_Matrix4x4)
192  */
193 bool PyObject_IsMT_Matrix(PyObject *pymat, unsigned int rank);
194
195 #endif