Package com.ardor3d.extension.effect.particle

Class SimpleParticleInfluenceFactory.BasicGravity

java.lang.Object

com.ardor3d.extension.effect.particle.ParticleInfluence

com.ardor3d.extension.effect.particle.SimpleParticleInfluenceFactory.BasicGravity

All Implemented Interfaces:

Savable

Enclosing class:

SimpleParticleInfluenceFactory

public static class SimpleParticleInfluenceFactory.BasicGravity
extends ParticleInfluence

Constructor Summary

Constructors

Constructor	Description
BasicGravity()
BasicGravity(ReadOnlyVector3 gravForce, boolean rotateWithScene)

Method Summary

Modifier and Type	Method	Description
void	apply(double dt, Particle p, int index)	Apply the influence defined by this class on a given particle.
Class<? extends SimpleParticleInfluenceFactory.BasicGravity>	getClassTag()
ReadOnlyVector3	getGravityForce()
boolean	isRotateWithScene()
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	setGravityForce(ReadOnlyVector3 gravForce)
void	setRotateWithScene(boolean rotateWithScene)
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

Constructor Details

BasicGravity

public BasicGravity()

BasicGravity

public BasicGravity(ReadOnlyVector3 gravForce,
 boolean rotateWithScene)

Method Details

getGravityForce

public ReadOnlyVector3 getGravityForce()

setGravityForce

public void setGravityForce(ReadOnlyVector3 gravForce)

isRotateWithScene

public boolean isRotateWithScene()

setRotateWithScene

public void setRotateWithScene(boolean rotateWithScene)

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 p,
 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.

p - 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.

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 SimpleParticleInfluenceFactory.BasicGravity> getClassTag()

Specified by:

getClassTag in interface Savable

Overrides:

getClassTag in class ParticleInfluence