remove unused includes
[blender.git] / source / blender / python / generic / euler.c
index 73fcaeb457b6274ab4415897d068659b8c88832c..3c018333b39d97b70360999875dafa944093959f 100644 (file)
@@ -15,7 +15,7 @@
  *
  * You should have received a copy of the GNU General Public License
  * along with this program; if not, write to the Free Software Foundation,
- * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  *
  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
  * All rights reserved.
 
 #include "Mathutils.h"
 
-#include "BLI_arithb.h"
+#include "BLI_math.h"
 #include "BKE_utildefines.h"
-#include "BLI_blenlib.h"
-
-
-//-------------------------DOC STRINGS ---------------------------
-
-static PyObject *Euler_Zero( EulerObject * self );
-static PyObject *Euler_Unique( EulerObject * self );
-static PyObject *Euler_ToMatrix( EulerObject * self );
-static PyObject *Euler_ToQuat( EulerObject * self );
-static PyObject *Euler_Rotate( EulerObject * self, PyObject *args );
-static PyObject *Euler_MakeCompatible( EulerObject * self, EulerObject *value );
-static PyObject *Euler_copy( EulerObject * self, PyObject *args );
-
-//-----------------------METHOD DEFINITIONS ----------------------
-static struct PyMethodDef Euler_methods[] = {
-       {"zero", (PyCFunction) Euler_Zero, METH_NOARGS, NULL},
-       {"unique", (PyCFunction) Euler_Unique, METH_NOARGS, NULL},
-       {"toMatrix", (PyCFunction) Euler_ToMatrix, METH_NOARGS, NULL},
-       {"toQuat", (PyCFunction) Euler_ToQuat, METH_NOARGS, NULL},
-       {"rotate", (PyCFunction) Euler_Rotate, METH_VARARGS, NULL},
-       {"makeCompatible", (PyCFunction) Euler_MakeCompatible, METH_O, NULL},
-       {"__copy__", (PyCFunction) Euler_copy, METH_VARARGS, NULL},
-       {"copy", (PyCFunction) Euler_copy, METH_VARARGS, NULL},
-       {NULL, NULL, 0, NULL}
-};
 
 //----------------------------------Mathutils.Euler() -------------------
 //makes a new euler for you to play with
@@ -64,6 +39,7 @@ static PyObject *Euler_new(PyTypeObject * type, PyObject * args, PyObject * kwar
        int size, i;
        float eul[3];
        PyObject *e;
+       short order= 0;  // TODO, add order option
 
        size = PyTuple_GET_SIZE(args);
        if (size == 1) {
@@ -76,7 +52,7 @@ static PyObject *Euler_new(PyTypeObject * type, PyObject * args, PyObject * kwar
                }
        } else if (size == 0) {
                //returns a new empty 3d euler
-               return newEulerObject(NULL, Py_NEW, NULL);
+               return newEulerObject(NULL, order, Py_NEW, NULL);
        } else {
                listObject = args;
        }
@@ -102,36 +78,60 @@ static PyObject *Euler_new(PyTypeObject * type, PyObject * args, PyObject * kwar
                        return NULL;
                }
        }
-       return newEulerObject(eul, Py_NEW, NULL);
+       return newEulerObject(eul, order, Py_NEW, NULL);
+}
+
+short euler_order_from_string(const char *str, const char *error_prefix)
+{
+       if((str[0] && str[1] && str[2] && str[3]=='\0')) {
+               switch(*((int32_t *)str)) {
+                       case 'X'|'Y'<<8|'Z'<<16:        return 0;
+                       case 'X'|'Z'<<8|'Y'<<16:        return 1;
+                       case 'Y'|'X'<<8|'Z'<<16:        return 2;
+                       case 'Y'|'Z'<<8|'X'<<16:        return 3;
+                       case 'Z'|'X'<<8|'Y'<<16:        return 4;
+                       case 'Z'|'Y'<<8|'X'<<16:        return 5;
+               }
+       }
+
+       PyErr_Format(PyExc_TypeError, "%s: invalid euler order '%s'", error_prefix, str);
+       return -1;
 }
 
 //-----------------------------METHODS----------------------------
 //----------------------------Euler.toQuat()----------------------
 //return a quaternion representation of the euler
