Package org.web3d.x3d.sai.ParticleSystems

Interface ConeEmitter

All Superinterfaces:
X3DNode, X3DParticleEmitterNode
All Known Implementing Classes:
ConeEmitter
public interface ConeEmitter
extends X3DParticleEmitterNode
ConeEmitter generates all available particles from a specific point in space.

X3D node tooltip: (X3D version 3.2 or later) [X3DParticleEmitterNode] ConeEmitter generates all available particles from a specific point in space. Particles are emitted from the single point specified by the position field emanating in a direction randomly distributed within the cone specified by the angle and direction fields. *


Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
See Also:
SAI Java Specification, X3D Abstract Specification: ConeEmitter, X3D Tooltips: ConeEmitter, X3D Scene Authoring Hints

  • Method Summary

    Modifier and Type Method Description
    float getAngle()
    Provide float value unit axis, angle (in radians) within allowed range of [0,3.1416] from inputOutput SFFloat field named angle.
    float[] getDirection()
    Provide array of 3-tuple float results within allowed range of [-1,1] from inputOutput SFVec3f field named direction.
    float getMass()
    Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named mass.
    X3DMetadataObject getMetadata()
    Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    float[] getPosition()
    Provide array of 3-tuple float results from inputOutput SFVec3f field named position.
    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 inputOutput SFFloat field named surfaceArea.
    float getVariation()
    Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named variation.
    ConeEmitter setAngle​(float newValue)
    Accessor method to assign float value unit axis, angle (in radians) to inputOutput SFFloat field named angle.
    ConeEmitter setDirection​(float[] newValue)
    Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named direction.
    ConeEmitter setMass​(float newValue)
    Accessor method to assign float value to inputOutput SFFloat field named mass.
    ConeEmitter setMetadata​(X3DMetadataObject newValue)
    Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    ConeEmitter setPosition​(float[] newValue)
    Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named position.
    ConeEmitter setSpeed​(float newValue)
    Accessor method to assign float value to inputOutput SFFloat field named speed.
    ConeEmitter setSurfaceArea​(float newValue)
    Accessor method to assign float value to inputOutput SFFloat field named surfaceArea.
    ConeEmitter setVariation​(float newValue)
    Accessor method to assign float value to inputOutput SFFloat field named variation.

  • Method Details

    • getAngle

      float getAngle()
      Provide float value unit axis, angle (in radians) within allowed range of [0,3.1416] from inputOutput SFFloat field named angle.

      Tooltip: [0,+infinity) Cone boundary for random distribution of particles about initial direction.
      Returns:
      value of angle field

    • setAngle

      ConeEmitter setAngle​(float newValue)
      Accessor method to assign float value unit axis, angle (in radians) to inputOutput SFFloat field named angle.

      Tooltip: [0,+infinity) Cone boundary for random distribution of particles about initial direction.
      Parameters:
      newValue - is new value for the angle field.
      Returns:
      ConeEmitter - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getDirection

      float[] getDirection()
      Provide array of 3-tuple float results within allowed range of [-1,1] from inputOutput SFVec3f field named direction.

      Tooltip: Initial direction from which particles emanate. *
      Returns:
      value of direction field

    • setDirection

      ConeEmitter setDirection​(float[] newValue)
      Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named direction.

      Tooltip: Initial direction from which particles emanate. *
      Parameters:
      newValue - is new value for the direction field.
      Returns:
      ConeEmitter - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getMass

      float getMass()
      Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named mass.
      Specified by:
      getMass in interface X3DParticleEmitterNode
      Returns:
      value of mass field

    • setMass

      ConeEmitter setMass​(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named mass.
      Specified by:
      setMass in interface X3DParticleEmitterNode
      Parameters:
      newValue - is new value for the mass field.
      Returns:
      ConeEmitter - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getMetadata

      X3DMetadataObject getMetadata()
      Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.

      Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
      Specified by:
      getMetadata in interface X3DNode
      Specified by:
      getMetadata in interface X3DParticleEmitterNode
      Returns:
      value of metadata field
      See Also:
      X3D Scene Authoring Hints: Metadata Nodes

    • setMetadata

      ConeEmitter setMetadata​(X3DMetadataObject newValue)
      Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.

      Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
      Specified by:
      setMetadata in interface X3DNode
      Specified by:
      setMetadata in interface X3DParticleEmitterNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      ConeEmitter - 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

    • getPosition

      float[] getPosition()
      Provide array of 3-tuple float results from inputOutput SFVec3f field named position.

      Tooltip: Point from which particles emanate. *
      Returns:
      value of position field

    • setPosition

      ConeEmitter setPosition​(float[] newValue)
      Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named position.

      Tooltip: Point from which particles emanate. *
      Parameters:
      newValue - is new value for the position field.
      Returns:
      ConeEmitter - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getSpeed

      float getSpeed()
      Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named speed.

      Tooltip: [0,+infinity) Initial linear speed (default is m/s) imparted to all particles along their direction of movement. *
      Specified by:
      getSpeed in interface X3DParticleEmitterNode
      Returns:
      value of speed field

    • setSpeed

      ConeEmitter setSpeed​(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named speed.

      Tooltip: [0,+infinity) Initial linear speed (default is m/s) imparted to all particles along their direction of movement. *
      Specified by:
      setSpeed in interface X3DParticleEmitterNode
      Parameters:
      newValue - is new value for the speed field.
      Returns:
      ConeEmitter - 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 inputOutput SFFloat field named surfaceArea.

      Tooltip: [0,+infinity) Particle surface area in area base units (default is meters squared). Surface area is used for calculations such as wind effects per particle.
      • Hint: surfaceArea value represents average frontal area presented to the wind.
      • Hint: assumes spherical model for each particle (i.e., surface area is the same regardless of direction).
      Specified by:
      getSurfaceArea in interface X3DParticleEmitterNode
      Returns:
      value of surfaceArea field

    • setSurfaceArea

      ConeEmitter setSurfaceArea​(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named surfaceArea.

      Tooltip: [0,+infinity) Particle surface area in area base units (default is meters squared). Surface area is used for calculations such as wind effects per particle.
      • Hint: surfaceArea value represents average frontal area presented to the wind.
      • Hint: assumes spherical model for each particle (i.e., surface area is the same regardless of direction).
      Specified by:
      setSurfaceArea in interface X3DParticleEmitterNode
      Parameters:
      newValue - is new value for the surfaceArea field.
      Returns:
      ConeEmitter - 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.

      Tooltip: [0,+infinity) Multiplier for the randomness used to control the range of possible output values. The bigger the value, the more random the output and the bigger the range of possible initial values possible.
      • Hint: variation of zero does not allow any randomness.
      Specified by:
      getVariation in interface X3DParticleEmitterNode
      Returns:
      value of variation field

    • setVariation

      ConeEmitter setVariation​(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named variation.

      Tooltip: [0,+infinity) Multiplier for the randomness used to control the range of possible output values. The bigger the value, the more random the output and the bigger the range of possible initial values possible.
      • Hint: variation of zero does not allow any randomness.
      Specified by:
      setVariation in interface X3DParticleEmitterNode
      Parameters:
      newValue - is new value for the variation field.
      Returns:
      ConeEmitter - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).