org.j3d.geom.particle
Class MaxTimeParticleFunction

java.lang.Object
  org.j3d.geom.particle.MaxTimeParticleFunction

All Implemented Interfaces:

ParticleFunction

public class MaxTimeParticleFunction
extends java.lang.Object
implements ParticleFunction

A ParticleFunction that is used to cull particles that have reached their maximum allowed time.

Within this particle system architecture, particles are not automatically removed from the scene when their lifetime is reached. This function is used to cull them from visibility at that point by comparing the current time with the particle's death time.

Version:

$Revision: 2.0 $

Author:

Daniel Selman

Constructor Summary

MaxTimeParticleFunction()
Construct a new function that manages a particle's lifetime based on the maximum age it can be

Method Summary

boolean	apply(Particle particle) Apply this function to the given particle right now.
boolean	isEnabled() Check to see if this function has been enabled or not currently.
boolean	newFrame(int deltaT) Notification that the system is about to do an update of the particles and to do any system-level initialisation.
void	setEnabled(boolean state) Set the enabled state of this function.

Methods inherited from class java.lang.Object

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

Constructor Detail

MaxTimeParticleFunction

public MaxTimeParticleFunction()

Construct a new function that manages a particle's lifetime based on the maximum age it can be

Method Detail

isEnabled

public boolean isEnabled()

Check to see if this function has been enabled or not currently.

Specified by:

isEnabled in interface ParticleFunction

Returns:

True if this is enabled

setEnabled

public void setEnabled(boolean state)

Set the enabled state of this function. A disabled function will not be applied to particles during this update.

Specified by:

setEnabled in interface ParticleFunction

Parameters:

state - The new enabled state to set it to

apply

public boolean apply(Particle particle)

Apply this function to the given particle right now.

Specified by:

apply in interface ParticleFunction

Parameters:

particle - The particle to apply the function to

Returns:

true if the particle has changed, false otherwise

newFrame

public boolean newFrame(int deltaT)

Notification that the system is about to do an update of the particles and to do any system-level initialisation.

Specified by:

newFrame in interface ParticleFunction

Parameters:

deltaT - The elapsed time in milliseconds since the last frame

Returns:

true if this should force another update after this one