copy of docs from 2.4x for python modules that have been kept
[blender.git] / source / blender / python / generic / vector.h
1 /* $Id$
2  *
3  * ***** BEGIN GPL LICENSE BLOCK *****
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License
7  * as published by the Free Software Foundation; either version 2
8  * of the License, or (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software Foundation,
17  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
18  *
19  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
20  * All rights reserved.
21  *
22  * The Original Code is: all of this file.
23  *
24  * Contributor(s): Willian P. Germano & Joseph Gilbert
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  *
28  */
29
30 #ifndef EXPP_vector_h
31 #define EXPP_vector_h
32
33 #include <Python.h>
34
35 extern PyTypeObject vector_Type;
36 #define VectorObject_Check(_v) PyObject_TypeCheck((_v), &vector_Type)
37
38 typedef struct { /* keep aligned with BaseMathObject in Mathutils.h */
39         PyObject_VAR_HEAD 
40         float *vec;                                     /*1D array of data (alias), wrapped status depends on wrapped status */
41         PyObject *cb_user;                                      /* if this vector references another object, otherwise NULL, *Note* this owns its reference */
42         unsigned char cb_type;  /* which user funcs do we adhere to, RNA, GameObject, etc */
43         unsigned char cb_subtype;               /* subtype: location, rotation... to avoid defining many new functions for every attribute of the same type */
44         unsigned char wrapped;          /* wrapped data type? */
45         /* end BaseMathObject */
46
47         unsigned char size;                     /* vec size 2,3 or 4 */
48 } VectorObject;
49
50 /*prototypes*/
51 PyObject *newVectorObject(float *vec, int size, int type, PyTypeObject *base_type);
52 PyObject *newVectorObject_cb(PyObject *user, int size, int callback_type, int subtype);
53
54 #endif                          /* EXPP_vector_h */