merge with trunk r38787
[blender.git] / source / blender / python / mathutils / mathutils.h
1 /* 
2  * $Id: mathutils.h 38674 2011-07-25 01:44:19Z campbellbarton $
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  * This is a new part of Blender.
24  *
25  * Contributor(s): Joseph Gilbert
26  *
27  * ***** END GPL LICENSE BLOCK *****
28 */
29
30 /** \file blender/python/generic/mathutils.h
31  *  \ingroup pygen
32  */
33
34 //Include this file for access to vector, quat, matrix, euler, etc...
35
36 #ifndef MATHUTILS_H
37 #define MATHUTILS_H
38
39 /* Can cast different mathutils types to this, use for generic funcs */
40
41 extern char BaseMathObject_Wrapped_doc[];
42 extern char BaseMathObject_Owner_doc[];
43
44 #define BASE_MATH_MEMBERS(_data) \
45         PyObject_VAR_HEAD \
46         float *_data;                           /* array of data (alias), wrapped status depends on wrapped status */ \
47         PyObject *cb_user;                      /* if this vector references another object, otherwise NULL, *Note* this owns its reference */ \
48         unsigned char cb_type;          /* which user funcs do we adhere to, RNA, GameObject, etc */ \
49         unsigned char cb_subtype;       /* subtype: location, rotation... to avoid defining many new functions for every attribute of the same type */ \
50         unsigned char wrapped;          /* wrapped data type? */ \
51
52 typedef struct {
53         BASE_MATH_MEMBERS(data)
54 } BaseMathObject;
55
56 #include "mathutils_Vector.h"
57 #include "mathutils_Matrix.h"
58 #include "mathutils_Quaternion.h"
59 #include "mathutils_Euler.h"
60 #include "mathutils_Color.h"
61 #include "mathutils_geometry.h"
62
63 PyObject *BaseMathObject_getOwner( BaseMathObject * self, void * );
64 PyObject *BaseMathObject_getWrapped( BaseMathObject *self, void * );
65
66 int BaseMathObject_traverse(BaseMathObject *self, visitproc visit, void *arg);
67 int BaseMathObject_clear(BaseMathObject *self);
68 void BaseMathObject_dealloc(BaseMathObject * self);
69
70 PyMODINIT_FUNC PyInit_mathutils(void);
71
72 int EXPP_FloatsAreEqual(float A, float B, int floatSteps);
73 int EXPP_VectorsAreEqual(float *vecA, float *vecB, int size, int floatSteps);
74
75 #define Py_NEW  1
76 #define Py_WRAP 2
77
78 typedef struct Mathutils_Callback Mathutils_Callback;
79
80 typedef int (*BaseMathCheckFunc)(BaseMathObject *);                                                     /* checks the user is still valid */
81 typedef int (*BaseMathGetFunc)(BaseMathObject *, int);                          /* gets the vector from the user */
82 typedef int (*BaseMathSetFunc)(BaseMathObject *, int);                          /* sets the users vector values once the vector is modified */
83 typedef int (*BaseMathGetIndexFunc)(BaseMathObject *, int, int);        /* same as above but only for an index */
84 typedef int (*BaseMathSetIndexFunc)(BaseMathObject *, int, int);        /* same as above but only for an index */
85
86 struct Mathutils_Callback {
87         BaseMathCheckFunc               check;
88         BaseMathGetFunc                 get;
89         BaseMathSetFunc                 set;
90         BaseMathGetIndexFunc    get_index;
91         BaseMathSetIndexFunc    set_index;
92 };
93
94 int Mathutils_RegisterCallback(Mathutils_Callback *cb);
95
96 int _BaseMathObject_ReadCallback(BaseMathObject *self);
97 int _BaseMathObject_WriteCallback(BaseMathObject *self);
98 int _BaseMathObject_ReadIndexCallback(BaseMathObject *self, int index);
99 int _BaseMathObject_WriteIndexCallback(BaseMathObject *self, int index);
100
101 /* since this is called so often avoid where possible */
102 #define BaseMath_ReadCallback(_self) (((_self)->cb_user ?       _BaseMathObject_ReadCallback((BaseMathObject *)_self):0))
103 #define BaseMath_WriteCallback(_self) (((_self)->cb_user ?_BaseMathObject_WriteCallback((BaseMathObject *)_self):0))
104 #define BaseMath_ReadIndexCallback(_self, _index) (((_self)->cb_user ?  _BaseMathObject_ReadIndexCallback((BaseMathObject *)_self, _index):0))
105 #define BaseMath_WriteIndexCallback(_self, _index) (((_self)->cb_user ? _BaseMathObject_WriteIndexCallback((BaseMathObject *)_self, _index):0))
106
107 /* utility func */
108 int mathutils_array_parse(float *array, int array_min, int array_max, PyObject *value, const char *error_prefix);
109 int mathutils_any_to_rotmat(float rmat[3][3], PyObject *value, const char *error_prefix);
110
111 int column_vector_multiplication(float rvec[4], VectorObject *vec, MatrixObject *mat);
112
113 #endif /* MATHUTILS_H */