Merge branch 'blender2.7'
[blender.git] / source / blender / python / mathutils / mathutils_Quaternion.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_QUATERNION_H__
24 #define __MATHUTILS_QUATERNION_H__
25
26 /** \file blender/python/mathutils/mathutils_Quaternion.h
27  *  \ingroup pymathutils
28  */
29
30 extern PyTypeObject quaternion_Type;
31
32 #define QuaternionObject_Check(v) PyObject_TypeCheck((v), &quaternion_Type)
33 #define QuaternionObject_CheckExact(v) (Py_TYPE(v) == &quaternion_Type)
34
35 typedef struct {
36         BASE_MATH_MEMBERS(quat);
37 } QuaternionObject;
38
39 /* struct data contains a pointer to the actual data that the
40  * object uses. It can use either PyMem allocated data (which will
41  * be stored in py_data) or be a wrapper for data allocated through
42  * blender (stored in blend_data). This is an either/or struct not both */
43
44 /* prototypes */
45 PyObject *Quaternion_CreatePyObject(
46         const float quat[4],
47         PyTypeObject *base_type
48         ) ATTR_WARN_UNUSED_RESULT;
49 PyObject *Quaternion_CreatePyObject_wrap(
50         float quat[4],
51         PyTypeObject *base_type
52         ) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);
53 PyObject *Quaternion_CreatePyObject_cb(
54         PyObject *cb_user,
55         unsigned char cb_type, unsigned char cb_subtype
56         ) ATTR_WARN_UNUSED_RESULT;
57
58 #endif /* __MATHUTILS_QUATERNION_H__ */