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