Module GameTypes :: Class KX_MeshProxy
[frames] | no frames]

Class KX_MeshProxy

PyObjectPlus --+        
               |        
          CValue --+    
                   |    
         SCA_IObject --+
                       |
                      KX_MeshProxy

A mesh object.

You can only change the vertex properties of a mesh object, not the mesh topology.

To use mesh objects effectively, you should know a bit about how the game engine handles them.

  1. Mesh Objects are converted from Blender at scene load.
  2. The Converter groups polygons by Material. This means they can be sent to the renderer efficiently. A material holds:
    1. The texture.
    2. The Blender material.
    3. The Tile properties
    4. The face properties - (From the "Texture Face" panel)
    5. Transparency & z sorting
    6. Light layer
    7. Polygon shape (triangle/quad)
    8. Game Object
  3. Verticies will be split by face if necessary. Verticies can only be shared between faces if:
    1. They are at the same position
    2. UV coordinates are the same
    3. Their normals are the same (both polygons are "Set Smooth")
    4. They are the same colour

    For example: a cube has 24 verticies: 6 faces with 4 verticies per face.

The correct method of iterating over every KX_VertexProxy in a game object:

       import GameLogic
       
       co = GameLogic.getCurrentController()
       obj = co.owner
       
       m_i = 0
       mesh = obj.getMesh(m_i) # There can be more than one mesh...
       while mesh != None:
               for mat in range(mesh.getNumMaterials()):
                       for v_index in range(mesh.getVertexArrayLength(mat)):
                               vertex = mesh.getVertex(mat, v_index)
                               # Do something with vertex here...
                               # ... eg: colour the vertex red.
                               vertex.colour = [1.0, 0.0, 0.0, 1.0]
               m_i += 1
               mesh = obj.getMesh(m_i)
Instance Methods
integer
getNumMaterials()
Gets the number of materials associated with this object.
string
getMaterialName(matid)
Gets the name of the specified material.
string
getTextureName(matid)
Gets the name of the specified material's texture.
integer
getVertexArrayLength(matid)
Gets the length of the vertex array associated with the specified material.
KX_VertexProxy
getVertex(matid, index)
Gets the specified vertex from the mesh object.
integer
getNumPolygons()
Returns the number of polygon in the mesh.
KX_PolyProxy
getPolygon(index)
Gets the specified polygon from the mesh.
bool
isA(game_type)
Check if this is a type or a subtype game_type. (Inherited from GameTypes.PyObjectPlus)
    Deprecated
string
getName()
Returns the name of the CValue. (Inherited from GameTypes.CValue)
Instance Variables
bool invalid
Test if the object has been freed by the game engine and is no longer valid. (Inherited from GameTypes.PyObjectPlus)
list of KX_BlenderMaterial or KX_PolygonMaterial types materials
string name
The name of this CValue derived object (read-only). (Inherited from GameTypes.CValue)
integer numMaterials
integer numPolygons
Method Details

getMaterialName(matid)

 

Gets the name of the specified material.

Parameters:
  • matid (integer) - the specified material.
Returns: string
the attached material name.

getTextureName(matid)

 

Gets the name of the specified material's texture.

Parameters:
  • matid (integer) - the specified material
Returns: string
the attached material's texture name.

getVertexArrayLength(matid)

 

Gets the length of the vertex array associated with the specified material.

There is one vertex array for each material.

Parameters:
  • matid (integer) - the specified material
Returns: integer
the number of verticies in the vertex array.

getVertex(matid, index)

 

Gets the specified vertex from the mesh object.

Parameters:
  • matid (integer) - the specified material
  • index (integer) - the index into the vertex array.
Returns: KX_VertexProxy
a vertex object.

getPolygon(index)

 

Gets the specified polygon from the mesh.

Parameters:
  • index (integer) - polygon number
Returns: KX_PolyProxy
a polygon object.