diff options
Diffstat (limited to 'doc/python_api/rst/bge_types/bge.types.KX_PolyProxy.rst')
| -rw-r--r-- | doc/python_api/rst/bge_types/bge.types.KX_PolyProxy.rst | 136 |
1 files changed, 0 insertions, 136 deletions
diff --git a/doc/python_api/rst/bge_types/bge.types.KX_PolyProxy.rst b/doc/python_api/rst/bge_types/bge.types.KX_PolyProxy.rst deleted file mode 100644 index 68baff8d45c..00000000000 --- a/doc/python_api/rst/bge_types/bge.types.KX_PolyProxy.rst +++ /dev/null @@ -1,136 +0,0 @@ -KX_PolyProxy(SCA_IObject) -========================= - -base class --- :class:`SCA_IObject` - -.. class:: KX_PolyProxy(SCA_IObject) - - A polygon holds the index of the vertex forming the poylgon. - - Note: - The polygon attributes are read-only, you need to retrieve the vertex proxy if you want - to change the vertex settings. - - .. attribute:: material_name - - The name of polygon material, empty if no material. - - :type: string - - .. attribute:: material - - The material of the polygon. - - :type: :class:`KX_BlenderMaterial` - - .. attribute:: texture_name - - The texture name of the polygon. - - :type: string - - .. attribute:: material_id - - The material index of the polygon, use this to retrieve vertex proxy from mesh proxy. - - :type: integer - - .. attribute:: v1 - - vertex index of the first vertex of the polygon, use this to retrieve vertex proxy from mesh proxy. - - :type: integer - - .. attribute:: v2 - - vertex index of the second vertex of the polygon, use this to retrieve vertex proxy from mesh proxy. - - :type: integer - - .. attribute:: v3 - - vertex index of the third vertex of the polygon, use this to retrieve vertex proxy from mesh proxy. - - :type: integer - - .. attribute:: v4 - - Vertex index of the fourth vertex of the polygon, 0 if polygon has only 3 vertex - Use this to retrieve vertex proxy from mesh proxy. - - :type: integer - - .. attribute:: visible - - visible state of the polygon: 1=visible, 0=invisible. - - :type: integer - - .. attribute:: collide - - collide state of the polygon: 1=receives collision, 0=collision free. - - :type: integer - - .. method:: getMaterialName() - - Returns the polygon material name with MA prefix - - :return: material name - :rtype: string - - .. method:: getMaterial() - - :return: The polygon material - :rtype: :class:`KX_BlenderMaterial` - - .. method:: getTextureName() - - :return: The texture name - :rtype: string - - .. method:: getMaterialIndex() - - Returns the material bucket index of the polygon. - This index and the ones returned by getVertexIndex() are needed to retrieve the vertex proxy from :class:`MeshProxy`. - - :return: the material index in the mesh - :rtype: integer - - .. method:: getNumVertex() - - Returns the number of vertex of the polygon. - - :return: number of vertex, 3 or 4. - :rtype: integer - - .. method:: isVisible() - - Returns whether the polygon is visible or not - - :return: 0=invisible, 1=visible - :rtype: boolean - - .. method:: isCollider() - - Returns whether the polygon is receives collision or not - - :return: 0=collision free, 1=receives collision - :rtype: integer - - .. method:: getVertexIndex(vertex) - - Returns the mesh vertex index of a polygon vertex - This index and the one returned by getMaterialIndex() are needed to retrieve the vertex proxy from :class:`MeshProxy`. - - :arg vertex: index of the vertex in the polygon: 0->3 - :arg vertex: integer - :return: mesh vertex index - :rtype: integer - - .. method:: getMesh() - - Returns a mesh proxy - - :return: mesh proxy - :rtype: :class:`MeshProxy` |