Interface ConeEmitter
 All Superinterfaces:
X3DNode
,X3DParticleEmitterNode
 All Known Implementing Classes:
ConeEmitter
ConeEmitter generates all available particles from a specific point in space.
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
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
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.
ConeEmitter 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:

Method Summary
Modifier and TypeMethodDescriptionfloat
getAngle()
Provide float value unit axis, angle (in radians) within allowed range of [0,3.1416] from inputOutput SFFloat field named angle.float[]
Provide array of 3tuple 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.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[]
Provide array of 3tuple 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
Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named surfaceArea.float
Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named variation.setAngle
(float newValue) Accessor method to assign float value unit axis, angle (in radians) to inputOutput SFFloat field named angle.setDirection
(float[] newValue) Accessor method to assign 3tuple float array to inputOutput SFVec3f field named direction.setMass
(float newValue) Accessor method to assign float value to inputOutput SFFloat field named mass.setMetadata
(X3DMetadataObject newValue) Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.setOn
(boolean newValue) Accessor method to assign boolean value to inputOutput SFBool field named on.setPosition
(float[] newValue) Accessor method to assign 3tuple float array to inputOutput SFVec3f field named position.setSpeed
(float newValue) Accessor method to assign float value to inputOutput SFFloat field named speed.setSurfaceArea
(float newValue) Accessor method to assign float value to inputOutput SFFloat field named surfaceArea.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. Hint: radian units for angular measure https://en.wikipedia.org/wiki/Radian
 Returns:
 value of angle field

setAngle
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. Hint: radian units for angular measure https://en.wikipedia.org/wiki/Radian
 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 3tuple 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
Accessor method to assign 3tuple 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.
Tooltip: [0,+infinity) Basic mass of each particle, defined in mass base units (default is kilograms). Hint: mass is needed if gravity or other forcerelated calculations are performed on a perparticle 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/ISOIEC197751v4IS//Part01/concepts.html#Standardunitscoordinates
 Specified by:
getMass
in interfaceX3DParticleEmitterNode
 Returns:
 value of mass field

setMass
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 forcerelated calculations are performed on a perparticle 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/ISOIEC197751v4IS//Part01/concepts.html#Standardunitscoordinates
 Specified by:
setMass
in interfaceX3DParticleEmitterNode
 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. Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISOIEC197751v4IS//Part01/components/core.html#Metadata
 Specified by:
getMetadata
in interfaceX3DNode
 Specified by:
getMetadata
in interfaceX3DParticleEmitterNode
 Returns:
 value of metadata field
 See Also:

setMetadata
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/ISOIEC197751v4IS//Part01/components/core.html#Metadata
 Specified by:
setMetadata
in interfaceX3DNode
 Specified by:
setMetadata
in interfaceX3DParticleEmitterNode
 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:

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 interfaceX3DParticleEmitterNode
 Returns:
 value of on field

setOn
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 interfaceX3DParticleEmitterNode
 Parameters:
newValue
 is new value for the on field. Returns:
ConeEmitter
 namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getPosition
float[] getPosition()Provide array of 3tuple float results from inputOutput SFVec3f field named position.
Tooltip: Point from which particles emanate. * Returns:
 value of position field

setPosition
Accessor method to assign 3tuple 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 interfaceX3DParticleEmitterNode
 Returns:
 value of speed field

setSpeed
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 interfaceX3DParticleEmitterNode
 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 interfaceX3DParticleEmitterNode
 Returns:
 value of surfaceArea field

setSurfaceArea
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 interfaceX3DParticleEmitterNode
 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 interfaceX3DParticleEmitterNode
 Returns:
 value of variation field

setVariation
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 interfaceX3DParticleEmitterNode
 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).
