Package com.ardor3d.extension.effect.particle

Class SwarmInfluence

java.lang.Object

com.ardor3d.extension.effect.particle.ParticleInfluence

com.ardor3d.extension.effect.particle.SwarmInfluence

All Implemented Interfaces:

Savable

public class SwarmInfluence
extends ParticleInfluence

Simple swarming influence for use with particles.

Field Summary

Fields

Modifier and Type	Field	Description
static final double	DEFAULT_DEVIANCE
static final double	DEFAULT_MAX_SPEED
static final double	DEFAULT_SPEED_BUMP
static final double	DEFAULT_SWARM_RANGE_SQ
static final double	DEFAULT_TURN_SPEED

Constructor Summary

Constructors

Constructor	Description
SwarmInfluence()
SwarmInfluence(ReadOnlyVector3 offset, double swarmRange)

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 SwarmInfluence>	getClassTag()
double	getDeviance()
double	getMaxSpeed()
double	getSpeedBump()
ReadOnlyVector3	getSwarmOffset()
double	getSwarmRange()
double	getTurnSpeed()
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	setDeviance(double deviance)
void	setMaxSpeed(double maxSpeed)
void	setSpeedBump(double speedVariance)
void	setSwarmOffset(ReadOnlyVector3 offset)
void	setSwarmRange(double swarmRange)
void	setTurnSpeed(double turnSpeed)
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_SWARM_RANGE_SQ

public static final double DEFAULT_SWARM_RANGE_SQ

See Also:

• Constant Field Values

DEFAULT_DEVIANCE

public static final double DEFAULT_DEVIANCE

See Also:

• Constant Field Values

DEFAULT_TURN_SPEED

public static final double DEFAULT_TURN_SPEED

See Also:

• Constant Field Values

DEFAULT_SPEED_BUMP

public static final double DEFAULT_SPEED_BUMP

See Also:

• Constant Field Values

DEFAULT_MAX_SPEED

public static final double DEFAULT_MAX_SPEED

See Also:

• Constant Field Values

Constructor Details

SwarmInfluence

public SwarmInfluence()

SwarmInfluence

public SwarmInfluence(ReadOnlyVector3 offset,
 double swarmRange)

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.

getSwarmRange

public double getSwarmRange()

setSwarmRange

public void setSwarmRange(double swarmRange)

getSwarmOffset

public ReadOnlyVector3 getSwarmOffset()

setSwarmOffset

public void setSwarmOffset(ReadOnlyVector3 offset)

getDeviance

public double getDeviance()

setDeviance

public void setDeviance(double deviance)

getSpeedBump

public double getSpeedBump()

setSpeedBump

public void setSpeedBump(double speedVariance)

getTurnSpeed

public double getTurnSpeed()

setTurnSpeed

public void setTurnSpeed(double turnSpeed)

getMaxSpeed

public double getMaxSpeed()

setMaxSpeed

public void setMaxSpeed(double maxSpeed)

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 SwarmInfluence> getClassTag()

Specified by:

getClassTag in interface Savable

Overrides:

getClassTag in class ParticleInfluence