All Superinterfaces:: X3DNode, X3DParticleEmitterNode

All Known Implementing Classes:: PolylineEmitter

public interface PolylineEmitter extends X3DParticleEmitterNode

PolylineEmitter emits particles along a single polyline.

Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the org.web3d.x3d.jsail classes. PolylineEmitter node tooltip: (X3D version 3.2 or later) [X3DParticleEmitterNode] PolylineEmitter emits particles along a single polyline. The coordinates for the line along which particles should be randomly generated are taken from a combination of the coord and coordIndex fields. The starting point for generating particles is randomly distributed along this line and given the initial speed and direction.

Hint: if no coordinates are available, PolylineEmitter acts like a point source located at local origin.

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

See Also:

Method Summary

Modifier and Type

Method

Description

X3DCoordinateNode

getCoord()

Provide org.web3d.x3d.sai.Rendering.X3DCoordinateNode instance (using a properly typed node) from inputOutput SFNode field coord.

int[]

getCoordIndex()

Provide array of int results within allowed range of [-1,infinity) from initializeOnly MFInt32 field named coordIndex.

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.

boolean

getOn()

Provide boolean value from inputOutput SFBool field named on.

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.

PolylineEmitter

setCoord(X3DCoordinateNode newValue)

Accessor method to assign org.web3d.x3d.sai.Rendering.X3DCoordinateNode instance (using a properly typed node) to inputOutput SFNode field coord.

PolylineEmitter

setCoordIndex(int[] newValue)

Accessor method to assign int array to initializeOnly MFInt32 field named coordIndex.

PolylineEmitter

setDirection(float[] newValue)

Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named direction.

PolylineEmitter

setMass(float newValue)

Accessor method to assign float value to inputOutput SFFloat field named mass.

PolylineEmitter

setMetadata(X3DMetadataObject newValue)

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

PolylineEmitter

setOn(boolean newValue)

Accessor method to assign boolean value to inputOutput SFBool field named on.

PolylineEmitter

setSpeed(float newValue)

Accessor method to assign float value to inputOutput SFFloat field named speed.

PolylineEmitter

setSurfaceArea(float newValue)

Accessor method to assign float value to inputOutput SFFloat field named surfaceArea.

PolylineEmitter

setVariation(float newValue)

Accessor method to assign float value to inputOutput SFFloat field named variation.

Method Details
- getCoord
  X3DCoordinateNode getCoord()
  
  Provide org.web3d.x3d.sai.Rendering.X3DCoordinateNode instance (using a properly typed node) from inputOutput SFNode field coord.
  
  Tooltip: [X3DCoordinateNode] Coordinates for the line along which particles are randomly generated.
  
  Warning: If no coordinates are available, PolylineEmitter acts like a point source located at local origin.
  
  Returns:
  
  value of coord field
- setCoord
  PolylineEmitter setCoord(X3DCoordinateNode newValue)
  
  Accessor method to assign org.web3d.x3d.sai.Rendering.X3DCoordinateNode instance (using a properly typed node) to inputOutput SFNode field coord.
  
  Tooltip: [X3DCoordinateNode] Coordinates for the line along which particles are randomly generated.
  
  Warning: If no coordinates are available, PolylineEmitter acts like a point source located at local origin.
  
  Parameters:
  
  newValue - is new value for the coord field.
  
  Returns:
  
  PolylineEmitter - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getCoordIndex
  int[] getCoordIndex()
  
  Provide array of int results within allowed range of [-1,infinity) from initializeOnly MFInt32 field named coordIndex.
  
  Tooltip: [-1,+infinity) coordIndex indices are applied to contained Coordinate values in order to define randomly generated initial geometry of the particles.
  
  Warning: If no coordinates are available, PolylineEmitter acts like a point source located at local origin.
  
  Warning: coordIndex is required in order to connect contained coordinate point values.
  
  Returns:
  
  value of coordIndex field
- setCoordIndex
  PolylineEmitter setCoordIndex(int[] newValue)
  
  Accessor method to assign int array to initializeOnly MFInt32 field named coordIndex.
  
  Tooltip: [-1,+infinity) coordIndex indices are applied to contained Coordinate values in order to define randomly generated initial geometry of the particles.
  
  Warning: If no coordinates are available, PolylineEmitter acts like a point source located at local origin.
  
  Warning: coordIndex is required in order to connect contained coordinate point values.
  
  Parameters:
  
  newValue - is new value for the coordIndex field.
  
  Returns:
  
  PolylineEmitter - 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
  
  PolylineEmitter 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:
  
  PolylineEmitter - 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.
  
  Tooltip: [0,+infinity) Basic mass of each particle, defined in mass base units (default is kilograms).
  
  Hint: mass is needed if gravity or other force-related calculations are performed on a per-particle basis.
  
  Hint: https://en.wikipedia.org/wiki/Kilogram
  
  Hint: X3D Architecture 4.3.6 Standard units and coordinate system https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/concepts.html#Standardunitscoordinates
  
  Specified by:
  
  getMass in interface X3DParticleEmitterNode
  
  Returns:
  
  value of mass field
- setMass
  PolylineEmitter setMass(float newValue)
  
  Accessor method to assign float value to inputOutput SFFloat field named mass.
  
  Tooltip: [0,+infinity) Basic mass of each particle, defined in mass base units (default is kilograms).
  
  Hint: mass is needed if gravity or other force-related calculations are performed on a per-particle basis.
  
  Hint: https://en.wikipedia.org/wiki/Kilogram
  
  Hint: X3D Architecture 4.3.6 Standard units and coordinate system https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/concepts.html#Standardunitscoordinates
  
  Specified by:
  
  setMass in interface X3DParticleEmitterNode
  
  Parameters:
  
  newValue - is new value for the mass field.
  
  Returns:
  
  PolylineEmitter - 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.
  
  Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/core.html#Metadata
  
  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
  PolylineEmitter 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.
  
  Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/core.html#Metadata
  
  Specified by:
  
  setMetadata in interface X3DNode
  
  Specified by:
  
  setMetadata in interface X3DParticleEmitterNode
  
  Parameters:
  
  newValue - is new value for the metadata field.
  
  Returns:
  
  PolylineEmitter - 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
- getOn
  
  boolean getOn()
  
  Provide boolean value from inputOutput SFBool field named on.
  
  Tooltip: Enables/disables production of particles from this emitter node. If operating when turned off, existing particles complete their rendering process. *
  
  Specified by:
  
  getOn in interface X3DParticleEmitterNode
  
  Returns:
  
  value of on field
- setOn
  
  PolylineEmitter setOn(boolean newValue)
  
  Accessor method to assign boolean value to inputOutput SFBool field named on.
  
  Tooltip: Enables/disables production of particles from this emitter node. If operating when turned off, existing particles complete their rendering process. *
  
  Specified by:
  
  setOn in interface X3DParticleEmitterNode
  
  Parameters:
  
  newValue - is new value for the on field.
  
  Returns:
  
  PolylineEmitter - 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
  
  PolylineEmitter 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:
  
  PolylineEmitter - 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
  PolylineEmitter 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:
  
  PolylineEmitter - 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
  PolylineEmitter 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:
  
  PolylineEmitter - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

Interface PolylineEmitter

Method Summary

Method Details

getCoord

setCoord

getCoordIndex

setCoordIndex

getDirection

setDirection

getMass

setMass

getMetadata

setMetadata

getOn

setOn

getSpeed

setSpeed

getSurfaceArea

setSurfaceArea

getVariation

setVariation