Module technology.sola.engine

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

Class ParticleAppearanceConfiguration

java.lang.Object

technology.sola.engine.physics.component.particle.ParticleConfiguration

technology.sola.engine.physics.component.particle.ParticleAppearanceConfiguration

@NullMarked
public class ParticleAppearanceConfiguration
extends ParticleConfiguration

ParticleAppearanceConfiguration contains configuration for the appearance properties of emitted Particles.

Method Summary

Modifier and Type	Method	Description
ParticleColorFunction	colorFunction()
float	maxSize()
float	minSize()
ParticleAppearanceConfiguration	setColorFunction(ParticleColorFunction colorFunction)	Updates the ParticleColorFunction for newly emitted Particles.
ParticleAppearanceConfiguration	setShapeFunction(ParticleShapeFunction shapeFunction)	Updates the ParticleShapeFunction for newly emitted Particles.
ParticleAppearanceConfiguration	setSize(float size)	Updates the size for newly emitted Particles to be a fixed value.
ParticleAppearanceConfiguration	setSizeBounds(float minSize, float maxSize)	Updates the minimum and maximum size values for newly emitted Particles.
ParticleShapeFunction	shapeFunction()

Methods inherited from class technology.sola.engine.physics.component.particle.ParticleConfiguration

done

Methods inherited from class java.lang.Object

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

Method Details

minSize

public float minSize()

Returns:

the minimum size for newly emitted Particles

maxSize

public float maxSize()

Returns:

the maximum size for newly emitted Particles

setSizeBounds

public ParticleAppearanceConfiguration setSizeBounds(float minSize,
 float maxSize)

Updates the minimum and maximum size values for newly emitted Particles.

Parameters:

minSize - the minimum size for new particles

maxSize - the maximum size for new particles

Returns:

this

setSize

public ParticleAppearanceConfiguration setSize(float size)

Updates the size for newly emitted Particles to be a fixed value.

Parameters:

size - the size for new particles

Returns:

this

colorFunction

public ParticleColorFunction colorFunction()

Returns:

function to generate a Particle's color

setColorFunction

public ParticleAppearanceConfiguration setColorFunction(ParticleColorFunction colorFunction)

Updates the ParticleColorFunction for newly emitted Particles.

Parameters:

colorFunction - the new color function for new particles

Returns:

this

shapeFunction

public ParticleShapeFunction shapeFunction()

Returns:

function to generate a Particle's ParticleShape

setShapeFunction

public ParticleAppearanceConfiguration setShapeFunction(ParticleShapeFunction shapeFunction)

Updates the ParticleShapeFunction for newly emitted Particles.

Parameters:

shapeFunction - the new shape function for new particles

Returns:

this