Use epydoc for generating game python reference (like the bpython guys)
[blender.git] / source / gameengine / PyDoc / KX_MeshProxy.py
1 # $Id$
2 # Documentation for KX_MeshProxy
3
4 class KX_MeshProxy:
5         """
6         A mesh object.
7         
8         You can only change the vertex properties of a mesh object, not the mesh topology.
9         """
10         
11         def GetNumMaterials():
12                 """
13                 Gets the number of materials associated with this object.
14                 
15                 @rtype: integer
16                 """
17         
18         def GetMaterialName(matid):
19                 """
20                 Gets the name of the specified material.
21                 
22                 @type matid: integer
23                 @param matid: the specified material.
24                 @rtype: string
25                 @return: the attached material name.
26                 """
27         def GetTextureName(matid):
28                 """
29                 Gets the name of the specified material's texture.
30                 
31                 @type matid: integer
32                 @param matid: the specified material
33                 @rtype: string
34                 @return: the attached material's texture name.
35                 """
36         def GetVertexArrayLength(matid):
37                 """
38                 Gets the length of the vertex array associated with the specified material.
39                 
40                 There is one vertex array for each material.
41                 
42                 @type matid: integer
43                 @param matid: the specified material
44                 @rtype: integer
45                 @return: the number of verticies in the vertex array.
46                 """
47         def GetVertex(matid, index):
48                 """
49                 Gets the specified vertex from the mesh object.
50                 
51                 @type matid: integer
52                 @param matid: the specified material
53                 @type index: integer
54                 @param index: the index into the vertex array.
55                 @rtype: KX_VertexProxy
56                 @return: a vertex object.
57                 """
58