org.web3d.vrml.nodes
Interface VRMLParticleEmitterNodeType

All Superinterfaces:

FrameStateListener, VRMLNode, VRMLNodeType

public interface VRMLParticleEmitterNodeType

extends VRMLNodeType

A node which specifies an emitter of particles for a particle system.

Version:

$Revision: 1.1 $

Author:

Justin Couch

Method Summary

org.j3d.geom.particle.ParticleInitializer	getInitializer() Get the internal initialiser model that will be used for this particle system implementation.
float	getMass() Get the current value of the mass field.
float	getSpeed() Get the current value of the speed field.
float	getSurfaceArea() Get the current value of the surfaceArea field.
float	getVariation() Get the current value of the variation field.
void	setMass(float mass) Set the position field value to the new value.
void	setSpeed(float speed) Set the position field value to the new value.
void	setSurfaceArea(float surfaceArea) Set the position field value to the new value.
void	setVariation(float variation) Set the variation field value to the new value.

Methods inherited from interface org.web3d.vrml.nodes.VRMLNodeType

addNodeListener, getFieldValue, getMetadataObject, getRefCount, hasFieldChanged, isSetupFinished, notifyExternProtoLoaded, removeNodeListener, sendRoute, setDEF, setFrameStateManager, setMetadataObject, setupFinished, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, updateRefCount

Methods inherited from interface org.web3d.vrml.lang.VRMLNode

getFieldDeclaration, getFieldIndex, getNodeFieldIndices, getNumFields, getPrimaryType, getSecondaryType, getUserData, getVRMLNodeName, isDEF, setErrorReporter, setUserData, setVersion

Methods inherited from interface org.web3d.vrml.nodes.FrameStateListener

allEventsComplete

Method Detail

getInitializer

public org.j3d.geom.particle.ParticleInitializer getInitializer()

Get the internal initialiser model that will be used for this particle system implementation. This may not be available until after setupFinished() has been called.

Returns:

The initialiser instance to use

getSpeed

public float getSpeed()

Get the current value of the speed field.

Returns:

the current speed value 0 - inf.

setSpeed

public void setSpeed(float speed)
              throws InvalidFieldValueException

Set the position field value to the new value.

Parameters:

speed - The new position to set

Throws:

InvalidFieldValueException

getMass

public float getMass()

Get the current value of the mass field.

Returns:

the current mass value 0 - inf.

setMass

public void setMass(float mass)
             throws InvalidFieldValueException

Set the position field value to the new value.

Parameters:

mass - The new mass to set

Throws:

InvalidFieldValueException - The mass value was negative

getSurfaceArea

public float getSurfaceArea()

Get the current value of the surfaceArea field.

Returns:

the current surfaceArea value 0 - inf.

setSurfaceArea

public void setSurfaceArea(float surfaceArea)
                    throws InvalidFieldValueException

Set the position field value to the new value.

Parameters:

surfaceArea - The new amount of surface area to set

Throws:

InvalidFieldValueException - The area value was negative

getVariation

public float getVariation()

Get the current value of the variation field.

Returns:

The current variation value

setVariation

public void setVariation(float variation)
                  throws InvalidFieldValueException

Set the variation field value to the new value. If it is out of range the throw an exception.

Parameters:

variation - The new amount of variation to set

Throws:

InvalidFieldValueException - The field is out of range