Murl Engine Lua Addon API  Version 1.0 beta
Murl.Resource.IMesh

The IMesh resource object interface.


Table members

Methods


GetNumberOfBones()

Get the number of bones affecting this mesh.

Integer GetNumberOfBones()

Returns
Integer The number of bones.

GetBoundingBoxMin()

Get the minimum vector of the axis-aligned bounding box.

Murl.Math.Vector GetBoundingBoxMin()

Returns
Murl.Math.Vector The AABB minimum vector.

GetBoundingBoxMax()

Get the maximum vector of the axis-aligned bounding box.

Murl.Math.Vector GetBoundingBoxMax()

Returns
Murl.Math.Vector The AABB maximum vector.

GetNumberOfVertexBuffers()

Get the total number of vertex buffers present.

Integer GetNumberOfVertexBuffers()

Returns
Integer The number of vertex buffers present.

GetNumberOfVertexBufferVertices(vertexBufferIndex)

Get the number of vertices stored in the vertex buffer at a given index.

Integer GetNumberOfVertexBufferVertices(Integer vertexBufferIndex)

Parameters
vertexBufferIndexThe index of the vertex buffer, from 0 to GetNumberOfVertexBuffers()-1.
Returns
Integer The number of vertices.

GetNumberOfVertexBufferAttributes(vertexBufferIndex)

Get the number of attributes defined for the vertex buffer at a given index.

Integer GetNumberOfVertexBufferAttributes(Integer vertexBufferIndex)

Parameters
vertexBufferIndexThe index of the vertex buffer, from 0 to GetNumberOfVertexBuffers()-1.
Returns
Integer The number of attributes.

GetVertexBufferAccessMode(vertexBufferIndex)

Get the access mode of the vertex buffer at a given index.

Murl.IEnums.BufferAccessMode GetVertexBufferAccessMode(Integer vertexBufferIndex)

Parameters
vertexBufferIndexThe index of the vertex buffer, from 0 to GetNumberOfVertexBuffers()-1.
Returns
Murl.IEnums.BufferAccessMode The buffer access mode.

GetVertexBufferByteStride(vertexBufferIndex)

Get the byte stride of the vertex buffer at a given index.

Integer GetVertexBufferByteStride(Integer vertexBufferIndex)

Parameters
vertexBufferIndexThe index of the vertex buffer, from 0 to GetNumberOfVertexBuffers()-1.
Returns
Integer The byte stride.

GetVertexBufferAttributeItem(vertexBufferIndex, attributeIndex)

Get the predefined item of a vertex buffer attribute.

Murl.IEnums.AttributeItem GetVertexBufferAttributeItem(Integer vertexBufferIndex, Integer attributeIndex)

Parameters
vertexBufferIndexThe index of the vertex buffer, from 0 to GetNumberOfVertexBuffers()-1.
attributeIndexThe index of the attribute, from 0 to GetNumberOfVertexBufferAttributes()-1.
Returns
Murl.IEnums.AttributeItem The attribute item.

GetVertexBufferAttributeType(vertexBufferIndex, attributeIndex)

Get the data type of a vertex buffer attribute.

Murl.IEnums.AttributeType GetVertexBufferAttributeType(Integer vertexBufferIndex, Integer attributeIndex)

Parameters
vertexBufferIndexThe index of the vertex buffer, from 0 to GetNumberOfVertexBuffers()-1.
attributeIndexThe index of the attribute, from 0 to GetNumberOfVertexBufferAttributes()-1.
Returns
Murl.IEnums.AttributeType The attribute type.

GetVertexBufferAttributeByteOffset(vertexBufferIndex, attributeIndex)

Get the byte offset of a vertex buffer attribute.

Integer GetVertexBufferAttributeByteOffset(Integer vertexBufferIndex, Integer attributeIndex)

Parameters
vertexBufferIndexThe index of the vertex buffer, from 0 to GetNumberOfVertexBuffers()-1.
attributeIndexThe index of the attribute, from 0 to GetNumberOfVertexBufferAttributes()-1.
Returns
Integer The byte offset.

GetVertexBufferSlot(vertexBufferIndex)

Get the slot index to which a vertex buffer gets assigned.

