libgdx API

com.badlogic.gdx.graphics.g2d
Class ParticleEmitter

java.lang.Object
  extended by com.badlogic.gdx.graphics.g2d.ParticleEmitter
Direct Known Subclasses:
ParticleEmitterBox2D

public class ParticleEmitter
extends java.lang.Object


Nested Class Summary
static class ParticleEmitter.GradientColorValue
           
static class ParticleEmitter.NumericValue
           
static class ParticleEmitter.ParticleValue
           
static class ParticleEmitter.RangedNumericValue
           
static class ParticleEmitter.ScaledNumericValue
           
static class ParticleEmitter.SpawnEllipseSide
           
static class ParticleEmitter.SpawnShape
           
static class ParticleEmitter.SpawnShapeValue
           
 
Field Summary
 float duration
           
 float durationTimer
           
 
Constructor Summary
ParticleEmitter()
           
ParticleEmitter(java.io.BufferedReader reader)
           
ParticleEmitter(ParticleEmitter emitter)
           
 
Method Summary
 void addParticle()
           
 void addParticles(int count)
           
 void allowCompletion()
          Ignores the continuous setting until the emitter is started again.
 void draw(SpriteBatch spriteBatch)
           
 void draw(SpriteBatch spriteBatch, float delta)
          Updates and draws the particles.
 int getActiveCount()
           
 ParticleEmitter.ScaledNumericValue getAngle()
           
 ParticleEmitter.RangedNumericValue getDelay()
           
 ParticleEmitter.RangedNumericValue getDuration()
           
 ParticleEmitter.ScaledNumericValue getEmission()
           
 ParticleEmitter.ScaledNumericValue getGravity()
           
 java.lang.String getImagePath()
           
 ParticleEmitter.ScaledNumericValue getLife()
           
 ParticleEmitter.ScaledNumericValue getLifeOffset()
           
 int getMaxParticleCount()
           
 int getMinParticleCount()
           
 java.lang.String getName()
           
 float getPercentComplete()
           
 ParticleEmitter.ScaledNumericValue getRotation()
           
 ParticleEmitter.ScaledNumericValue getScale()
           
 ParticleEmitter.ScaledNumericValue getSpawnHeight()
           
 ParticleEmitter.SpawnShapeValue getSpawnShape()
           
 ParticleEmitter.ScaledNumericValue getSpawnWidth()
           
 Sprite getSprite()
           
 ParticleEmitter.GradientColorValue getTint()
           
 ParticleEmitter.ScaledNumericValue getTransparency()
           
 ParticleEmitter.ScaledNumericValue getVelocity()
           
 ParticleEmitter.ScaledNumericValue getWind()
           
 float getX()
           
 ParticleEmitter.RangedNumericValue getXOffsetValue()
           
 float getY()
           
 ParticleEmitter.RangedNumericValue getYOffsetValue()
           
 boolean isAdditive()
           
 boolean isAligned()
           
 boolean isAttached()
           
 boolean isBehind()
           
 boolean isComplete()
           
 boolean isContinuous()
           
 void load(java.io.BufferedReader reader)
           
protected  com.badlogic.gdx.graphics.g2d.ParticleEmitter.Particle newParticle(Sprite sprite)
           
 void reset()
           
 void save(java.io.Writer output)
           
 void setAdditive(boolean additive)
           
 void setAligned(boolean aligned)
           
 void setAttached(boolean attached)
           
 void setBehind(boolean behind)
           
 void setContinuous(boolean continuous)
           
 void setFlip(boolean flipX, boolean flipY)
           
 void setImagePath(java.lang.String imagePath)
           
 void setMaxParticleCount(int maxParticleCount)
           
 void setMinParticleCount(int minParticleCount)
           
 void setName(java.lang.String name)
           
 void setPosition(float x, float y)
           
 void setSprite(Sprite sprite)
           
 void start()
           
 void update(float delta)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

duration

public float duration

durationTimer

public float durationTimer
Constructor Detail

