PyAPI: add function to check any mathutils type
[blender.git] / source / blender / python / mathutils / mathutils_Vector.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): Willian P. Germano & Joseph Gilbert
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 /** \file blender/python/mathutils/mathutils_Vector.h
24  *  \ingroup pymathutils
25  */
26
27
28 #ifndef __MATHUTILS_VECTOR_H__
29 #define __MATHUTILS_VECTOR_H__
30
31 extern PyTypeObject vector_Type;
32
33 #define VectorObject_Check(v) PyObject_TypeCheck((v), &vector_Type)
34 #define VectorObject_CheckExact(v) (Py_TYPE(v) == &vector_Type)
35
36 typedef struct {
37         BASE_MATH_MEMBERS(vec);
38
39         int size;  /* vec size 2 or more */
40 } VectorObject;
41
42 /*prototypes*/
43 PyObject *Vector_CreatePyObject(
44         const float *vec, const int size,
45         PyTypeObject *base_type
46         ) ATTR_WARN_UNUSED_RESULT;
47 PyObject *Vector_CreatePyObject_wrap(
48         float *vec, const int size,
49         PyTypeObject *base_type
50         ) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);
51 PyObject *Vector_CreatePyObject_cb(
52         PyObject *user, int size,
53         unsigned char cb_type, unsigned char subtype
54         ) ATTR_WARN_UNUSED_RESULT;
55 PyObject *Vector_CreatePyObject_alloc(
56         float *vec, const int size,
57         PyTypeObject *base_type
58         ) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);
59
60 #endif  /* __MATHUTILS_VECTOR_H__ */