com.badlogic.gdx.graphics.g3d

Class Renderable

java.lang.Object

com.badlogic.gdx.graphics.g3d.Renderable

public class Renderable
extends Object

A Renderable contains all information about a single render instruction (typically a draw call).

It defines what (the shape), how (the material) and where (the transform) should be rendered by which shader.

The shape is defined using the mesh, meshPartOffset, meshPartSize and primitiveType members. This matches the members of the MeshPart class. The meshPartOffset is used to specify the offset within the mesh and the meshPartSize is used to specify the part (in total number of vertices) to render. If the mesh is indexed (which is when Mesh.getNumIndices() > 0) then both values are in number of indices within the indices array of the mesh, otherwise they are in number of vertices within the vertices array of the mesh. Note that some classes might require the mesh to be indexed.

The material and (optional) environment values are combined to specify how the shape should look like. Typically these are used to specify uniform values or other OpenGL state changes. When a value is present in both the material and environment, then the value of the material will be used.

Renderables can be rendered directly using a Shader (in which case the shader member is ignored). Though more typically Renderables are rendered via a ModelBatch, either directly, or by passing a RenderableProvider like ModelInstance to the RenderBatch.

A ModelInstance returns all Renderables via its ModelInstance.getRenderables(Array, Pool) method. In which case the value of ModelInstance.userData will be set to the userData member. The userData member can be used to pass additional data to the shader. However, in most scenario's it is advised to use the material or environment member with custom Attributes to pass data to the shader.

In some cases, (for example for non-hierarchical basic game objects requiring only a single draw call) it is possible to extend the Renderable class and add additional fields to pass to the shader. While extending the Renderable class can be useful, the shader should not rely on it. Similar to the userData member it is advised to use the material and environment members to pass data to the shader.

When using a ModelBatch to render a Renderable, The Renderable and all its values must not be changed in between the call to ModelBatch.begin(com.badlogic.gdx.graphics.Camera) and ModelBatch.end(). Therefor Renderable instances cannot be reused for multiple render calls.

When the shader member of the Renderable is set, the ShaderProvider of the ModelBatch may decide to use that shader instead of the default shader. Therefor, to assure the default shader is used, the shader member must be set to null.

Author:

badlogic, xoppa

Field Summary

Fields

Modifier and Type	Field and Description
Matrix4[]	bones The bone transformations used for skinning, or null if not applicable.
Environment	environment The Environment to be used to render this Renderable, may be null.
Material	material The Material to be applied to the shape (part of the mesh), must not be null.
Mesh	mesh The Mesh which contains the part to render
int	meshPartOffset The offset in the mesh to the part to render.
int	meshPartSize The size (in total number of vertices) of the part in the mesh to render.
int	primitiveType The primitive type, OpenGL constant e.g: GL20.GL_TRIANGLES, GL20.GL_POINTS, GL20.GL_LINES, GL20.GL_LINE_STRIP, GL20.GL_TRIANGLE_STRIP
Shader	shader The Shader to be used to render this Renderable using a ModelBatch, may be null.
Object	userData User definable value, may be null.
Matrix4	worldTransform Used to specify the transformations (like translation, scale and rotation) to apply to the shape.

Constructor Summary

Constructors

Constructor and Description
Renderable()

Method Summary

Methods

Modifier and Type	Method and Description
Renderable	set(Renderable renderable)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

worldTransform

public final Matrix4 worldTransform

Used to specify the transformations (like translation, scale and rotation) to apply to the shape. In other words: it is used to transform the vertices from model space into world space.

mesh

public Mesh mesh

The Mesh which contains the part to render

meshPartOffset

public int meshPartOffset

The offset in the mesh to the part to render. If the mesh is indexed (Mesh.getNumIndices() > 0), this is the offset in the indices array, otherwise it is the offset in the vertices array.

meshPartSize

public int meshPartSize

The size (in total number of vertices) of the part in the mesh to render. When the mesh is indexed ( Mesh.getNumIndices() > 0), this is the number of indices, otherwise it is the number of vertices.

primitiveType

public int primitiveType

The primitive type, OpenGL constant e.g: GL20.GL_TRIANGLES, GL20.GL_POINTS, GL20.GL_LINES, GL20.GL_LINE_STRIP, GL20.GL_TRIANGLE_STRIP

material

public Material material

The Material to be applied to the shape (part of the mesh), must not be null.

See Also:

environment

environment

public Environment environment

The Environment to be used to render this Renderable, may be null. When specified it will be combined by the shader with the material. When both the material and environment contain an attribute of the same type, the attribute of the material will be used.

bones

public Matrix4[] bones

The bone transformations used for skinning, or null if not applicable. When specified and the mesh contains one or more VertexAttributes.Usage.BoneWeight vertex attributes, then the BoneWeight index is used as index in the array. If the array isn't large enough then the identity matrix is used. Each BoneWeight weight is used to combine multiple bones into a single transformation matrix, which is used to transform the vertex to model space. In other words: the bone transformation is applied prior to the worldTransform.

shader

public Shader shader

The Shader to be used to render this Renderable using a ModelBatch, may be null. It is not guaranteed that the shader will be used, the used ShaderProvider is responsible for actually choosing the correct shader to use.

userData

public Object userData

User definable value, may be null.

Constructor Detail

Renderable

public Renderable()

Method Detail

set

public Renderable set(Renderable renderable)