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