svn merge -r 21041:21301 https://svn.blender.org/svnroot/bf-blender/branches/blender2...
[blender.git] / source / blender / python / generic / Mathutils.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  * This is a new part of Blender.
24  *
25  * Contributor(s): Joseph Gilbert
26  *
27  * ***** END GPL LICENSE BLOCK *****
28 */
29 //Include this file for access to vector, quat, matrix, euler, etc...
30
31 #ifndef EXPP_Mathutils_H
32 #define EXPP_Mathutils_H
33
34 #include <Python.h>
35 #include "../intern/bpy_compat.h"
36 #include "vector.h"
37 #include "matrix.h"
38 #include "quat.h"
39 #include "euler.h"
40
41 /* #define USE_MATHUTILS_DEG - for backwards compat */
42
43 /* Can cast different mathutils types to this, use for generic funcs */
44
45 typedef struct {
46         PyObject_VAR_HEAD
47         float *data;                                    /*array of data (alias), wrapped status depends on wrapped status */
48         PyObject *cb_user;                                      /* if this vector references another object, otherwise NULL, *Note* this owns its reference */
49         unsigned char cb_type;  /* which user funcs do we adhere to, RNA, GameObject, etc */
50         unsigned char cb_subtype;               /* subtype: location, rotation... to avoid defining many new functions for every attribute of the same type */
51         unsigned char wrapped;          /* wrapped data type? */
52 } BaseMathObject;
53
54 PyObject *BaseMathObject_getOwner( BaseMathObject * self, void * );
55 PyObject *BaseMathObject_getWrapped( BaseMathObject *self, void * );
56 void BaseMathObject_dealloc(BaseMathObject * self);
57
58
59
60
61 PyObject *Mathutils_Init( const char * from );
62
63 PyObject *quat_rotation(PyObject *arg1, PyObject *arg2);
64
65 int EXPP_FloatsAreEqual(float A, float B, int floatSteps);
66 int EXPP_VectorsAreEqual(float *vecA, float *vecB, int size, int floatSteps);
67
68
69 #define Py_PI  3.14159265358979323846
70
71 #define Py_NEW  1
72 #define Py_WRAP 2
73
74
75 /* Mathutils is used by the BGE and Blender so have to define 
76  * some things here for luddite mac users of py2.3 */
77 #ifndef Py_RETURN_NONE
78 #define Py_RETURN_NONE  return Py_INCREF(Py_None), Py_None
79 #endif
80 #ifndef Py_RETURN_FALSE
81 #define Py_RETURN_FALSE  return Py_INCREF(Py_False), Py_False
82 #endif
83 #ifndef Py_RETURN_TRUE
84 #define Py_RETURN_TRUE  return Py_INCREF(Py_True), Py_True
85 #endif
86
87 typedef struct Mathutils_Callback Mathutils_Callback;
88 struct Mathutils_Callback {
89         int             (*check)(PyObject *user);                                       /* checks the user is still valid */
90         int             (*get)(PyObject *user, int subtype, float *from);       /* gets the vector from the user */
91         int             (*set)(PyObject *user, int subtype, float *to); /* sets the users vector values once the vector is modified */
92         int             (*get_index)(PyObject *user, int subtype, float *from,int index);       /* same as above but only for an index */
93         int             (*set_index)(PyObject *user, int subtype, float *to,    int index);     /* same as above but only for an index */
94 };
95
96 int Mathutils_RegisterCallback(Mathutils_Callback *cb);
97
98 int _BaseMathObject_ReadCallback(BaseMathObject *self);
99 int _BaseMathObject_WriteCallback(BaseMathObject *self);
100 int _BaseMathObject_ReadIndexCallback(BaseMathObject *self, int index);
101 int _BaseMathObject_WriteIndexCallback(BaseMathObject *self, int index);
102
103 /* since this is called so often avoid where possible */
104 #define BaseMath_ReadCallback(_self) (((_self)->cb_user ?       _BaseMathObject_ReadCallback((BaseMathObject *)_self):1))
105 #define BaseMath_WriteCallback(_self) (((_self)->cb_user ?_BaseMathObject_WriteCallback((BaseMathObject *)_self):1))
106 #define BaseMath_ReadIndexCallback(_self, _index) (((_self)->cb_user ?  _BaseMathObject_ReadIndexCallback((BaseMathObject *)_self, _index):1))
107 #define BaseMath_WriteIndexCallback(_self, _index) (((_self)->cb_user ? _BaseMathObject_WriteIndexCallback((BaseMathObject *)_self, _index):1))
108
109 #endif                          /* EXPP_Mathutils_H */