Package org.web3d.x3d.sai.particlesystems

Interface ParticleSystem

All Superinterfaces:

X3DBoundedObject, X3DChildNode, X3DNode, X3DShapeNode

All Known Implementing Classes:

SAIParticleSystem, SAIParticleSystem

public interface ParticleSystem
extends X3DShapeNode

Defines the requirements of an X3D ParticleSystem node

Version:

$Revision: 1.2 $

Author:

Rex Melton

Method Summary

Modifier and Type	Method	Description
void	getColorKey(float[] val)	Return the colorKey value in the argument float[]
X3DNode	getColorRamp()	Return the colorRamp X3DNode value.
boolean	getCreateParticles()	Return the createParticles boolean value.
X3DNode	getEmitter()	Return the emitter X3DNode value.
boolean	getEnabled()	Return the enabled boolean value.
String	getGeometryType()	Return the geometryType String value.
boolean	getIsActive()	Return the isActive boolean value.
float	getLifetimeVariation()	Return the lifetimeVariation float value.
int	getMaxParticles()	Return the maxParticles int value.
int	getNumColorKey()	Return the number of MFFloat items in the colorKey field.
int	getNumPhysics()	Return the number of MFNode items in the physics field.
int	getNumTexCoordKey()	Return the number of MFFloat items in the texCoordKey field.
float	getParticleLifetime()	Return the particleLifetime float value.
void	getParticleSize(float[] val)	Return the particleSize value in the argument float[]
void	getPhysics(X3DNode[] val)	Return the physics value in the argument X3DNode[]
void	getTexCoordKey(float[] val)	Return the texCoordKey value in the argument float[]
X3DNode	getTexCoordRamp()	Return the texCoordRamp X3DNode value.
void	setColorKey(float[] val)	Set the colorKey field.
void	setColorRamp(X3DNode val)	Set the colorRamp field.
void	setCreateParticles(boolean val)	Set the createParticles field.
void	setEmitter(X3DParticleEmitterNode val)	Set the emitter field.
void	setEmitter(X3DProtoInstance val)	Set the emitter field.
void	setEnabled(boolean val)	Set the enabled field.
void	setGeometryType(String val)	Set the geometryType field.
void	setLifetimeVariation(float val)	Set the lifetimeVariation field.
void	setMaxParticles(int val)	Set the maxParticles field.
void	setParticleLifetime(float val)	Set the particleLifetime field.
void	setParticleSize(float[] val)	Set the particleSize field.
void	setPhysics(X3DNode[] val)	Set the physics field.
void	setTexCoordKey(float[] val)	Set the texCoordKey field.
void	setTexCoordRamp(X3DNode val)	Set the texCoordRamp field.

Methods inherited from interface org.web3d.x3d.sai.X3DBoundedObject

getBboxCenter, getBboxSize, setBboxCenter, setBboxSize

Methods inherited from interface org.web3d.x3d.sai.X3DNode

dispose, getField, getFieldDefinitions, getMetadata, getNodeName, getNodeType, isRealized, realize, setMetadata

Methods inherited from interface org.web3d.x3d.sai.X3DShapeNode

getAppearance, getGeometry, setAppearance, setAppearance, setGeometry, setGeometry

Method Details

getGeometryType

String getGeometryType()

Return the geometryType String value.

Returns:

The geometryType String value.

setGeometryType

void setGeometryType(String val)

Set the geometryType field.

Parameters:

val - The String to set.

getEnabled

boolean getEnabled()

Return the enabled boolean value.

Returns:

The enabled boolean value.

setEnabled

void setEnabled(boolean val)

Set the enabled field.

Parameters:

val - The boolean to set.

getMaxParticles

int getMaxParticles()

Return the maxParticles int value.

Returns:

The maxParticles int value.

setMaxParticles

void setMaxParticles(int val)

Set the maxParticles field.

Parameters:

val - The int to set.

getParticleLifetime

float getParticleLifetime()

Return the particleLifetime float value.

Returns:

The particleLifetime float value.

setParticleLifetime

void setParticleLifetime(float val)

Set the particleLifetime field.

Parameters:

val - The float to set.

getLifetimeVariation

float getLifetimeVariation()

Return the lifetimeVariation float value.

Returns:

The lifetimeVariation float value.

setLifetimeVariation

void setLifetimeVariation(float val)

Set the lifetimeVariation field.

Parameters:

val - The float to set.

getEmitter

X3DNode getEmitter()

Return the emitter X3DNode value.

Returns:

The emitter X3DNode value.

setEmitter

void setEmitter(X3DParticleEmitterNode val)

Set the emitter field.

Parameters:

val - The X3DParticleEmitterNode to set.

setEmitter

void setEmitter(X3DProtoInstance val)

Set the emitter field.

Parameters:

val - The X3DProtoInstance to set.

getNumPhysics

int getNumPhysics()

Return the number of MFNode items in the physics field.

Returns:

the number of MFNode items in the physics field.

getPhysics

void getPhysics(X3DNode[] val)

Return the physics value in the argument X3DNode[]

Parameters:

val - The X3DNode[] to initialize.

setPhysics

void setPhysics(X3DNode[] val)

Set the physics field.

Parameters:

val - The X3DNode[] to set.

getColorRamp

X3DNode getColorRamp()

Return the colorRamp X3DNode value.

Returns:

The colorRamp X3DNode value.

setColorRamp

void setColorRamp(X3DNode val)

Set the colorRamp field.

Parameters:

val - The X3DNode to set.

getNumColorKey

int getNumColorKey()

Return the number of MFFloat items in the colorKey field.

Returns:

the number of MFFloat items in the colorKey field.

getColorKey

void getColorKey(float[] val)

Return the colorKey value in the argument float[]

Parameters:

val - The float[] to initialize.

setColorKey

void setColorKey(float[] val)

Set the colorKey field.

Parameters:

val - The float[] to set.

getIsActive

boolean getIsActive()

Return the isActive boolean value.

Returns:

The isActive boolean value.

getParticleSize

void getParticleSize(float[] val)

Return the particleSize value in the argument float[]

Parameters:

val - The float[] to initialize.

setParticleSize

void setParticleSize(float[] val)

Set the particleSize field.

Parameters:

val - The float[] to set.

getCreateParticles

boolean getCreateParticles()

Return the createParticles boolean value.

Returns:

The createParticles boolean value.

setCreateParticles

void setCreateParticles(boolean val)

Set the createParticles field.

Parameters:

val - The boolean to set.

getTexCoordRamp

X3DNode getTexCoordRamp()

Return the texCoordRamp X3DNode value.

Returns:

The texCoordRamp X3DNode value.

setTexCoordRamp

void setTexCoordRamp(X3DNode val)

Set the texCoordRamp field.

Parameters:

val - The X3DNode to set.

getNumTexCoordKey

int getNumTexCoordKey()

Return the number of MFFloat items in the texCoordKey field.

Returns:

the number of MFFloat items in the texCoordKey field.

getTexCoordKey

void getTexCoordKey(float[] val)

Return the texCoordKey value in the argument float[]

Parameters:

val - The float[] to initialize.

setTexCoordKey

void setTexCoordKey(float[] val)

Set the texCoordKey field.

Parameters:

val - The float[] to set.