doxygen: prevent GPL license block from being parsed as doxygen comment.
[blender.git] / source / gameengine / Ketsji / KX_MeshProxy.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_MeshProxy.h
31  *  \ingroup ketsji
32  */
33
34 #ifndef __KX_MESHPROXY
35 #define __KX_MESHPROXY
36
37 #ifdef WITH_PYTHON
38
39 #include "SCA_IObject.h"
40
41 /* utility conversion function */
42 bool ConvertPythonToMesh(PyObject * value, class RAS_MeshObject **object, bool py_none_ok, const char *error_prefix);
43
44 class KX_MeshProxy      : public CValue
45 {
46         Py_Header;
47
48         class RAS_MeshObject*   m_meshobj;
49 public:
50         KX_MeshProxy(class RAS_MeshObject* mesh);
51         virtual ~KX_MeshProxy();
52
53         void SetMeshModified(bool v);
54
55         // stuff for cvalue related things
56         virtual CValue*         Calc(VALUE_OPERATOR op, CValue *val) ;
57         virtual CValue*         CalcFinal(VALUE_DATA_TYPE dtype, VALUE_OPERATOR op, CValue *val);
58         virtual const STR_String &      GetText();
59         virtual double          GetNumber();
60         virtual RAS_MeshObject* GetMesh() { return m_meshobj; }
61         virtual STR_String&     GetName();
62         virtual void            SetName(const char *name);                                                              // Set the name of the value
63         virtual CValue*         GetReplica();
64
65 // stuff for python integration
66
67         KX_PYMETHOD(KX_MeshProxy,GetNumMaterials);      // Deprecated
68         KX_PYMETHOD(KX_MeshProxy,GetMaterialName);
69         KX_PYMETHOD(KX_MeshProxy,GetTextureName);
70         KX_PYMETHOD_NOARGS(KX_MeshProxy,GetNumPolygons); // Deprecated
71         
72         // both take materialid (int)
73         KX_PYMETHOD(KX_MeshProxy,GetVertexArrayLength);
74         KX_PYMETHOD(KX_MeshProxy,GetVertex);
75         KX_PYMETHOD(KX_MeshProxy,GetPolygon);
76         
77         static PyObject*        pyattr_get_materials(void* self_v, const KX_PYATTRIBUTE_DEF *attrdef);
78         static PyObject * pyattr_get_numMaterials(void * self, const KX_PYATTRIBUTE_DEF * attrdef);
79         static PyObject * pyattr_get_numPolygons(void * self, const KX_PYATTRIBUTE_DEF * attrdef);
80 };
81
82 #endif // WITH_PYTHON
83
84 #endif //__KX_MESHPROXY
85