APIdia Launch Partner
Top Description Inners Fields Constructors Methods
com.badlogic.gdx.graphics.g3d.particles.emitters

public Class RegularEmitter

extends Emitter
implements Serializable
Class Inheritance
All Implemented Interfaces
com.badlogic.gdx.utils.Json.Serializable
Imports
com.badlogic.gdx.graphics.g3d.particles.ParallelArray.FloatChannel, .ParticleChannels, .ParticleControllerComponent, com.badlogic.gdx.graphics.g3d.particles.values.RangedNumericValue, .ScaledNumericValue, com.badlogic.gdx.utils.Json, .JsonValue

It's a generic use Emitter which fits most of the particles simulation scenarios.
Author
Inferno

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
RegularEmitter.EmissionMode

Possible emission modes.

Field Summary

Modifier and TypeField and Description
private boolean
protected float
protected float
public RangedNumericValue
protected float
protected float
public RangedNumericValue
protected int
protected int
protected int
private RegularEmitter.EmissionMode
public ScaledNumericValue
protected int
private ParallelArray.FloatChannel
protected int
protected int
protected int
public ScaledNumericValue
public ScaledNumericValue
Inherited from com.badlogic.gdx.graphics.g3d.particles.emitters.Emitter:
maxParticleCountminParticleCountpercent

Constructor Summary

AccessConstructor and Description
public
public

Method Summary

Modifier and TypeMethod and Description
public void
activateParticles(int startIndex, int count)

Overrides com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.activateParticles.

Called to initialize new emitted particles.

private void
addParticles(int count)

public void
allocateChannels()

Overrides com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.allocateChannels.

Called during initialization to allocate additional particles channels

public ParticleControllerComponent
public RangedNumericValue
public RangedNumericValue
public ScaledNumericValue
public RegularEmitter.EmissionMode

Returns:

Current emission mode.
getEmissionMode
()

Gets current emission mode.

public ScaledNumericValue
public ScaledNumericValue
public float
public void
init()

Overrides com.badlogic.gdx.graphics.g3d.particles.emitters.Emitter.init.

Called once during intialization

public boolean
public boolean
public void
public void
public void
setContinuous(boolean continuous)

public void
setEmissionMode(RegularEmitter.EmissionMode
Emission mode to set.
emissionMode
)

Sets emission mode.

public void
start()

Overrides com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.start.

Called at the start of the simulation.

public void
update()

Overrides com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.update.

Called to execute the component behavior.

public void
Inherited from com.badlogic.gdx.graphics.g3d.particles.emitters.Emitter:
endgetMaxParticleCountgetMinParticleCountsetsetMaxParticleCountsetMinParticleCountsetParticleCount

Field Detail

continuousback to summary
private boolean continuous
delayback to summary
protected float delay
delayTimerback to summary
protected float delayTimer
delayValueback to summary
public RangedNumericValue delayValue
durationback to summary
protected float duration
durationTimerback to summary
protected float durationTimer
durationValueback to summary
public RangedNumericValue durationValue
emissionback to summary
protected int emission
emissionDeltaback to summary
protected int emissionDelta
emissionDiffback to summary
protected int emissionDiff
emissionModeback to summary
private RegularEmitter.EmissionMode emissionMode
emissionValueback to summary
public ScaledNumericValue emissionValue
lifeback to summary
protected int life
lifeChannelback to summary
private ParallelArray.FloatChannel lifeChannel
lifeDiffback to summary
protected int lifeDiff
lifeOffsetback to summary
protected int lifeOffset
lifeOffsetDiffback to summary
protected int lifeOffsetDiff
lifeOffsetValueback to summary
public ScaledNumericValue lifeOffsetValue
lifeValueback to summary
public ScaledNumericValue lifeValue

Constructor Detail

RegularEmitterback to summary
public RegularEmitter()
RegularEmitterback to summary
public RegularEmitter(RegularEmitter regularEmitter)

Method Detail

