Modifier and Type	Class and Description
public static interface	ModelCache.MeshPool Allows to reuse one or more meshes while avoiding creating new objects.
public static class	ModelCache.SimpleMeshPool A basic `MeshPool` implementation that avoids creating new meshes at the cost of memory usage.
public static class	ModelCache.Sorter A `RenderableSorter` that sorts by vertex attributes, material attributes and primitive types (in that order), so that meshes can be easily merged.
public static class	ModelCache.TightMeshPool A tight `MeshPool` implementation, which is typically used for static meshes (create once, use many).

Modifier and Type	Field and Description
private boolean	building
private Camera	camera
private Array<Renderable>	items
private MeshBuilder	meshBuilder
private FlushablePool<MeshPart>	meshPartPool
private ModelCache.MeshPool	meshPool
private Array<Renderable>	renderables
private FlushablePool<Renderable>	renderablesPool
private RenderableSorter	sorter
private Array<Renderable>	tmp

Access	Constructor and Description
public	ModelCache() Create a ModelCache using the default `Sorter` and the `SimpleMeshPool` implementation.
public	ModelCache(RenderableSorter sorter, ModelCache.MeshPool meshPool) Create a ModelCache using the specified `RenderableSorter` and `MeshPool` implementation.

Method Summary

Modifier and Type	Method and Description
public void	add(Renderable The `Renderable` to add, should not change while the cache is needed. renderable) Adds the specified `Renderable` to the cache.
public void	add(final RenderableProvider renderableProvider) Adds the specified `RenderableProvider` to the cache, see `add(Renderable)`.
public <T extends RenderableProvider> void	add(final Iterable<T> renderableProviders) Adds the specified `RenderableProvider`s to the cache, see `add(Renderable)`.
public void	begin() Begin creating the cache, must be followed by a call to `end()`, in between these calls one or more calls to one of the add(...) methods can be made.
public void	begin(Camera The `Camera` that will passed to the `RenderableSorter` camera) Begin creating the cache, must be followed by a call to `end()`, in between these calls one or more calls to one of the add(...) methods can be made.
public void	dispose() Implements com.badlogic.gdx.utils.Disposable.dispose. Releases all resources of this object.
public void	end() Finishes creating the cache, must be called after a call to `begin()`, only after this call the cache will be valid (until the next call to `begin()`).
public void	getRenderables(Array<Renderable> renderables, Pool<Renderable> pool) Implements com.badlogic.gdx.graphics.g3d.RenderableProvider.getRenderables. Returns `Renderable` instances.
private Renderable	obtainRenderable(Material material, int primitiveType)

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

Field Detail

building	back to summary
private boolean building

camera	back to summary
private Camera camera

items	back to summary
private Array<Renderable> items

meshBuilder	back to summary
private MeshBuilder meshBuilder

meshPartPool	back to summary
private FlushablePool<MeshPart> meshPartPool

meshPool	back to summary
private ModelCache.MeshPool meshPool

renderables	back to summary
private Array<Renderable> renderables

renderablesPool	back to summary
private FlushablePool<Renderable> renderablesPool

sorter	back to summary
private RenderableSorter sorter

tmp	back to summary
private Array<Renderable> tmp

Constructor Detail

ModelCache	back to summary
public ModelCache() Create a ModelCache using the default `Sorter` and the `SimpleMeshPool` implementation. This might not be the most optimal implementation for you use-case, but should be good to start with.

ModelCache back to summary

ModelCache	back to summary
public ModelCache(RenderableSorter sorter, ModelCache.MeshPool meshPool) Create a ModelCache using the specified `RenderableSorter` and `MeshPool` implementation. The `RenderableSorter` implementation will be called with the camera specified in `begin(Camera)`. By default this will be null. The sorter is important for optimizing the cache. For the best result, make sure that renderables that can be merged are next to each other.

public ModelCache(RenderableSorter sorter, ModelCache.MeshPool meshPool)