+
+static char Euler_ToQuat_doc[] =
+".. method:: to_quat()\n"
+"\n"
+"   Return a quaternion representation of the euler.\n"
+"\n"
+"   :return: Quaternion representation of the euler.\n"
+"   :rtype: :class:`Quaternion`\n";
+
 static PyObject *Euler_ToQuat(EulerObject * self)
 {
        float quat[4];
-#ifdef USE_MATHUTILS_DEG
-       float eul[3];
-       int x;
-#endif
 
        if(!BaseMath_ReadCallback(self))
                return NULL;
 
-#ifdef USE_MATHUTILS_DEG
-       for(x = 0; x < 3; x++) {
-               eul[x] = self->eul[x] * ((float)Py_PI / 180);
-       }
-       EulToQuat(eul, quat);
-#else
-       EulToQuat(self->eul, quat);
-#endif
+       if(self->order==0)      eul_to_quat(quat, self->eul);
+       else                            eulO_to_quat(quat, self->eul, self->order);
 
        return newQuaternionObject(quat, Py_NEW, NULL);
 }
 //----------------------------Euler.toMatrix()---------------------
 //return a matrix representation of the euler
+static char Euler_ToMatrix_doc[] =
+".. method:: to_matrix()\n"
+"\n"
+"   Return a matrix representation of the euler.\n"
+"\n"
+"   :return: A 3x3 roation matrix representation of the euler.\n"
+"   :rtype: :class:`Matrix`\n";
+
 static PyObject *Euler_ToMatrix(EulerObject * self)
 {
        float mat[9] = {0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f};
@@ -139,23 +139,22 @@ static PyObject *Euler_ToMatrix(EulerObject * self)
        if(!BaseMath_ReadCallback(self))
                return NULL;
 
-#ifdef USE_MATHUTILS_DEG
-       {
-               float eul[3];
-               int x;
-               
-               for(x = 0; x < 3; x++) {
-                       eul[x] = self->eul[x] * ((float)Py_PI / 180);
-               }
-               EulToMat3(eul, (float (*)[3]) mat);
-       }
-#else
-       EulToMat3(self->eul, (float (*)[3]) mat);
-#endif
+       if(self->order==0)      eul_to_mat3((float (*)[3])mat, self->eul);
+       else                            eulO_to_mat3((float (*)[3])mat, self->eul, self->order);
+
        return newMatrixObject(mat, 3, 3 , Py_NEW, NULL);
 }
 //----------------------------Euler.unique()-----------------------
 //sets the x,y,z values to a unique euler rotation
+// TODO, check if this works with rotation order!!!
+static char Euler_Unique_doc[] =
+".. method:: unique()\n"
+"\n"
+"   Calculate a unique rotation for this euler. Avoids gimble lock.\n"
+"\n"
+"   :return: an instance of itself\n"
+"   :rtype: :class:`Euler`\n";
+
 static PyObject *Euler_Unique(EulerObject * self)
 {
 #define PI_2           (Py_PI * 2.0)
@@ -167,16 +166,9 @@ static PyObject *Euler_Unique(EulerObject * self)
        if(!BaseMath_ReadCallback(self))
                return NULL;
 
-#ifdef USE_MATHUTILS_DEG
-       //radians
-       heading = self->eul[0] * (float)Py_PI / 180;
-       pitch = self->eul[1] * (float)Py_PI / 180;
-       bank = self->eul[2] * (float)Py_PI / 180;
-#else
        heading = self->eul[0];
        pitch = self->eul[1];
        bank = self->eul[2];
-#endif
 
        //wrap heading in +180 / -180
        pitch += Py_PI;
@@ -207,19 +199,20 @@ static PyObject *Euler_Unique(EulerObject * self)
        heading -= (floor(heading * PI_INV)) * PI_2;
        heading -= Py_PI;
 
-#ifdef USE_MATHUTILS_DEG
-       //back to degrees
-       self->eul[0] = (float)(heading * 180 / (float)Py_PI);
-       self->eul[1] = (float)(pitch * 180 / (float)Py_PI);
-       self->eul[2] = (float)(bank * 180 / (float)Py_PI);
-#endif
-
        BaseMath_WriteCallback(self);
        Py_INCREF(self);
        return (PyObject *)self;
 }
 //----------------------------Euler.zero()-------------------------
 //sets the euler to 0,0,0
