doxygen: prevent GPL license block from being parsed as doxygen comment.
[blender.git] / source / gameengine / Ketsji / KX_PythonSeq.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): Campbell Barton
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29
30 /** \file KX_PythonSeq.h
31  *  \ingroup ketsji
32  *  \brief Readonly sequence wrapper for lookups on logic bricks
33  */
34  
35 #ifndef _adr_py_seq_h_                          // only process once,
36 #define _adr_py_seq_h_                          // even if multiply included
37
38 #ifdef WITH_PYTHON
39
40 #include "PyObjectPlus.h"
41
42 // -------------------------
43 enum KX_PYGENSEQ_TYPE {
44         KX_PYGENSEQ_CONT_TYPE_SENSORS,
45         KX_PYGENSEQ_CONT_TYPE_ACTUATORS,
46         KX_PYGENSEQ_OB_TYPE_SENSORS,
47         KX_PYGENSEQ_OB_TYPE_CONTROLLERS,
48         KX_PYGENSEQ_OB_TYPE_ACTUATORS,
49         KX_PYGENSEQ_OB_TYPE_CONSTRAINTS,
50         KX_PYGENSEQ_OB_TYPE_CHANNELS,
51 };
52
53 /* The Main PyType Object defined in Main.c */
54 extern PyTypeObject KX_PythonSeq_Type;
55
56 #define BPy_KX_PythonSeq_Check(v) \
57     ((v)->ob_type == &KX_PythonSeq_Type)
58
59 typedef struct {
60         PyObject_VAR_HEAD
61         PyObject *base;
62         short type;
63         short iter;
64 } KX_PythonSeq;
65
66 PyObject *KX_PythonSeq_CreatePyObject(PyObject *base, short type);
67
68 #endif // WITH_PYTHON
69
70 #endif // _adr_py_seq_h_