RNA: sync API changes from 2.8
[blender.git] / source / blender / python / mathutils / mathutils.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * Contributor(s): Joseph Gilbert
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 #ifndef __MATHUTILS_H__
24 #define __MATHUTILS_H__
25
26 /** \file blender/python/mathutils/mathutils.h
27  *  \ingroup pymathutils
28  */
29
30 /* Can cast different mathutils types to this, use for generic funcs */
31
32 #include "BLI_compiler_attrs.h"
33
34 struct DynStr;
35
36 extern char BaseMathObject_is_wrapped_doc[];
37 extern char BaseMathObject_is_frozen_doc[];
38 extern char BaseMathObject_owner_doc[];
39
40 #define BASE_MATH_NEW(struct_name, root_type, base_type) \
41         (struct_name *)((base_type ? (base_type)->tp_alloc(base_type, 0) : _PyObject_GC_New(&(root_type))));
42
43
44 /** BaseMathObject.flag */
45 enum {
46         /**
47          * Do not own the memory used in this vector,
48          * \note This is error prone if the memory may be freed while this vector is in use.
49          * Prefer using callbacks where possible, see: #Mathutils_RegisterCallback
50          */
51         BASE_MATH_FLAG_IS_WRAP    = (1 << 0),
52         /**
53          * Prevent changes to the vector so it can be used as a set or dictionary key for example.
54          * (typical use cases for tuple).
55          */
56         BASE_MATH_FLAG_IS_FROZEN  = (1 << 1),
57 };
58 #define BASE_MATH_FLAG_DEFAULT 0
59
60 #define BASE_MATH_MEMBERS(_data)                                                                                 \
61         PyObject_VAR_HEAD                                                                                            \
62         float *_data;               /* array of data (alias), wrapped status depends on wrapped status */            \
63         PyObject *cb_user;          /* if this vector references another object, otherwise NULL,                     \
64                                      * *Note* this owns its reference */                                             \
65         unsigned char cb_type;      /* which user funcs do we adhere to, RNA, GameObject, etc */                     \
66         unsigned char cb_subtype;   /* subtype: location, rotation...                                                \
67                                      * to avoid defining many new functions for every attribute of the same type */  \
68         unsigned char flag          /* wrapped data type? */                                                         \
69
70 typedef struct {
71         BASE_MATH_MEMBERS(data);
72 } BaseMathObject;
73
74 /* types */
75 #include "mathutils_Vector.h"
76 #include "mathutils_Matrix.h"
77 #include "mathutils_Quaternion.h"
78 #include "mathutils_Euler.h"
79 #include "mathutils_Color.h"
80
81 PyObject *BaseMathObject_owner_get(BaseMathObject *self, void *);
82 PyObject *BaseMathObject_is_wrapped_get(BaseMathObject *self, void *);
83 PyObject *BaseMathObject_is_frozen_get(BaseMathObject *self, void *);
84
85 extern char BaseMathObject_freeze_doc[];
86 PyObject *BaseMathObject_freeze(BaseMathObject *self);
87
88 int BaseMathObject_traverse(BaseMathObject *self, visitproc visit, void *arg);
89 int BaseMathObject_clear(BaseMathObject *self);
90 void BaseMathObject_dealloc(BaseMathObject *self);
91
92 PyMODINIT_FUNC PyInit_mathutils(void);
93
94 int EXPP_FloatsAreEqual(float A, float B, int floatSteps);
95 int EXPP_VectorsAreEqual(const float *vecA, const float *vecB, int size, int floatSteps);
96
97 typedef struct Mathutils_Callback Mathutils_Callback;
98
99 typedef int (*BaseMathCheckFunc)(BaseMathObject *);               /* checks the user is still valid */
100 typedef int (*BaseMathGetFunc)(BaseMathObject *, int);            /* gets the vector from the user */
101 typedef int (*BaseMathSetFunc)(BaseMathObject *, int);            /* sets the users vector values once its modified */
102 typedef int (*BaseMathGetIndexFunc)(BaseMathObject *, int, int);  /* same as above but only for an index */
103 typedef int (*BaseMathSetIndexFunc)(BaseMathObject *, int, int);  /* same as above but only for an index */
104
105 struct Mathutils_Callback {
106         BaseMathCheckFunc               check;
107         BaseMathGetFunc                 get;
108         BaseMathSetFunc                 set;
109         BaseMathGetIndexFunc    get_index;
110         BaseMathSetIndexFunc    set_index;
111 };
112
113 unsigned char Mathutils_RegisterCallback(Mathutils_Callback *cb);
114
115 int _BaseMathObject_ReadCallback(BaseMathObject *self);
116 int _BaseMathObject_WriteCallback(BaseMathObject *self);
117 int _BaseMathObject_ReadIndexCallback(BaseMathObject *self, int index);
118 int _BaseMathObject_WriteIndexCallback(BaseMathObject *self, int index);
119
120 void _BaseMathObject_RaiseFrozenExc(const BaseMathObject *self);
121 void _BaseMathObject_RaiseNotFrozenExc(const BaseMathObject *self);
122
123 /* since this is called so often avoid where possible */
124 #define BaseMath_ReadCallback(_self) \
125         (((_self)->cb_user ?    _BaseMathObject_ReadCallback((BaseMathObject *)_self) : 0))
126 #define BaseMath_WriteCallback(_self) \
127         (((_self)->cb_user ?_BaseMathObject_WriteCallback((BaseMathObject *)_self) : 0))
128 #define BaseMath_ReadIndexCallback(_self, _index) \
129         (((_self)->cb_user ?    _BaseMathObject_ReadIndexCallback((BaseMathObject *)_self, _index) : 0))
130 #define BaseMath_WriteIndexCallback(_self, _index) \
131         (((_self)->cb_user ?    _BaseMathObject_WriteIndexCallback((BaseMathObject *)_self, _index) : 0))
132
133 /* support BASE_MATH_FLAG_IS_FROZEN */
134 #define BaseMath_ReadCallback_ForWrite(_self) \
135         (UNLIKELY((_self)->flag & BASE_MATH_FLAG_IS_FROZEN) ? \
136         (_BaseMathObject_RaiseFrozenExc((BaseMathObject *)_self), -1) : (BaseMath_ReadCallback(_self)))
137
138 #define BaseMath_ReadIndexCallback_ForWrite(_self, _index) \
139         (UNLIKELY((_self)->flag & BASE_MATH_FLAG_IS_FROZEN) ? \
140         (_BaseMathObject_RaiseFrozenExc((BaseMathObject *)_self), -1) : (BaseMath_ReadIndexCallback(_self, _index)))
141
142 #define BaseMath_Prepare_ForWrite(_self) \
143         (UNLIKELY((_self)->flag & BASE_MATH_FLAG_IS_FROZEN) ? \
144         (_BaseMathObject_RaiseFrozenExc((BaseMathObject *)_self), -1) : 0)
145
146 #define BaseMathObject_Prepare_ForHash(_self) \
147         (UNLIKELY(((_self)->flag & BASE_MATH_FLAG_IS_FROZEN) == 0) ? \
148          (_BaseMathObject_RaiseNotFrozenExc((BaseMathObject *)_self), -1) : 0)
149
150 /* utility func */
151 int mathutils_array_parse(float *array, int array_min, int array_max, PyObject *value, const char *error_prefix);
152 int mathutils_array_parse_alloc(float **array, int array_min, PyObject *value, const char *error_prefix);
153 int mathutils_array_parse_alloc_v(float **array, int array_dim, PyObject *value, const char *error_prefix);
154 int mathutils_any_to_rotmat(float rmat[3][3], PyObject *value, const char *error_prefix);
155
156 Py_hash_t mathutils_array_hash(const float *float_array, size_t array_len);
157
158 /* zero remaining unused elements of the array */
159 #define MU_ARRAY_ZERO      (1u << 30)
160 /* ignore larger py sequences than requested (just use first elements),
161  * handy when using 3d vectors as 2d */
162 #define MU_ARRAY_SPILL     (1u << 31)
163
164 #define MU_ARRAY_FLAGS (MU_ARRAY_ZERO | MU_ARRAY_SPILL)
165
166 int column_vector_multiplication(float rvec[4], VectorObject *vec, MatrixObject *mat);
167
168 #ifndef MATH_STANDALONE
169 /* dynstr as python string utility funcions */
170 PyObject *mathutils_dynstr_to_py(struct DynStr *ds);
171 #endif
172
173 int mathutils_deepcopy_args_check(PyObject *args);
174
175 #endif /* __MATHUTILS_H__ */