Integer GetVertexBufferSlot(Integer vertexBufferIndex)

Parameters
vertexBufferIndexThe index of the vertex buffer, from 0 to GetNumberOfVertexBuffers()-1.
Returns
Integer The slot index.

GetVertexBufferUnit(vertexBufferIndex)

Get the unit index to which a vertex buffer gets assigned.

Integer GetVertexBufferUnit(Integer vertexBufferIndex)

Parameters
vertexBufferIndexThe index of the vertex buffer, from 0 to GetNumberOfVertexBuffers()-1.
Returns
Integer The unit index.

GetNumberOfIndexBuffers()

Get the total number of index buffers present.

Integer GetNumberOfIndexBuffers()

Returns
Integer The number of index buffers present.

GetNumberOfIndexBufferIndices(indexBufferIndex)

Get the number of indices stored in the index buffer at a given index.

Integer GetNumberOfIndexBufferIndices(Integer indexBufferIndex)

Parameters
indexBufferIndexThe index of the index buffer, from 0 to GetNumberOfIndexBuffers()-1.
Returns
Integer The number of indices.

GetNumberOfIndexBufferSegments(indexBufferIndex)

Get the number of segments stored in the index buffer at a given index.

Integer GetNumberOfIndexBufferSegments(Integer indexBufferIndex)

Parameters
indexBufferIndexThe index of the index buffer, from 0 to GetNumberOfIndexBuffers()-1.
Returns
Integer The number of segments.

GetIndexBufferAccessMode(indexBufferIndex)

Get the access mode of the index buffer at a given index.

Murl.IEnums.BufferAccessMode GetIndexBufferAccessMode(Integer indexBufferIndex)

Parameters
indexBufferIndexThe index of the index buffer, from 0 to GetNumberOfIndexBuffers()-1.
Returns
Murl.IEnums.BufferAccessMode The buffer access mode.

GetIndexBufferIndexType(indexBufferIndex)

Get the data type of the index buffer at a given index.

Murl.IEnums.IndexType GetIndexBufferIndexType(Integer indexBufferIndex)

Parameters
indexBufferIndexThe index of the index buffer, from 0 to GetNumberOfIndexBuffers()-1.
Returns
Murl.IEnums.IndexType The data type.

GetIndexBufferPrimitiveType(indexBufferIndex)

Get the primitive type of the index buffer at a given index.

Murl.IEnums.PrimitiveType GetIndexBufferPrimitiveType(Integer indexBufferIndex)

Parameters
indexBufferIndexThe index of the index buffer, from 0 to GetNumberOfIndexBuffers()-1.
Returns
Murl.IEnums.PrimitiveType The primitive type.

GetIndexBufferVerticesSlot(indexBufferIndex)

Get the slot of vertices used to render the index buffer at a given index.

Integer GetIndexBufferVerticesSlot(Integer indexBufferIndex)

Parameters
indexBufferIndexThe index of the index buffer, from 0 to GetNumberOfIndexBuffers()-1.
Returns
Integer The vertices' slot.

GetIndexBufferMaterialSlot(indexBufferIndex)

Get the slot index for the material used to render the index buffer at a given index.

Integer GetIndexBufferMaterialSlot(Integer indexBufferIndex)

Parameters
indexBufferIndexThe index of the index buffer, from 0 to GetNumberOfIndexBuffers()-1.
Returns
Integer The material slot.

GetIndexBufferParametersSlot(indexBufferIndex)

Get the slot index for the parameters used to render the index buffer at a given index.

Integer GetIndexBufferParametersSlot(Integer indexBufferIndex)

Parameters
indexBufferIndexThe index of the index buffer, from 0 to GetNumberOfIndexBuffers()-1.
Returns
Integer The parameters slot.

GetIndexBufferTextureSlot(indexBufferIndex, unit)

Get the slot index for the texture at a given unit used to render the index buffer at a given index.

Integer GetIndexBufferTextureSlot(Integer indexBufferIndex, Integer unit)

Parameters
indexBufferIndexThe index of the index buffer, from 0 to GetNumberOfIndexBuffers()-1.
unitThe texture unit, in the range from 0 to IEnums::NUM_TEXTURE_UNITS.
Returns
Integer The texture slot.

