libGDX 1.14.2 · com.badlogic.gdx.graphics.g3d.utils.ShapeCache

A relatively lightweight class which can be used to render basic shapes which don't need a node structure and alike. Can be used for batching both static and dynamic shapes which share the same Material and transformation Matrix4 within the world. Use ModelBatch to render the `ShapeCache`. Must be disposed when no longer needed to release native resources.

How to use it :

// Create cache
ShapeCache cache = new ShapeCache();
// Build the cache, for dynamic shapes, this would be in the render method.
MeshPartBuilder builder = cache.begin();
FrustumShapeBuilder.build(builder, camera);
BoxShapeBuilder.build(builder, box);
cache.end()
// Render
modelBatch.render(cache);
// After using it
cache.dispose();

Modifier and Type	Field and Description
private final MeshBuilder	builder Builder used to update the mesh
private boolean	building
private final String	id
private final Mesh	mesh Mesh being rendered
private final Renderable	renderable

Constructor Summary

Access	Constructor and Description
public	ShapeCache() Create a ShapeCache with default values
public	ShapeCache(int max vertices in mesh maxVertices, int max indices in mesh maxIndices, VertexAttributes vertex attributes attributes, int primitiveType) Create a ShapeCache with parameters

Method Summary

Modifier and Type	Method and Description
public MeshPartBuilder	begin() Initialize ShapeCache for mesh generation with GL_LINES primitive type
public MeshPartBuilder	begin(int OpenGL primitive type primitiveType) Initialize ShapeCache for mesh generation
public void	dispose() Implements com.badlogic.gdx.utils.Disposable.dispose. Releases all resources of this object.
public void	end() Generate mesh and renderable
public Material	Returns: material getMaterial() Allows to customize the material.
public void	getRenderables(Array<Renderable> renderables, Pool<Renderable> pool) Implements com.badlogic.gdx.graphics.g3d.RenderableProvider.getRenderables. Returns `Renderable` instances.
public Matrix4	Returns: world transform getWorldTransform() Allows to customize the world transform matrix.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

builder	back to summary
private final MeshBuilder builder Builder used to update the mesh

building	back to summary
private boolean building

id	back to summary
private final String id

mesh	back to summary
private final Mesh mesh Mesh being rendered

renderable	back to summary
private final Renderable renderable

Constructor Detail

ShapeCache	back to summary
public ShapeCache() Create a ShapeCache with default values

ShapeCache	back to summary
public ShapeCache(int maxVertices, int maxIndices, VertexAttributes attributes, int primitiveType) Create a ShapeCache with parameters Parameters maxVertices:int max vertices in mesh maxIndices:int max indices in mesh attributes:VertexAttributes vertex attributes

ShapeCache

back to summary

public ShapeCache(int maxVertices, int maxIndices, VertexAttributes attributes, int primitiveType)

Create a ShapeCache with parameters

Parameters

maxVertices:int: max vertices in mesh
maxIndices:int: max indices in mesh
attributes:VertexAttributes: vertex attributes

Method Detail

begin	back to summary
public MeshPartBuilder begin() Initialize ShapeCache for mesh generation with GL_LINES primitive type

begin	back to summary
public MeshPartBuilder begin(int primitiveType) Initialize ShapeCache for mesh generation Parameters primitiveType:int OpenGL primitive type

begin

back to summary

public MeshPartBuilder begin(int primitiveType)

Initialize ShapeCache for mesh generation

Parameters

primitiveType:int: OpenGL primitive type

dispose	back to summary
public void dispose() Implements com.badlogic.gdx.utils.Disposable.dispose. Doc from com.badlogic.gdx.utils.Disposable.dispose. Releases all resources of this object. Annotations @Override

dispose

back to summary

public void dispose()

Implements com.badlogic.gdx.utils.Disposable.dispose.

Doc from com.badlogic.gdx.utils.Disposable.dispose.

Releases all resources of this object.

Annotations

@Override

end	back to summary
public void end() Generate mesh and renderable

getMaterial	back to summary
public Material getMaterial() Allows to customize the material. Returns:Material material

getMaterial

back to summary

public Material getMaterial()

Allows to customize the material.

Returns:Material: material

getRenderables back to summary

getRenderables	back to summary
public void getRenderables(Array<Renderable> renderables, Pool<Renderable> pool) Implements com.badlogic.gdx.graphics.g3d.RenderableProvider.getRenderables. Doc from com.badlogic.gdx.graphics.g3d.RenderableProvider.getRenderables. Returns `Renderable` instances. Renderables are obtained from the provided `Pool` and added to the provided array. The Renderables obtained using `Pool#obtain()` will later be put back into the pool, do not store them internally. The resulting array can be rendered via a `ModelBatch`. Annotations @Override

public void getRenderables(Array<Renderable> renderables, Pool<Renderable> pool)

Implements com.badlogic.gdx.graphics.g3d.RenderableProvider.getRenderables.

Doc from com.badlogic.gdx.graphics.g3d.RenderableProvider.getRenderables.

Returns Renderable instances. Renderables are obtained from the provided Pool and added to the provided array. The Renderables obtained using Pool#obtain() will later be put back into the pool, do not store them internally. The resulting array can be rendered via a ModelBatch.

Annotations

@Override

getWorldTransform	back to summary
public Matrix4 getWorldTransform() Allows to customize the world transform matrix. Returns:Matrix4 world transform

getWorldTransform

back to summary

public Matrix4 getWorldTransform()

Allows to customize the world transform matrix.

Returns:Matrix4: world transform

public Class ShapeCache

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail