RegularEmitter (libgdx API)

java.lang.Object
- com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent
- - com.badlogic.gdx.graphics.g3d.particles.emitters.Emitter
  - - com.badlogic.gdx.graphics.g3d.particles.emitters.RegularEmitter

All Implemented Interfaces:

ResourceData.Configurable, Disposable, Json.Serializable
```
public class RegularEmitter
extends Emitter
implements Json.Serializable
```
It's a generic use Emitter which fits most of the particles simulation scenarios.

Author:

Inferno

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class RegularEmitter.EmissionMode
Possible emission modes.

Nested Classes
Modifier and Type	Class and Description
`static class`	`RegularEmitter.EmissionMode` Possible emission modes.

Field Summary

Fields
Modifier and Type	Field and Description
`protected float`	`delay`
`protected float`	`delayTimer`
`RangedNumericValue`	`delayValue`
`protected float`	`duration`
`protected float`	`durationTimer`
`RangedNumericValue`	`durationValue`
`protected int`	`emission`
`protected int`	`emissionDelta`
`protected int`	`emissionDiff`
`ScaledNumericValue`	`emissionValue`
`protected int`	`life`
`protected int`	`lifeDiff`
`protected int`	`lifeOffset`
`protected int`	`lifeOffsetDiff`
`ScaledNumericValue`	`lifeOffsetValue`
`ScaledNumericValue`	`lifeValue`

Fields inherited from class com.badlogic.gdx.graphics.g3d.particles.emitters.Emitter
maxParticleCount, minParticleCount, percent

Fields inherited from class com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent
controller, TMP_M3, TMP_M4, TMP_Q, TMP_Q2, TMP_V1, TMP_V2, TMP_V3, TMP_V4, TMP_V5, TMP_V6

Constructor Summary

Constructors
Constructor and Description

RegularEmitter()

RegularEmitter(RegularEmitter regularEmitter)

Constructors
Constructor and Description
`RegularEmitter()`
`RegularEmitter(RegularEmitter regularEmitter)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`activateParticles(int startIndex, int count)` Called to initialize new emitted particles.
`void`	`allocateChannels()` Called during initialization to allocate additional particles channels
`ParticleControllerComponent`	`copy()`
`RangedNumericValue`	`getDelay()`
`RangedNumericValue`	`getDuration()`
`ScaledNumericValue`	`getEmission()`
`RegularEmitter.EmissionMode`	`getEmissionMode()` Gets current emission mode.
`ScaledNumericValue`	`getLife()`
`ScaledNumericValue`	`getLifeOffset()`
`float`	`getPercentComplete()`
`void`	`init()` Called once during intialization
`boolean`	`isComplete()`
`boolean`	`isContinuous()`
`void`	`read(Json json, JsonValue jsonData)`
`void`	`set(RegularEmitter emitter)`
`void`	`setContinuous(boolean continuous)`
`void`	`setEmissionMode(RegularEmitter.EmissionMode emissionMode)` Sets emission mode.
`void`	`start()` Called at the start of the simulation.
`void`	`update()` Called to execute the component behavior.
`void`	`write(Json json)`

Methods inherited from class com.badlogic.gdx.graphics.g3d.particles.emitters.Emitter
end, getMaxParticleCount, getMinParticleCount, set, setMaxParticleCount, setMinParticleCount, setParticleCount

Methods inherited from class com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent
dispose, killParticles, load, save, set

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - delayValue
```
public RangedNumericValue delayValue
```
  - durationValue
```
public RangedNumericValue durationValue
```
  - lifeOffsetValue
```
public ScaledNumericValue lifeOffsetValue
```
  - lifeValue
```
public ScaledNumericValue lifeValue
```
  - emissionValue
```
public ScaledNumericValue emissionValue
```
  - emission
```
protected int emission
```
  - emissionDiff
```
protected int emissionDiff
```
  - emissionDelta
```
protected int emissionDelta
```
  - lifeOffset
```
protected int lifeOffset
```
  - lifeOffsetDiff
```
protected int lifeOffsetDiff
```
  - life
```
protected int life
```
  - lifeDiff
```
protected int lifeDiff
```
  - duration
```
protected float duration
```
  - delay
```
protected float delay
```
  - durationTimer
```
protected float durationTimer
```
  - delayTimer
```
protected float delayTimer
```
- Constructor Detail
  - RegularEmitter
```
public RegularEmitter()
```
  - RegularEmitter
```
public RegularEmitter(RegularEmitter regularEmitter)
```
- Method Detail
  - allocateChannels
```
public void allocateChannels()
```
    Description copied from class: ParticleControllerComponent
    
    Called during initialization to allocate additional particles channels
    
    Overrides:
    
    allocateChannels in class ParticleControllerComponent
  - start
```
public void start()
```
    Description copied from class: ParticleControllerComponent
    
    Called at the start of the simulation.
    
    Overrides:
    
    start in class ParticleControllerComponent
  - init
```
public void init()
```
    Description copied from class: ParticleControllerComponent
    
    Called once during intialization
    
    Overrides:
    
    init in class Emitter
  - activateParticles
```
public void activateParticles(int startIndex,
                              int count)
```
    Description copied from class: ParticleControllerComponent
    
    Called to initialize new emitted particles.
    
    Overrides:
    
    activateParticles in class ParticleControllerComponent
  - update
```
public void update()
```
    Description copied from class: ParticleControllerComponent
    
    Called to execute the component behavior.
    
    Overrides:
    
    update in class ParticleControllerComponent
  - getLife
```
public ScaledNumericValue getLife()
```
  - getEmission
```
public ScaledNumericValue getEmission()
```
  - getDuration
```
public RangedNumericValue getDuration()
```
  - getDelay
```
public RangedNumericValue getDelay()
```
  - getLifeOffset
```
public ScaledNumericValue getLifeOffset()
```
  - isContinuous
```
public boolean isContinuous()
```
  - setContinuous
```
public void setContinuous(boolean continuous)
```
  - getEmissionMode
```
public RegularEmitter.EmissionMode getEmissionMode()
```
    Gets current emission mode.
    
    Returns:
    
    Current emission mode.
  - setEmissionMode
```
public void setEmissionMode(RegularEmitter.EmissionMode emissionMode)
```
    Sets emission mode. Emission mode does not affect already emitted particles.
    
    Parameters:
    
    emissionMode - Emission mode to set.
  - isComplete
```
public boolean isComplete()
```
    Overrides:
    
    isComplete in class Emitter
  - getPercentComplete
```
public float getPercentComplete()
```
  - set
```
public void set(RegularEmitter emitter)
```
  - copy
```
public ParticleControllerComponent copy()
```
    Specified by:
    
    copy in class ParticleControllerComponent
  - write
```
public void write(Json json)
```
    Specified by:
    
    write in interface Json.Serializable
    
    Overrides:
    
    write in class Emitter
  - read
```
public void read(Json json,
                 JsonValue jsonData)
```
    Specified by:
    
    read in interface Json.Serializable
    
    Overrides:
    
    read in class Emitter

Class RegularEmitter

Nested Class Summary

Field Summary

Fields inherited from class com.badlogic.gdx.graphics.g3d.particles.emitters.Emitter

Fields inherited from class com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent

Constructor Summary

Method Summary

Methods inherited from class com.badlogic.gdx.graphics.g3d.particles.emitters.Emitter

Methods inherited from class com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent

Methods inherited from class java.lang.Object

Field Detail

delayValue

durationValue

lifeOffsetValue

lifeValue

emissionValue

emission

emissionDiff

emissionDelta

lifeOffset

lifeOffsetDiff

life

lifeDiff

duration

delay

durationTimer

delayTimer

Constructor Detail

RegularEmitter

RegularEmitter

Method Detail

allocateChannels

start

init

activateParticles

update

getLife

getEmission

getDuration

getDelay

getLifeOffset

isContinuous

setContinuous

getEmissionMode

setEmissionMode

isComplete

getPercentComplete

set

copy

write

read