Class PolylineEmitter
java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.ParticleSystems.PolylineEmitter
- All Implemented Interfaces:
X3DNode
,PolylineEmitter
,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
Package hint: This org.web3d.x3d.jsail concrete class is used for implementing a standalone X3D object as a Plain Old Java Object (POJO). If you are writing Java code for use inside an X3D Script node, compile separate code using only the org.web3d.x3d.sai package instead.
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 org.web3d.x3d.jsail concrete class is used for implementing a standalone X3D object as a Plain Old Java Object (POJO). If you are writing Java code for use inside an X3D Script node, compile separate code using only the org.web3d.x3d.sai package instead.
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
String constant COMPONENT defines X3D component for the PolylineEmitter element: ParticleSystemsstatic final String
containerField describes typical field relationship of a node to its parent.static final X3DCoordinateNode
SFNode field named coord has default value null (Java syntax) or NULL (XML syntax).MFInt32 field named coordIndex has default value {-1} (Java syntax) or -1 (XML syntax).static final float[]
SFVec3f field named direction has default value {0f,1f,0f} (Java syntax) or 0 1 0 (XML syntax).static final String
fromField ROUTE name for SFNode field named coord.static final String
fromField ROUTE name for SFVec3f field named direction.static final String
fromField ROUTE name for SFNode field named IS.static final String
fromField ROUTE name for SFFloat field named mass.static final String
fromField ROUTE name for SFNode field named metadata.static final String
fromField ROUTE name for SFBool field named on.static final String
fromField ROUTE name for SFFloat field named speed.static final String
fromField ROUTE name for SFFloat field named surfaceArea.static final String
fromField ROUTE name for SFFloat field named variation.static final IS
SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).static final int
Integer constant LEVEL provides default X3D ParticleSystems component level for this element: 1static final float
SFFloat field named mass has default value 0f (Java syntax) or 0 (XML syntax).static final X3DMetadataObject
SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).static final String
String constant NAME provides name of this element: PolylineEmitter.static final boolean
SFBool field named on has default value true (Java syntax) or true (XML syntax).static final float
SFFloat field named speed has default value 0f (Java syntax) or 0 (XML syntax).static final float
SFFloat field named surfaceArea has default value 0f (Java syntax) or 0 (XML syntax).static final String
toField ROUTE name for SFNode field named coord.static final String
toField ROUTE name for SFVec3f field named direction.static final String
toField ROUTE name for SFFloat field named mass.static final String
toField ROUTE name for SFNode field named metadata.static final String
toField ROUTE name for SFBool field named on.static final String
toField ROUTE name for MFInt32 field named set_coordIndex.static final String
toField ROUTE name for SFFloat field named speed.static final String
toField ROUTE name for SFFloat field named surfaceArea.static final String
toField ROUTE name for SFFloat field named variation.static final float
SFFloat field named variation has default value 0.25f (Java syntax) or 0.25 (XML syntax).Fields inherited from class org.web3d.x3d.jsail.X3DConcreteNode
containerField_ALLOWED_VALUES, containerFieldOverride, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE
Fields inherited from class org.web3d.x3d.jsail.X3DConcreteElement
CLASS_DEFAULT_VALUE, ID_DEFAULT_VALUE, STYLE_DEFAULT_VALUE, validationResult
-
Constructor Summary
ConstructorDescriptionConstructor for PolylineEmitter to initialize member variables with default values.PolylineEmitter
(String DEFlabel) Utility constructor that assigns DEF label after initializing member variables with default values. -
Method Summary
Modifier and TypeMethodDescriptionaddComments
(String newComment) Add comment as String to contained commentsList.addComments
(String[] newComments) Add comments as String[] array to contained commentsList.addComments
(CommentsBlock newCommentsBlock) Add CommentsBlock to contained commentsList.addCoordIndex
(int newValue) Add singleton int value to MFInt32 coordIndex field.addCoordIndex
(SFInt32 newValue) Add singleton SFInt32 value to MFInt32 coordIndex field.Utility method to clear SFNode value of coord field.Utility method to clear MFInt32 value of coordIndex field.clearIS()
Utility method to clear SFNode value of IS field.Utility method to clear SFNode value of metadata field.findElementByNameValue
(String nameValue) Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.findElementByNameValue
(String nameValue, String elementName) Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.findNodeByDEF
(String DEFvalue) Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.getAccessType
(String fieldName) Indicate accessType corresponding to given fieldName.final String
Defines X3D component for the PolylineEmitter element: ParticleSystemsfinal int
Provides default X3D component level for this element: 1final String
containerField describes typical field relationship of a node to its parent.getCoord()
Provide org.web3d.x3d.sai.Rendering.X3DCoordinateNode instance (using a properly typed node) from inputOutput SFNode field coord.int[]
Provide array of Integer results within allowed range of [-1,infinity) from initializeOnly MFInt32 field named coordIndex.Utility method to get ArrayList value of MFInt32 coordIndex field, similar togetCoordIndex()
.Utility method to get String value of MFInt32 coordIndex field, similar togetCoordIndex()
.Provide String value from inputOutput SFString field named class.Provide String value from inputOutput SFString field named style.getDEF()
Provide String value from inputOutput SFString field named DEF.float[]
Provide array of 3-tuple float results within allowed range of [-1,1] from inputOutput SFVec3f field named direction.final String
Provides name of this element: PolylineEmittergetFieldType
(String fieldName) Indicate type corresponding to given fieldName.Provide String value from inputOutput SFString field named id.getIS()
Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.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
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.getUSE()
Provide String value from inputOutput SFString field named USE.float
Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named variation.boolean
hasCoord()
Indicate whether an object is available for inputOutput SFNode field coord.boolean
hasElementByNameValue
(String nameValue, String elementName) Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.boolean
hasIS()
Indicate whether an object is available for inputOutput SFNode field IS.boolean
Indicate whether an object is available for inputOutput SFNode field metadata.boolean
hasNodeByDEF
(String DEFvalue) Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.final void
Initialize all member variables to default values.setCoord
(ProtoInstance newValue) Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field coord.setCoord
(X3DCoordinateNode newValue) Accessor method to assign org.web3d.x3d.sai.Rendering.X3DCoordinateNode instance (using a properly typed node) to inputOutput SFNode field coord.setCoordIndex
(int[] newValue) Accessor method to assign Integer array to initializeOnly MFInt32 field named coordIndex.setCoordIndex
(ArrayList<Integer> newValue) Assign ArrayList value of MFInt32 coordIndex field, similar tosetCoordIndex(int[])
.setCoordIndex
(MFInt32 newValue) Assign typed object value to MFInt32 coordIndex field, similar tosetCoordIndex(int[])
.final PolylineEmitter
setCssClass
(String newValue) Accessor method to assign String value to inputOutput SFString field named class.setCssClass
(SFString newValue) Assign typed object value to SFString cssClass field, similar tosetCssClass(String)
.final PolylineEmitter
setCssStyle
(String newValue) Accessor method to assign String value to inputOutput SFString field named style.setCssStyle
(SFString newValue) Assign typed object value to SFString cssClass field, similar tosetCssStyle(String)
.final PolylineEmitter
Accessor method to assign String value to inputOutput SFString field named DEF.Assign typed object value to SFString DEF field, similar tosetDEF(String)
.setDirection
(double[] newArray) Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetDirection(float[])
.setDirection
(double x, double y, double z) Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetDirection(float[])
.setDirection
(float[] newValue) Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named direction.setDirection
(float x, float y, float z) Assign values to SFVec3f direction field, similar tosetDirection(float[])
.setDirection
(SFVec3f newValue) Assign typed object value to SFVec3f direction field, similar tosetDirection(float[])
.final PolylineEmitter
Accessor method to assign String value to inputOutput SFString field named id.Assign typed object value to SFString HtmlID field, similar tosetHtmlID(String)
.Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.setMass
(double newValue) Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetMass(float)
.setMass
(float newValue) Accessor method to assign float value to inputOutput SFFloat field named mass.Assign typed object value to SFFloat mass field, similar tosetMass(float)
.setMetadata
(ProtoInstance newValue) Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.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.Assign typed object value to SFBool on field, similar tosetOn(boolean)
.setSpeed
(double newValue) Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetSpeed(float)
.setSpeed
(float newValue) Accessor method to assign float value to inputOutput SFFloat field named speed.Assign typed object value to SFFloat speed field, similar tosetSpeed(float)
.setSurfaceArea
(double newValue) Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetSurfaceArea(float)
.setSurfaceArea
(float newValue) Accessor method to assign float value to inputOutput SFFloat field named surfaceArea.setSurfaceArea
(SFFloat newValue) Assign typed object value to SFFloat surfaceArea field, similar tosetSurfaceArea(float)
.final PolylineEmitter
Accessor method to assign String value to inputOutput SFString field named USE.Assign typed object value to SFString USE field, similar tosetUSE(String)
.setUSE
(PolylineEmitter DEFnode) Assign a USE reference to another DEF node of same node type, similar tosetUSE(String)
.setVariation
(double newValue) Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetVariation(float)
.setVariation
(float newValue) Accessor method to assign float value to inputOutput SFFloat field named variation.setVariation
(SFFloat newValue) Assign typed object value to SFFloat variation field, similar tosetVariation(float)
.toStringClassicVRML
(int indentLevel) Recursive method to provide ClassicVRML string serialization.toStringVRML97
(int indentLevel) Recursive method to provide VRML97 string serialization.toStringX3D
(int indentLevel) Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.validate()
Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.Methods inherited from class org.web3d.x3d.jsail.X3DConcreteNode
getContainerFieldAllowedValues, getContainerFieldOverride, getName, hasDEF, hasNameField, hasUSE, includesNameField, isNode, isStatement, resetContainerFieldOverride, setConcreteDEF, setConcreteUSE, setContainerFieldOverride
Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement
addComments, clearParent, findAncestorElementByName, findAncestorProtoBody, findAncestorScene, findAncestorX3D, getPackageName, getParent, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorScene, hasAncestorX3D, hasParent, isValid, setConcreteCssClass, setConcreteCssStyle, setConcreteHtmlID, setParent, toStringClassicVRML, toStringVRML97, toStringX3D
-
Field Details
-
NAME
String constant NAME provides name of this element: PolylineEmitter.- See Also:
-
COMPONENT
String constant COMPONENT defines X3D component for the PolylineEmitter element: ParticleSystems- See Also:
-
LEVEL
public static final int LEVELInteger constant LEVEL provides default X3D ParticleSystems component level for this element: 1- See Also:
-
COORD_DEFAULT_VALUE
SFNode field named coord has default value null (Java syntax) or NULL (XML syntax). -
COORDINDEX_DEFAULT_VALUE
-
DIRECTION_DEFAULT_VALUE
public static final float[] DIRECTION_DEFAULT_VALUESFVec3f field named direction has default value {0f,1f,0f} (Java syntax) or 0 1 0 (XML syntax). -
IS_DEFAULT_VALUE
SFNode field named IS has default value null (Java syntax) or NULL (XML syntax). -
MASS_DEFAULT_VALUE
public static final float MASS_DEFAULT_VALUESFFloat field named mass has default value 0f (Java syntax) or 0 (XML syntax).- See Also:
-
METADATA_DEFAULT_VALUE
SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax). -
ON_DEFAULT_VALUE
public static final boolean ON_DEFAULT_VALUESFBool field named on has default value true (Java syntax) or true (XML syntax).- See Also:
-
SPEED_DEFAULT_VALUE
public static final float SPEED_DEFAULT_VALUESFFloat field named speed has default value 0f (Java syntax) or 0 (XML syntax).- See Also:
-
SURFACEAREA_DEFAULT_VALUE
public static final float SURFACEAREA_DEFAULT_VALUESFFloat field named surfaceArea has default value 0f (Java syntax) or 0 (XML syntax).- See Also:
-
VARIATION_DEFAULT_VALUE
public static final float VARIATION_DEFAULT_VALUESFFloat field named variation has default value 0.25f (Java syntax) or 0.25 (XML syntax).- See Also:
-
containerField_DEFAULT_VALUE
containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, this default value is provided for informational purposes only.
containerField_DEFAULT_VALUE = "emitter";
containerField_ALLOWED_VALUES = {"emitter" }; type xs:NMTOKEN- See Also:
-
fromField_COORD
fromField ROUTE name for SFNode field named coord.- See Also:
-
toField_COORD
-
fromField_DIRECTION
fromField ROUTE name for SFVec3f field named direction.- See Also:
-
toField_DIRECTION
toField ROUTE name for SFVec3f field named direction.- See Also:
-
fromField_IS
-
fromField_MASS
fromField ROUTE name for SFFloat field named mass.- See Also:
-
toField_MASS
-
fromField_METADATA
fromField ROUTE name for SFNode field named metadata.- See Also:
-
toField_METADATA
toField ROUTE name for SFNode field named metadata.- See Also:
-
fromField_ON
-
toField_ON
-
toField_SET_COORDINDEX
toField ROUTE name for MFInt32 field named set_coordIndex.- See Also:
-
fromField_SPEED
fromField ROUTE name for SFFloat field named speed.- See Also:
-
toField_SPEED
toField ROUTE name for SFFloat field named speed.- See Also:
-
fromField_SURFACEAREA
fromField ROUTE name for SFFloat field named surfaceArea.- See Also:
-
toField_SURFACEAREA
toField ROUTE name for SFFloat field named surfaceArea.- See Also:
-
fromField_VARIATION
fromField ROUTE name for SFFloat field named variation.- See Also:
-
toField_VARIATION
toField ROUTE name for SFFloat field named variation.- See Also:
-
-
Constructor Details
-
PolylineEmitter
public PolylineEmitter()Constructor for PolylineEmitter to initialize member variables with default values. -
PolylineEmitter
Utility constructor that assigns DEF label after initializing member variables with default values.- Parameters:
DEFlabel
- unique DEF name for this X3D node
-
-
Method Details
-
getElementName
Provides name of this element: PolylineEmitter- Specified by:
getElementName
in classX3DConcreteElement
- Returns:
- name of this element
-
getComponent
Defines X3D component for the PolylineEmitter element: ParticleSystems- Specified by:
getComponent
in classX3DConcreteElement
- Returns:
- X3D component for this element
-
getComponentLevel
public final int getComponentLevel()Provides default X3D component level for this element: 1- Specified by:
getComponentLevel
in classX3DConcreteElement
- Returns:
- default X3D component level for this element
-
getFieldType
Indicate type corresponding to given fieldName.- Specified by:
getFieldType
in classX3DConcreteElement
- Parameters:
fieldName
- name of field in this X3D node- Returns:
- X3D type (SFvec3f etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE if not recognized
- See Also:
-
getAccessType
Indicate accessType corresponding to given fieldName.- Specified by:
getAccessType
in classX3DConcreteElement
- Parameters:
fieldName
- name of field in this X3D node- Returns:
- X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized
- See Also:
-
getContainerFieldDefault
containerField describes typical field relationship of a node to its parent. Programmer usage is not ordinarily needed when using this API, since this default value is provided for informational purposes only.- Specified by:
getContainerFieldDefault
in classX3DConcreteNode
- Returns:
- default containerField value
- See Also:
-
initialize
public final void initialize()Initialize all member variables to default values.- Overrides:
initialize
in classX3DConcreteNode
-
getCoord
Provide org.web3d.x3d.sai.Rendering.X3DCoordinateNode instance (using a properly typed node) from inputOutput SFNode field coord.- Specified by:
getCoord
in interfacePolylineEmitter
- Returns:
- value of coord field
- See Also:
-
setCoord
Accessor method to assign org.web3d.x3d.sai.Rendering.X3DCoordinateNode instance (using a properly typed node) to inputOutput SFNode field coord.- Specified by:
setCoord
in interfacePolylineEmitter
- 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).- See Also:
-
clearCoord
Utility method to clear SFNode value of coord field.- Returns:
PolylineEmitter
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setCoord
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field coord.- 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).- See Also:
-
hasCoord
public boolean hasCoord()Indicate whether an object is available for inputOutput SFNode field coord.- Returns:
- whether a properly typed node or ProtoInstance or CommentsBlock is available.
- See Also:
-
getCoordIndex
public int[] getCoordIndex()Provide array of Integer 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.
- Specified by:
getCoordIndex
in interfacePolylineEmitter
- Returns:
- value of coordIndex field
-
getCoordIndexList
Utility method to get ArrayList value of MFInt32 coordIndex field, similar togetCoordIndex()
.- Returns:
- value of coordIndex field
-
getCoordIndexString
Utility method to get String value of MFInt32 coordIndex field, similar togetCoordIndex()
.- Returns:
- value of coordIndex field
-
setCoordIndex
Accessor method to assign Integer 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.
- Specified by:
setCoordIndex
in interfacePolylineEmitter
- 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).
-
setCoordIndex
Assign typed object value to MFInt32 coordIndex field, similar tosetCoordIndex(int[])
.- 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).
-
setCoordIndex
Assign ArrayList value of MFInt32 coordIndex field, similar tosetCoordIndex(int[])
.- 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).
-
clearCoordIndex
Utility method to clear MFInt32 value of coordIndex field. This method does not initialize withCOORDINDEX_DEFAULT_VALUE.- Returns:
PolylineEmitter
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
addCoordIndex
Add singleton int value to MFInt32 coordIndex field.- Parameters:
newValue
- is new value to add to the coordIndex field.- Returns:
PolylineEmitter
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addCoordIndex
Add singleton SFInt32 value to MFInt32 coordIndex field.- Parameters:
newValue
- is new value to add to the coordIndex field.- Returns:
PolylineEmitter
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getDirection
public 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. *- Specified by:
getDirection
in interfacePolylineEmitter
- Returns:
- value of direction field
-
setDirection
Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named direction.
Tooltip: Initial direction from which particles emanate. *- Specified by:
setDirection
in interfacePolylineEmitter
- 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).
-
setDirection
Assign typed object value to SFVec3f direction field, similar tosetDirection(float[])
.- 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).
-
setDirection
Assign values to SFVec3f direction field, similar tosetDirection(float[])
.- Parameters:
x
- first componenty
- second componentz
- third component- Returns:
PolylineEmitter
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setDirection
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetDirection(float[])
.- Parameters:
x
- first componenty
- second componentz
- third component- Returns:
PolylineEmitter
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setDirection
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetDirection(float[])
.- Parameters:
newArray
- is new value for field- Returns:
PolylineEmitter
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getIS
Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.- Specified by:
getIS
in classX3DConcreteNode
- Returns:
- value of IS field
- See Also:
-
setIS
Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.- Specified by:
setIS
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the IS field.- Returns:
PolylineEmitter
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
clearIS
Utility method to clear SFNode value of IS field.- Returns:
PolylineEmitter
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
hasIS
public boolean hasIS()Indicate whether an object is available for inputOutput SFNode field IS.- Returns:
- whether a concrete statement or CommentsBlock is available.
- See Also:
-
getMass
public 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 interfacePolylineEmitter
- 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 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 interfacePolylineEmitter
- Specified by:
setMass
in interfaceX3DParticleEmitterNode
- 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).
-
setMass
Assign typed object value to SFFloat mass field, similar tosetMass(float)
.- 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).
-
setMass
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetMass(float)
.- Parameters:
newValue
- is new value for field- Returns:
PolylineEmitter
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getMetadata
Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.- Specified by:
getMetadata
in interfacePolylineEmitter
- 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.- Specified by:
setMetadata
in interfacePolylineEmitter
- Specified by:
setMetadata
in interfaceX3DNode
- Specified by:
setMetadata
in interfaceX3DParticleEmitterNode
- Specified by:
setMetadata
in classX3DConcreteNode
- 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:
-
clearMetadata
Utility method to clear SFNode value of metadata field.- Returns:
PolylineEmitter
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setMetadata
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.- Specified by:
setMetadata
in classX3DConcreteNode
- 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:
-
hasMetadata
public boolean hasMetadata()Indicate whether an object is available for inputOutput SFNode field metadata.- Returns:
- whether a properly typed node or ProtoInstance or CommentsBlock is available.
- See Also:
-
getOn
public 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 interfacePolylineEmitter
- 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 interfacePolylineEmitter
- Specified by:
setOn
in interfaceX3DParticleEmitterNode
- 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).
-
setOn
Assign typed object value to SFBool on field, similar tosetOn(boolean)
.- 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
public 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 interfacePolylineEmitter
- 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 interfacePolylineEmitter
- Specified by:
setSpeed
in interfaceX3DParticleEmitterNode
- 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).
-
setSpeed
Assign typed object value to SFFloat speed field, similar tosetSpeed(float)
.- 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).
-
setSpeed
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetSpeed(float)
.- Parameters:
newValue
- is new value for field- Returns:
PolylineEmitter
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getSurfaceArea
public 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 interfacePolylineEmitter
- 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 interfacePolylineEmitter
- Specified by:
setSurfaceArea
in interfaceX3DParticleEmitterNode
- 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).
-
setSurfaceArea
Assign typed object value to SFFloat surfaceArea field, similar tosetSurfaceArea(float)
.- 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).
-
setSurfaceArea
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetSurfaceArea(float)
.- Parameters:
newValue
- is new value for field- Returns:
PolylineEmitter
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getVariation
public 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 interfacePolylineEmitter
- 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 interfacePolylineEmitter
- Specified by:
setVariation
in interfaceX3DParticleEmitterNode
- 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).
-
setVariation
Assign typed object value to SFFloat variation field, similar tosetVariation(float)
.- 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).
-
setVariation
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetVariation(float)
.- Parameters:
newValue
- is new value for field- Returns:
PolylineEmitter
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getDEF
Provide String value from inputOutput SFString field named DEF.
Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.- Hint: descriptive DEF names improve clarity and help document a model.
- Hint: well-defined names can simplify design and debugging through improved author understanding.
- Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
- Overrides:
getDEF
in classX3DConcreteNode
- Returns:
- value of DEF field
- See Also:
-
setDEF
Accessor method to assign String value to inputOutput SFString field named DEF.
Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.- Hint: descriptive DEF names improve clarity and help document a model.
- Hint: well-defined names can simplify design and debugging through improved author understanding.
- Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
Note that setting the DEF value clears the USE value.- Specified by:
setDEF
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the DEF field.- Returns:
PolylineEmitter
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setDEF
Assign typed object value to SFString DEF field, similar tosetDEF(String)
.- Parameters:
newValue
- is new value for the DEF field.- Returns:
PolylineEmitter
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getUSE
Provide String value from inputOutput SFString field named USE.
Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value).- Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
- Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute.
- Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
- Overrides:
getUSE
in classX3DConcreteNode
- Returns:
- value of USE field
- See Also:
-
setUSE
Accessor method to assign String value to inputOutput SFString field named USE.
Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value).- Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
- Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute.
- Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
Note: eachUSE
node is still an independent object, with theUSE
value matching theDEF
value in the preceding object.
Warning: invoking thesetUSE()
method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.
Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.- Specified by:
setUSE
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the USE field.- Returns:
PolylineEmitter
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setUSE
Assign typed object value to SFString USE field, similar tosetUSE(String)
.- Parameters:
newValue
- is new value for the USE field.- Returns:
PolylineEmitter
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getCssClass
Provide String value from inputOutput SFString field named class.- Overrides:
getCssClass
in classX3DConcreteElement
- Returns:
- value of class field
- See Also:
-
setCssClass
Accessor method to assign String value to inputOutput SFString field named class.- Specified by:
setCssClass
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the class field.- Returns:
PolylineEmitter
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
setCssClass
Assign typed object value to SFString cssClass field, similar tosetCssClass(String)
.- Parameters:
newValue
- is new value for the class field.- Returns:
PolylineEmitter
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getHtmlID
Provide String value from inputOutput SFString field named id.- Overrides:
getHtmlID
in classX3DConcreteElement
- Returns:
- value of id field
- See Also:
-
setHtmlID
Accessor method to assign String value to inputOutput SFString field named id.- Specified by:
setHtmlID
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the id field.- Returns:
PolylineEmitter
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
setHtmlID
Assign typed object value to SFString HtmlID field, similar tosetHtmlID(String)
.- Parameters:
newValue
- is new value for the id field.- Returns:
PolylineEmitter
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getCssStyle
Provide String value from inputOutput SFString field named style.- Overrides:
getCssStyle
in classX3DConcreteElement
- Returns:
- value of style field
- See Also:
-
setCssStyle
Accessor method to assign String value to inputOutput SFString field named style.- Specified by:
setCssStyle
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the style field.- Returns:
PolylineEmitter
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
setCssStyle
Assign typed object value to SFString cssClass field, similar tosetCssStyle(String)
.- Parameters:
newValue
- is new value for the style field.- Returns:
PolylineEmitter
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setUSE
Assign a USE reference to another DEF node of same node type, similar tosetUSE(String)
.
Warning: note that thesetUSE()
method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.
Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.- Parameters:
DEFnode
- must have a DEF value defined- Returns:
PolylineEmitter
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addComments
Add comment as String to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newComment
- initial value- Returns:
PolylineEmitter
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
addComments
Add comments as String[] array to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newComments
- array of comments- Returns:
PolylineEmitter
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
addComments
Add CommentsBlock to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newCommentsBlock
- block of comments to add- Returns:
PolylineEmitter
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
toStringX3D
Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.- Specified by:
toStringX3D
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- X3D string
- See Also:
-
toStringClassicVRML
Recursive method to provide ClassicVRML string serialization.- Specified by:
toStringClassicVRML
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- ClassicVRML string
- See Also:
-
toStringVRML97
Recursive method to provide VRML97 string serialization.- Specified by:
toStringVRML97
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- VRML97 string
- See Also:
-
findElementByNameValue
Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.
Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.
Warning: more than one element may be found that has the same name, this method does not handle that case.- Specified by:
findElementByNameValue
in classX3DConcreteElement
- Parameters:
nameValue
- is value of the name field being searched for in this element and child elements(if any)- Returns:
- object reference to found element, null otherwise
- See Also:
-
findElementByNameValue
Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.
Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.
Warning: more than one element may be found that has the same name, this method does not handle that case.- Specified by:
findElementByNameValue
in classX3DConcreteElement
- Parameters:
nameValue
- is value of the name field being searched for in this element and child elements(if any)elementName
- identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)- Returns:
- object reference to found element, null otherwise
- See Also:
-
hasElementByNameValue
Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.- Parameters:
nameValue
- is value of the name field being searched for in this element and child elements(if any)elementName
- identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)- Returns:
- whether node is found
- See Also:
-
findNodeByDEF
Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.
Warning: more than one element may be found that has the same DEF, this method does not handle that case.- Specified by:
findNodeByDEF
in classX3DConcreteElement
- Parameters:
DEFvalue
- is value of the name field being searched for in this element and child elements(if any)- Returns:
- object reference to found node, null otherwise
- See Also:
-
hasNodeByDEF
Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.- Parameters:
DEFvalue
- is value of the name field being searched for in this element and child elements(if any)- Returns:
- whether node is found
- See Also:
-
validate
Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values. TODO document specific validation methods.- Specified by:
validate
in classX3DConcreteElement
- Returns:
- validation results (if any)
-