Create a ModelCache using the specified RenderableSorter and MeshPool implementation. The RenderableSorter implementation will be called with the camera specified in begin(Camera). By default this will be null. The sorter is important for optimizing the cache. For the best result, make sure that renderables that can be merged are next to each other.

Method Detail

add back to summary

add	back to summary
public void add(Renderable renderable) Adds the specified `Renderable` to the cache. Must be called in between a call to `begin()` and `end()`. All member objects might (depending on possibilities) be used by reference and should not change while the cache is used. If the `Renderable#bones` member is not null then skinning is assumed and the renderable will be added as-is, by reference. Otherwise the renderable will be merged with other renderables as much as possible, depending on the `Mesh#getVertexAttributes()`, `Renderable#material` and primitiveType (in that order). The `Renderable#environment`, `Renderable#shader` and `Renderable#userData` values (if any) are removed. Parameters renderable:Renderable The `Renderable` to add, should not change while the cache is needed.

public void add(Renderable renderable)

Adds the specified Renderable to the cache. Must be called in between a call to begin() and end(). All member objects might (depending on possibilities) be used by reference and should not change while the cache is used. If the Renderable#bones member is not null then skinning is assumed and the renderable will be added as-is, by reference. Otherwise the renderable will be merged with other renderables as much as possible, depending on the Mesh#getVertexAttributes(), Renderable#material and primitiveType (in that order). The Renderable#environment, Renderable#shader and Renderable#userData values (if any) are removed.

Parameters

renderable:Renderable: The Renderable to add, should not change while the cache is needed.

add	back to summary
public void add(final RenderableProvider renderableProvider) Adds the specified `RenderableProvider` to the cache, see `add(Renderable)`.

add	back to summary
public <T extends RenderableProvider> void add(final Iterable<T> renderableProviders) Adds the specified `RenderableProvider`s to the cache, see `add(Renderable)`.

begin back to summary

begin	back to summary
public void begin() Begin creating the cache, must be followed by a call to `end()`, in between these calls one or more calls to one of the add(...) methods can be made. Calling this method will clear the cache and prepare it for creating a new cache. The cache is not valid until the call to `end()` is made. Use one of the add methods (e.g. `add(Renderable)` or `add(RenderableProvider)`) to add renderables to the cache.

public void begin()

Begin creating the cache, must be followed by a call to end(), in between these calls one or more calls to one of the add(...) methods can be made. Calling this method will clear the cache and prepare it for creating a new cache. The cache is not valid until the call to end() is made. Use one of the add methods (e.g. add(Renderable) or add(RenderableProvider)) to add renderables to the cache.

begin back to summary

begin	back to summary
public void begin(Camera camera) Begin creating the cache, must be followed by a call to `end()`, in between these calls one or more calls to one of the add(...) methods can be made. Calling this method will clear the cache and prepare it for creating a new cache. The cache is not valid until the call to `end()` is made. Use one of the add methods (e.g. `add(Renderable)` or `add(RenderableProvider)`) to add renderables to the cache. Parameters camera:Camera The `Camera` that will passed to the `RenderableSorter`

public void begin(Camera camera)

Parameters

camera:Camera: The Camera that will passed to the RenderableSorter

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() Finishes creating the cache, must be called after a call to `begin()`, only after this call the cache will be valid (until the next call to `begin()`). Calling this method will process all renderables added using one of the add(...) methods and will combine them if possible.

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

obtainRenderable	back to summary
private Renderable obtainRenderable(Material material, int primitiveType)

com.badlogic.gdx.graphics.g3d back to summary

public Interface ModelCache.MeshPool

Known Direct Implementers: com.badlogic.gdx.graphics.g3d.ModelCache.SimpleMeshPool, com.badlogic.gdx.graphics.g3d.ModelCache.TightMeshPool

Allows to reuse one or more meshes while avoiding creating new objects. Depending on the implementation it might add memory optimizations as well. Call the obtain(VertexAttributes, int, int) method to obtain a mesh which can at minimum the specified amount of vertices and indices. Call the flush() method to flush the pool ant release all previously obtained meshes.

