libGDX 1.14.2 · com.badlogic.gdx.graphics.g2d.ParticleEffect

Modifier and Type	Field and Description
private BoundingBox	bounds
private final Array<ParticleEmitter>	emitters
protected float	motionScale
private boolean	ownsTexture
protected float	xSizeScale
protected float	ySizeScale

Access	Constructor and Description
public	ParticleEffect()
public	ParticleEffect(ParticleEffect effect)

Method Summary

Modifier and Type	Method and Description
public void	allowCompletion()
public void	dispose() Implements com.badlogic.gdx.utils.Disposable.dispose. Disposes the texture for each sprite for each ParticleEmitter.
public void	draw(Batch spriteBatch)
public void	draw(Batch spriteBatch, float delta)
public ParticleEmitter	findEmitter(String name) Returns the emitter with the specified name, or null.
public void	flipY()
public BoundingBox	getBoundingBox() Returns the bounding box for all active particles.
public Array<ParticleEmitter>	getEmitters()
public boolean	isComplete()
public void	load(FileHandle effectFile, FileHandle imagesDir)
public void	load(FileHandle effectFile, TextureAtlas atlas)
public void	load(FileHandle effectFile, TextureAtlas atlas, String atlasPrefix)
public void	loadEmitterImages(TextureAtlas atlas)
public void	loadEmitterImages(TextureAtlas atlas, String atlasPrefix)
public void	loadEmitterImages(FileHandle imagesDir)
public void	loadEmitters(FileHandle effectFile)
protected Texture	loadTexture(FileHandle file)
protected ParticleEmitter	newEmitter(BufferedReader reader)
protected ParticleEmitter	newEmitter(ParticleEmitter emitter)
public void	preAllocateParticles() Allocates all emitters particles.
public void	reset() Resets the effect so it can be started again like a new effect.
public void	reset(boolean Whether to restore the original size and motion parameters if they were scaled. Repeated scaling and resetting may introduce error. resetScaling) Resets the effect so it can be started again like a new effect.
public void	reset(boolean Whether to restore the original size and motion parameters if they were scaled. Repeated scaling and resetting may introduce error. resetScaling, boolean Whether to start the effect after resetting. start) Resets the effect so it can be started again like a new effect.
public void	save(Writer output)
public void	scaleEffect(float scaleFactor) Permanently scales all the size and motion parameters of all the emitters in this effect.
public void	scaleEffect(float scaleFactor, float motionScaleFactor) Permanently scales all the size and motion parameters of all the emitters in this effect.
public void	scaleEffect(float xSizeScaleFactor, float ySizeScaleFactor, float motionScaleFactor) Permanently scales all the size and motion parameters of all the emitters in this effect.
public void	setDuration(int duration)
public void	setEmittersCleanUpBlendFunction(boolean cleanUpBlendFunction) Sets the `cleansUpBlendFunction` parameter on all `ParticleEmitters` currently in this ParticleEffect.
public void	setFlip(boolean flipX, boolean flipY)
public void	setPosition(float x, float y)
public void	start()
public void	update(float delta)

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

bounds	back to summary
private BoundingBox bounds

emitters	back to summary
private final Array<ParticleEmitter> emitters

motionScale	back to summary
protected float motionScale

ownsTexture	back to summary
private boolean ownsTexture

xSizeScale	back to summary
protected float xSizeScale

ySizeScale	back to summary
protected float ySizeScale

ParticleEffect	back to summary
public ParticleEffect()

ParticleEffect	back to summary
public ParticleEffect(ParticleEffect effect)

Method Detail

allowCompletion	back to summary
public void allowCompletion()

dispose	back to summary
public void dispose() Implements com.badlogic.gdx.utils.Disposable.dispose. Disposes the texture for each sprite for each ParticleEmitter.

dispose

back to summary

public void dispose()

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

Disposes the texture for each sprite for each ParticleEmitter.

draw	back to summary
public void draw(Batch spriteBatch)

draw	back to summary
public void draw(Batch spriteBatch, float delta)

findEmitter	back to summary
public ParticleEmitter findEmitter(String name) Returns the emitter with the specified name, or null.

flipY	back to summary
public void flipY()

getBoundingBox	back to summary
public BoundingBox getBoundingBox() Returns the bounding box for all active particles. z axis will always be zero.

getEmitters	back to summary
public Array<ParticleEmitter> getEmitters()

