Package com.ardor3d.extension.effect.particle

Class WanderInfluence

java.lang.Object

com.ardor3d.extension.effect.particle.ParticleInfluence

com.ardor3d.extension.effect.particle.WanderInfluence

All Implemented Interfaces:

Savable

public class WanderInfluence
extends ParticleInfluence

Field Summary

Fields

Modifier and Type	Field	Description
static final double	DEFAULT_DISTANCE
static final double	DEFAULT_JITTER
static final double	DEFAULT_RADIUS

Constructor Summary

Constructors

Constructor	Description
WanderInfluence()

Method Summary

Modifier and Type	Method	Description
void	apply(double dt, Particle particle, int index)	Apply the influence defined by this class on a given particle.
Class<? extends WanderInfluence>	getClassTag()
double	getWanderDistance()
double	getWanderJitter()
double	getWanderRadius()
void	prepare(ParticleSystem system)	Gives the influence a chance to perform any necessary initialization immediately before ParticleInfluence.apply(double, com.ardor3d.extension.effect.particle.Particle, int) is called on each particle for the current frame.
void	read(InputCapsule capsule)
void	setWanderDistance(double wanderDistance)
void	setWanderJitter(double wanderJitter)
void	setWanderRadius(double wanderRadius)
void	write(OutputCapsule capsule)

Methods inherited from class com.ardor3d.extension.effect.particle.ParticleInfluence

isEnabled, setEnabled

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_RADIUS

public static final double DEFAULT_RADIUS

See Also:

• Constant Field Values

DEFAULT_DISTANCE

public static final double DEFAULT_DISTANCE

See Also:

• Constant Field Values

DEFAULT_JITTER

public static final double DEFAULT_JITTER

See Also:

• Constant Field Values

Constructor Details

WanderInfluence

public WanderInfluence()

Method Details

prepare

public void prepare(ParticleSystem system)

Description copied from class: ParticleInfluence

Gives the influence a chance to perform any necessary initialization immediately before ParticleInfluence.apply(double, com.ardor3d.extension.effect.particle.Particle, int) is called on each particle for the current frame.

Overrides:

prepare in class ParticleInfluence

Parameters:

system - the particle system containing the influence

apply

public void apply(double dt,
 Particle particle,
 int index)

Description copied from class: ParticleInfluence

Apply the influence defined by this class on a given particle. Should probably do this by making a call to particle.getSpeed().addLocal(....); etc.

Specified by:

apply in class ParticleInfluence

Parameters:

dt - amount of time since last apply call in ms.

particle - the particle to apply the influence to.

index - the index of the particle we are working with. This is useful for adding small steady amounts of variation, or remembering information.

getWanderDistance

public double getWanderDistance()

setWanderDistance

public void setWanderDistance(double wanderDistance)

getWanderJitter

public double getWanderJitter()

setWanderJitter

public void setWanderJitter(double wanderJitter)

getWanderRadius

public double getWanderRadius()

setWanderRadius

public void setWanderRadius(double wanderRadius)

write

public void write(OutputCapsule capsule)
           throws IOException

Specified by:

write in interface Savable

Overrides:

write in class ParticleInfluence

Throws:

IOException

read

public void read(InputCapsule capsule)
          throws IOException

Specified by:

read in interface Savable

Overrides:

read in class ParticleInfluence

Throws:

IOException

getClassTag

public Class<? extends WanderInfluence> getClassTag()

Specified by:

getClassTag in interface Savable

Overrides:

getClassTag in class ParticleInfluence