com.jmex.effects.particles
Class SimpleParticleInfluenceFactory.BasicWind

java.lang.Object
  extended by com.jmex.effects.particles.ParticleInfluence
      extended by com.jmex.effects.particles.SimpleParticleInfluenceFactory.BasicWind
All Implemented Interfaces:
Savable
Enclosing class:
SimpleParticleInfluenceFactory

public static class SimpleParticleInfluenceFactory.BasicWind
extends ParticleInfluence


Constructor Summary
SimpleParticleInfluenceFactory.BasicWind()
           
SimpleParticleInfluenceFactory.BasicWind(float windStr, Vector3f windDir, boolean addRandom, boolean rotateWithScene)
           
 
Method Summary
 void apply(float dt, Particle p, int index)
          Apply the influence defined by this class on a given particle.
 java.lang.Class getClassTag()
           
 float getStrength()
           
 Vector3f getWindDirection()
           
 boolean isRandom()
           
 boolean isRotateWithScene()
           
 void prepare(ParticleSystem system)
          Gives the influence a chance to perform any necessary initialization immediately before ParticleInfluence.apply(float, com.jmex.effects.particles.Particle, int) is called on each particle for the current frame.
 void read(JMEImporter e)
           
 void setRandom(boolean addRandom)
           
 void setRotateWithScene(boolean rotateWithScene)
           
 void setStrength(float windStr)
           
 void setWindDirection(Vector3f windDir)
           
 void write(JMEExporter e)
           
 
Methods inherited from class com.jmex.effects.particles.ParticleInfluence
isEnabled, setEnabled
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SimpleParticleInfluenceFactory.BasicWind

public SimpleParticleInfluenceFactory.BasicWind()

SimpleParticleInfluenceFactory.BasicWind

public SimpleParticleInfluenceFactory.BasicWind(float windStr,
                                                Vector3f windDir,
                                                boolean addRandom,
                                                boolean rotateWithScene)
Method Detail

getStrength

public float getStrength()

setStrength

public void setStrength(float windStr)

getWindDirection

public Vector3f getWindDirection()

setWindDirection

public void setWindDirection(Vector3f windDir)

isRandom

public boolean isRandom()

setRandom

public void setRandom(boolean addRandom)

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(float, com.jmex.effects.particles.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(float 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(JMEExporter e)
           throws java.io.IOException
Specified by:
write in interface Savable
Overrides:
write in class ParticleInfluence
Throws:
java.io.IOException

read

public void read(JMEImporter e)
          throws java.io.IOException
Specified by:
read in interface Savable
Overrides:
read in class ParticleInfluence
Throws:
java.io.IOException

getClassTag

public java.lang.Class getClassTag()
Specified by:
getClassTag in interface Savable
Overrides:
getClassTag in class ParticleInfluence