doxygen: prevent GPL license block from being parsed as doxygen comment.
[blender.git] / source / gameengine / Ketsji / KX_VertexProxy.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_VertexProxy.h
31  *  \ingroup ketsji
32  */
33
34 #ifndef __KX_VERTEXPROXY
35 #define __KX_VERTEXPROXY
36
37 #ifdef WITH_PYTHON
38
39 #include "SCA_IObject.h"
40
41 class KX_VertexProxy    : public CValue
42 {
43         Py_Header;
44 protected:
45
46         class RAS_TexVert*      m_vertex;
47         class KX_MeshProxy*     m_mesh;
48 public:
49         KX_VertexProxy(class KX_MeshProxy*mesh, class RAS_TexVert* vertex);
50         virtual ~KX_VertexProxy();
51
52         // stuff for cvalue related things
53         CValue*         Calc(VALUE_OPERATOR op, CValue *val) ;
54         CValue*         CalcFinal(VALUE_DATA_TYPE dtype, VALUE_OPERATOR op, CValue *val);
55         const STR_String &      GetText();
56         double          GetNumber();
57         STR_String&     GetName();
58         void            SetName(const char *name);                                                              // Set the name of the value
59         CValue*         GetReplica();
60
61
62 // stuff for python integration
63
64         static PyObject* pyattr_get_x(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef);
65         static PyObject* pyattr_get_y(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef);
66         static PyObject* pyattr_get_z(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef);
67         static PyObject* pyattr_get_r(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef);
68         static PyObject* pyattr_get_g(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef);
69         static PyObject* pyattr_get_b(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef);
70         static PyObject* pyattr_get_a(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef);
71         static PyObject* pyattr_get_u(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef);
72         static PyObject* pyattr_get_v(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef);
73         static PyObject* pyattr_get_u2(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef);
74         static PyObject* pyattr_get_v2(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef);
75         static PyObject* pyattr_get_XYZ(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef);
76         static PyObject* pyattr_get_UV(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef);
77         static PyObject* pyattr_get_color(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef);
78         static PyObject* pyattr_get_normal(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef);
79         static int pyattr_set_x(void *self, const struct KX_PYATTRIBUTE_DEF *attrdef, PyObject *value);
80         static int pyattr_set_y(void *self, const struct KX_PYATTRIBUTE_DEF *attrdef, PyObject *value);
81         static int pyattr_set_z(void *self, const struct KX_PYATTRIBUTE_DEF *attrdef, PyObject *value);
82         static int pyattr_set_u(void *self, const struct KX_PYATTRIBUTE_DEF *attrdef, PyObject *value);
83         static int pyattr_set_v(void *self, const struct KX_PYATTRIBUTE_DEF *attrdef, PyObject *value);
84         static int pyattr_set_u2(void *self, const struct KX_PYATTRIBUTE_DEF *attrdef, PyObject *value);
85         static int pyattr_set_v2(void *self, const struct KX_PYATTRIBUTE_DEF *attrdef, PyObject *value);
86         static int pyattr_set_r(void *self, const struct KX_PYATTRIBUTE_DEF *attrdef, PyObject *value);
87         static int pyattr_set_g(void *self, const struct KX_PYATTRIBUTE_DEF *attrdef, PyObject *value);
88         static int pyattr_set_b(void *self, const struct KX_PYATTRIBUTE_DEF *attrdef, PyObject *value);
89         static int pyattr_set_a(void *self, const struct KX_PYATTRIBUTE_DEF *attrdef, PyObject *value);
90         static int pyattr_set_XYZ(void *self, const struct KX_PYATTRIBUTE_DEF *attrdef, PyObject *value);
91         static int pyattr_set_UV(void *self, const struct KX_PYATTRIBUTE_DEF *attrdef, PyObject *value);
92         static int pyattr_set_color(void *self, const struct KX_PYATTRIBUTE_DEF *attrdef, PyObject *value);
93         static int pyattr_set_normal(void *self, const struct KX_PYATTRIBUTE_DEF *attrdef, PyObject *value);
94
95         KX_PYMETHOD_NOARGS(KX_VertexProxy,GetXYZ);
96         KX_PYMETHOD_O(KX_VertexProxy,SetXYZ);
97         KX_PYMETHOD_NOARGS(KX_VertexProxy,GetUV);
98         KX_PYMETHOD_O(KX_VertexProxy,SetUV);
99         
100         KX_PYMETHOD_NOARGS(KX_VertexProxy,GetUV2);
101         KX_PYMETHOD_VARARGS(KX_VertexProxy,SetUV2);
102
103         KX_PYMETHOD_NOARGS(KX_VertexProxy,GetRGBA);
104         KX_PYMETHOD_O(KX_VertexProxy,SetRGBA);
105         KX_PYMETHOD_NOARGS(KX_VertexProxy,GetNormal);
106         KX_PYMETHOD_O(KX_VertexProxy,SetNormal);
107
108 };
109
110 #endif // WITH_PYTHON
111
112 #endif //__KX_VERTEXPROXY
113