Method Summary

Modifier and Type Method and Description

Modifier and Type	Method and Description
public void	flush() Releases all previously obtained `Mesh`es using the the `obtain(VertexAttributes, int, int)` method.
public Mesh	Returns: the obtained Mesh, or null when no mesh could be obtained. obtain(VertexAttributes the vertex attributes of the mesh to obtain vertexAttributes, int the minimum amount vertices the mesh should be able to store vertexCount, int the minimum amount of indices the mesh should be able to store indexCount) Will try to reuse or, when not possible to reuse, optionally create a `Mesh` that meets the specified criteria.

public void

flush()

Releases all previously obtained Meshes using the the obtain(VertexAttributes, int, int) method.

public Mesh

Returns:

the obtained Mesh, or null when no mesh could be obtained.

obtain(VertexAttributes

the vertex attributes of the mesh to obtain

vertexAttributes, int

the minimum amount vertices the mesh should be able to store

vertexCount, int

the minimum amount of indices the mesh should be able to store

indexCount)

Will try to reuse or, when not possible to reuse, optionally create a Mesh that meets the specified criteria.

Inherited from com.badlogic.gdx.utils.Disposable:: dispose

Method Detail

flush	back to summary
public void flush() Releases all previously obtained `Mesh`es using the the `obtain(VertexAttributes, int, int)` method.

obtain back to summary

obtain	back to summary
public Mesh obtain(VertexAttributes vertexAttributes, int vertexCount, int indexCount) Will try to reuse or, when not possible to reuse, optionally create a `Mesh` that meets the specified criteria. Parameters vertexAttributes:VertexAttributes the vertex attributes of the mesh to obtain vertexCount:int the minimum amount vertices the mesh should be able to store indexCount:int the minimum amount of indices the mesh should be able to store Returns:Mesh the obtained Mesh, or null when no mesh could be obtained.

public Mesh obtain(VertexAttributes vertexAttributes, int vertexCount, int indexCount)

Will try to reuse or, when not possible to reuse, optionally create a Mesh that meets the specified criteria.

Parameters

vertexAttributes:VertexAttributes: the vertex attributes of the mesh to obtain
vertexCount:int: the minimum amount vertices the mesh should be able to store
indexCount:int: the minimum amount of indices the mesh should be able to store

Returns:Mesh

the obtained Mesh, or null when no mesh could be obtained.

com.badlogic.gdx.graphics.g3d back to summary

public Class ModelCache.SimpleMeshPool

Class Inheritance

extends Object
implements MeshPool

java.lang.Object
com.badlogic.gdx.graphics.g3d.ModelCache.SimpleMeshPool

All Implemented Interfaces

com.badlogic.gdx.graphics.g3d.ModelCache.MeshPool, com.badlogic.gdx.utils.Disposable

A basic MeshPool implementation that avoids creating new meshes at the cost of memory usage. It does this by making the mesh always the maximum (64k) size. Use this when for dynamic caching where you need to obtain meshes very frequently (typically every frame).

Author: Xoppa

Field Summary

Modifier and Type	Field and Description
private Array<Mesh>	freeMeshes
private Array<Mesh>	usedMeshes

Constructor Summary

Access	Constructor and Description
public	SimpleMeshPool()

Method Summary

Modifier and Type	Method and Description
public void	dispose() Implements com.badlogic.gdx.utils.Disposable.dispose. Releases all resources of this object.
public void	flush() Implements com.badlogic.gdx.graphics.g3d.ModelCache.MeshPool.flush. Releases all previously obtained `Mesh`es using the the `obtain(VertexAttributes, int, int)` method.
public Mesh	obtain(VertexAttributes vertexAttributes, int vertexCount, int indexCount) Implements com.badlogic.gdx.graphics.g3d.ModelCache.MeshPool.obtain. Will try to reuse or, when not possible to reuse, optionally create a `Mesh` that meets the specified criteria.

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

Field Detail

freeMeshes	back to summary
private Array<Mesh> freeMeshes

