Merge from trunk 16122-16307
[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
44 inline unsigned int Size(const MT_Matrix4x4&)          { return 4; }
45 inline unsigned int Size(const MT_Matrix3x3&)          { return 3; }
46 inline unsigned int Size(const MT_Tuple2&)                { return 2; }
47 inline unsigned int Size(const MT_Tuple3&)                { return 3; }
48 inline unsigned int Size(const MT_Tuple4&)                { return 4; }
49
50 /**
51  *  Converts the given python matrix to an MT class.
52  */
53 template<class T>
54 bool PyMatTo(PyObject* pymat, T& mat)
55 {
56         bool noerror = true;
57         mat.setIdentity();
58         if (PySequence_Check(pymat))
59         {
60                 unsigned int rows = PySequence_Size(pymat);
61                 if (rows != Size(mat))
62                         return false;
63                         
64                 for (unsigned int y = 0; noerror && y < Size(mat); y++)
65                 {
66                         PyObject *pyrow = PySequence_GetItem(pymat, y); /* new ref */
67                         if (!PyErr_Occurred() && PySequence_Check(pyrow))
68                         {
69                                 unsigned int cols = PySequence_Size(pyrow);
70                                 if (cols != Size(mat))
71                                         noerror = false;
72                                 else
73                                 {
74                                         for( unsigned int x = 0; x < Size(mat); x++)
75                                         {
76                                                 PyObject *item = PySequence_GetItem(pyrow, x); /* new ref */
77                                                 mat[y][x] = PyFloat_AsDouble(item);
78                                                 Py_DECREF(item);
79                                         }
80                                 }
81                         } else 
82                                 noerror = false;
83                         Py_DECREF(pyrow);
84                 }
85         } else 
86                 noerror = false;
87         
88         if (noerror==false)
89                 PyErr_SetString(PyExc_TypeError, "could not be converted to a matrix (sequence of sequences)");
90         
91         return noerror;
92 }
93
94 /**
95  *  Converts a python list to a MT class.
96  */
97 template<class T>
98 bool PyVecTo(PyObject* pyval, T& vec)
99 {
100         if (PySequence_Check(pyval))
101         {
102                 unsigned int numitems = PySequence_Size(pyval);
103                 if (numitems != Size(vec)) {
104                         char err[128];
105                         sprintf(err, "error setting vector, %d args, should be %d", numitems, Size(vec));
106                         PyErr_SetString(PyExc_AttributeError, err);
107                         return false;
108                 }
109                 
110                 for (unsigned int x = 0; x < numitems; x++)
111                 {
112                         PyObject *item = PySequence_GetItem(pyval, x); /* new ref */
113                         vec[x] = PyFloat_AsDouble(item);
114                         Py_DECREF(item);
115                 }
116                 
117                 if (PyErr_Occurred()) {
118                         PyErr_SetString(PyExc_AttributeError, "one or more of the items in the sequence was not a float");
119                         return false;
120                 }
121                 
122                 return true;
123         } else
124         {
125                 char err[128];
126                 sprintf(err, "not a sequence type, expected a sequence of numbers size %d", Size(vec));
127                 PyErr_SetString(PyExc_AttributeError, err);
128         }
129         
130         return false;
131 }
132
133 /**
134  *  Converts a python argument to an MT class.
135  *  This paramater expects arguments as passed to a python method.
136  */
137 template<class T>
138 bool PyVecArgTo(PyObject* args, T& vec)
139 {
140         PyObject* pylist;
141         if (PyArg_ParseTuple(args,"O",&pylist))
142                 return PyVecTo(pylist, vec);
143                 
144         return false;
145 }
146
147 /**
148  * Converts an MT_Matrix4x4 to a python object.
149  */
150 PyObject* PyObjectFrom(const MT_Matrix4x4 &mat);
151
152 /**
153  * Converts an MT_Matrix3x3 to a python object.
154  */
155 PyObject* PyObjectFrom(const MT_Matrix3x3 &mat);
156
157 /**
158  * Converts an MT_Tuple2 to a python object.
159  */
160 PyObject* PyObjectFrom(const MT_Tuple2 &vec);
161
162 /**
163  * Converts an MT_Tuple3 to a python object
164  */
165 PyObject* PyObjectFrom(const MT_Tuple3 &vec);
166
167 /**
168  * Converts an MT_Tuple4 to a python object.
169  */
170 PyObject* PyObjectFrom(const MT_Tuple4 &pos);
171
172 /**
173  * True if the given PyObject can be converted to an MT_Matrix
174  * @param rank = 3 (for MT_Matrix3x3) or 4 (for MT_Matrix4x4)
175  */
176 bool PyObject_IsMT_Matrix(PyObject *pymat, unsigned int rank);
177
178 #endif