Module technology.sola.engine

Package technology.sola.engine.physics.component.particle

Class ParticleEmitterComponent

java.lang.Object

technology.sola.engine.physics.component.particle.ParticleEmitterComponent

All Implemented Interfaces:

technology.sola.ecs.Component

@NullMarked
public class ParticleEmitterComponent
extends Object
implements technology.sola.ecs.Component

ParticleEmitterComponent is a Component that contains data for emitting Particles as well as data for its emitted particles.

Constructor Summary

Constructors

Constructor	Description
ParticleEmitterComponent()

Method Summary

Modifier and Type	Method	Description
ParticleAppearanceConfiguration	appearanceConfig()
ParticleEmissionConfiguration	emissionConfig()
void	emitIfAble(float delta, Vector2D inheritedVelocity)	Emits new particles if enough time has elapsed based on the set properties for emission.
Iterator<Particle>	emittedParticleIterator()
ParticleMovementConfiguration	movementConfig()

Methods inherited from class java.lang.Object

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

Methods inherited from interface technology.sola.ecs.Component

afterDeserialize

Constructor Details

ParticleEmitterComponent

public ParticleEmitterComponent()

Method Details

emitIfAble

public void emitIfAble(float delta,
 Vector2D inheritedVelocity)

Emits new particles if enough time has elapsed based on the set properties for emission.

Parameters:

delta - the elapsed delta time

inheritedVelocity - the inherited velocity for emitted particles from the parent Entity

emittedParticleIterator

public Iterator<Particle> emittedParticleIterator()

Returns:

the Iterator for Particles

movementConfig

public ParticleMovementConfiguration movementConfig()

Returns:

object containing emitted Particle movement configuration

appearanceConfig

public ParticleAppearanceConfiguration appearanceConfig()

Returns:

object containing emitted Particle appearance configuration

emissionConfig

public ParticleEmissionConfiguration emissionConfig()

Returns:

object containing emitted Particle emission configuration