Package gaiasky.util.gdx

Class IntModelBatch

java.lang.Object

gaiasky.util.gdx.IntModelBatch

All Implemented Interfaces:

com.badlogic.gdx.utils.Disposable

public class IntModelBatch
extends Object
implements com.badlogic.gdx.utils.Disposable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	IntModelBatch.RenderablePool

Field Summary

Fields

Modifier and Type	Field	Description
protected com.badlogic.gdx.graphics.Camera	camera
protected final com.badlogic.gdx.graphics.g3d.utils.RenderContext	context	the RenderContext
protected final com.badlogic.gdx.utils.Array<IntRenderable>	renderables	list of Renderables to be rendered in the current batch
protected final IntModelBatch.RenderablePool	renderablesPool
protected final IntShaderProvider	shaderProvider	the IntShaderProvider, provides IntShader instances for IntRenderables
protected final IntRenderableSorter	sorter	the IntRenderableSorter

Constructor Summary

Constructors

Constructor	Description
IntModelBatch()	Construct a ModelBatch with the default implementation
IntModelBatch(com.badlogic.gdx.graphics.g3d.utils.RenderContext context)	Construct a ModelBatch, using this constructor makes you responsible for calling context.begin() and context.end() yourself.
IntModelBatch(com.badlogic.gdx.graphics.g3d.utils.RenderContext context, IntRenderableSorter sorter)	Construct a ModelBatch, using this constructor makes you responsible for calling context.begin() and context.end() yourself.
IntModelBatch(com.badlogic.gdx.graphics.g3d.utils.RenderContext context, IntShaderProvider shaderProvider)	Construct a ModelBatch, using this constructor makes you responsible for calling context.begin() and context.end() yourself.
IntModelBatch(com.badlogic.gdx.graphics.g3d.utils.RenderContext context, IntShaderProvider shaderProvider, IntRenderableSorter sorter)	Construct a ModelBatch, using this constructor makes you responsible for calling context.begin() and context.end() yourself.
IntModelBatch(IntShaderProvider shaderProvider)	Construct a ModelBatch
IntModelBatch(IntShaderProvider shaderProvider, IntRenderableSorter sorter)	Construct a ModelBatch
IntModelBatch(String vertexShaderCode, String fragmentShaderCode)	Construct a ModelBatch with the default implementation and the specified ubershader.

Method Summary

Modifier and Type	Method	Description
void	begin(com.badlogic.gdx.graphics.Camera cam)	Start rendering one or more IntRenderables.
void	cancel()	Cancels the current render operation without rendering anything.
void	dispose()
void	end()	End rendering one or more IntRenderables.
void	flush()	Flushes the batch, causing all IntRenderables in the batch to be rendered.
com.badlogic.gdx.graphics.Camera	getCamera()	Provides access to the current camera in between begin(Camera) and end().
IntRenderableSorter	getRenderableSorter()
com.badlogic.gdx.graphics.g3d.utils.RenderContext	getRenderContext()
IntShaderProvider	getShaderProvider()
boolean	ownsRenderContext()	Checks whether the RenderContext returned by getRenderContext() is owned and managed by this ModelBatch.
void	render(IntRenderable renderable)	Add a single IntRenderable to the batch.
void	render(IntRenderableProvider renderableProvider)	Calls RenderableProvider.getRenderables(Array, Pool) and adds all returned IntRenderable instances to the current batch to be rendered.
void	render(IntRenderableProvider renderableProvider, Environment environment)	Calls RenderableProvider.getRenderables(Array, Pool) and adds all returned IntRenderable instances to the current batch to be rendered.
void	render(IntRenderableProvider renderableProvider, Environment environment, IntShader shader)	Calls IntRenderableProvider.getRenderables(Array, Pool) and adds all returned IntRenderable instances to the current batch to be rendered.
void	render(IntRenderableProvider renderableProvider, IntShader shader)	Calls RenderableProvider.getRenderables(Array, Pool) and adds all returned IntRenderable instances to the current batch to be rendered.
<T extends IntRenderableProvider> void	render(Iterable<T> renderableProviders)	Calls RenderableProvider.getRenderables(Array, Pool) and adds all returned IntRenderable instances to the current batch to be rendered.
<T extends IntRenderableProvider> void	render(Iterable<T> renderableProviders, Environment environment)	Calls IntRenderableProvider.getRenderables(Array, Pool) and adds all returned IntRenderable instances to the current batch to be rendered.
<T extends IntRenderableProvider> void	render(Iterable<T> renderableProviders, Environment environment, IntShader shader)	Calls IntRenderableProvider.getRenderables(Array, Pool) and adds all returned IntRenderable instances to the current batch to be rendered.
<T extends IntRenderableProvider> void	render(Iterable<T> renderableProviders, IntShader shader)	Calls IntRenderableProvider.getRenderables(Array, Pool) and adds all returned IntRenderable instances to the current batch to be rendered.
void	setCamera(com.badlogic.gdx.graphics.Camera cam)	Change the camera in between begin(Camera) and end().

