Package org.web3d.x3d.sai.ParticleSystems

Interface PointEmitter

All Superinterfaces:

X3DNode, X3DParticleEmitterNode

All Known Implementing Classes:

PointEmitter

public interface PointEmitter
extends X3DParticleEmitterNode

PointEmitter generates particles from a specific point in space using the specified direction and speed.

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. PointEmitter node tooltip: (X3D version 3.2 or later) [X3DParticleEmitterNode] PointEmitter generates particles from a specific point in space using the specified direction and speed. *


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: PointEmitter
• X3D Tooltips: PointEmitter
• X3D Scene Authoring Hints

Method Summary

Modifier and Type	Method	Description
float[]	getDirection()	Provide array of 3-tuple float results 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[]	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.
PointEmitter	setDirection(float[] newValue)	Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named direction.
PointEmitter	setMass(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named mass.
PointEmitter	setMetadata(X3DMetadataObject newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
PointEmitter	setOn(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named on.
PointEmitter	setPosition(float[] newValue)	Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named position.
PointEmitter	setSpeed(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named speed.
PointEmitter	setSurfaceArea(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named surfaceArea.
PointEmitter	setVariation(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named variation.

Method Details

getDirection

float[] getDirection()

Provide array of 3-tuple float results from inputOutput SFVec3f field named direction.

Tooltip: Initial direction from which particles emanate. *

Returns:

value of direction field

setDirection

PointEmitter 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:

PointEmitter - 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

PointEmitter 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:

PointEmitter - 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

PointEmitter 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:

PointEmitter - 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

PointEmitter 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:

PointEmitter - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

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

PointEmitter 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:

PointEmitter - 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

PointEmitter 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:

PointEmitter - 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

PointEmitter 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:

PointEmitter - 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

PointEmitter 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:

PointEmitter - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).