+static char Euler_Zero_doc[] =
+".. method:: zero()\n"
+"\n"
+"   Set all values to zero.\n"
+"\n"
+"   :return: an instance of itself\n"
+"   :rtype: :class:`Euler`\n";
+
 static PyObject *Euler_Zero(EulerObject * self)
 {
        self->eul[0] = 0.0;
@@ -250,66 +243,43 @@ static PyObject *Euler_Rotate(EulerObject * self, PyObject *args)
        if(!BaseMath_ReadCallback(self))
                return NULL;
 
-#ifdef USE_MATHUTILS_DEG
-       {
-               int x;
-
-               //covert to radians
-               angle *= ((float)Py_PI / 180);
-               for(x = 0; x < 3; x++) {
-                       self->eul[x] *= ((float)Py_PI / 180);
-               }
-       }
-#endif
-       euler_rot(self->eul, angle, *axis);
-
-#ifdef USE_MATHUTILS_DEG
-       {
-               int x;
-               //convert back from radians
-               for(x = 0; x < 3; x++) {
-                       self->eul[x] *= (180 / (float)Py_PI);
-               }
-       }
-#endif
+       if(self->order == 0)    rotate_eul(self->eul, *axis, angle);
+       else                                    rotate_eulO(self->eul, self->order, *axis, angle);
 
        BaseMath_WriteCallback(self);
        Py_INCREF(self);
        return (PyObject *)self;
 }
 
