com.jme3.effect.influencers
Interface ParticleInfluencer

All Superinterfaces:
java.lang.Cloneable, Savable
All Known Implementing Classes:
DefaultParticleInfluencer, EmptyParticleInfluencer, NewtonianParticleInfluencer

public interface ParticleInfluencer
extends Savable, java.lang.Cloneable

An interface that defines the methods to affect initial velocity of the particles.


Method Summary
 ParticleInfluencer clone()
          This method clones the influencer instance.
 Vector3f getInitialVelocity()
          This method returns the initial velocity.
 float getVelocityVariation()
          This method returns the velocity variation.
 void influenceParticle(Particle particle, EmitterShape emitterShape)
          This method influences the particle.
 void setInitialVelocity(Vector3f initialVelocity)
           
 void setVelocityVariation(float variation)
           
 
Methods inherited from interface com.jme3.export.Savable
read, write
 

Method Detail

influenceParticle

void influenceParticle(Particle particle,
                       EmitterShape emitterShape)
This method influences the particle.

Parameters:
particle - particle to be influenced
emitterShape - the shape of it emitter

clone

ParticleInfluencer clone()
This method clones the influencer instance.

Returns:
cloned instance

setInitialVelocity

void setInitialVelocity(Vector3f initialVelocity)
Parameters:
initialVelocity - Set the initial velocity a particle is spawned with, the initial velocity given in the parameter will be varied according to the velocity variation set in ParticleEmitter.setVelocityVariation(float). A particle will move toward its velocity unless it is effected by the gravity.

getInitialVelocity

Vector3f getInitialVelocity()
This method returns the initial velocity.

Returns:
the initial velocity

setVelocityVariation

void setVelocityVariation(float variation)
Parameters:
variation - Set the variation by which the initial velocity of the particle is determined. variation should be a value from 0 to 1, where 0 means particles are to spawn with exactly the velocity given in ParticleEmitter.setInitialVelocity(com.jme3.math.Vector3f), and 1 means particles are to spawn with a completely random velocity.

getVelocityVariation

float getVelocityVariation()
This method returns the velocity variation.

Returns:
the velocity variation