usedMeshes	back to summary
private Array<Mesh> usedMeshes

Constructor Detail

SimpleMeshPool	back to summary
public SimpleMeshPool()

Method Detail

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

flush back to summary

flush	back to summary
public void flush() Implements com.badlogic.gdx.graphics.g3d.ModelCache.MeshPool.flush. Doc from com.badlogic.gdx.graphics.g3d.ModelCache.MeshPool.flush. Releases all previously obtained `Mesh`es using the the `obtain(VertexAttributes, int, int)` method. Annotations @Override

public void flush()

Implements com.badlogic.gdx.graphics.g3d.ModelCache.MeshPool.flush.

Doc from com.badlogic.gdx.graphics.g3d.ModelCache.MeshPool.flush.

Releases all previously obtained Meshes using the the obtain(VertexAttributes, int, int) method.

Annotations

@Override

obtain back to summary

obtain	back to summary
public Mesh obtain(VertexAttributes vertexAttributes, int vertexCount, int indexCount) Implements com.badlogic.gdx.graphics.g3d.ModelCache.MeshPool.obtain. Doc from com.badlogic.gdx.graphics.g3d.ModelCache.MeshPool.obtain. Will try to reuse or, when not possible to reuse, optionally create a `Mesh` that meets the specified criteria. Annotations @Override

public Mesh obtain(VertexAttributes vertexAttributes, int vertexCount, int indexCount)

Implements com.badlogic.gdx.graphics.g3d.ModelCache.MeshPool.obtain.

Doc from com.badlogic.gdx.graphics.g3d.ModelCache.MeshPool.obtain.

Will try to reuse or, when not possible to reuse, optionally create a Mesh that meets the specified criteria.

Annotations

@Override

com.badlogic.gdx.graphics.g3d back to summary

public Class ModelCache.Sorter

Class Inheritance

extends Object
implements RenderableSorter, Comparator<Renderable>

java.lang.Object
com.badlogic.gdx.graphics.g3d.ModelCache.Sorter

All Implemented Interfaces

java.util.Comparator, com.badlogic.gdx.graphics.g3d.utils.RenderableSorter

A RenderableSorter that sorts by vertex attributes, material attributes and primitive types (in that order), so that meshes can be easily merged.

Author: Xoppa

Constructor Summary

Access	Constructor and Description
public	Sorter()

Method Summary

Modifier and Type	Method and Description
public int	compare(Renderable arg0, Renderable arg1) Implements java.util.Comparator.compare. Compares its two arguments for order.
public void	sort(Camera camera, Array<Renderable> renderables) Implements com.badlogic.gdx.graphics.g3d.utils.RenderableSorter.sort. Sorts the array of `Renderable` instances based on some criteria, e.g. material, distance to camera etc.

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

Constructor Detail

Sorter	back to summary
public Sorter()

Method Detail

compare back to summary

compare	back to summary
public int compare(Renderable arg0, Renderable arg1) Implements java.util.Comparator.compare. Doc from java.util.Comparator.compare. Compares its two arguments for order. Returns a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second. The implementor must ensure that `signum(compare(x, y)) == -signum(compare(y, x))` for all `x` and `y`. (This implies that `compare(x, y)` must throw an exception if and only if `compare(y, x)` throws an exception.) The implementor must also ensure that the relation is transitive: `((compare(x, y)>0) && (compare(y, z)>0))` implies `compare(x, z)>0`. Finally, the implementor must ensure that `compare(x, y)==0` implies that `signum(compare(x, z))==signum(compare(y, z))` for all `z`. Annotations @Override

public int compare(Renderable arg0, Renderable arg1)

Implements java.util.Comparator.compare.

Doc from java.util.Comparator.compare.

Compares its two arguments for order. Returns a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

The implementor must ensure that signum(compare(x, y)) == -signum(compare(y, x)) for all x and y. (This implies that compare(x, y) must throw an exception if and only if compare(y, x) throws an exception.)

The implementor must also ensure that the relation is transitive: ((compare(x, y)>0) && (compare(y, z)>0)) implies compare(x, z)>0.