GetNumberOfMorphBuffers(vertexBufferIndex)

Get the total number of morph buffers present for a given vertex buffer.

Integer GetNumberOfMorphBuffers(Integer vertexBufferIndex)

Parameters
vertexBufferIndexThe index of the vertex buffer, from 0 to GetNumberOfVertexBuffers()-1.
Returns
Integer The number of morph buffers present.

GetNumberOfMorphBufferVertices(vertexBufferIndex, morphBufferIndex)

Get the number of morphed vertices for a given vertex and morph buffer.

Integer GetNumberOfMorphBufferVertices(Integer vertexBufferIndex, Integer morphBufferIndex)

Parameters
vertexBufferIndexThe index of the vertex buffer, from 0 to GetNumberOfVertexBuffers()-1.
morphBufferIndexThe index of the morph buffer, from 0 to GetNumberOfMorphBuffers()-1.
Returns
Integer The number of morphed vertices.

GetNumberOfMorphBufferAttributes(vertexBufferIndex, morphBufferIndex)

Get the number of morphed attributes for a given vertex and morph buffer.

Integer GetNumberOfMorphBufferAttributes(Integer vertexBufferIndex, Integer morphBufferIndex)

Parameters
vertexBufferIndexThe index of the vertex buffer, from 0 to GetNumberOfVertexBuffers()-1.
morphBufferIndexThe index of the morph buffer, from 0 to GetNumberOfMorphBuffers()-1.
Returns
Integer The number of morphed attributes.

GetMorphBufferByteStride(vertexBufferIndex, morphBufferIndex)

Get the byte stride for a given vertex and morph buffer.

Integer GetMorphBufferByteStride(Integer vertexBufferIndex, Integer morphBufferIndex)

Parameters
vertexBufferIndexThe index of the vertex buffer, from 0 to GetNumberOfVertexBuffers()-1.
morphBufferIndexThe index of the morph buffer, from 0 to GetNumberOfMorphBuffers()-1.
Returns
Integer The byte stride.

GetMorphBufferAttributeItem(vertexBufferIndex, morphBufferIndex, attributeIndex)

Get the predefined morph attribute item for a given vertex and morph buffer.

Murl.IEnums.AttributeItem GetMorphBufferAttributeItem(Integer vertexBufferIndex, Integer morphBufferIndex, Integer attributeIndex)

Parameters
vertexBufferIndexThe index of the vertex buffer, from 0 to GetNumberOfVertexBuffers()-1.
morphBufferIndexThe index of the morph buffer, from 0 to GetNumberOfMorphBuffers()-1.
attributeIndexThe index of the attribute, from 0 to GetNumberOfMorphBufferAttributes()-1.
Returns
Murl.IEnums.AttributeItem The attribute item.

GetMorphBufferAttributeType(vertexBufferIndex, morphBufferIndex, attributeIndex)

Get the morph attribute data type for a given vertex and morph buffer.

Murl.IEnums.AttributeType GetMorphBufferAttributeType(Integer vertexBufferIndex, Integer morphBufferIndex, Integer attributeIndex)

Parameters
vertexBufferIndexThe index of the vertex buffer, from 0 to GetNumberOfVertexBuffers()-1.
morphBufferIndexThe index of the morph buffer, from 0 to GetNumberOfMorphBuffers()-1.
attributeIndexThe index of the attribute, from 0 to GetNumberOfMorphBufferAttributes()-1.
Returns
Murl.IEnums.AttributeType The attribute type.

GetMorphBufferAttributeByteOffset(vertexBufferIndex, morphBufferIndex, attributeIndex)

Get the morph attribute byte offset for a given vertex and morph buffer.

Integer GetMorphBufferAttributeByteOffset(Integer vertexBufferIndex, Integer morphBufferIndex, Integer attributeIndex)

Parameters
vertexBufferIndexThe index of the vertex buffer, from 0 to GetNumberOfVertexBuffers()-1.
morphBufferIndexThe index of the morph buffer, from 0 to GetNumberOfMorphBuffers()-1.
attributeIndexThe index of the attribute, from 0 to GetNumberOfMorphBufferAttributes()-1.
Returns
Integer The byte offset.

