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