Mesh

Supported platforms:
Available since: Gideros 2012.09
Inherits from: Sprite

Description

The Mesh class is used to create and display custom constructed set of triangles (triangle meshes). It basically consists of 4 arrays:

• vertex
• index
• color (optional)
• textureCoordinate (optional)

and a texture (optional). The Mesh class provides more than one way to set/modify these arrays.

The Mesh can be 2D or 3D, the latter expects an additional Z coordinate in its vertices. Additionally, 3D meshes and their children are rendered with depth testing enabled, which prevents far objects to be drawn above nearest ones, irrespective of actual drawing order.

the Mesh class doesn't do bounds check: if an element at index array points to an non-existent vertex, the application may crash

Example

Drawing a colored Mesh rectangle

local mesh = Mesh.new()
stage:addChild(mesh)
-- 1. vertex (0, 0)
-- 2. vertex (100, 0)
-- 3. vertex (100, 150)
-- 4. vertex (0, 150)
mesh:setVertexArray(0, 0,   100, 0,   100, 150,   0, 150)

-- 1. triangle from 1, 2 and 3 vertex
-- 2. triangle from 1, 3 and 4 vertex
mesh:setIndexArray(1, 2, 3,     1, 3, 4)

-- 1. vertex 0xff0000 color with 0.5 alpha
-- 2. vertex 0x00ff00 color with 0.7 alpha
-- 3. vertex 0x0000ff color with 1 alpha
-- 4. vertex 0xffff00 color with 0 alpha
mesh:setColorArray(0xff0000, 0.5, 0x00ff00, 0.7, 0x0000ff, 1.0, 0xffff00, 0)

Methods Mesh.new creates a new Mesh instance Mesh:clearColorArray clears the color array Mesh:clearIndexArray clears the index array Mesh:clearTexture clears the Mesh texture Mesh:clearTextureCoordinateArray clears the texture coordinate array Mesh:clearVertexArray clears the vertex array Mesh:getColor returns color and alpha of the i-th element from color array Mesh:getColorArraySize gets the size of the Color array Mesh:getIndex returns the i-th element from index array Mesh:getIndexArraySize gets the size of the Index array Mesh:getTextureCoordinate returns u and v coordinate of the i-th element from texture coordinate array Mesh:getTextureCoordinateArraySize gets the size of the Texture Coordinate array Mesh:getVertex returns x and y coordinate of the i-th element from vertex array Mesh:getVertexArraySize gets the size of the Vertices array Mesh:resizeColorArray resizes the Color array Mesh:resizeIndexArray resizes the Index array Mesh:resizeTextureCoordinateArray resizes the texture coordinates array Mesh:resizeVertexArray resizes the vertex array Mesh:setColor set a color in the color array Mesh:setColorArray sets or replace the whole color array Mesh:setColors sets several colors at once Mesh:setGenericArray sets or replace a generic array Mesh:setIndex set an index in the index array Mesh:setIndexArray sets or replace the whole index array Mesh:setIndices sets several indices at once Mesh:setTexture attach a texture to the Mesh Mesh:setTextureCoordinate set a texture coordinate in the texture coordinates array Mesh:setTextureCoordinateArray sets or replace the whole texture coordinates array Mesh:setTextureCoordinates sets several texture coordinates at once Mesh:setVertex set a vertex in the vertex array Mesh:setVertexArray sets or replace the whole vertex array Mesh:setVertices sets several vertices at once

Events Constants

---

• Main Page
• Lua API
• Main API
• Plugins