Methods inherited from class java.lang.Object

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

Field Details

renderablesPool

protected final IntModelBatch.RenderablePool renderablesPool

renderables

protected final com.badlogic.gdx.utils.Array<IntRenderable> renderables

list of Renderables to be rendered in the current batch

context

protected final com.badlogic.gdx.graphics.g3d.utils.RenderContext context

the RenderContext

shaderProvider

protected final IntShaderProvider shaderProvider

the IntShaderProvider, provides IntShader instances for IntRenderables

sorter

protected final IntRenderableSorter sorter

the IntRenderableSorter

camera

protected com.badlogic.gdx.graphics.Camera camera

Constructor Details

IntModelBatch

public IntModelBatch(com.badlogic.gdx.graphics.g3d.utils.RenderContext context,
 IntShaderProvider shaderProvider,
 IntRenderableSorter sorter)

Construct a ModelBatch, using this constructor makes you responsible for calling context.begin() and context.end() yourself.

Parameters:

context - The RenderContext to use.

shaderProvider - The IntShaderProvider to use, will be disposed when this ModelBatch is disposed.

sorter - The RenderableSorter to use.

IntModelBatch

public IntModelBatch(com.badlogic.gdx.graphics.g3d.utils.RenderContext context,
 IntShaderProvider shaderProvider)

Construct a ModelBatch, using this constructor makes you responsible for calling context.begin() and context.end() yourself.

Parameters:

context - The RenderContext to use.

shaderProvider - The IntShaderProvider to use, will be disposed when this ModelBatch is disposed.

IntModelBatch

public IntModelBatch(com.badlogic.gdx.graphics.g3d.utils.RenderContext context,
 IntRenderableSorter sorter)

Construct a ModelBatch, using this constructor makes you responsible for calling context.begin() and context.end() yourself.

Parameters:

context - The RenderContext to use.

sorter - The IntRenderableSorter to use.

IntModelBatch

public IntModelBatch(com.badlogic.gdx.graphics.g3d.utils.RenderContext context)

Construct a ModelBatch, using this constructor makes you responsible for calling context.begin() and context.end() yourself.

Parameters:

context - The RenderContext to use.

IntModelBatch

public IntModelBatch(IntShaderProvider shaderProvider)

Construct a ModelBatch

Parameters:

shaderProvider - The IntShaderProvider to use, will be disposed when this ModelBatch is disposed.

IntModelBatch

public IntModelBatch(IntShaderProvider shaderProvider,
 IntRenderableSorter sorter)

Construct a ModelBatch

Parameters:

shaderProvider - The IntShaderProvider to use, will be disposed when this ModelBatch is disposed.

sorter - The IntRenderableSorter to use.

IntModelBatch

public IntModelBatch(String vertexShaderCode,
 String fragmentShaderCode)

Construct a ModelBatch with the default implementation and the specified ubershader. See DefaultIntShader for more information about using a custom ubershader. Requires OpenGL ES 2.0.

Parameters:

vertexShaderCode - The vertex shader to use.

fragmentShaderCode - The fragment shader to use.

IntModelBatch

public IntModelBatch()

Construct a ModelBatch with the default implementation

Method Details

begin

public void begin(com.badlogic.gdx.graphics.Camera cam)

Start rendering one or more IntRenderables. Use one of the render() methods to provide the renderables. Must be followed by a call to end(). The OpenGL context must not be altered between begin(Camera) and end().

Parameters:

cam - The Camera to be used when rendering and sorting.

getCamera

public com.badlogic.gdx.graphics.Camera getCamera()

Provides access to the current camera in between begin(Camera) and end(). Do not change the camera's values. Use setCamera(Camera), if you need to change the camera.

Returns:

The current camera being used or null if called outside begin(Camera) and end().

setCamera

public void setCamera(com.badlogic.gdx.graphics.Camera cam)

Change the camera in between begin(Camera) and end(). This causes the batch to be flushed. Can only be called after the call to begin(Camera) and before the call to end().

Parameters:

cam - The new camera to use.

ownsRenderContext

public boolean ownsRenderContext()

Checks whether the RenderContext returned by getRenderContext() is owned and managed by this ModelBatch. When the RenderContext isn't owned by the ModelBatch, you are responsible for calling the RenderContext.begin() and RenderContext.end() methods yourself, as well as disposing the RenderContext.

Returns:

True if this ModelBatch owns the RenderContext, false otherwise.