isComplete	back to summary
public boolean isComplete()

load	back to summary
public void load(FileHandle effectFile, FileHandle imagesDir)

load	back to summary
public void load(FileHandle effectFile, TextureAtlas atlas)

load	back to summary
public void load(FileHandle effectFile, TextureAtlas atlas, String atlasPrefix)

loadEmitterImages	back to summary
public void loadEmitterImages(TextureAtlas atlas)

loadEmitterImages	back to summary
public void loadEmitterImages(TextureAtlas atlas, String atlasPrefix)

loadEmitterImages	back to summary
public void loadEmitterImages(FileHandle imagesDir)

loadEmitters	back to summary
public void loadEmitters(FileHandle effectFile)

loadTexture	back to summary
protected Texture loadTexture(FileHandle file)

newEmitter	back to summary
protected ParticleEmitter newEmitter(BufferedReader reader) throws IOException

newEmitter	back to summary
protected ParticleEmitter newEmitter(ParticleEmitter emitter)

preAllocateParticles	back to summary
public void preAllocateParticles() Allocates all emitters particles. See `com.badlogic.gdx.graphics.g2d.ParticleEmitter#preAllocateParticles()`

reset	back to summary
public void reset() Resets the effect so it can be started again like a new effect. Any changes to scale are reverted. See `reset(boolean)`.

reset	back to summary
public void reset(boolean resetScaling) Resets the effect so it can be started again like a new effect. Parameters resetScaling:boolean Whether to restore the original size and motion parameters if they were scaled. Repeated scaling and resetting may introduce error.

reset

back to summary

public void reset(boolean resetScaling)

Resets the effect so it can be started again like a new effect.

Parameters

resetScaling:boolean: Whether to restore the original size and motion parameters if they were scaled. Repeated scaling and resetting may introduce error.

reset	back to summary
public void reset(boolean resetScaling, boolean start) Resets the effect so it can be started again like a new effect. Parameters resetScaling:boolean Whether to restore the original size and motion parameters if they were scaled. Repeated scaling and resetting may introduce error. start:boolean Whether to start the effect after resetting.

reset

back to summary

public void reset(boolean resetScaling, boolean start)

Resets the effect so it can be started again like a new effect.

Parameters

resetScaling:boolean: Whether to restore the original size and motion parameters if they were scaled. Repeated scaling and resetting may introduce error.
start:boolean: Whether to start the effect after resetting.

save	back to summary
public void save(Writer output) throws IOException

scaleEffect	back to summary
public void scaleEffect(float scaleFactor) Permanently scales all the size and motion parameters of all the emitters in this effect. If this effect originated from a `ParticleEffectPool`, the scale will be reset when it is returned to the pool.

scaleEffect	back to summary
public void scaleEffect(float scaleFactor, float motionScaleFactor) Permanently scales all the size and motion parameters of all the emitters in this effect. If this effect originated from a `ParticleEffectPool`, the scale will be reset when it is returned to the pool.

scaleEffect	back to summary
public void scaleEffect(float xSizeScaleFactor, float ySizeScaleFactor, float motionScaleFactor) Permanently scales all the size and motion parameters of all the emitters in this effect. If this effect originated from a `ParticleEffectPool`, the scale will be reset when it is returned to the pool.

setDuration	back to summary
public void setDuration(int duration)

setEmittersCleanUpBlendFunction back to summary

setEmittersCleanUpBlendFunction	back to summary
public void setEmittersCleanUpBlendFunction(boolean cleanUpBlendFunction) Sets the `cleansUpBlendFunction` parameter on all `ParticleEmitters` currently in this ParticleEffect. Important Note If set to false and if the next object to use this Batch expects alpha blending, you are responsible for setting the Batch's blend function to (GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA) before that next object is drawn.

public void setEmittersCleanUpBlendFunction(boolean cleanUpBlendFunction)

Sets the cleansUpBlendFunction parameter on all ParticleEmitters currently in this ParticleEffect.

Important Note

If set to false and if the next object to use this Batch expects alpha blending, you are responsible for setting the Batch's blend function to (GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA) before that next object is drawn.

setFlip	back to summary
public void setFlip(boolean flipX, boolean flipY)

setPosition	back to summary
public void setPosition(float x, float y)

start	back to summary
public void start()

update	back to summary
public void update(float delta)

public Class ParticleEffect

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail