Xj3D VRML/X3D Code API

org.web3d.vrml.nodes
Interface VRMLParticleSystemNodeType

All Superinterfaces:
FrameStateListener, VRMLBoundedNodeType, VRMLChildNodeType, VRMLNode, VRMLNodeType, VRMLShapeNodeType

public interface VRMLParticleSystemNodeType
extends VRMLShapeNodeType, VRMLBoundedNodeType

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

Version:
$Revision: 1.1 $
Author:
Justin Couch

Method Summary
 boolean getEnabled()
          Get the current enabled state of this model.
 org.j3d.geom.particle.ParticleSystem getSystem()
          Get the internal initialiser model that will be used for this particle system implementation.
 boolean isActive()
          Check to see if this node is currently active for evaluation.
 void setActive(boolean state)
          Manually set the particle system to inactive due to the behaviour of the internals.
 void setEnabled(boolean state)
          Set the enabled state of the Physics model.
 
Methods inherited from interface org.web3d.vrml.nodes.VRMLShapeNodeType
getAppearance, getGeometry, setAppearance, setGeometry
 
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
 
Methods inherited from interface org.web3d.vrml.nodes.VRMLBoundedNodeType
getBboxCenter, getBboxSize
 

Method Detail

getSystem

public org.j3d.geom.particle.ParticleSystem getSystem()
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

setEnabled

public void setEnabled(boolean state)
Set the enabled state of the Physics model.

Parameters:
state - true to enable the use of this model

getEnabled

public boolean getEnabled()
Get the current enabled state of this model.

Returns:
The value of the enabled field

isActive

public boolean isActive()
Check to see if this node is currently active for evaluation.

Returns:
true if the node still can run this frame

setActive

public void setActive(boolean state)
Manually set the particle system to inactive due to the behaviour of the internals. The manager has decided that this node is no longer needing to be run, so indicate that the activity level has changed.

Parameters:
state - true to set this as active, false for inActive

Xj3D VRML/X3D Code API

Copyright © 2001 - 2005 Web3D Consortium