Package com.badlogic.gdx.graphics.g3d.particles.batches

Class BillboardParticleBatch

java.lang.Object

com.badlogic.gdx.graphics.g3d.particles.batches.BufferedParticleBatch<BillboardControllerRenderData>

com.badlogic.gdx.graphics.g3d.particles.batches.BillboardParticleBatch

All Implemented Interfaces:

ParticleBatch<BillboardControllerRenderData>, ResourceData.Configurable, RenderableProvider

public class BillboardParticleBatch
extends BufferedParticleBatch<BillboardControllerRenderData>

This class is used to render billboard particles.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BillboardParticleBatch.Config

Field Summary

Fields

Modifier and Type	Field	Description
protected BlendingAttribute	blendingAttribute
protected DepthTestAttribute	depthTestAttribute
protected static int	directionUsage
protected ParticleShader.AlignMode	mode
protected static int	sizeAndRotationUsage
protected Texture	texture
protected static Matrix3	TMP_M3
protected static Vector3	TMP_V1
protected static Vector3	TMP_V2
protected static Vector3	TMP_V3
protected static Vector3	TMP_V4
protected static Vector3	TMP_V5
protected static Vector3	TMP_V6
protected boolean	useGPU

Fields inherited from class com.badlogic.gdx.graphics.g3d.particles.batches.BufferedParticleBatch

bufferedParticlesCount, camera, currentCapacity, renderData, sorter

Constructor Summary

Constructors

Constructor	Description
BillboardParticleBatch()
BillboardParticleBatch(int capacity)
BillboardParticleBatch(ParticleShader.AlignMode mode, boolean useGPU, int capacity)
BillboardParticleBatch(ParticleShader.AlignMode mode, boolean useGPU, int capacity, BlendingAttribute blendingAttribute, DepthTestAttribute depthTestAttribute)	Create a new BillboardParticleBatch

Method Summary

Modifier and Type	Method	Description
void	allocParticlesData(int capacity)
protected Renderable	allocRenderable()
void	begin()	Must be called once before any drawing operation
protected void	flush(int[] offsets)	Sends the data to the gpu.
ParticleShader.AlignMode	getAlignMode()
BlendingAttribute	getBlendingAttribute()
void	getRenderables(Array<Renderable> renderables, Pool<Renderable> pool)	Returns Renderable instances.
protected Shader	getShader(Renderable renderable)
Texture	getTexture()
boolean	isUseGPU()
void	load(AssetManager manager, ResourceData resources)
void	save(AssetManager manager, ResourceData resources)
void	setAlignMode(ParticleShader.AlignMode mode)	Sets the current align mode.
void	setTexture(Texture texture)
void	setUseGpu(boolean useGPU)	Sets the current align mode.
void	setVertexData()	Sets vertex attributes and size

Methods inherited from class com.badlogic.gdx.graphics.g3d.particles.batches.BufferedParticleBatch

draw, end, ensureCapacity, getBufferedCount, getSorter, resetCapacity, setCamera, setSorter

Methods inherited from class java.lang.Object

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

Field Detail

TMP_V1

protected static final Vector3 TMP_V1

TMP_V2

protected static final Vector3 TMP_V2

TMP_V3

protected static final Vector3 TMP_V3

TMP_V4

protected static final Vector3 TMP_V4

TMP_V5

protected static final Vector3 TMP_V5

TMP_V6

protected static final Vector3 TMP_V6

TMP_M3

protected static final Matrix3 TMP_M3

sizeAndRotationUsage

protected static final int sizeAndRotationUsage

See Also:

Constant Field Values

directionUsage

protected static final int directionUsage

See Also:

Constant Field Values

useGPU

protected boolean useGPU

mode

protected ParticleShader.AlignMode mode

texture

protected Texture texture

blendingAttribute

protected BlendingAttribute blendingAttribute

depthTestAttribute

protected DepthTestAttribute depthTestAttribute

Constructor Detail

BillboardParticleBatch

public BillboardParticleBatch(ParticleShader.AlignMode mode,
                              boolean useGPU,
                              int capacity,
                              BlendingAttribute blendingAttribute,
                              DepthTestAttribute depthTestAttribute)

Create a new BillboardParticleBatch

Parameters:

mode -

useGPU - Allow to use GPU instead of CPU

capacity - Max particle displayed

blendingAttribute - Blending attribute used by the batch

depthTestAttribute - DepthTest attribute used by the batch

BillboardParticleBatch

public BillboardParticleBatch(ParticleShader.AlignMode mode,
                              boolean useGPU,
                              int capacity)

BillboardParticleBatch

public BillboardParticleBatch()

BillboardParticleBatch

public BillboardParticleBatch(int capacity)

Method Detail

allocParticlesData

public void allocParticlesData(int capacity)

Specified by:

allocParticlesData in class BufferedParticleBatch<BillboardControllerRenderData>

allocRenderable

protected Renderable allocRenderable()

getShader

protected Shader getShader(Renderable renderable)

setVertexData

public void setVertexData()

Sets vertex attributes and size

setAlignMode

public void setAlignMode(ParticleShader.AlignMode mode)

Sets the current align mode. It will reallocate internal data, use only when necessary.

getAlignMode

public ParticleShader.AlignMode getAlignMode()

setUseGpu

public void setUseGpu(boolean useGPU)

Sets the current align mode. It will reallocate internal data, use only when necessary.

isUseGPU

public boolean isUseGPU()

setTexture

public void setTexture(Texture texture)

getTexture

public Texture getTexture()

getBlendingAttribute

public BlendingAttribute getBlendingAttribute()

begin

public void begin()

Description copied from interface: ParticleBatch

Must be called once before any drawing operation

Specified by:

begin in interface ParticleBatch<BillboardControllerRenderData>

Overrides:

begin in class BufferedParticleBatch<BillboardControllerRenderData>

flush

protected void flush(int[] offsets)

Description copied from class: BufferedParticleBatch

Sends the data to the gpu. This method must use the calculated offsets to build the particles meshes. The offsets represent the position at which a particle should be placed into the vertex array.

Specified by:

flush in class BufferedParticleBatch<BillboardControllerRenderData>

Parameters:

offsets - the calculated offsets

getRenderables

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

Description copied from interface: RenderableProvider

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.

Parameters:

renderables - the output array

pool - the pool to obtain Renderables from

save

public void save(AssetManager manager,
                 ResourceData resources)

load

public void load(AssetManager manager,
                 ResourceData resources)