ParticleEmitter

public ParticleEmitter()

ParticleEmitter

public ParticleEmitter(java.io.BufferedReader reader)
                throws java.io.IOException
Throws:
java.io.IOException

ParticleEmitter

public ParticleEmitter(ParticleEmitter emitter)
Method Detail

setMaxParticleCount

public void setMaxParticleCount(int maxParticleCount)

addParticle

public void addParticle()

addParticles

public void addParticles(int count)

update

public void update(float delta)

draw

public void draw(SpriteBatch spriteBatch)

draw

public void draw(SpriteBatch spriteBatch,
                 float delta)
Updates and draws the particles. This is slightly more efficient than calling update(float) and draw(SpriteBatch) separately.


start

public void start()

reset

public void reset()

newParticle

protected com.badlogic.gdx.graphics.g2d.ParticleEmitter.Particle newParticle(Sprite sprite)

setPosition

public void setPosition(float x,
                        float y)

setSprite

public void setSprite(Sprite sprite)

allowCompletion

public void allowCompletion()
Ignores the continuous setting until the emitter is started again. This allows the emitter to stop smoothly.


getSprite

public Sprite getSprite()

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

getLife

public ParticleEmitter.ScaledNumericValue getLife()

getScale

public ParticleEmitter.ScaledNumericValue getScale()

getRotation

public ParticleEmitter.ScaledNumericValue getRotation()

getTint

public ParticleEmitter.GradientColorValue getTint()

getVelocity

public ParticleEmitter.ScaledNumericValue getVelocity()

getWind

public ParticleEmitter.ScaledNumericValue getWind()

getGravity

public ParticleEmitter.ScaledNumericValue getGravity()

getAngle

public ParticleEmitter.ScaledNumericValue getAngle()

getEmission

public ParticleEmitter.ScaledNumericValue getEmission()

getTransparency

public ParticleEmitter.ScaledNumericValue getTransparency()

getDuration

public ParticleEmitter.RangedNumericValue getDuration()

getDelay

public ParticleEmitter.RangedNumericValue getDelay()

getLifeOffset

public ParticleEmitter.ScaledNumericValue getLifeOffset()

getXOffsetValue

public ParticleEmitter.RangedNumericValue getXOffsetValue()

getYOffsetValue

public ParticleEmitter.RangedNumericValue getYOffsetValue()

getSpawnWidth

public ParticleEmitter.ScaledNumericValue getSpawnWidth()

getSpawnHeight

public ParticleEmitter.ScaledNumericValue getSpawnHeight()

getSpawnShape

public ParticleEmitter.SpawnShapeValue getSpawnShape()

isAttached

public boolean isAttached()

setAttached

public void setAttached(boolean attached)

isContinuous

public boolean isContinuous()

setContinuous

public void setContinuous(boolean continuous)

isAligned

public boolean isAligned()

setAligned

public void setAligned(boolean aligned)

isAdditive

public boolean isAdditive()

setAdditive

public void setAdditive(boolean additive)

isBehind

public boolean isBehind()

setBehind

public void setBehind(boolean behind)

getMinParticleCount

public int getMinParticleCount()

setMinParticleCount

public void setMinParticleCount(int minParticleCount)

getMaxParticleCount

public int getMaxParticleCount()

isComplete

public boolean isComplete()

getPercentComplete

public float getPercentComplete()

getX

public float getX()

getY

public float getY()

getActiveCount

public int getActiveCount()

getImagePath

public java.lang.String getImagePath()

setImagePath

public void setImagePath(java.lang.String imagePath)

setFlip

public void setFlip(boolean flipX,
                    boolean flipY)

save

public void save(java.io.Writer output)
          throws java.io.IOException
Throws:
java.io.IOException

load

public void load(java.io.BufferedReader reader)
          throws java.io.IOException
Throws:
java.io.IOException

libgdx API

Copyright 2010 Mario Zechner (contact@badlogicgames.com), Nathan Sweet (admin@esotericsoftware.com)