activateParticlesback to summary
public void activateParticles(int startIndex, int count)

Overrides com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.activateParticles.

Doc from com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.activateParticles.

Called to initialize new emitted particles.

addParticlesback to summary
private void addParticles(int count)
allocateChannelsback to summary
public void allocateChannels()

Overrides com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.allocateChannels.

Doc from com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.allocateChannels.

Called during initialization to allocate additional particles channels

Annotations
@Override
copyback to summary
public ParticleControllerComponent copy()

Implements abstract com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.copy.

Annotations
@Override
getDelayback to summary
public RangedNumericValue getDelay()
getDurationback to summary
public RangedNumericValue getDuration()
getEmissionback to summary
public ScaledNumericValue getEmission()
getEmissionModeback to summary
public RegularEmitter.EmissionMode getEmissionMode()

Gets current emission mode.

Returns:RegularEmitter.EmissionMode

Current emission mode.

getLifeback to summary
public ScaledNumericValue getLife()
getLifeOffsetback to summary
public ScaledNumericValue getLifeOffset()
getPercentCompleteback to summary
public float getPercentComplete()
initback to summary
public void init()

Overrides com.badlogic.gdx.graphics.g3d.particles.emitters.Emitter.init.

Doc from com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.init.

Called once during intialization

isCompleteback to summary
public boolean isComplete()

Overrides com.badlogic.gdx.graphics.g3d.particles.emitters.Emitter.isComplete.

Annotations
@Override
isContinuousback to summary
public boolean isContinuous()
readback to summary
public void read(Json json, JsonValue jsonData)

Overrides com.badlogic.gdx.graphics.g3d.particles.emitters.Emitter.read.

Implements com.badlogic.gdx.utils.Json.Serializable.read.

Annotations
@Override
setback to summary
public void set(RegularEmitter emitter)
setContinuousback to summary
public void setContinuous(boolean continuous)
setEmissionModeback to summary
public void setEmissionMode(RegularEmitter.EmissionMode emissionMode)

Sets emission mode. Emission mode does not affect already emitted particles.

Parameters
emissionMode:RegularEmitter.EmissionMode

Emission mode to set.

startback to summary
public void start()

Overrides com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.start.

Doc from com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.start.

Called at the start of the simulation.

Annotations
@Override
updateback to summary
public void update()

Overrides com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.update.

Doc from com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.update.

Called to execute the component behavior.

writeback to summary
public void write(Json json)

Overrides com.badlogic.gdx.graphics.g3d.particles.emitters.Emitter.write.

Implements com.badlogic.gdx.utils.Json.Serializable.write.

Annotations
@Override
com.badlogic.gdx.graphics.g3d.particles.emitters back to summary

public final Enum RegularEmitter.EmissionMode

extends Enum<RegularEmitter.EmissionMode>
Class Inheritance

Possible emission modes. Emission mode does not affect already emitted particles.

Field Summary

Modifier and TypeField and Description
public static final RegularEmitter.EmissionMode
Disabled

Prevents new particle emission.

public static final RegularEmitter.EmissionMode
Enabled

New particles can be emitted.

public static final RegularEmitter.EmissionMode
EnabledUntilCycleEnd

Only valid for continuous emitters.

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public static RegularEmitter.EmissionMode
public static RegularEmitter.EmissionMode[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

Disabledback to summary
public static final RegularEmitter.EmissionMode Disabled

Prevents new particle emission.

Enabledback to summary
public static final RegularEmitter.EmissionMode Enabled

New particles can be emitted.

EnabledUntilCycleEndback to summary
public static final RegularEmitter.EmissionMode EnabledUntilCycleEnd

Only valid for continuous emitters. It will only emit particles until the end of the effect duration. After that emission cycle will not be restarted.

Constructor Detail

EmissionModeback to summary
private EmissionMode()

Method Detail

valueOfback to summary
public static RegularEmitter.EmissionMode valueOf(String name)
valuesback to summary
public static RegularEmitter.EmissionMode[] values()