GetMorphBufferIndexType(vertexBufferIndex, morphBufferIndex)

Get the index data type for a given vertex and morph buffer.

Murl.IEnums.IndexType GetMorphBufferIndexType(Integer vertexBufferIndex, Integer morphBufferIndex)

Parameters
vertexBufferIndexThe index of the vertex buffer, from 0 to GetNumberOfVertexBuffers()-1.
morphBufferIndexThe index of the morph buffer, from 0 to GetNumberOfMorphBuffers()-1.
Returns
Murl.IEnums.IndexType The data type.

GetNumberOfDeformBuffers(vertexBufferIndex)

Get the total number of deform buffers present for a given vertex buffer.

Integer GetNumberOfDeformBuffers(Integer vertexBufferIndex)

Parameters
vertexBufferIndexThe index of the vertex buffer, from 0 to GetNumberOfVertexBuffers()-1.
Returns
Integer The number of deform buffers present.

GetNumberOfDeformEntries(vertexBufferIndex, deformBufferIndex)

Get the number of entries for a given vertex and deform buffer.

Integer GetNumberOfDeformEntries(Integer vertexBufferIndex, Integer deformBufferIndex)

Parameters
vertexBufferIndexThe index of the vertex buffer, from 0 to GetNumberOfVertexBuffers()-1.
deformBufferIndexThe index of the deform buffer, from 0 to GetNumberOfDeformBuffers()-1.
Returns
Integer The number of entries.

GetNumberOfDeformBufferVertices(vertexBufferIndex, deformBufferIndex, deformEntryIndex)

Get the number of deformed vertices for a given vertex buffer, deform buffer and deform entry.

Integer GetNumberOfDeformBufferVertices(Integer vertexBufferIndex, Integer deformBufferIndex, Integer deformEntryIndex)

Parameters
vertexBufferIndexThe index of the vertex buffer, from 0 to GetNumberOfVertexBuffers()-1.
deformBufferIndexThe index of the deform buffer, from 0 to GetNumberOfDeformBuffers()-1.
deformEntryIndexThe index of the deform entry, from 0 to GetNumberOfDeformEntries()-1.
Returns
Integer The number of deformed vertices.

GetNumberOfDeformBufferAttributes(vertexBufferIndex, deformBufferIndex)

Get the number of deformed attributes for a given vertex and deform buffer.

Integer GetNumberOfDeformBufferAttributes(Integer vertexBufferIndex, Integer deformBufferIndex)

Parameters
vertexBufferIndexThe index of the vertex buffer, from 0 to GetNumberOfVertexBuffers()-1.
deformBufferIndexThe index of the morph buffer, from 0 to GetNumberOfDeformBuffers()-1.
Returns
Integer The number of deformed attributes.

GetDeformBufferByteStride(vertexBufferIndex, deformBufferIndex)

Get the byte stride for a given vertex and deform buffer.

Integer GetDeformBufferByteStride(Integer vertexBufferIndex, Integer deformBufferIndex)

Parameters
vertexBufferIndexThe index of the vertex buffer, from 0 to GetNumberOfVertexBuffers()-1.
deformBufferIndexThe index of the deform buffer, from 0 to GetNumberOfDeformBuffers()-1.
Returns
Integer The byte stride.

GetDeformBufferAttributeItem(vertexBufferIndex, deformBufferIndex, attributeIndex)

Get the predefined deform attribute item for a given vertex and deform buffer.

Murl.IEnums.AttributeItem GetDeformBufferAttributeItem(Integer vertexBufferIndex, Integer deformBufferIndex, Integer attributeIndex)

Parameters
vertexBufferIndexThe index of the vertex buffer, from 0 to GetNumberOfVertexBuffers()-1.
deformBufferIndexThe index of the deform buffer, from 0 to GetNumberOfDeformBuffers()-1.
attributeIndexThe index of the attribute, from 0 to GetNumberOfDeformBufferAttributes()-1.
Returns
Murl.IEnums.AttributeItem The attribute item.

GetDeformBufferAttributeType(vertexBufferIndex, deformBufferIndex, attributeIndex)