getRenderContext

public com.badlogic.gdx.graphics.g3d.utils.RenderContext getRenderContext()

Returns:

the RenderContext used by this ModelBatch.

getShaderProvider

public IntShaderProvider getShaderProvider()

Returns:

the IntShaderProvider used by this ModelBatch.

getRenderableSorter

public IntRenderableSorter getRenderableSorter()

Returns:

the IntRenderableSorter used by this ModelBatch.

flush

public void flush()

Flushes the batch, causing all IntRenderables in the batch to be rendered. Can only be called after the call to begin(Camera) and before the call to end().

end

public void end()

End rendering one or more IntRenderables. Must be called after a call to begin(Camera). This will flush the batch, causing any renderables provided using one of the render() methods to be rendered. After a call to this method the OpenGL context can be altered again.

cancel

public void cancel()

Cancels the current render operation without rendering anything. To use in case of a crash.

render

public void render(IntRenderable renderable)

Add a single IntRenderable to the batch. The IntShaderProvider will be used to fetch a suitable IntShader. Can only be called after a call to begin(Camera) and before a call to end().

Parameters:

renderable - The IntRenderable to be added.

render

public void render(IntRenderableProvider renderableProvider)

Calls RenderableProvider.getRenderables(Array, Pool) and adds all returned IntRenderable instances to the current batch to be rendered. Can only be called after a call to begin(Camera) and before a call to end().

Parameters:

renderableProvider - the renderable provider

render

public <T extends IntRenderableProvider> void render(Iterable<T> renderableProviders)

Calls RenderableProvider.getRenderables(Array, Pool) and adds all returned IntRenderable instances to the current batch to be rendered. Can only be called after a call to begin(Camera) and before a call to end().

Parameters:

renderableProviders - one or more renderable providers

render

public void render(IntRenderableProvider renderableProvider,
 Environment environment)

Calls RenderableProvider.getRenderables(Array, Pool) and adds all returned IntRenderable instances to the current batch to be rendered. Any environment set on the returned renderables will be replaced with the given environment. Can only be called after a call to begin(Camera) and before a call to end().

Parameters:

renderableProvider - the renderable provider

environment - the Environment to use for the renderables

render

public <T extends IntRenderableProvider> void render(Iterable<T> renderableProviders,
 Environment environment)

Calls IntRenderableProvider.getRenderables(Array, Pool) and adds all returned IntRenderable instances to the current batch to be rendered. Any environment set on the returned renderables will be replaced with the given environment. Can only be called after a call to begin(Camera) and before a call to end().

Parameters:

renderableProviders - one or more renderable providers

environment - the Environment to use for the renderables

render

public void render(IntRenderableProvider renderableProvider,
 IntShader shader)

Calls RenderableProvider.getRenderables(Array, Pool) and adds all returned IntRenderable instances to the current batch to be rendered. Any shaders set on the returned renderables will be replaced with the given IntShader. Can only be called after a call to begin(Camera) and before a call to end().

Parameters:

renderableProvider - the renderable provider

shader - the shader to use for the renderables

render

public <T extends IntRenderableProvider> void render(Iterable<T> renderableProviders,
 IntShader shader)

Calls IntRenderableProvider.getRenderables(Array, Pool) and adds all returned IntRenderable instances to the current batch to be rendered. Any shaders set on the returned renderables will be replaced with the given IntShader. Can only be called after a call to begin(Camera) and before a call to end().

Parameters:

renderableProviders - one or more renderable providers

shader - the shader to use for the renderables

render

public void render(IntRenderableProvider renderableProvider,
 Environment environment,
 IntShader shader)

Calls IntRenderableProvider.getRenderables(Array, Pool) and adds all returned IntRenderable instances to the current batch to be rendered. Any environment set on the returned renderables will be replaced with the given environment. Any shaders set on the returned renderables will be replaced with the given IntShader. Can only be called after a call to begin(Camera) and before a call to end().

Parameters:

renderableProvider - the renderable provider

environment - the Environment to use for the renderables

shader - the shader to use for the renderables

render

public <T extends IntRenderableProvider> void render(Iterable<T> renderableProviders,
 Environment environment,
 IntShader shader)

Calls IntRenderableProvider.getRenderables(Array, Pool) and adds all returned IntRenderable instances to the current batch to be rendered. Any environment set on the returned renderables will be replaced with the given environment. Any shaders set on the returned renderables will be replaced with the given IntShader. Can only be called after a call to begin(Camera) and before a call to end().

Parameters:

renderableProviders - one or more renderable providers

environment - the Environment to use for the renderables

shader - the shader to use for the renderables

dispose

public void dispose()

Specified by:

dispose in interface com.badlogic.gdx.utils.Disposable