Finally, the implementor must ensure that compare(x, y)==0 implies that signum(compare(x, z))==signum(compare(y, z)) for all z.

Annotations

@Override

sort back to summary

sort	back to summary
public void sort(Camera camera, Array<Renderable> renderables) Implements com.badlogic.gdx.graphics.g3d.utils.RenderableSorter.sort. Doc from com.badlogic.gdx.graphics.g3d.utils.RenderableSorter.sort. Sorts the array of `Renderable` instances based on some criteria, e.g. material, distance to camera etc. Annotations @Override

public void sort(Camera camera, Array<Renderable> renderables)

Implements com.badlogic.gdx.graphics.g3d.utils.RenderableSorter.sort.

Doc from com.badlogic.gdx.graphics.g3d.utils.RenderableSorter.sort.

Sorts the array of Renderable instances based on some criteria, e.g. material, distance to camera etc.

Annotations

@Override

com.badlogic.gdx.graphics.g3d back to summary

public Class ModelCache.TightMeshPool

Class Inheritance

extends Object
implements MeshPool

java.lang.Object
com.badlogic.gdx.graphics.g3d.ModelCache.TightMeshPool

All Implemented Interfaces

com.badlogic.gdx.graphics.g3d.ModelCache.MeshPool, com.badlogic.gdx.utils.Disposable

A tight MeshPool implementation, which is typically used for static meshes (create once, use many).

Author: Xoppa

Field Summary

Modifier and Type	Field and Description
private Array<Mesh>	freeMeshes
private Array<Mesh>	usedMeshes

Constructor Summary

Access	Constructor and Description
public	TightMeshPool()

Method Summary

Modifier and Type	Method and Description
public void	dispose() Implements com.badlogic.gdx.utils.Disposable.dispose. Releases all resources of this object.
public void	flush() Implements com.badlogic.gdx.graphics.g3d.ModelCache.MeshPool.flush. Releases all previously obtained `Mesh`es using the the `obtain(VertexAttributes, int, int)` method.
public Mesh	obtain(VertexAttributes vertexAttributes, int vertexCount, int indexCount) Implements com.badlogic.gdx.graphics.g3d.ModelCache.MeshPool.obtain. Will try to reuse or, when not possible to reuse, optionally create a `Mesh` that meets the specified criteria.

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

Field Detail

freeMeshes	back to summary
private Array<Mesh> freeMeshes

usedMeshes	back to summary
private Array<Mesh> usedMeshes

Constructor Detail

TightMeshPool	back to summary
public TightMeshPool()

Method Detail

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

flush back to summary

flush	back to summary
public void flush() Implements com.badlogic.gdx.graphics.g3d.ModelCache.MeshPool.flush. Doc from com.badlogic.gdx.graphics.g3d.ModelCache.MeshPool.flush. Releases all previously obtained `Mesh`es using the the `obtain(VertexAttributes, int, int)` method. Annotations @Override

public void flush()

Implements com.badlogic.gdx.graphics.g3d.ModelCache.MeshPool.flush.

Doc from com.badlogic.gdx.graphics.g3d.ModelCache.MeshPool.flush.

Releases all previously obtained Meshes using the the obtain(VertexAttributes, int, int) method.

Annotations

@Override

obtain back to summary

public Mesh obtain(VertexAttributes vertexAttributes, int vertexCount, int indexCount)

Implements com.badlogic.gdx.graphics.g3d.ModelCache.MeshPool.obtain.

Doc from com.badlogic.gdx.graphics.g3d.ModelCache.MeshPool.obtain.

Will try to reuse or, when not possible to reuse, optionally create a Mesh that meets the specified criteria.

Annotations

@Override

public Class ModelCache

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Interface ModelCache.MeshPool

Method Summary

Method Detail

public Class ModelCache.SimpleMeshPool

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class ModelCache.Sorter

Constructor Summary

Method Summary

Constructor Detail

Method Detail

public Class ModelCache.TightMeshPool

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail