Merge branch 'master' into blender2.8
[blender.git] / source / blender / python / mathutils / mathutils_Euler.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
24 #ifndef __MATHUTILS_EULER_H__
25 #define __MATHUTILS_EULER_H__
26
27 /** \file blender/python/mathutils/mathutils_Euler.h
28  *  \ingroup pymathutils
29  */
30
31 extern PyTypeObject euler_Type;
32 #define EulerObject_Check(v) PyObject_TypeCheck((v), &euler_Type)
33 #define EulerObject_CheckExact(v) (Py_TYPE(v) == &euler_Type)
34
35 typedef struct {
36         BASE_MATH_MEMBERS(eul);
37         unsigned char order;            /* rotation order */
38
39 } EulerObject;
40
41 /* struct data contains a pointer to the actual data that the
42  * object uses. It can use either PyMem allocated data (which will
43  * be stored in py_data) or be a wrapper for data allocated through
44  * blender (stored in blend_data). This is an either/or struct not both */
45
46 /* prototypes */
47 PyObject *Euler_CreatePyObject(
48         const float eul[3], const short order,
49         PyTypeObject *base_type
50         ) ATTR_WARN_UNUSED_RESULT;
51 PyObject *Euler_CreatePyObject_wrap(
52         float eul[3], const short order,
53         PyTypeObject *base_type
54         ) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);
55 PyObject *Euler_CreatePyObject_cb(
56         PyObject *cb_user, const short order,
57         unsigned char cb_type, unsigned char cb_subtype
58         ) ATTR_WARN_UNUSED_RESULT;
59
60 short euler_order_from_string(const char *str, const char *error_prefix);
61
62
63 #endif /* __MATHUTILS_EULER_H__ */