Package org.web3d.x3d.sai.ParticleSystems

Interface X3DParticleEmitterNode

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
The X3DParticleEmitterNode abstract type represents any node that is an emitter of particles.


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

    Modifier and Type Method 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 setMass​(float newValue)
    Accessor method to assign float value to inputOutput SFFloat field named mass.
    X3DParticleEmitterNode setMetadata​(X3DMetadataObject newValue)
    Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    X3DParticleEmitterNode setSpeed​(float newValue)
    Accessor method to assign float value to inputOutput SFFloat field named speed.
    X3DParticleEmitterNode setSurfaceArea​(float newValue)
    Accessor method to assign float value to initializeOnly SFFloat field named surfaceArea.
    X3DParticleEmitterNode setVariation​(float newValue)
    Accessor method to assign float value to inputOutput SFFloat field named variation.

  • Method Details

    • 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)
      Accessor method to assign float value 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)
      Accessor method to 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)
      Accessor method to assign float value 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)
      Accessor method to assign float value 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)
      Accessor method to assign float value 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).