X3DParticleEmitterNode (X3DJSAIL, X3D Java Scene Access Interface Library)

All Superinterfaces:

X3DNode

All Known Subinterfaces:

ConeEmitter, ExplosionEmitter, PointEmitter, PolylineEmitter, SurfaceEmitter, VolumeEmitter

All Known Implementing Classes:

ConeEmitterObject, ExplosionEmitterObject, PointEmitterObject, PolylineEmitterObject, SurfaceEmitterObject, VolumeEmitterObject
```
public interface X3DParticleEmitterNode
extends X3DNode
```
Abstract node interface, defined by X3D specification to support X3D Java interoperability.

Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).

See Also:

SAI Java Specification: TODO, X3D Abstract Specification: TODO, X3D Tooltips, X3D Scene Authoring Hints

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`float`	`getMass()` Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named mass.
`X3DMetadataObject`	`getMetadata()` Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
`float`	`getSpeed()` Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named speed.
`float`	`getSurfaceArea()` Provide float value within allowed range of [0,infinity) from initializeOnly SFFloat field named surfaceArea.
`float`	`getVariation()` Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named variation.
`X3DParticleEmitterNode`	`setCssClass(java.lang.String newValue)` Assign String value to inputOutput SFString field named class.
`X3DParticleEmitterNode`	`setDEF(java.lang.String newValue)` Assign String value to inputOutput SFString field named DEF.
`X3DParticleEmitterNode`	`setMass(float newValue)` Assign float value within allowed range of [0,infinity) to inputOutput SFFloat field named mass.
`X3DParticleEmitterNode`	`setMetadata(X3DMetadataObject newValue)` Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`X3DParticleEmitterNode`	`setSpeed(float newValue)` Assign float value within allowed range of [0,infinity) to inputOutput SFFloat field named speed.
`X3DParticleEmitterNode`	`setSurfaceArea(float newValue)` Assign float value within allowed range of [0,infinity) to initializeOnly SFFloat field named surfaceArea.
`X3DParticleEmitterNode`	`setUSE(java.lang.String newValue)` Assign String value to inputOutput SFString field named USE.
`X3DParticleEmitterNode`	`setVariation(float newValue)` Assign float value within allowed range of [0,infinity) to inputOutput SFFloat field named variation.

- Method Detail
  - getMass
```
float getMass()
```
    Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named mass.
    
    Returns:
    
    value of mass field
  - setMass
```
X3DParticleEmitterNode setMass(float newValue)
```
    Assign float value within allowed range of [0,infinity) to inputOutput SFFloat field named mass.
    
    Parameters:
    
    newValue - is new value for the mass field.
    
    Returns:
    
    X3DParticleEmitterNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getMetadata
```
X3DMetadataObject getMetadata()
```
    Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    
    Specified by:
    
    getMetadata in interface X3DNode
    
    Returns:
    
    value of metadata field
    
    See Also:
    
    X3D Scene Authoring Hints: Metadata Nodes
  - setMetadata
```
X3DParticleEmitterNode setMetadata(X3DMetadataObject newValue)
```
    Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    
    Specified by:
    
    setMetadata in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the metadata field.
    
    Returns:
    
    X3DParticleEmitterNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    
    See Also:
    
    X3D Scene Authoring Hints: Metadata Nodes
  - getSpeed
```
float getSpeed()
```
    Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named speed.
    
    Returns:
    
    value of speed field
  - setSpeed
```
X3DParticleEmitterNode setSpeed(float newValue)
```
    Assign float value within allowed range of [0,infinity) to inputOutput SFFloat field named speed.
    
    Parameters:
    
    newValue - is new value for the speed field.
    
    Returns:
    
    X3DParticleEmitterNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getSurfaceArea
```
float getSurfaceArea()
```
    Provide float value within allowed range of [0,infinity) from initializeOnly SFFloat field named surfaceArea.
    
    Returns:
    
    value of surfaceArea field
  - setSurfaceArea
```
X3DParticleEmitterNode setSurfaceArea(float newValue)
```
    Assign float value within allowed range of [0,infinity) to initializeOnly SFFloat field named surfaceArea.
    
    Parameters:
    
    newValue - is new value for the surfaceArea field.
    
    Returns:
    
    X3DParticleEmitterNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getVariation
```
float getVariation()
```
    Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named variation.
    
    Returns:
    
    value of variation field
  - setVariation
```
X3DParticleEmitterNode setVariation(float newValue)
```
    Assign float value within allowed range of [0,infinity) to inputOutput SFFloat field named variation.
    
    Parameters:
    
    newValue - is new value for the variation field.
    
    Returns:
    
    X3DParticleEmitterNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setDEF
```
X3DParticleEmitterNode setDEF(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named DEF.
    
    Note that setting the DEF value clears the USE value.
    
    Specified by:
    
    setDEF in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    X3DParticleEmitterNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUSE
```
X3DParticleEmitterNode setUSE(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named USE.
    
    Note: each USE node is still an independent object, with the USE value matching the DEF value in the preceding object.
    
    Warning: invoking the setUSE() method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.
    
    Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.
    
    Specified by:
    
    setUSE in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    X3DParticleEmitterNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setCssClass
```
X3DParticleEmitterNode setCssClass(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named class.
    
    Specified by:
    
    setCssClass in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    X3DParticleEmitterNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

Interface X3DParticleEmitterNode

Method Summary

Method Detail

getMass

setMass

getMetadata

setMetadata

getSpeed

setSpeed

getSurfaceArea

setSurfaceArea

getVariation

setVariation

setDEF

setUSE

setCssClass