doxygen: prevent GPL license block from being parsed as doxygen comment.
[blender.git] / source / gameengine / Ketsji / KX_PolyProxy.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): none yet.
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29
30 /** \file KX_PolyProxy.h
31  *  \ingroup ketsji
32  */
33
34 #ifndef __KX_POLYROXY
35 #define __KX_POLYPROXY
36
37 #ifdef WITH_PYTHON
38
39 #include "SCA_IObject.h"
40
41 class KX_PolyProxy      : public CValue
42 {
43         Py_Header;
44 protected:
45         class RAS_Polygon*              m_polygon;
46         class RAS_MeshObject*   m_mesh;
47 public:
48         KX_PolyProxy(const class RAS_MeshObject*mesh, class RAS_Polygon* polygon);
49         virtual ~KX_PolyProxy();
50
51         // stuff for cvalue related things
52         CValue*         Calc(VALUE_OPERATOR op, CValue *val) ;
53         CValue*         CalcFinal(VALUE_DATA_TYPE dtype, VALUE_OPERATOR op, CValue *val);
54         const STR_String &      GetText();
55         double          GetNumber();
56         STR_String&     GetName();
57         void            SetName(const char *name);                                                              // Set the name of the value
58         CValue*         GetReplica();
59
60
61 // stuff for python integration
62         static PyObject* pyattr_get_material_name(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef);
63         static PyObject* pyattr_get_texture_name(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef);
64         static PyObject* pyattr_get_material(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef);
65         static PyObject* pyattr_get_material_id(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef);
66         static PyObject* pyattr_get_v1(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef);
67         static PyObject* pyattr_get_v2(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef);
68         static PyObject* pyattr_get_v3(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef);
69         static PyObject* pyattr_get_v4(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef);
70         static PyObject* pyattr_get_visible(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef);
71         static PyObject* pyattr_get_collide(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef);
72
73         KX_PYMETHOD_DOC_NOARGS(KX_PolyProxy,getMaterialIndex)
74         KX_PYMETHOD_DOC_NOARGS(KX_PolyProxy,getNumVertex)
75         KX_PYMETHOD_DOC_NOARGS(KX_PolyProxy,isVisible)
76         KX_PYMETHOD_DOC_NOARGS(KX_PolyProxy,isCollider)
77         KX_PYMETHOD_DOC_NOARGS(KX_PolyProxy,getMaterialName)
78         KX_PYMETHOD_DOC_NOARGS(KX_PolyProxy,getTextureName)
79         KX_PYMETHOD_DOC(KX_PolyProxy,getVertexIndex)
80         KX_PYMETHOD_DOC_NOARGS(KX_PolyProxy,getMesh)
81         KX_PYMETHOD_DOC_NOARGS(KX_PolyProxy,getMaterial)
82
83 };
84
85 #endif // WITH_PYTHON
86
87 #endif //__KX_POLYPROXY
88