Class CollisionCollection

java.lang.Object

org.web3d.x3d.jsail.X3DConcreteElement

org.web3d.x3d.jsail.X3DConcreteNode

org.web3d.x3d.jsail.RigidBodyPhysics.CollisionCollection

All Implemented Interfaces:

X3DChildNode, X3DNode, X3DBoundedObject, CollisionCollection

public class CollisionCollection
extends X3DConcreteNode
implements CollisionCollection

CollisionCollection holds a collection of objects that can be managed as a single entity for resolution of inter-object collisions.

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. CollisionCollection node tooltip: (X3D version 3.2 or later) [X3DChildNode,X3DBoundedObject] CollisionCollection holds a collection of objects that can be managed as a single entity for resolution of inter-object collisions.

• Hint: contains an array of CollisionSpace, CollidableShape or CollidableOffset nodes (containerField='collidables').
• Hint: content must be visible to be collidable and to be pickable.

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:

• X3D Abstract Specification: CollisionCollection
• X3D Tooltips: CollisionCollection
• X3D Scene Authoring Hints

Field Summary

Fields

Modifier and Type	Field	Description
static final String	APPLIEDPARAMETERS_BOUNCE	Tooltip: The bounce field value is used.
static final String	APPLIEDPARAMETERS_CONSTANT_FORCE	Tooltip: Apply softnessConstantForceMix value.
static final ArrayList<String>	APPLIEDPARAMETERS_DEFAULT_VALUE	MFString field named appliedParameters has default quoted value new String[] {"BOUNCE"} (Java syntax) or quoted value "BOUNCE" (XML syntax).
static final String	APPLIEDPARAMETERS_ERROR_REDUCTION	Tooltip: Apply softnessErrorCorrection value.
static final String	APPLIEDPARAMETERS_FRICTION_COEFFICIENT_2	Tooltip: Apply frictionCoefficients values.
static final String	APPLIEDPARAMETERS_SLIP_1	Tooltip: Apply first component of slipFactors array.
static final String	APPLIEDPARAMETERS_SLIP_2	Tooltip: Apply second component of slipFactors array.
static final String	APPLIEDPARAMETERS_SPEED_1	Tooltip: Apply first component of surfaceSpeed array.
static final String	APPLIEDPARAMETERS_SPEED_2	Tooltip: Apply second component of surfaceSpeed array.
static final String	APPLIEDPARAMETERS_USER_FRICTION	Tooltip: The system will normally calculate the friction direction vector that is perpendicular to the contact normal.
static final float[]	BBOXCENTER_DEFAULT_VALUE	SFVec3f field named bboxCenter has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).
static final boolean	BBOXDISPLAY_DEFAULT_VALUE	SFBool field named bboxDisplay has default value false (Java syntax) or false (XML syntax).
static final float[]	BBOXSIZE_DEFAULT_VALUE	SFVec3f field named bboxSize has default value {-1f,-1f,-1f} (Java syntax) or -1 -1 -1 (XML syntax).
static final float	BOUNCE_DEFAULT_VALUE	SFFloat field named bounce has default value 0f (Java syntax) or 0 (XML syntax).
static final String	COMPONENT	String constant COMPONENT defines X3D component for the CollisionCollection element: RigidBodyPhysics
static final String	containerField_DEFAULT_VALUE	containerField describes typical field relationship of a node to its parent.
static final String	DESCRIPTION_DEFAULT_VALUE	SFString field named description has default value equal to an empty string.
static final boolean	ENABLED_DEFAULT_VALUE	SFBool field named enabled has default value true (Java syntax) or true (XML syntax).
static final float[]	FRICTIONCOEFFICIENTS_DEFAULT_VALUE	SFVec2f field named frictionCoefficients has default value {0f,0f} (Java syntax) or 0 0 (XML syntax).
static final String	fromField_APPLIEDPARAMETERS	fromField ROUTE name for MFString field named appliedParameters.
static final String	fromField_BBOXDISPLAY	fromField ROUTE name for SFBool field named bboxDisplay.
static final String	fromField_BOUNCE	fromField ROUTE name for SFFloat field named bounce.
static final String	fromField_COLLIDABLES	fromField ROUTE name for MFNode field named collidables.
static final String	fromField_DESCRIPTION	fromField ROUTE name for SFString field named description.
static final String	fromField_ENABLED	fromField ROUTE name for SFBool field named enabled.
static final String	fromField_FRICTIONCOEFFICIENTS	fromField ROUTE name for SFVec2f field named frictionCoefficients.
static final String	fromField_IS	fromField ROUTE name for SFNode field named IS.
static final String	fromField_METADATA	fromField ROUTE name for SFNode field named metadata.
static final String	fromField_MINBOUNCESPEED	fromField ROUTE name for SFFloat field named minBounceSpeed.
static final String	fromField_SLIPFACTORS	fromField ROUTE name for SFVec2f field named slipFactors.
static final String	fromField_SOFTNESSCONSTANTFORCEMIX	fromField ROUTE name for SFFloat field named softnessConstantForceMix.
static final String	fromField_SOFTNESSERRORCORRECTION	fromField ROUTE name for SFFloat field named softnessErrorCorrection.
static final String	fromField_SURFACESPEED	fromField ROUTE name for SFVec2f field named surfaceSpeed.
static final String	fromField_VISIBLE	fromField ROUTE name for SFBool field named visible.
static final IS	IS_DEFAULT_VALUE	SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).
static final int	LEVEL	Integer constant LEVEL provides default X3D RigidBodyPhysics component level for this element: 1
static final X3DMetadataObject	METADATA_DEFAULT_VALUE	SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).
static final float	MINBOUNCESPEED_DEFAULT_VALUE	SFFloat field named minBounceSpeed has default value 0.1f (Java syntax) or 0.1 (XML syntax).
static final String	NAME	String constant NAME provides name of this element: CollisionCollection.
static final float[]	SLIPFACTORS_DEFAULT_VALUE	SFVec2f field named slipFactors has default value {0f,0f} (Java syntax) or 0 0 (XML syntax).
static final float	SOFTNESSCONSTANTFORCEMIX_DEFAULT_VALUE	SFFloat field named softnessConstantForceMix has default value 0.0001f (Java syntax) or 0.0001 (XML syntax).
static final float	SOFTNESSERRORCORRECTION_DEFAULT_VALUE	SFFloat field named softnessErrorCorrection has default value 0.8f (Java syntax) or 0.8 (XML syntax).
static final float[]	SURFACESPEED_DEFAULT_VALUE	SFVec2f field named surfaceSpeed has default value {0f,0f} (Java syntax) or 0 0 (XML syntax).
static final String	toField_APPLIEDPARAMETERS	toField ROUTE name for MFString field named appliedParameters.
static final String	toField_BBOXDISPLAY	toField ROUTE name for SFBool field named bboxDisplay.
static final String	toField_BOUNCE	toField ROUTE name for SFFloat field named bounce.
static final String	toField_COLLIDABLES	toField ROUTE name for MFNode field named collidables.
static final String	toField_DESCRIPTION	toField ROUTE name for SFString field named description.
static final String	toField_ENABLED	toField ROUTE name for SFBool field named enabled.
static final String	toField_FRICTIONCOEFFICIENTS	toField ROUTE name for SFVec2f field named frictionCoefficients.
static final String	toField_METADATA	toField ROUTE name for SFNode field named metadata.
static final String	toField_MINBOUNCESPEED	toField ROUTE name for SFFloat field named minBounceSpeed.
static final String	toField_SLIPFACTORS	toField ROUTE name for SFVec2f field named slipFactors.
static final String	toField_SOFTNESSCONSTANTFORCEMIX	toField ROUTE name for SFFloat field named softnessConstantForceMix.
static final String	toField_SOFTNESSERRORCORRECTION	toField ROUTE name for SFFloat field named softnessErrorCorrection.
static final String	toField_SURFACESPEED	toField ROUTE name for SFVec2f field named surfaceSpeed.
static final String	toField_VISIBLE	toField ROUTE name for SFBool field named visible.
static final boolean	VISIBLE_DEFAULT_VALUE	SFBool field named visible has default value true (Java syntax) or true (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

Constructors

Constructor	Description
CollisionCollection()	Constructor for CollisionCollection to initialize member variables with default values.
CollisionCollection(String DEFlabel)	Utility constructor that assigns DEF label after initializing member variables with default values.

Method Summary

Modifier and Type	Method	Description
CollisionCollection	addAppliedParameters(String newValue)	Add singleton String value to MFString appliedParameters field.
CollisionCollection	addAppliedParameters(SFString newValue)	Add singleton SFString value to MFString appliedParameters field.
CollisionCollection	addCollidables(ProtoInstance newValue)	Add single ProtoInstance (with appropriate node type and containerField value) to MFNode array for collidables field.
CollisionCollection	addCollidables(X3DNode newValue)	Add single child node to existing array of collidables nodes (if any).
void	addCollidables(X3DNode[] newValue)	Add array of child collidables nodes to array of existing nodes (if any).
CollisionCollection	addComments(String newComment)	Add comment as String to contained commentsList.
CollisionCollection	addComments(String[] newComments)	Add comments as String[] array to contained commentsList.
CollisionCollection	addComments(CommentsBlock newCommentsBlock)	Add CommentsBlock to contained commentsList.
CollisionCollection	clearAppliedParameters()	Utility method to clear MFString value of appliedParameters field.
CollisionCollection	clearCollidables()	Utility method to clear MFNode value of collidables field.
CollisionCollection	clearIS()	Utility method to clear SFNode value of IS field.
CollisionCollection	clearMetadata()	Utility method to clear SFNode value of metadata field.
X3DConcreteElement	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.
X3DConcreteElement	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.
X3DConcreteNode	findNodeByDEF(String DEFvalue)	Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
String	getAccessType(String fieldName)	Indicate accessType corresponding to given fieldName.
String[]	getAppliedParameters()	Provide array of String enumeration results (baseType MFString) ['"BOUNCE"' | '"USER_FRICTION"' | '"FRICTION_COEFFICIENT-2"' | '"ERROR_REDUCTION"' | '"CONSTANT_FORCE"' | '"SPEED-1"' | '"SPEED-2"' | '"SLIP-1"' | '"SLIP-2"'] from inputOutput MFString field named appliedParameters.
ArrayList<String>	getAppliedParametersList()	Utility method to get ArrayList value of MFString appliedParameters field, similar to getAppliedParameters().
String	getAppliedParametersString()	Utility method to get String value of MFString appliedParameters field, similar to getAppliedParameters().
float[]	getBboxCenter()	Provide array of 3-tuple float results from initializeOnly SFVec3f field named bboxCenter.
boolean	getBboxDisplay()	Provide boolean value from inputOutput SFBool field named bboxDisplay.
float[]	getBboxSize()	Provide array of 3-tuple float results within allowed range of [0,infinity), or default value [-1 -1 -1], from initializeOnly SFVec3f field named bboxSize.
float	getBounce()	Provide float value within allowed range of [0,1] from inputOutput SFFloat field named bounce.
X3DNode[]	getCollidables()	Provide array of org.web3d.x3d.sai.Core.X3DNode results (using an array consisting of properly typed nodes or ProtoInstances) with acceptable node types limited to X3DNBodyCollisionSpaceNode|X3DNBodyCollidableNode, from inputOutput MFNode field collidables.
ArrayList<X3DNode>	getCollidablesList()	Utility method to get ArrayList value of MFNode collidables field, similar to getCollidables().
final String	getComponent()	Defines X3D component for the CollisionCollection element: RigidBodyPhysics
final int	getComponentLevel()	Provides default X3D component level for this element: 1
final String	getContainerFieldDefault()	containerField describes typical field relationship of a node to its parent.
String	getCssClass()	Provide String value from inputOutput SFString field named class.
String	getCssStyle()	Provide String value from inputOutput SFString field named style.
String	getDEF()	Provide String value from inputOutput SFString field named DEF.
String	getDescription()	Provide String value from inputOutput SFString field named description.
final String	getElementName()	Provides name of this element: CollisionCollection
boolean	getEnabled()	Provide boolean value from inputOutput SFBool field named enabled.
String	getFieldType(String fieldName)	Indicate type corresponding to given fieldName.
float[]	getFrictionCoefficients()	Provide array of 2-tuple float results within allowed range of [0,infinity) from inputOutput SFVec2f field named frictionCoefficients.
String	getHtmlID()	Provide String value from inputOutput SFString field named id.
IS	getIS()	Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.
X3DMetadataObject	getMetadata()	Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
float	getMinBounceSpeed()	Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named minBounceSpeed.
float[]	getSlipFactors()	Provide array of 2-tuple float results from inputOutput SFVec2f field named slipFactors.
float	getSoftnessConstantForceMix()	Provide float value within allowed range of [0,1] from inputOutput SFFloat field named softnessConstantForceMix.
float	getSoftnessErrorCorrection()	Provide float value within allowed range of [0,1] from inputOutput SFFloat field named softnessErrorCorrection.
float[]	getSurfaceSpeed()	Provide array of 2-tuple float results from inputOutput SFVec2f field named surfaceSpeed.
String	getUSE()	Provide String value from inputOutput SFString field named USE.
boolean	getVisible()	Provide boolean value from inputOutput SFBool field named visible.
boolean	hasCollidables()	Indicate whether an object is available for inputOutput MFNode field collidables.
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	hasMetadata()	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()	Initialize all member variables to default values.
CollisionCollection	setAppliedParameters(String newValue)	Assign singleton String value to MFString appliedParameters field, similar to setAppliedParameters(String[]).
CollisionCollection	setAppliedParameters(String[] newValue)	Accessor method to assign String enumeration array (""BOUNCE"" | ""USER_FRICTION"" | ""FRICTION_COEFFICIENT-2"" | ""ERROR_REDUCTION"" | ""CONSTANT_FORCE"" | ""SPEED-1"" | ""SPEED-2"" | ""SLIP-1"" | ""SLIP-2"") to inputOutput MFString field named appliedParameters.
CollisionCollection	setAppliedParameters(ArrayList<String> newValue)	Assign ArrayList value of MFString appliedParameters field, similar to setAppliedParameters(String[]).
CollisionCollection	setAppliedParameters(MFString newValue)	Assign typed object value to MFString appliedParameters field, similar to setAppliedParameters(String[]).
CollisionCollection	setAppliedParameters(SFString newValue)	Assign single SFString object value to MFString appliedParameters field, similar to setAppliedParameters(String[]).
CollisionCollection	setBboxCenter(double[] newArray)	Utility method: double-precision set-array accessor for X3D floating-point type, similar to setBboxCenter(float[]).
CollisionCollection	setBboxCenter(double x, double y, double z)	Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setBboxCenter(float[]).
CollisionCollection	setBboxCenter(float[] newValue)	Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxCenter.
CollisionCollection	setBboxCenter(float x, float y, float z)	Assign values to SFVec3f bboxCenter field, similar to setBboxCenter(float[]).
CollisionCollection	setBboxCenter(SFVec3f newValue)	Assign typed object value to SFVec3f bboxCenter field, similar to setBboxCenter(float[]).
CollisionCollection	setBboxDisplay(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named bboxDisplay.
CollisionCollection	setBboxDisplay(SFBool newValue)	Assign typed object value to SFBool bboxDisplay field, similar to setBboxDisplay(boolean).
CollisionCollection	setBboxSize(double[] newArray)	Utility method: double-precision set-array accessor for X3D floating-point type, similar to setBboxSize(float[]).
CollisionCollection	setBboxSize(double x, double y, double z)	Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setBboxSize(float[]).
CollisionCollection	setBboxSize(float[] newValue)	Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxSize.
CollisionCollection	setBboxSize(float x, float y, float z)	Assign values to SFVec3f bboxSize field, similar to setBboxSize(float[]).
CollisionCollection	setBboxSize(SFVec3f newValue)	Assign typed object value to SFVec3f bboxSize field, similar to setBboxSize(float[]).
CollisionCollection	setBounce(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setBounce(float).
CollisionCollection	setBounce(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named bounce.
CollisionCollection	setBounce(SFFloat newValue)	Assign typed object value to SFFloat bounce field, similar to setBounce(float).
CollisionCollection	setCollidables(ArrayList<X3DNode> newValue)	Assign ArrayList value of MFNode collidables field, similar to setCollidables(org.web3d.x3d.sai.Core.X3DNode[]).
void	setCollidables(X3DNode newValue)	Set single child collidables node, replacing prior array of existing nodes (if any).
CollisionCollection	setCollidables(X3DNode[] newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DNode array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field collidables.
final CollisionCollection	setCssClass(String newValue)	Accessor method to assign String value to inputOutput SFString field named class.
CollisionCollection	setCssClass(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssClass(String).
final CollisionCollection	setCssStyle(String newValue)	Accessor method to assign String value to inputOutput SFString field named style.
CollisionCollection	setCssStyle(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssStyle(String).
final CollisionCollection	setDEF(String newValue)	Accessor method to assign String value to inputOutput SFString field named DEF.
CollisionCollection	setDEF(SFString newValue)	Assign typed object value to SFString DEF field, similar to setDEF(String).
CollisionCollection	setDescription(String newValue)	Accessor method to assign String value to inputOutput SFString field named description.
CollisionCollection	setDescription(SFString newValue)	Assign typed object value to SFString description field, similar to setDescription(String).
CollisionCollection	setEnabled(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named enabled.
CollisionCollection	setEnabled(SFBool newValue)	Assign typed object value to SFBool enabled field, similar to setEnabled(boolean).
CollisionCollection	setFrictionCoefficients(double[] newArray)	Utility method: double-precision set-array accessor for X3D floating-point type, similar to setFrictionCoefficients(float[]).
CollisionCollection	setFrictionCoefficients(double x, double y)	Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setFrictionCoefficients(float[]).
CollisionCollection	setFrictionCoefficients(float[] newValue)	Accessor method to assign 2-tuple float array to inputOutput SFVec2f field named frictionCoefficients.
CollisionCollection	setFrictionCoefficients(float x, float y)	Assign values to SFVec2f frictionCoefficients field, similar to setFrictionCoefficients(float[]).
CollisionCollection	setFrictionCoefficients(SFVec2f newValue)	Assign typed object value to SFVec2f frictionCoefficients field, similar to setFrictionCoefficients(float[]).
final CollisionCollection	setHtmlID(String newValue)	Accessor method to assign String value to inputOutput SFString field named id.
CollisionCollection	setHtmlID(SFString newValue)	Assign typed object value to SFString HtmlID field, similar to setHtmlID(String).
CollisionCollection	setIS(IS newValue)	Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
CollisionCollection	setMetadata(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
CollisionCollection	setMetadata(X3DMetadataObject newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
CollisionCollection	setMinBounceSpeed(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setMinBounceSpeed(float).
CollisionCollection	setMinBounceSpeed(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named minBounceSpeed.
CollisionCollection	setMinBounceSpeed(SFFloat newValue)	Assign typed object value to SFFloat minBounceSpeed field, similar to setMinBounceSpeed(float).
CollisionCollection	setSlipFactors(double[] newArray)	Utility method: double-precision set-array accessor for X3D floating-point type, similar to setSlipFactors(float[]).
CollisionCollection	setSlipFactors(double x, double y)	Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setSlipFactors(float[]).
CollisionCollection	setSlipFactors(float[] newValue)	Accessor method to assign 2-tuple float array to inputOutput SFVec2f field named slipFactors.
CollisionCollection	setSlipFactors(float x, float y)	Assign values to SFVec2f slipFactors field, similar to setSlipFactors(float[]).
CollisionCollection	setSlipFactors(SFVec2f newValue)	Assign typed object value to SFVec2f slipFactors field, similar to setSlipFactors(float[]).
CollisionCollection	setSoftnessConstantForceMix(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setSoftnessConstantForceMix(float).
CollisionCollection	setSoftnessConstantForceMix(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named softnessConstantForceMix.
CollisionCollection	setSoftnessConstantForceMix(SFFloat newValue)	Assign typed object value to SFFloat softnessConstantForceMix field, similar to setSoftnessConstantForceMix(float).
CollisionCollection	setSoftnessErrorCorrection(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setSoftnessErrorCorrection(float).
CollisionCollection	setSoftnessErrorCorrection(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named softnessErrorCorrection.
CollisionCollection	setSoftnessErrorCorrection(SFFloat newValue)	Assign typed object value to SFFloat softnessErrorCorrection field, similar to setSoftnessErrorCorrection(float).
CollisionCollection	setSurfaceSpeed(double[] newArray)	Utility method: double-precision set-array accessor for X3D floating-point type, similar to setSurfaceSpeed(float[]).
CollisionCollection	setSurfaceSpeed(double x, double y)	Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setSurfaceSpeed(float[]).
CollisionCollection	setSurfaceSpeed(float[] newValue)	Accessor method to assign 2-tuple float array to inputOutput SFVec2f field named surfaceSpeed.
CollisionCollection	setSurfaceSpeed(float x, float y)	Assign values to SFVec2f surfaceSpeed field, similar to setSurfaceSpeed(float[]).
CollisionCollection	setSurfaceSpeed(SFVec2f newValue)	Assign typed object value to SFVec2f surfaceSpeed field, similar to setSurfaceSpeed(float[]).
final CollisionCollection	setUSE(String newValue)	Accessor method to assign String value to inputOutput SFString field named USE.
CollisionCollection	setUSE(SFString newValue)	Assign typed object value to SFString USE field, similar to setUSE(String).
CollisionCollection	setUSE(CollisionCollection DEFnode)	Assign a USE reference to another DEF node of same node type, similar to setUSE(String).
CollisionCollection	setVisible(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named visible.
CollisionCollection	setVisible(SFBool newValue)	Assign typed object value to SFBool visible field, similar to setVisible(boolean).
String	toStringClassicVRML(int indentLevel)	Recursive method to provide ClassicVRML string serialization.
String	toStringVRML97(int indentLevel)	Recursive method to provide VRML97 string serialization.
String	toStringX3D(int indentLevel)	Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
String	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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

APPLIEDPARAMETERS_BOUNCE

public static final String APPLIEDPARAMETERS_BOUNCE

Tooltip: The bounce field value is used. MFString field named appliedParameters with X3DUOM simpleType appliedParametersChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "BOUNCE" (Java syntax) or '"BOUNCE"' (XML syntax).

See Also:

• XML Schema: appliedParametersChoices
• Constant Field Values

APPLIEDPARAMETERS_USER_FRICTION

public static final String APPLIEDPARAMETERS_USER_FRICTION

Tooltip: The system will normally calculate the friction direction vector that is perpendicular to the contact normal. This setting indicates that the user-supplied value in this contact should be used. MFString field named appliedParameters with X3DUOM simpleType appliedParametersChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "USER_FRICTION" (Java syntax) or '"USER_FRICTION"' (XML syntax).

See Also:

• XML Schema: appliedParametersChoices
• Constant Field Values

APPLIEDPARAMETERS_FRICTION_COEFFICIENT_2

public static final String APPLIEDPARAMETERS_FRICTION_COEFFICIENT_2

Tooltip: Apply frictionCoefficients values. MFString field named appliedParameters with X3DUOM simpleType appliedParametersChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "FRICTION_COEFFICIENT-2" (Java syntax) or '"FRICTION_COEFFICIENT-2"' (XML syntax).

See Also:

• XML Schema: appliedParametersChoices
• Constant Field Values

APPLIEDPARAMETERS_ERROR_REDUCTION

public static final String APPLIEDPARAMETERS_ERROR_REDUCTION

Tooltip: Apply softnessErrorCorrection value. MFString field named appliedParameters with X3DUOM simpleType appliedParametersChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "ERROR_REDUCTION" (Java syntax) or '"ERROR_REDUCTION"' (XML syntax).

See Also:

• XML Schema: appliedParametersChoices
• Constant Field Values

APPLIEDPARAMETERS_CONSTANT_FORCE

public static final String APPLIEDPARAMETERS_CONSTANT_FORCE

Tooltip: Apply softnessConstantForceMix value. MFString field named appliedParameters with X3DUOM simpleType appliedParametersChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "CONSTANT_FORCE" (Java syntax) or '"CONSTANT_FORCE"' (XML syntax).

See Also:

• XML Schema: appliedParametersChoices
• Constant Field Values

APPLIEDPARAMETERS_SPEED_1

public static final String APPLIEDPARAMETERS_SPEED_1

Tooltip: Apply first component of surfaceSpeed array. MFString field named appliedParameters with X3DUOM simpleType appliedParametersChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "SPEED-1" (Java syntax) or '"SPEED-1"' (XML syntax).

See Also:

• XML Schema: appliedParametersChoices
• Constant Field Values

APPLIEDPARAMETERS_SPEED_2

public static final String APPLIEDPARAMETERS_SPEED_2

Tooltip: Apply second component of surfaceSpeed array. MFString field named appliedParameters with X3DUOM simpleType appliedParametersChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "SPEED-2" (Java syntax) or '"SPEED-2"' (XML syntax).

See Also:

• XML Schema: appliedParametersChoices
• Constant Field Values

APPLIEDPARAMETERS_SLIP_1

public static final String APPLIEDPARAMETERS_SLIP_1

Tooltip: Apply first component of slipFactors array. MFString field named appliedParameters with X3DUOM simpleType appliedParametersChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "SLIP-1" (Java syntax) or '"SLIP-1"' (XML syntax).

See Also:

• XML Schema: appliedParametersChoices
• Constant Field Values

APPLIEDPARAMETERS_SLIP_2

public static final String APPLIEDPARAMETERS_SLIP_2

Tooltip: Apply second component of slipFactors array. MFString field named appliedParameters with X3DUOM simpleType appliedParametersChoices and with X3DUOM baseType MFString is an array that can only include one set of the quoted enumeration values "SLIP-2" (Java syntax) or '"SLIP-2"' (XML syntax).

See Also:

• XML Schema: appliedParametersChoices
• Constant Field Values

NAME

public static final String NAME

String constant NAME provides name of this element: CollisionCollection.

See Also:

• Constant Field Values

COMPONENT

public static final String COMPONENT

String constant COMPONENT defines X3D component for the CollisionCollection element: RigidBodyPhysics

See Also:

• Constant Field Values

LEVEL

public static final int LEVEL

Integer constant LEVEL provides default X3D RigidBodyPhysics component level for this element: 1

See Also:

• Constant Field Values

APPLIEDPARAMETERS_DEFAULT_VALUE

public static final ArrayList<String> APPLIEDPARAMETERS_DEFAULT_VALUE

MFString field named appliedParameters has default quoted value new String[] {"BOUNCE"} (Java syntax) or quoted value "BOUNCE" (XML syntax).

BBOXCENTER_DEFAULT_VALUE

public static final float[] BBOXCENTER_DEFAULT_VALUE

SFVec3f field named bboxCenter has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).

BBOXDISPLAY_DEFAULT_VALUE

public static final boolean BBOXDISPLAY_DEFAULT_VALUE

SFBool field named bboxDisplay has default value false (Java syntax) or false (XML syntax).

See Also:

• Constant Field Values

BBOXSIZE_DEFAULT_VALUE

public static final float[] BBOXSIZE_DEFAULT_VALUE

SFVec3f field named bboxSize has default value {-1f,-1f,-1f} (Java syntax) or -1 -1 -1 (XML syntax).

BOUNCE_DEFAULT_VALUE

public static final float BOUNCE_DEFAULT_VALUE

SFFloat field named bounce has default value 0f (Java syntax) or 0 (XML syntax).

See Also:

• Constant Field Values

DESCRIPTION_DEFAULT_VALUE

public static final String DESCRIPTION_DEFAULT_VALUE

SFString field named description has default value equal to an empty string.

See Also:

• Constant Field Values

ENABLED_DEFAULT_VALUE

public static final boolean ENABLED_DEFAULT_VALUE

SFBool field named enabled has default value true (Java syntax) or true (XML syntax).

See Also:

• Constant Field Values

FRICTIONCOEFFICIENTS_DEFAULT_VALUE

public static final float[] FRICTIONCOEFFICIENTS_DEFAULT_VALUE

SFVec2f field named frictionCoefficients has default value {0f,0f} (Java syntax) or 0 0 (XML syntax).

IS_DEFAULT_VALUE

public static final IS IS_DEFAULT_VALUE

SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).

METADATA_DEFAULT_VALUE

public static final X3DMetadataObject METADATA_DEFAULT_VALUE

SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).

MINBOUNCESPEED_DEFAULT_VALUE

public static final float MINBOUNCESPEED_DEFAULT_VALUE

SFFloat field named minBounceSpeed has default value 0.1f (Java syntax) or 0.1 (XML syntax).

See Also:

• Constant Field Values

SLIPFACTORS_DEFAULT_VALUE

public static final float[] SLIPFACTORS_DEFAULT_VALUE

SFVec2f field named slipFactors has default value {0f,0f} (Java syntax) or 0 0 (XML syntax).

SOFTNESSCONSTANTFORCEMIX_DEFAULT_VALUE

public static final float SOFTNESSCONSTANTFORCEMIX_DEFAULT_VALUE

SFFloat field named softnessConstantForceMix has default value 0.0001f (Java syntax) or 0.0001 (XML syntax).

See Also:

• Constant Field Values

SOFTNESSERRORCORRECTION_DEFAULT_VALUE

public static final float SOFTNESSERRORCORRECTION_DEFAULT_VALUE

SFFloat field named softnessErrorCorrection has default value 0.8f (Java syntax) or 0.8 (XML syntax).

See Also:

• Constant Field Values

SURFACESPEED_DEFAULT_VALUE

public static final float[] SURFACESPEED_DEFAULT_VALUE

SFVec2f field named surfaceSpeed has default value {0f,0f} (Java syntax) or 0 0 (XML syntax).

VISIBLE_DEFAULT_VALUE

public static final boolean VISIBLE_DEFAULT_VALUE

SFBool field named visible has default value true (Java syntax) or true (XML syntax).

See Also:

• Constant Field Values

containerField_DEFAULT_VALUE

public static final String 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 = "collider";
containerField_ALLOWED_VALUES = {"collider" }; type xs:NMTOKEN

See Also:

• X3D Scene Authoring Hints: containerField
• X3D Scene Authoring Hints: validation choices for containerField
• X3D Unified Object Model (X3DUOM)
• Constant Field Values

fromField_APPLIEDPARAMETERS

public static final String fromField_APPLIEDPARAMETERS

fromField ROUTE name for MFString field named appliedParameters.

See Also:

• Constant Field Values

toField_APPLIEDPARAMETERS

public static final String toField_APPLIEDPARAMETERS

toField ROUTE name for MFString field named appliedParameters.

See Also:

• Constant Field Values

fromField_BBOXDISPLAY

public static final String fromField_BBOXDISPLAY

fromField ROUTE name for SFBool field named bboxDisplay.

See Also:

• Constant Field Values

toField_BBOXDISPLAY

public static final String toField_BBOXDISPLAY

toField ROUTE name for SFBool field named bboxDisplay.

See Also:

• Constant Field Values

fromField_BOUNCE

public static final String fromField_BOUNCE

fromField ROUTE name for SFFloat field named bounce.

See Also:

• Constant Field Values

toField_BOUNCE

public static final String toField_BOUNCE

toField ROUTE name for SFFloat field named bounce.

See Also:

• Constant Field Values

fromField_COLLIDABLES

public static final String fromField_COLLIDABLES

fromField ROUTE name for MFNode field named collidables.

See Also:

• Constant Field Values

toField_COLLIDABLES

public static final String toField_COLLIDABLES

toField ROUTE name for MFNode field named collidables.

See Also:

• Constant Field Values

fromField_DESCRIPTION

public static final String fromField_DESCRIPTION

fromField ROUTE name for SFString field named description.

See Also:

• Constant Field Values

toField_DESCRIPTION

public static final String toField_DESCRIPTION

toField ROUTE name for SFString field named description.

See Also:

• Constant Field Values

fromField_ENABLED

public static final String fromField_ENABLED

fromField ROUTE name for SFBool field named enabled.

See Also:

• Constant Field Values

toField_ENABLED

public static final String toField_ENABLED

toField ROUTE name for SFBool field named enabled.

See Also:

• Constant Field Values

fromField_FRICTIONCOEFFICIENTS

public static final String fromField_FRICTIONCOEFFICIENTS

fromField ROUTE name for SFVec2f field named frictionCoefficients.

See Also:

• Constant Field Values

toField_FRICTIONCOEFFICIENTS

public static final String toField_FRICTIONCOEFFICIENTS

toField ROUTE name for SFVec2f field named frictionCoefficients.

See Also:

• Constant Field Values

fromField_IS

public static final String fromField_IS

fromField ROUTE name for SFNode field named IS.

See Also:

• Constant Field Values

fromField_METADATA

public static final String fromField_METADATA

fromField ROUTE name for SFNode field named metadata.

See Also:

• Constant Field Values

toField_METADATA

public static final String toField_METADATA

toField ROUTE name for SFNode field named metadata.

See Also:

• Constant Field Values

fromField_MINBOUNCESPEED

public static final String fromField_MINBOUNCESPEED

fromField ROUTE name for SFFloat field named minBounceSpeed.

See Also:

• Constant Field Values

toField_MINBOUNCESPEED

public static final String toField_MINBOUNCESPEED

toField ROUTE name for SFFloat field named minBounceSpeed.

See Also:

• Constant Field Values

fromField_SLIPFACTORS

public static final String fromField_SLIPFACTORS

fromField ROUTE name for SFVec2f field named slipFactors.

See Also:

• Constant Field Values

toField_SLIPFACTORS

public static final String toField_SLIPFACTORS

toField ROUTE name for SFVec2f field named slipFactors.

See Also:

• Constant Field Values

fromField_SOFTNESSCONSTANTFORCEMIX

public static final String fromField_SOFTNESSCONSTANTFORCEMIX

fromField ROUTE name for SFFloat field named softnessConstantForceMix.

See Also:

• Constant Field Values

toField_SOFTNESSCONSTANTFORCEMIX

public static final String toField_SOFTNESSCONSTANTFORCEMIX

toField ROUTE name for SFFloat field named softnessConstantForceMix.

See Also:

• Constant Field Values

fromField_SOFTNESSERRORCORRECTION

public static final String fromField_SOFTNESSERRORCORRECTION

fromField ROUTE name for SFFloat field named softnessErrorCorrection.

See Also:

• Constant Field Values

toField_SOFTNESSERRORCORRECTION

public static final String toField_SOFTNESSERRORCORRECTION

toField ROUTE name for SFFloat field named softnessErrorCorrection.

See Also:

• Constant Field Values

fromField_SURFACESPEED

public static final String fromField_SURFACESPEED

fromField ROUTE name for SFVec2f field named surfaceSpeed.

See Also:

• Constant Field Values

toField_SURFACESPEED

public static final String toField_SURFACESPEED

toField ROUTE name for SFVec2f field named surfaceSpeed.

See Also:

• Constant Field Values

fromField_VISIBLE

public static final String fromField_VISIBLE

fromField ROUTE name for SFBool field named visible.

See Also:

• Constant Field Values

toField_VISIBLE

public static final String toField_VISIBLE

toField ROUTE name for SFBool field named visible.

See Also:

• Constant Field Values

Constructor Details

CollisionCollection

public CollisionCollection()

Constructor for CollisionCollection to initialize member variables with default values.

CollisionCollection

public CollisionCollection(String DEFlabel)

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

public final String getElementName()

Provides name of this element: CollisionCollection

Specified by:

getElementName in class X3DConcreteElement

Returns:

name of this element

getComponent

public final String getComponent()

Defines X3D component for the CollisionCollection element: RigidBodyPhysics

Specified by:

getComponent in class X3DConcreteElement

Returns:

X3D component for this element

getComponentLevel

public final int getComponentLevel()

Provides default X3D component level for this element: 1

Specified by:

getComponentLevel in class X3DConcreteElement

Returns:

default X3D component level for this element

getFieldType

public String getFieldType(String fieldName)

Indicate type corresponding to given fieldName.

Specified by:

getFieldType in class X3DConcreteElement

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:

• ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE

getAccessType

public String getAccessType(String fieldName)

Indicate accessType corresponding to given fieldName.

Specified by:

getAccessType in class X3DConcreteElement

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:

• ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE

getContainerFieldDefault

public final String 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 class X3DConcreteNode

Returns:

default containerField value

See Also:

• containerField_DEFAULT_VALUE
• X3DConcreteNode.containerField_ALLOWED_VALUES
• X3D Scene Authoring Hints: containerField
• X3D Scene Authoring Hints: validation choices for containerField
• X3D Unified Object Model (X3DUOM)

initialize

public final void initialize()

Initialize all member variables to default values.

Overrides:

initialize in class X3DConcreteNode

getAppliedParameters

public String[] getAppliedParameters()

Provide array of String enumeration results (baseType MFString) ['"BOUNCE"' | '"USER_FRICTION"' | '"FRICTION_COEFFICIENT-2"' | '"ERROR_REDUCTION"' | '"CONSTANT_FORCE"' | '"SPEED-1"' | '"SPEED-2"' | '"SLIP-1"' | '"SLIP-2"'] from inputOutput MFString field named appliedParameters.

Tooltip: Default global parameters for collision outputs of rigid body physics system. Contact node can override parent CollisionCollection node. Selectable values for array: "BOUNCE" "USER_FRICTION" "FRICTION_COEFFICIENT_2" "ERROR_REDUCTION" "CONSTANT_FORCE" "SPEED_1" "SPEED_2" "SLIP_1" "SLIP_2".

• Hint: BOUNCE: bounce value is used; USER_FRICTION: apply user-supplied value; FRICTION_COEFFICIENT_2: apply frictionCoefficients values; ERROR_REDUCTION: apply softnessErrorCorrection value; CONSTANT_FORCE: apply softnessConstantForceMix value; SPEED_1: apply first component of surfaceSpeed array; SPEED_2: apply second component of surfaceSpeed array; SLIP_1: apply first component of slipFactors array; SLIP_2: apply second component of slipFactors array.

Available enumeration values for string comparison: BOUNCE, USER_FRICTION, FRICTION_COEFFICIENT_2, ERROR_REDUCTION, CONSTANT_FORCE, SPEED_1, SPEED_2, SLIP_1, SLIP_2.

Specified by:

getAppliedParameters in interface CollisionCollection

Returns:

value of appliedParameters field

getAppliedParametersList

public ArrayList<String> getAppliedParametersList()

Utility method to get ArrayList value of MFString appliedParameters field, similar to getAppliedParameters().

Returns:

value of appliedParameters field

getAppliedParametersString

public String getAppliedParametersString()

Utility method to get String value of MFString appliedParameters field, similar to getAppliedParameters().

Returns:

value of appliedParameters field

setAppliedParameters

public CollisionCollection setAppliedParameters(String[] newValue)

Accessor method to assign String enumeration array (""BOUNCE"" | ""USER_FRICTION"" | ""FRICTION_COEFFICIENT-2"" | ""ERROR_REDUCTION"" | ""CONSTANT_FORCE"" | ""SPEED-1"" | ""SPEED-2"" | ""SLIP-1"" | ""SLIP-2"") to inputOutput MFString field named appliedParameters.

Warning: authors can only choose from a strict list of enumeration values (BOUNCE, USER_FRICTION, FRICTION_COEFFICIENT_2, ERROR_REDUCTION, CONSTANT_FORCE, SPEED_1, SPEED_2, SLIP_1, SLIP_2).

Tooltip: Default global parameters for collision outputs of rigid body physics system. Contact node can override parent CollisionCollection node. Selectable values for array: "BOUNCE" "USER_FRICTION" "FRICTION_COEFFICIENT_2" "ERROR_REDUCTION" "CONSTANT_FORCE" "SPEED_1" "SPEED_2" "SLIP_1" "SLIP_2".

• Hint: BOUNCE: bounce value is used; USER_FRICTION: apply user-supplied value; FRICTION_COEFFICIENT_2: apply frictionCoefficients values; ERROR_REDUCTION: apply softnessErrorCorrection value; CONSTANT_FORCE: apply softnessConstantForceMix value; SPEED_1: apply first component of surfaceSpeed array; SPEED_2: apply second component of surfaceSpeed array; SLIP_1: apply first component of slipFactors array; SLIP_2: apply second component of slipFactors array.

Specified by:

setAppliedParameters in interface CollisionCollection

Parameters:

newValue - is new value for the appliedParameters field.

Returns:

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

setAppliedParameters

public CollisionCollection setAppliedParameters(MFString newValue)

Assign typed object value to MFString appliedParameters field, similar to setAppliedParameters(String[]).

Parameters:

newValue - is new value for the appliedParameters field.

Returns:

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

setAppliedParameters

public CollisionCollection setAppliedParameters(SFString newValue)

Assign single SFString object value to MFString appliedParameters field, similar to setAppliedParameters(String[]).

Parameters:

newValue - is new value for the appliedParameters field.

Returns:

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

See Also:

• MFString.cleanupEnumerationValues(String)

setAppliedParameters

public CollisionCollection setAppliedParameters(String newValue)

Assign singleton String value to MFString appliedParameters field, similar to setAppliedParameters(String[]).

Parameters:

newValue - is new value for the appliedParameters field.

Returns:

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

See Also:

• MFString.cleanupEnumerationValues(String)

setAppliedParameters

public CollisionCollection setAppliedParameters(ArrayList<String> newValue)

Assign ArrayList value of MFString appliedParameters field, similar to setAppliedParameters(String[]).

Parameters:

newValue - is new value for the appliedParameters field.

Returns:

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

clearAppliedParameters

public CollisionCollection clearAppliedParameters()

Utility method to clear MFString value of appliedParameters field. This method does not initialize withAPPLIEDPARAMETERS_DEFAULT_VALUE.

Returns:

CollisionCollection - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

addAppliedParameters

public CollisionCollection addAppliedParameters(String newValue)

Add singleton String value to MFString appliedParameters field.

Parameters:

newValue - is new value to add to the appliedParameters field.

Returns:

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

See Also:

• MFString.cleanupEnumerationValues(String)

addAppliedParameters

public CollisionCollection addAppliedParameters(SFString newValue)

Add singleton SFString value to MFString appliedParameters field.

Parameters:

newValue - is new value to add to the appliedParameters field.

Returns:

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

See Also:

• MFString.cleanupEnumerationValues(String)

getBboxCenter

public float[] getBboxCenter()

Provide array of 3-tuple float results from initializeOnly SFVec3f field named bboxCenter.

Tooltip: Bounding box center accompanies bboxSize and provides an optional hint for bounding box position offset from origin of local coordinate system.

• Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with a corresponding cost of increased file size.
• Hint: X3D Architecture, 10.2.2 Bounding boxes https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#BoundingBoxes
• Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#X3DBoundedObject

Specified by:

getBboxCenter in interface CollisionCollection

Specified by:

getBboxCenter in interface X3DBoundedObject

Returns:

value of bboxCenter field

setBboxCenter

public CollisionCollection setBboxCenter(float[] newValue)

Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxCenter.

Tooltip: Bounding box center accompanies bboxSize and provides an optional hint for bounding box position offset from origin of local coordinate system.

• Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with a corresponding cost of increased file size.
• Hint: X3D Architecture, 10.2.2 Bounding boxes https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#BoundingBoxes
• Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#X3DBoundedObject

Specified by:

setBboxCenter in interface CollisionCollection

Specified by:

setBboxCenter in interface X3DBoundedObject

Parameters:

newValue - is new value for the bboxCenter field.

Returns:

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

setBboxCenter

public CollisionCollection setBboxCenter(SFVec3f newValue)

Assign typed object value to SFVec3f bboxCenter field, similar to setBboxCenter(float[]).

Parameters:

newValue - is new value for the bboxCenter field.

Returns:

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

setBboxCenter

public CollisionCollection setBboxCenter(float x,
 float y,
 float z)

Assign values to SFVec3f bboxCenter field, similar to setBboxCenter(float[]).

Parameters:

x - first component

y - second component

z - third component

Returns:

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

setBboxCenter

public CollisionCollection setBboxCenter(double x,
 double y,
 double z)

Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setBboxCenter(float[]).

Parameters:

x - first component

y - second component

z - third component

Returns:

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

setBboxCenter

public CollisionCollection setBboxCenter(double[] newArray)

Utility method: double-precision set-array accessor for X3D floating-point type, similar to setBboxCenter(float[]).

Parameters:

newArray - is new value for field

Returns:

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

getBboxDisplay

public boolean getBboxDisplay()

Provide boolean value from inputOutput SFBool field named bboxDisplay.

Tooltip: Whether to display bounding box for associated geometry, aligned with world coordinates.

• Hint: the bounding box is displayed regardless of whether contained content is visible.

Specified by:

getBboxDisplay in interface CollisionCollection

Specified by:

getBboxDisplay in interface X3DBoundedObject

Returns:

value of bboxDisplay field

setBboxDisplay

public CollisionCollection setBboxDisplay(boolean newValue)

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

Tooltip: Whether to display bounding box for associated geometry, aligned with world coordinates.

• Hint: the bounding box is displayed regardless of whether contained content is visible.

Specified by:

setBboxDisplay in interface CollisionCollection

Specified by:

setBboxDisplay in interface X3DBoundedObject

Parameters:

newValue - is new value for the bboxDisplay field.

Returns:

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

setBboxDisplay

public CollisionCollection setBboxDisplay(SFBool newValue)

Assign typed object value to SFBool bboxDisplay field, similar to setBboxDisplay(boolean).

Parameters:

newValue - is new value for the bboxDisplay field.

Returns:

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

getBboxSize

public float[] getBboxSize()

Provide array of 3-tuple float results within allowed range of [0,infinity), or default value [-1 -1 -1], from initializeOnly SFVec3f field named bboxSize.

Tooltip: or [0,+infinity) Bounding box size is usually omitted, and can easily be calculated automatically by an X3D player at scene-loading time with minimal computational cost. Bounding box size can also be defined as an optional authoring hint that suggests an optimization or constraint.

• Hint: can be useful for collision computations or inverse-kinematics (IK) engines.
• Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with a corresponding cost of increased file size.
• Hint: X3D Architecture, 10.2.2 Bounding boxes https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#BoundingBoxes
• Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#X3DBoundedObject

Specified by:

getBboxSize in interface CollisionCollection

Specified by:

getBboxSize in interface X3DBoundedObject

Returns:

value of bboxSize field

setBboxSize

public CollisionCollection setBboxSize(float[] newValue)

Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxSize.

Tooltip: or [0,+infinity) Bounding box size is usually omitted, and can easily be calculated automatically by an X3D player at scene-loading time with minimal computational cost. Bounding box size can also be defined as an optional authoring hint that suggests an optimization or constraint.

• Hint: can be useful for collision computations or inverse-kinematics (IK) engines.
• Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with a corresponding cost of increased file size.
• Hint: X3D Architecture, 10.2.2 Bounding boxes https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#BoundingBoxes
• Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#X3DBoundedObject

Specified by:

setBboxSize in interface CollisionCollection

Specified by:

setBboxSize in interface X3DBoundedObject

Parameters:

newValue - is new value for the bboxSize field.

Returns:

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

setBboxSize

public CollisionCollection setBboxSize(SFVec3f newValue)

Assign typed object value to SFVec3f bboxSize field, similar to setBboxSize(float[]).

Parameters:

newValue - is new value for the bboxSize field.

Returns:

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

setBboxSize

public CollisionCollection setBboxSize(float x,
 float y,
 float z)

Assign values to SFVec3f bboxSize field, similar to setBboxSize(float[]).

Parameters:

x - first component

y - second component

z - third component

Returns:

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

setBboxSize

public CollisionCollection setBboxSize(double x,
 double y,
 double z)

Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setBboxSize(float[]).

Parameters:

x - first component

y - second component

z - third component

Returns:

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

setBboxSize

public CollisionCollection setBboxSize(double[] newArray)

Utility method: double-precision set-array accessor for X3D floating-point type, similar to setBboxSize(float[]).

Parameters:

newArray - is new value for field

Returns:

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

getBounce

public float getBounce()

Provide float value within allowed range of [0,1] from inputOutput SFFloat field named bounce.

Tooltip: [0,1] bounce indicates bounciness (0 = no bounce at all, 1 = maximum bounce). *

Specified by:

getBounce in interface CollisionCollection

Returns:

value of bounce field

setBounce

public CollisionCollection setBounce(float newValue)

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

Tooltip: [0,1] bounce indicates bounciness (0 = no bounce at all, 1 = maximum bounce). *

Specified by:

setBounce in interface CollisionCollection

Parameters:

newValue - is new value for the bounce field.

Returns:

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

setBounce

public CollisionCollection setBounce(SFFloat newValue)

Assign typed object value to SFFloat bounce field, similar to setBounce(float).

Parameters:

newValue - is new value for the bounce field.

Returns:

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

setBounce

public CollisionCollection setBounce(double newValue)

Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setBounce(float).

Parameters:

newValue - is new value for field

Returns:

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

getCollidables

public X3DNode[] getCollidables()

Provide array of org.web3d.x3d.sai.Core.X3DNode results (using an array consisting of properly typed nodes or ProtoInstances) with acceptable node types limited to X3DNBodyCollisionSpaceNode|X3DNBodyCollidableNode, from inputOutput MFNode field collidables.

Tooltip: [CollisionSpace|CollidableShape|CollidableOffset] CollisionCollection node holds a collection of objects in the collidables field that can be managed as a single entity for resolution of inter-object collisions with other groups of collidable objects. A group consists of both collidable objects as well as spaces that may be collided against each other. *


Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DNBodyCollisionSpaceNode|X3DNBodyCollidableNode.

Specified by:

getCollidables in interface CollisionCollection

Returns:

value of collidables field

See Also:

• X3DNBodyCollisionSpaceNode
• X3DNBodyCollidableNode

getCollidablesList

public ArrayList<X3DNode> getCollidablesList()

Utility method to get ArrayList value of MFNode collidables field, similar to getCollidables().

Returns:

value of collidables field

setCollidables

public CollisionCollection setCollidables(X3DNode[] newValue)

Accessor method to assign org.web3d.x3d.sai.Core.X3DNode array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field collidables.

Tooltip: [CollisionSpace|CollidableShape|CollidableOffset] CollisionCollection node holds a collection of objects in the collidables field that can be managed as a single entity for resolution of inter-object collisions with other groups of collidable objects. A group consists of both collidable objects as well as spaces that may be collided against each other. *


Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DNBodyCollisionSpaceNode|X3DNBodyCollidableNode.

Specified by:

setCollidables in interface CollisionCollection

Parameters:

newValue - is new value for the collidables field.

Returns:

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

setCollidables

public CollisionCollection setCollidables(ArrayList<X3DNode> newValue)

Assign ArrayList value of MFNode collidables field, similar to setCollidables(org.web3d.x3d.sai.Core.X3DNode[]).

Parameters:

newValue - is new value for the collidables field.

Returns:

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

addCollidables

public CollisionCollection addCollidables(X3DNode newValue)

Add single child node to existing array of collidables nodes (if any).

Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DNBodyCollisionSpaceNode|X3DNBodyCollidableNode and ProtoInstance.

Parameters:

newValue - is new value to be appended the collidables field.

Returns:

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

addCollidables

public CollisionCollection addCollidables(ProtoInstance newValue)

Add single ProtoInstance (with appropriate node type and containerField value) to MFNode array for collidables field.

Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to ShaderPart and ProtoInstance.

Parameters:

newValue - is new value to be appended the parts field.

Returns:

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

addCollidables

public void addCollidables(X3DNode[] newValue)

Add array of child collidables nodes to array of existing nodes (if any).

Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DNBodyCollisionSpaceNode|X3DNBodyCollidableNode.

Specified by:

addCollidables in interface CollisionCollection

Parameters:

newValue - is new value array to be appended the collidables field.

setCollidables

public void setCollidables(X3DNode newValue)

Set single child collidables node, replacing prior array of existing nodes (if any).

Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are restricted to X3DNBodyCollisionSpaceNode|X3DNBodyCollidableNode.

Specified by:

setCollidables in interface CollisionCollection

Parameters:

newValue - is new node for the collidables field (restricted to X3DNBodyCollisionSpaceNode|X3DNBodyCollidableNode)

clearCollidables

public CollisionCollection clearCollidables()

Utility method to clear MFNode value of collidables field. This method does not initialize withCOLLIDABLES_DEFAULT_VALUE.

Returns:

CollisionCollection - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

hasCollidables

public boolean hasCollidables()

Indicate whether an object is available for inputOutput MFNode field collidables.

Returns:

whether a properly typed node or ProtoInstance array or CommentsBlock is available.

See Also:

• getCollidables()

getDescription

public String getDescription()

Provide String value from inputOutput SFString field named description.

Tooltip: Author-provided prose that describes intended purpose of the node.

• Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).

Specified by:

getDescription in interface CollisionCollection

Returns:

value of description field

setDescription

public CollisionCollection setDescription(String newValue)

Accessor method to assign String value to inputOutput SFString field named description.

Tooltip: Author-provided prose that describes intended purpose of the node.

• Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).

Specified by:

setDescription in interface CollisionCollection

Parameters:

newValue - is new value for the description field.

Returns:

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

setDescription

public CollisionCollection setDescription(SFString newValue)

Assign typed object value to SFString description field, similar to setDescription(String).

Parameters:

newValue - is new value for the description field.

Returns:

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

getEnabled

public boolean getEnabled()

Provide boolean value from inputOutput SFBool field named enabled.

Tooltip: Enables/disables node operation. *

Specified by:

getEnabled in interface CollisionCollection

Returns:

value of enabled field

setEnabled

public CollisionCollection setEnabled(boolean newValue)

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

Tooltip: Enables/disables node operation. *

Specified by:

setEnabled in interface CollisionCollection

Parameters:

newValue - is new value for the enabled field.

Returns:

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

setEnabled

public CollisionCollection setEnabled(SFBool newValue)

Assign typed object value to SFBool enabled field, similar to setEnabled(boolean).

Parameters:

newValue - is new value for the enabled field.

Returns:

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

getFrictionCoefficients

public float[] getFrictionCoefficients()

Provide array of 2-tuple float results within allowed range of [0,infinity) from inputOutput SFVec2f field named frictionCoefficients.

Tooltip: frictionCoefficients used for computing surface drag. *

Specified by:

getFrictionCoefficients in interface CollisionCollection

Returns:

value of frictionCoefficients field

setFrictionCoefficients

public CollisionCollection setFrictionCoefficients(float[] newValue)

Accessor method to assign 2-tuple float array to inputOutput SFVec2f field named frictionCoefficients.

Tooltip: frictionCoefficients used for computing surface drag. *

Specified by:

setFrictionCoefficients in interface CollisionCollection

Parameters:

newValue - is new value for the frictionCoefficients field.

Returns:

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

setFrictionCoefficients

public CollisionCollection setFrictionCoefficients(SFVec2f newValue)

Assign typed object value to SFVec2f frictionCoefficients field, similar to setFrictionCoefficients(float[]).

Parameters:

newValue - is new value for the frictionCoefficients field.

Returns:

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

setFrictionCoefficients

public CollisionCollection setFrictionCoefficients(float x,
 float y)

Assign values to SFVec2f frictionCoefficients field, similar to setFrictionCoefficients(float[]).

Parameters:

x - first component

y - second component

Returns:

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

setFrictionCoefficients

public CollisionCollection setFrictionCoefficients(double x,
 double y)

Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setFrictionCoefficients(float[]).

Parameters:

x - first component

y - second component

Returns:

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

setFrictionCoefficients

public CollisionCollection setFrictionCoefficients(double[] newArray)

Utility method: double-precision set-array accessor for X3D floating-point type, similar to setFrictionCoefficients(float[]).

Parameters:

newArray - is new value for field

Returns:

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

getIS

public IS getIS()

Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.

Specified by:

getIS in class X3DConcreteNode

Returns:

value of IS field

See Also:

• X3D Tooltips: IS
• X3D Tooltips: connect

setIS

public CollisionCollection setIS(IS newValue)

Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.

Specified by:

setIS in class X3DConcreteNode

Parameters:

newValue - is new value for the IS field.

Returns:

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

See Also:

• X3D Tooltips: IS
• X3D Tooltips: connect

clearIS

public CollisionCollection clearIS()

Utility method to clear SFNode value of IS field.

Returns:

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

• getIS()

getMetadata

public X3DMetadataObject getMetadata()

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

Specified by:

getMetadata in interface CollisionCollection

Specified by:

getMetadata in interface X3DChildNode

Specified by:

getMetadata in interface X3DNode

Returns:

value of metadata field

See Also:

• 
  
  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
• X3D Scene Authoring Hints: Metadata Nodes

setMetadata

public CollisionCollection setMetadata(X3DMetadataObject newValue)

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 interface CollisionCollection

Specified by:

setMetadata in interface X3DChildNode

Specified by:

setMetadata in interface X3DNode

Specified by:

setMetadata in class X3DConcreteNode

Parameters:

newValue - is new value for the metadata field.

Returns:

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

See Also:

• 
  
  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
• X3D Scene Authoring Hints: Metadata Nodes

clearMetadata

public CollisionCollection clearMetadata()

Utility method to clear SFNode value of metadata field.

Returns:

CollisionCollection - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

setMetadata

public CollisionCollection setMetadata(ProtoInstance newValue)

Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.

Specified by:

setMetadata in class X3DConcreteNode

Parameters:

newValue - is new value for the metadata field.

Returns:

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

See Also:

• setMetadata(org.web3d.x3d.sai.Core.X3DMetadataObject)

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:

• getMetadata()
• getMetadataProtoInstance()
• X3D Scene Authoring Hints: Metadata Nodes

getMinBounceSpeed

public float getMinBounceSpeed()

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

Tooltip: [0,+infinity) minBounceSpeed m/s needed to bounce. *

Specified by:

getMinBounceSpeed in interface CollisionCollection

Returns:

value of minBounceSpeed field

setMinBounceSpeed

public CollisionCollection setMinBounceSpeed(float newValue)

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

Tooltip: [0,+infinity) minBounceSpeed m/s needed to bounce. *

Specified by:

setMinBounceSpeed in interface CollisionCollection

Parameters:

newValue - is new value for the minBounceSpeed field.

Returns:

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

setMinBounceSpeed

public CollisionCollection setMinBounceSpeed(SFFloat newValue)

Assign typed object value to SFFloat minBounceSpeed field, similar to setMinBounceSpeed(float).

Parameters:

newValue - is new value for the minBounceSpeed field.

Returns:

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

setMinBounceSpeed

public CollisionCollection setMinBounceSpeed(double newValue)

Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setMinBounceSpeed(float).

Parameters:

newValue - is new value for field

Returns:

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

getSlipFactors

public float[] getSlipFactors()

Provide array of 2-tuple float results from inputOutput SFVec2f field named slipFactors.

Tooltip: slipFactors used for computing surface drag. *

Specified by:

getSlipFactors in interface CollisionCollection

Returns:

value of slipFactors field

setSlipFactors

public CollisionCollection setSlipFactors(float[] newValue)

Accessor method to assign 2-tuple float array to inputOutput SFVec2f field named slipFactors.

Tooltip: slipFactors used for computing surface drag. *

Specified by:

setSlipFactors in interface CollisionCollection

Parameters:

newValue - is new value for the slipFactors field.

Returns:

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

setSlipFactors

public CollisionCollection setSlipFactors(SFVec2f newValue)

Assign typed object value to SFVec2f slipFactors field, similar to setSlipFactors(float[]).

Parameters:

newValue - is new value for the slipFactors field.

Returns:

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

setSlipFactors

public CollisionCollection setSlipFactors(float x,
 float y)

Assign values to SFVec2f slipFactors field, similar to setSlipFactors(float[]).

Parameters:

x - first component

y - second component

Returns:

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

setSlipFactors

public CollisionCollection setSlipFactors(double x,
 double y)

Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setSlipFactors(float[]).

Parameters:

x - first component

y - second component

Returns:

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

setSlipFactors

public CollisionCollection setSlipFactors(double[] newArray)

Utility method: double-precision set-array accessor for X3D floating-point type, similar to setSlipFactors(float[]).

Parameters:

newArray - is new value for field

Returns:

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

getSoftnessConstantForceMix

public float getSoftnessConstantForceMix()

Provide float value within allowed range of [0,1] from inputOutput SFFloat field named softnessConstantForceMix.

Tooltip: [0,1] softnessConstantForceMix value applies a constant force value to make colliding surfaces appear to be somewhat soft. *

Specified by:

getSoftnessConstantForceMix in interface CollisionCollection

Returns:

value of softnessConstantForceMix field

setSoftnessConstantForceMix

public CollisionCollection setSoftnessConstantForceMix(float newValue)

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

Tooltip: [0,1] softnessConstantForceMix value applies a constant force value to make colliding surfaces appear to be somewhat soft. *

Specified by:

setSoftnessConstantForceMix in interface CollisionCollection

Parameters:

newValue - is new value for the softnessConstantForceMix field.

Returns:

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

setSoftnessConstantForceMix

public CollisionCollection setSoftnessConstantForceMix(SFFloat newValue)

Assign typed object value to SFFloat softnessConstantForceMix field, similar to setSoftnessConstantForceMix(float).

Parameters:

newValue - is new value for the softnessConstantForceMix field.

Returns:

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

setSoftnessConstantForceMix

public CollisionCollection setSoftnessConstantForceMix(double newValue)

Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setSoftnessConstantForceMix(float).

Parameters:

newValue - is new value for field

Returns:

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

getSoftnessErrorCorrection

public float getSoftnessErrorCorrection()

Provide float value within allowed range of [0,1] from inputOutput SFFloat field named softnessErrorCorrection.

Tooltip: [0,1] softnessErrorCorrection indicates fraction of collision error fixed in a set of evaluations (0 = no error correction, 1 = all errors corrected in single step). *

Specified by:

getSoftnessErrorCorrection in interface CollisionCollection

Returns:

value of softnessErrorCorrection field

setSoftnessErrorCorrection

public CollisionCollection setSoftnessErrorCorrection(float newValue)

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

Tooltip: [0,1] softnessErrorCorrection indicates fraction of collision error fixed in a set of evaluations (0 = no error correction, 1 = all errors corrected in single step). *

Specified by:

setSoftnessErrorCorrection in interface CollisionCollection

Parameters:

newValue - is new value for the softnessErrorCorrection field.

Returns:

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

setSoftnessErrorCorrection

public CollisionCollection setSoftnessErrorCorrection(SFFloat newValue)

Assign typed object value to SFFloat softnessErrorCorrection field, similar to setSoftnessErrorCorrection(float).

Parameters:

newValue - is new value for the softnessErrorCorrection field.

Returns:

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

setSoftnessErrorCorrection

public CollisionCollection setSoftnessErrorCorrection(double newValue)

Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setSoftnessErrorCorrection(float).

Parameters:

newValue - is new value for field

Returns:

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

getSurfaceSpeed

public float[] getSurfaceSpeed()

Provide array of 2-tuple float results from inputOutput SFVec2f field named surfaceSpeed.

Tooltip: surfaceSpeed defines speed vectors for computing surface drag, if contact surfaces move independently of bodies. *

Specified by:

getSurfaceSpeed in interface CollisionCollection

Returns:

value of surfaceSpeed field

setSurfaceSpeed

public CollisionCollection setSurfaceSpeed(float[] newValue)

Accessor method to assign 2-tuple float array to inputOutput SFVec2f field named surfaceSpeed.

Tooltip: surfaceSpeed defines speed vectors for computing surface drag, if contact surfaces move independently of bodies. *

Specified by:

setSurfaceSpeed in interface CollisionCollection

Parameters:

newValue - is new value for the surfaceSpeed field.

Returns:

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

setSurfaceSpeed

public CollisionCollection setSurfaceSpeed(SFVec2f newValue)

Assign typed object value to SFVec2f surfaceSpeed field, similar to setSurfaceSpeed(float[]).

Parameters:

newValue - is new value for the surfaceSpeed field.

Returns:

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

setSurfaceSpeed

public CollisionCollection setSurfaceSpeed(float x,
 float y)

Assign values to SFVec2f surfaceSpeed field, similar to setSurfaceSpeed(float[]).

Parameters:

x - first component

y - second component

Returns:

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

setSurfaceSpeed

public CollisionCollection setSurfaceSpeed(double x,
 double y)

Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setSurfaceSpeed(float[]).

Parameters:

x - first component

y - second component

Returns:

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

setSurfaceSpeed

public CollisionCollection setSurfaceSpeed(double[] newArray)

Utility method: double-precision set-array accessor for X3D floating-point type, similar to setSurfaceSpeed(float[]).

Parameters:

newArray - is new value for field

Returns:

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

getVisible

public boolean getVisible()

Provide boolean value from inputOutput SFBool field named visible.

Tooltip: Whether or not renderable content within this node is visually displayed.

• Hint: the visible field has no effect on animation behaviors, event passing or other non-visual characteristics.
• Hint: content must be visible to be collidable and to be pickable.

Specified by:

getVisible in interface CollisionCollection

Specified by:

getVisible in interface X3DBoundedObject

Returns:

value of visible field

setVisible

public CollisionCollection setVisible(boolean newValue)

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

Tooltip: Whether or not renderable content within this node is visually displayed.

• Hint: the visible field has no effect on animation behaviors, event passing or other non-visual characteristics.
• Hint: content must be visible to be collidable and to be pickable.

Specified by:

setVisible in interface CollisionCollection

Specified by:

setVisible in interface X3DBoundedObject

Parameters:

newValue - is new value for the visible field.

Returns:

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

setVisible

public CollisionCollection setVisible(SFBool newValue)

Assign typed object value to SFBool visible field, similar to setVisible(boolean).

Parameters:

newValue - is new value for the visible field.

Returns:

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

getDEF

public String 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 class X3DConcreteNode

Returns:

value of DEF field

See Also:

• X3D Scene Authoring Hints: Naming Conventions

setDEF

public final CollisionCollection setDEF(String newValue)

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 class X3DConcreteNode

Parameters:

newValue - is new value for the DEF field.

Returns:

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

setDEF

public CollisionCollection setDEF(SFString newValue)

Assign typed object value to SFString DEF field, similar to setDEF(String).

Parameters:

newValue - is new value for the DEF field.

Returns:

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

getUSE

public String 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 class X3DConcreteNode

Returns:

value of USE field

See Also:

• X3D Scene Authoring Hints: Naming Conventions

setUSE

public final CollisionCollection setUSE(String newValue)

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: each USE node is still an independent object, with the USE value matching the DEF value in the preceding object.

Warning: invoking the setUSE() 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 class X3DConcreteNode

Parameters:

newValue - is new value for the USE field.

Returns:

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

setUSE

public CollisionCollection setUSE(SFString newValue)

Assign typed object value to SFString USE field, similar to setUSE(String).

Parameters:

newValue - is new value for the USE field.

Returns:

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

getCssClass

public String getCssClass()

Provide String value from inputOutput SFString field named class.

Overrides:

getCssClass in class X3DConcreteElement

Returns:

value of class field

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssClass

public final CollisionCollection setCssClass(String newValue)

Accessor method to assign String value to inputOutput SFString field named class.

Specified by:

setCssClass in class X3DConcreteNode

Parameters:

newValue - is new value for the class field.

Returns:

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

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssClass

public CollisionCollection setCssClass(SFString newValue)

Assign typed object value to SFString cssClass field, similar to setCssClass(String).

Parameters:

newValue - is new value for the class field.

Returns:

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

getHtmlID

public String getHtmlID()

Provide String value from inputOutput SFString field named id.

Overrides:

getHtmlID in class X3DConcreteElement

Returns:

value of id field

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setHtmlID

public final CollisionCollection setHtmlID(String newValue)

Accessor method to assign String value to inputOutput SFString field named id.

Specified by:

setHtmlID in class X3DConcreteNode

Parameters:

newValue - is new value for the id field.

Returns:

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

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
  Warning: the id attribute is in a distinct separate namespace from DEF identifiers and thus not applicable for USE nodes, ROUTE statements, or Script references.
• X3D Architecture Annex L - HTML authoring guidelines, L.3.1 Content definition and page presentation
• HTML 5.2 W3C Recommendation
• Document Object Model (DOM) Technical Reports
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setHtmlID

public CollisionCollection setHtmlID(SFString newValue)

Assign typed object value to SFString HtmlID field, similar to setHtmlID(String).

Parameters:

newValue - is new value for the id field.

Returns:

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

getCssStyle

public String getCssStyle()

Provide String value from inputOutput SFString field named style.

Overrides:

getCssStyle in class X3DConcreteElement

Returns:

value of style field

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssStyle

public final CollisionCollection setCssStyle(String newValue)

Accessor method to assign String value to inputOutput SFString field named style.

Specified by:

setCssStyle in class X3DConcreteNode

Parameters:

newValue - is new value for the style field.

Returns:

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

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssStyle

public CollisionCollection setCssStyle(SFString newValue)

Assign typed object value to SFString cssClass field, similar to setCssStyle(String).

Parameters:

newValue - is new value for the style field.

Returns:

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

setUSE

public CollisionCollection setUSE(CollisionCollection DEFnode)

Assign a USE reference to another DEF node of same node type, similar to setUSE(String).

Warning: note that the setUSE() 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:

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

addComments

public CollisionCollection addComments(String newComment)

Add comment as String to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComment - initial value

Returns:

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

See Also:

• X3D Architecture, clause 7.2.5.1 Organization

addComments

public CollisionCollection addComments(String[] newComments)

Add comments as String[] array to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComments - array of comments

Returns:

CollisionCollection - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

addComments

public CollisionCollection addComments(CommentsBlock newCommentsBlock)

Add CommentsBlock to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newCommentsBlock - block of comments to add

Returns:

CollisionCollection - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

toStringX3D

public String toStringX3D(int indentLevel)

Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.

Specified by:

toStringX3D in class X3DConcreteElement

Parameters:

indentLevel - number of levels of indentation for this element

Returns:

X3D string

See Also:

• X3D.FILE_EXTENSION_X3D
• X3D.FILE_EXTENSION_XML
• X3D.toStringXML()
• X3D.toFileXML(String)
• X3D.toFileX3D(String)
• X3D XML Encoding
• X3D Compressed Binary Encoding: X3D Canonical Form
• X3D Canonicalization (C14N) Tool

toStringClassicVRML

public String toStringClassicVRML(int indentLevel)

Recursive method to provide ClassicVRML string serialization.

Specified by:

toStringClassicVRML in class X3DConcreteElement

Parameters:

indentLevel - number of levels of indentation for this element

Returns:

ClassicVRML string

See Also:

• X3D.FILE_EXTENSION_CLASSICVRML
• X3D Resources: Virtual Reality Modeling Language (VRML) 97
• Extensible 3D (X3D) encodings Part 2: Classic VRML encoding
• Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Annex A: Grammar

toStringVRML97

public String toStringVRML97(int indentLevel)

Recursive method to provide VRML97 string serialization.

Specified by:

toStringVRML97 in class X3DConcreteElement

Parameters:

indentLevel - number of levels of indentation for this element

Returns:

VRML97 string

See Also:

• X3D.FILE_EXTENSION_VRML97
• X3D Resources: Virtual Reality Modeling Language (VRML) 97
• Virtual Reality Modeling Language (VRML) 97 specification
• VRML 97 v2.1 Amendment

findElementByNameValue

public X3DConcreteElement 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. 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 class X3DConcreteElement

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:

• findNodeByDEF(String)
• X3DConcreteElement.hasAncestorScene()
• X3DConcreteElement.findAncestorX3D()

findElementByNameValue

public X3DConcreteElement 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. 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 class X3DConcreteElement

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:

• findNodeByDEF(String)
• X3DConcreteElement.hasAncestorScene()
• X3DConcreteElement.findAncestorX3D()

hasElementByNameValue

public 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.

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:

• findElementByNameValue(String, String)

findNodeByDEF

public X3DConcreteNode findNodeByDEF(String DEFvalue)

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 class X3DConcreteElement

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:

• findElementByNameValue(String)
• X3DConcreteElement.hasAncestorScene()
• X3DConcreteElement.findAncestorX3D()

hasNodeByDEF

public boolean hasNodeByDEF(String DEFvalue)

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:

• findNodeByDEF(String)

validate

public String 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 class X3DConcreteElement

Returns:

validation results (if any)