+static char Euler_MakeCompatible_doc[] =
+".. method:: make_compatible(other)\n"
+"\n"
+"   Make this euler compatible with another, so interpolating between them works as intended.\n"
+"\n"
+"   :arg other: make compatible with this rotation.\n"
+"   :type other: :class:`Euler`\n"
+"   :return: an instance of itself.\n"
+"   :rtype: :class:`Euler`\n"
+"\n"
+"   .. note:: the order of eulers must match or an exception is raised.\n";
+
 static PyObject *Euler_MakeCompatible(EulerObject * self, EulerObject *value)
 {
-#ifdef USE_MATHUTILS_DEG
-       float eul_from_rad[3];
-       int x;
-#endif
-       
        if(!EulerObject_Check(value)) {
-               PyErr_SetString(PyExc_TypeError, "euler.makeCompatible(euler):expected a single euler argument.");
+               PyErr_SetString(PyExc_TypeError, "euler.make_compatible(euler): expected a single euler argument.");
                return NULL;
        }
        
        if(!BaseMath_ReadCallback(self) || !BaseMath_ReadCallback(value))
                return NULL;
 
-#ifdef USE_MATHUTILS_DEG
-       //covert to radians
-       for(x = 0; x < 3; x++) {
-               self->eul[x] = self->eul[x] * ((float)Py_PI / 180);
-               eul_from_rad[x] = value->eul[x] * ((float)Py_PI / 180);
+       if(self->order != value->order) {
+               PyErr_SetString(PyExc_ValueError, "euler.make_compatible(euler): rotation orders don't match\n");
+               return NULL;
        }
-       compatible_eul(self->eul, eul_from_rad);
-#else
+
        compatible_eul(self->eul, value->eul);
-#endif
 
-#ifdef USE_MATHUTILS_DEG
-       //convert back from radians
-       for(x = 0; x < 3; x++) {
-               self->eul[x] *= (180 / (float)Py_PI);
-       }
-#endif
        BaseMath_WriteCallback(self);
        Py_INCREF(self);
        return (PyObject *)self;
@@ -317,12 +287,23 @@ static PyObject *Euler_MakeCompatible(EulerObject * self, EulerObject *value)
 
 //----------------------------Euler.rotate()-----------------------
 // return a copy of the euler
+
+static char Euler_copy_doc[] =
+".. function:: copy()\n"
+"\n"
+"   Returns a copy of this euler.\n"
+"\n"
+"   :return: A copy of the euler.\n"
+"   :rtype: :class:`Euler`\n"
+"\n"
+"   .. note:: use this to get a copy of a wrapped euler with no reference to the original data.\n";
+
 static PyObject *Euler_copy(EulerObject * self, PyObject *args)
 {
        if(!BaseMath_ReadCallback(self))
                return NULL;
 
-       return newEulerObject(self->eul, Py_NEW, Py_TYPE(self));
+       return newEulerObject(self->eul, self->order, Py_NEW, Py_TYPE(self));
 }
 
 //----------------------------print object (internal)--------------
@@ -370,12 +351,7 @@ static PyObject* Euler_richcmpr(PyObject *objectA, PyObject *objectB, int compar
                        result = EXPP_VectorsAreEqual(eulA->eul, eulB->eul, 3, 1);
                        break;
                case Py_NE:
-                       result = EXPP_VectorsAreEqual(eulA->eul, eulB->eul, 3, 1);
-                       if (result == 0){
-                               result = 1;
-                       }else{
-                               result = 0;
-                       }
+                       result = !EXPP_VectorsAreEqual(eulA->eul, eulB->eul, 3, 1);
                        break;
                default:
                        printf("The result of the comparison could not be evaluated");
@@ -521,7 +497,6 @@ static PySequenceMethods Euler_SeqMethods = {
 /*
  * vector axis, vector.x/y/z/w
  */
-       
 static PyObject *Euler_getAxis( EulerObject * self, void *type )
 {
        return Euler_item(self, GET_INT_FROM_POINTER(type));
@@ -532,20 +507,62 @@ static int Euler_setAxis( EulerObject * self, PyObject * value, void * type )
        return Euler_ass_item(self, GET_INT_FROM_POINTER(type), value);
 }
 
+/* rotation order */
+static PyObject *Euler_getOrder(EulerObject *self, void *type)
+{
+       static char order[][4] = {"XYZ", "XZY", "YXZ", "YZX", "ZXY", "ZYX"};
+       return PyUnicode_FromString(order[self->order]);
+}
+
+static int Euler_setOrder( EulerObject * self, PyObject * value, void * type )
+{
+       char *order_str= _PyUnicode_AsString(value);
+       short order= euler_order_from_string(order_str, "euler.order");
+
+       if(order < 0)
+               return -1;
+
+       if(self->cb_user) {
+               PyErr_SetString(PyExc_TypeError, "euler.order: assignment is not allowed on eulers with an owner");
+               return -1;
+       }
+
+       self->order= order;
+       return 0;
+}
+
 /*****************************************************************************/
 /* Python attributes get/set structure:                                      */
 /*****************************************************************************/
 static PyGetSetDef Euler_getseters[] = {
-       {"x", (getter)Euler_getAxis, (setter)Euler_setAxis, "Euler X axis", (void *)0},
-       {"y", (getter)Euler_getAxis, (setter)Euler_setAxis, "Euler Y axis", (void *)1},
-       {"z", (getter)Euler_getAxis, (setter)Euler_setAxis, "Euler Z axis", (void *)2},
+       {"x", (getter)Euler_getAxis, (setter)Euler_setAxis, "Euler X axis in radians. **type** float", (void *)0},
+       {"y", (getter)Euler_getAxis, (setter)Euler_setAxis, "Euler Y axis in radians. **type** float", (void *)1},
+       {"z", (getter)Euler_getAxis, (setter)Euler_setAxis, "Euler Z axis in radians. **type** float", (void *)2},
+       {"order", (getter)Euler_getOrder, (setter)Euler_setOrder, "Euler rotation order. **type** string in ['XYZ', 'XZY', 'YXZ', 'YZX', 'ZXY', 'ZYX']", (void *)NULL},
 
-       {"wrapped", (getter)BaseMathObject_getWrapped, (setter)NULL, "True when this wraps blenders internal data", NULL},
-       {"__owner__", (getter)BaseMathObject_getOwner, (setter)NULL, "Read only owner for vectors that depend on another object", NULL},
+       {"is_wrapped", (getter)BaseMathObject_getWrapped, (setter)NULL, BaseMathObject_Wrapped_doc, NULL},
+       {"_owner", (getter)BaseMathObject_getOwner, (setter)NULL, BaseMathObject_Owner_doc, NULL},
        {NULL,NULL,NULL,NULL,NULL}  /* Sentinel */
 };
 
+
+//-----------------------METHOD DEFINITIONS ----------------------
+static struct PyMethodDef Euler_methods[] = {
+       {"zero", (PyCFunction) Euler_Zero, METH_NOARGS, Euler_Zero_doc},
+       {"unique", (PyCFunction) Euler_Unique, METH_NOARGS, Euler_Unique_doc},
+       {"to_matrix", (PyCFunction) Euler_ToMatrix, METH_NOARGS, Euler_ToMatrix_doc},
+       {"to_quat", (PyCFunction) Euler_ToQuat, METH_NOARGS, Euler_ToQuat_doc},
+       {"rotate", (PyCFunction) Euler_Rotate, METH_VARARGS, NULL},
+       {"make_compatible", (PyCFunction) Euler_MakeCompatible, METH_O, Euler_MakeCompatible_doc},
+       {"__copy__", (PyCFunction) Euler_copy, METH_VARARGS, Euler_copy_doc},
+       {"copy", (PyCFunction) Euler_copy, METH_VARARGS, Euler_copy_doc},
+       {NULL, NULL, 0, NULL}
+};
+
 //------------------PY_OBECT DEFINITION--------------------------
+static char euler_doc[] =
+"This object gives access to Eulers in Blender.";
+
 PyTypeObject euler_Type = {
        PyVarObject_HEAD_INIT(NULL, 0)
        "euler",                                                //tp_name
@@ -567,7 +584,7 @@ PyTypeObject euler_Type = {
        0,                                                              //tp_setattro
        0,                                                              //tp_as_buffer
        Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, //tp_flags
-       0,                                                              //tp_doc
+       euler_doc, //tp_doc
        0,                                                              //tp_traverse
        0,                                                              //tp_clear
        (richcmpfunc)Euler_richcmpr,    //tp_richcompare
@@ -600,7 +617,7 @@ PyTypeObject euler_Type = {
  (i.e. it was allocated elsewhere by MEM_mallocN())
   pass Py_NEW - if vector is not a WRAPPER and managed by PYTHON
  (i.e. it must be created here with PyMEM_malloc())*/
-PyObject *newEulerObject(float *eul, int type, PyTypeObject *base_type)
+PyObject *newEulerObject(float *eul, short order, int type, PyTypeObject *base_type)
 {
        EulerObject *self;
        int x;
@@ -628,12 +645,14 @@ PyObject *newEulerObject(float *eul, int type, PyTypeObject *base_type)
        }else{ //bad type
                return NULL;
        }
+
+       self->order= order;
        return (PyObject *)self;
 }
 
-PyObject *newEulerObject_cb(PyObject *cb_user, int cb_type, int cb_subtype)
+PyObject *newEulerObject_cb(PyObject *cb_user, short order, int cb_type, int cb_subtype)
 {
-       EulerObject *self= (EulerObject *)newEulerObject(NULL, Py_NEW, NULL);
+       EulerObject *self= (EulerObject *)newEulerObject(NULL, order, Py_NEW, NULL);
        if(self) {
                Py_INCREF(cb_user);
                self->cb_user=                  cb_user;