Get the deform attribute data type for a given vertex and deform buffer.

Murl.IEnums.AttributeType GetDeformBufferAttributeType(Integer vertexBufferIndex, Integer deformBufferIndex, Integer attributeIndex)

Parameters
vertexBufferIndexThe index of the vertex buffer, from 0 to GetNumberOfVertexBuffers()-1.
deformBufferIndexThe index of the deform buffer, from 0 to GetNumberOfDeformBuffers()-1.
attributeIndexThe index of the attribute, from 0 to GetNumberOfDeformBufferAttributes()-1.
Returns
Murl.IEnums.AttributeType The attribute type.

GetDeformBufferAttributeByteOffset(vertexBufferIndex, deformBufferIndex, attributeIndex)

Get the deform attribute byte offset for a given vertex and deform buffer.

Integer GetDeformBufferAttributeByteOffset(Integer vertexBufferIndex, Integer deformBufferIndex, Integer attributeIndex)

Parameters
vertexBufferIndexThe index of the vertex buffer, from 0 to GetNumberOfVertexBuffers()-1.
deformBufferIndexThe index of the deform buffer, from 0 to GetNumberOfDeformBuffers()-1.
attributeIndexThe index of the attribute, from 0 to GetNumberOfDeformBufferAttributes()-1.
Returns
Integer The byte offset.

GetDeformBufferIndexType(vertexBufferIndex, deformBufferIndex)

Get the index data type for a given vertex and deform buffer.

Murl.IEnums.IndexType GetDeformBufferIndexType(Integer vertexBufferIndex, Integer deformBufferIndex)

Parameters
vertexBufferIndexThe index of the vertex buffer, from 0 to GetNumberOfVertexBuffers()-1.
deformBufferIndexThe index of the deform buffer, from 0 to GetNumberOfDeformBuffers()-1.
Returns
Murl.IEnums.IndexType The data type.

GetNumberOfCollisionSurfaces()

Get the total number of collision surfaces present.

Integer GetNumberOfCollisionSurfaces()

Returns
Integer The number of collision surfaces.

GetCollisionSurfaceSlot(surfaceIndex)

Get the surface slot used for a given collision surface.

Integer GetCollisionSurfaceSlot(Integer surfaceIndex)

Parameters
surfaceIndexThe index of the surface, from 0 to GetNumberOfCollisionSurfaces()-1.
Returns
Integer The surface slot.

GetNumberOfBspPlanes()

Get the number of BSP splitting planes present.

Integer GetNumberOfBspPlanes()

Returns
Integer The number of planes.

GetNumberOfBspNodes()

Get the number of BSP nodes present.

Integer GetNumberOfBspNodes()

Returns
Integer The number of nodes.

GetNumberOfBspLeaves()

Get the number of BSP leaves present.

Integer GetNumberOfBspLeaves()

Returns
Integer The number of leaves.

GetNumberOfBspFaces()

Get the number of BSP faces present.

Integer GetNumberOfBspFaces()

Returns
Integer The number of faces.

GetNumberOfBspSegments()

Get the number of BSP segments present.

Integer GetNumberOfBspSegments()

Returns
Integer The number of segments.

GetNumberOfBspClusters()

Get the number of BSP clusters present.

Integer GetNumberOfBspClusters()

Returns
Integer The number of clusters.

GetBspClustersByteSize()

Get the byte size of a BSP cluster.

Integer GetBspClustersByteSize()

Returns
Integer The byte size.

GetNumberOfBoundingNodes()

Get the number of bounding volume hierarchy nodes present.

Integer GetNumberOfBoundingNodes()

Returns
Integer The number of nodes.

GetNumberOfBoundingLeaves()

Get the number of bounding volume hierarchy leaves present.

Integer GetNumberOfBoundingLeaves()

Returns
Integer The number of leaves.

GetNumberOfBoundingVertices()

Get the number of bounding volume hierarchy vertices present.

Integer GetNumberOfBoundingVertices()

Returns
Integer The number of vertices.

GetBoundingVerticesByteSize()

Get the total byte size of the bounding volume hierarchy vertices.

Integer GetBoundingVerticesByteSize()

Returns
Integer The byte size.