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