Class CollisionCollectionObject
java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.RigidBodyPhysics.CollisionCollectionObject
- All Implemented Interfaces:
X3DChildNode
,X3DNode
,X3DBoundedObject
,CollisionCollection
public class CollisionCollectionObject extends X3DConcreteNode implements CollisionCollection
CollisionCollection holds a collection of objects that can be managed as a single entity for resolution of inter-object collisions.
X3D 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.
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.
X3D 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.
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
APPLIEDPARAMETERS_BOUNCE
Tooltip: The bounce field value is used.static java.lang.String
APPLIEDPARAMETERS_CONSTANT_FORCE
Tooltip: Apply softnessConstantForceMix value.static java.util.ArrayList<java.lang.String>
APPLIEDPARAMETERS_DEFAULT_VALUE
MFString field named appliedParameters has default quoted value new String[] {"BOUNCE"} (Java syntax) or quoted value "BOUNCE" (XML syntax).static java.lang.String
APPLIEDPARAMETERS_ERROR_REDUCTION
Tooltip: Apply softnessErrorCorrection value.static java.lang.String
APPLIEDPARAMETERS_FRICTION_COEFFICIENT_2
Tooltip: Apply frictionCoefficients values.static java.lang.String
APPLIEDPARAMETERS_SLIP_1
Tooltip: Apply first component of slipFactors array.static java.lang.String
APPLIEDPARAMETERS_SLIP_2
Tooltip: Apply second component of slipFactors array.static java.lang.String
APPLIEDPARAMETERS_SPEED_1
Tooltip: Apply first component of surfaceSpeed array.static java.lang.String
APPLIEDPARAMETERS_SPEED_2
Tooltip: Apply second component of surfaceSpeed array.static java.lang.String
APPLIEDPARAMETERS_USER_FRICTION
Tooltip: The system will normally calculate the friction direction vector that is perpendicular to the contact normal.static float[]
BBOXCENTER_DEFAULT_VALUE
SFVec3f field named bboxCenter has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).static boolean
BBOXDISPLAY_DEFAULT_VALUE
SFBool field named bboxDisplay has default value false (Java syntax) or false (XML syntax).static float[]
BBOXSIZE_DEFAULT_VALUE
SFVec3f field named bboxSize has default value {-1f,-1f,-1f} (Java syntax) or -1 -1 -1 (XML syntax).static float
BOUNCE_DEFAULT_VALUE
SFFloat field named bounce has default value 0f (Java syntax) or 0 (XML syntax).static java.lang.String
COMPONENT
String constant COMPONENT defines X3D component for the CollisionCollection element: RigidBodyPhysicsstatic java.lang.String
containerField_DEFAULT_VALUE
containerField describes typical field relationship of a node to its parent.static boolean
ENABLED_DEFAULT_VALUE
SFBool field named enabled has default value true (Java syntax) or true (XML syntax).static float[]
FRICTIONCOEFFICIENTS_DEFAULT_VALUE
SFVec2f field named frictionCoefficients has default value {0f,0f} (Java syntax) or 0 0 (XML syntax).static java.lang.String
fromField_APPLIEDPARAMETERS
fromField ROUTE name for MFString field named appliedParameters.static java.lang.String
fromField_BBOXDISPLAY
fromField ROUTE name for SFBool field named bboxDisplay.static java.lang.String
fromField_BOUNCE
fromField ROUTE name for SFFloat field named bounce.static java.lang.String
fromField_COLLIDABLES
fromField ROUTE name for MFNode field named collidables.static java.lang.String
fromField_ENABLED
fromField ROUTE name for SFBool field named enabled.static java.lang.String
fromField_FRICTIONCOEFFICIENTS
fromField ROUTE name for SFVec2f field named frictionCoefficients.static java.lang.String
fromField_IS
fromField ROUTE name for SFNode field named IS.static java.lang.String
fromField_METADATA
fromField ROUTE name for SFNode field named metadata.static java.lang.String
fromField_MINBOUNCESPEED
fromField ROUTE name for SFFloat field named minBounceSpeed.static java.lang.String
fromField_SLIPFACTORS
fromField ROUTE name for SFVec2f field named slipFactors.static java.lang.String
fromField_SOFTNESSCONSTANTFORCEMIX
fromField ROUTE name for SFFloat field named softnessConstantForceMix.static java.lang.String
fromField_SOFTNESSERRORCORRECTION
fromField ROUTE name for SFFloat field named softnessErrorCorrection.static java.lang.String
fromField_SURFACESPEED
fromField ROUTE name for SFVec2f field named surfaceSpeed.static java.lang.String
fromField_VISIBLE
fromField ROUTE name for SFBool field named visible.static ISObject
IS_DEFAULT_VALUE
SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).static int
LEVEL
Integer constant LEVEL provides default X3D RigidBodyPhysics component level for this element: 1static X3DMetadataObject
METADATA_DEFAULT_VALUE
SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).static float
MINBOUNCESPEED_DEFAULT_VALUE
SFFloat field named minBounceSpeed has default value 0.1f (Java syntax) or 0.1 (XML syntax).static java.lang.String
NAME
String constant NAME provides name of this element: CollisionCollection.static float[]
SLIPFACTORS_DEFAULT_VALUE
SFVec2f field named slipFactors has default value {0f,0f} (Java syntax) or 0 0 (XML syntax).static float
SOFTNESSCONSTANTFORCEMIX_DEFAULT_VALUE
SFFloat field named softnessConstantForceMix has default value 0.0001f (Java syntax) or 0.0001 (XML syntax).static float
SOFTNESSERRORCORRECTION_DEFAULT_VALUE
SFFloat field named softnessErrorCorrection has default value 0.8f (Java syntax) or 0.8 (XML syntax).static float[]
SURFACESPEED_DEFAULT_VALUE
SFVec2f field named surfaceSpeed has default value {0f,0f} (Java syntax) or 0 0 (XML syntax).static java.lang.String
toField_APPLIEDPARAMETERS
toField ROUTE name for MFString field named appliedParameters.static java.lang.String
toField_BBOXDISPLAY
toField ROUTE name for SFBool field named bboxDisplay.static java.lang.String
toField_BOUNCE
toField ROUTE name for SFFloat field named bounce.static java.lang.String
toField_COLLIDABLES
toField ROUTE name for MFNode field named collidables.static java.lang.String
toField_ENABLED
toField ROUTE name for SFBool field named enabled.static java.lang.String
toField_FRICTIONCOEFFICIENTS
toField ROUTE name for SFVec2f field named frictionCoefficients.static java.lang.String
toField_METADATA
toField ROUTE name for SFNode field named metadata.static java.lang.String
toField_MINBOUNCESPEED
toField ROUTE name for SFFloat field named minBounceSpeed.static java.lang.String
toField_SLIPFACTORS
toField ROUTE name for SFVec2f field named slipFactors.static java.lang.String
toField_SOFTNESSCONSTANTFORCEMIX
toField ROUTE name for SFFloat field named softnessConstantForceMix.static java.lang.String
toField_SOFTNESSERRORCORRECTION
toField ROUTE name for SFFloat field named softnessErrorCorrection.static java.lang.String
toField_SURFACESPEED
toField ROUTE name for SFVec2f field named surfaceSpeed.static java.lang.String
toField_VISIBLE
toField ROUTE name for SFBool field named visible.static 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
CLASS_DEFAULT_VALUE, containerField_ALTERNATE_VALUES, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE
-
Constructor Summary
Constructors Constructor Description CollisionCollectionObject()
Constructor for CollisionCollectionObject to initialize member variables with default values.CollisionCollectionObject(java.lang.String DEFlabel)
Utility constructor that assigns DEF label after initializing member variables with default values. -
Method Summary
Modifier and Type Method Description CollisionCollectionObject
addAppliedParameters(java.lang.String newValue)
Add singleton String value to MFString appliedParameters field.CollisionCollectionObject
addAppliedParameters(SFStringObject newValue)
Add singleton SFStringObject value to MFString appliedParameters field.CollisionCollectionObject
addCollidables(ProtoInstanceObject newValue)
Add single ProtoInstanceObject (with appropriate node type and containerField value) to MFNode array for collidables field.CollisionCollectionObject
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).CollisionCollectionObject
addComments(java.lang.String newComment)
Add comment as String to contained commentsList.CollisionCollectionObject
addComments(java.lang.String[] newComments)
Add comments as String[] array to contained commentsList.CollisionCollectionObject
addComments(CommentsBlock newCommentsBlock)
Add CommentsBlock to contained commentsList.CollisionCollectionObject
clearAppliedParameters()
Utility method to clear MFString value of appliedParameters field.CollisionCollectionObject
clearCollidables()
Utility method to clear MFNode value of collidables field.CollisionCollectionObject
clearIS()
Utility method to clear SFNode value of IS field.CollisionCollectionObject
clearMetadata()
Utility method to clear SFNode value of metadata field.X3DConcreteElement
findElementByNameValue(java.lang.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(java.lang.String nameValue, java.lang.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(java.lang.String DEFvalue)
Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.java.lang.String
getAccessType(java.lang.String fieldName)
Indicate accessType corresponding to given fieldName.java.lang.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.java.util.ArrayList<java.lang.String>
getAppliedParametersList()
Utility method to get ArrayList value of MFString appliedParameters field, similar togetAppliedParameters()
.java.lang.String
getAppliedParametersString()
Utility method to get String value of MFString appliedParameters field, similar togetAppliedParameters()
.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 X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) with acceptable node types limited to X3DNBodyCollisionSpaceNode|X3DNBodyCollidableNode, from inputOutput MFNode field collidables.java.util.ArrayList<X3DNode>
getCollidablesList()
Utility method to get ArrayList value of MFNode collidables field, similar togetCollidables()
.java.lang.String
getComponent()
Defines X3D component for the CollisionCollection element: RigidBodyPhysicsint
getComponentLevel()
Provides default X3D component level for this element: 1java.lang.String
getContainerFieldDefault()
containerField describes typical field relationship of a node to its parent.java.lang.String
getCssClass()
Provide String value from inputOutput SFString field named class.java.lang.String
getDEF()
Provide String value from inputOutput SFString field named DEF.java.lang.String
getElementName()
Provides name of this element: CollisionCollectionboolean
getEnabled()
Provide boolean value from inputOutput SFBool field named enabled.java.lang.String
getFieldType(java.lang.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.ISObject
getIS()
Provide ISObject instance (using a properly typed node) from inputOutput SFNode field IS.X3DMetadataObject
getMetadata()
Provide 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.java.lang.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(java.lang.String nameValue, java.lang.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(java.lang.String DEFvalue)
Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.void
initialize()
Initialize all member variables to default values.CollisionCollectionObject
setAppliedParameters(java.lang.String newValue)
Assign singleton String value to MFString appliedParameters field, similar tosetAppliedParameters(String[])
.CollisionCollectionObject
setAppliedParameters(java.lang.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.CollisionCollectionObject
setAppliedParameters(java.util.ArrayList<java.lang.String> newValue)
Assign ArrayList value of MFString appliedParameters field, similar tosetAppliedParameters(String[])
.CollisionCollectionObject
setAppliedParameters(MFStringObject newValue)
Assign typed object value to MFString appliedParameters field, similar tosetAppliedParameters(String[])
.CollisionCollectionObject
setAppliedParameters(SFStringObject newValue)
Assign single SFString object value to MFString appliedParameters field, similar tosetAppliedParameters(String[])
.CollisionCollectionObject
setBboxCenter(double[] newArray)
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetBboxCenter(float[])
.CollisionCollectionObject
setBboxCenter(double x, double y, double z)
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetBboxCenter(float[])
.CollisionCollectionObject
setBboxCenter(float[] newValue)
Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxCenter.CollisionCollectionObject
setBboxCenter(float x, float y, float z)
Assign values to SFVec3f bboxCenter field, similar tosetBboxCenter(float[])
.CollisionCollectionObject
setBboxCenter(SFVec3fObject newValue)
Assign typed object value to SFVec3f bboxCenter field, similar tosetBboxCenter(float[])
.CollisionCollectionObject
setBboxDisplay(boolean newValue)
Accessor method to assign boolean value to inputOutput SFBool field named bboxDisplay.CollisionCollectionObject
setBboxDisplay(SFBoolObject newValue)
Assign typed object value to SFBool bboxDisplay field, similar tosetBboxDisplay(boolean)
.CollisionCollectionObject
setBboxSize(double[] newArray)
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetBboxSize(float[])
.CollisionCollectionObject
setBboxSize(double x, double y, double z)
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetBboxSize(float[])
.CollisionCollectionObject
setBboxSize(float[] newValue)
Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxSize.CollisionCollectionObject
setBboxSize(float x, float y, float z)
Assign values to SFVec3f bboxSize field, similar tosetBboxSize(float[])
.CollisionCollectionObject
setBboxSize(SFVec3fObject newValue)
Assign typed object value to SFVec3f bboxSize field, similar tosetBboxSize(float[])
.CollisionCollectionObject
setBounce(double newValue)
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetBounce(float)
.CollisionCollectionObject
setBounce(float newValue)
Accessor method to assign float value to inputOutput SFFloat field named bounce.CollisionCollectionObject
setBounce(SFFloatObject newValue)
Assign typed object value to SFFloat bounce field, similar tosetBounce(float)
.CollisionCollectionObject
setCollidables(java.util.ArrayList<X3DNode> newValue)
Assign ArrayList value of MFNode collidables field, similar tosetCollidables(X3DNode[])
.void
setCollidables(X3DNode newValue)
Set single child collidables node, replacing prior array of existing nodes (if any).CollisionCollectionObject
setCollidables(X3DNode[] newValue)
Accessor method to assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field collidables. // newValueInstanceAcceptableNodeTypesTest checks are needed for methods that override/subset X3DNode interfaces #1 boolean isNodeTypeAllowed = (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.sai.RigidBodyPhysics.X3DNBodyCollisionSpaceNode) || (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.sai.RigidBodyPhysics.X3DNBodyCollidableNode); if (!CollisionCollectionObject
setCssClass(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named class.CollisionCollectionObject
setCssClass(SFStringObject newValue)
Assign typed object value to SFString cssClass field, similar tosetCssClass(String)
.CollisionCollectionObject
setDEF(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named DEF.CollisionCollectionObject
setDEF(SFStringObject newValue)
Assign typed object value to SFString DEF field, similar tosetDEF(String)
.CollisionCollectionObject
setEnabled(boolean newValue)
Accessor method to assign boolean value to inputOutput SFBool field named enabled.CollisionCollectionObject
setEnabled(SFBoolObject newValue)
Assign typed object value to SFBool enabled field, similar tosetEnabled(boolean)
.CollisionCollectionObject
setFrictionCoefficients(double[] newArray)
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetFrictionCoefficients(float[])
.CollisionCollectionObject
setFrictionCoefficients(double x, double y)
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetFrictionCoefficients(float[])
.CollisionCollectionObject
setFrictionCoefficients(float[] newValue)
Accessor method to assign 2-tuple float array to inputOutput SFVec2f field named frictionCoefficients.CollisionCollectionObject
setFrictionCoefficients(float x, float y)
Assign values to SFVec2f frictionCoefficients field, similar tosetFrictionCoefficients(float[])
.CollisionCollectionObject
setFrictionCoefficients(SFVec2fObject newValue)
Assign typed object value to SFVec2f frictionCoefficients field, similar tosetFrictionCoefficients(float[])
.CollisionCollectionObject
setIS(ISObject newValue)
Accessor method to assign ISObject instance (using a properly typed node) to inputOutput SFNode field IS.CollisionCollectionObject
setMetadata(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.CollisionCollectionObject
setMetadata(X3DMetadataObject newValue)
Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.CollisionCollectionObject
setMinBounceSpeed(double newValue)
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetMinBounceSpeed(float)
.CollisionCollectionObject
setMinBounceSpeed(float newValue)
Accessor method to assign float value to inputOutput SFFloat field named minBounceSpeed.CollisionCollectionObject
setMinBounceSpeed(SFFloatObject newValue)
Assign typed object value to SFFloat minBounceSpeed field, similar tosetMinBounceSpeed(float)
.CollisionCollectionObject
setSlipFactors(double[] newArray)
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetSlipFactors(float[])
.CollisionCollectionObject
setSlipFactors(double x, double y)
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetSlipFactors(float[])
.CollisionCollectionObject
setSlipFactors(float[] newValue)
Accessor method to assign 2-tuple float array to inputOutput SFVec2f field named slipFactors.CollisionCollectionObject
setSlipFactors(float x, float y)
Assign values to SFVec2f slipFactors field, similar tosetSlipFactors(float[])
.CollisionCollectionObject
setSlipFactors(SFVec2fObject newValue)
Assign typed object value to SFVec2f slipFactors field, similar tosetSlipFactors(float[])
.CollisionCollectionObject
setSoftnessConstantForceMix(double newValue)
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetSoftnessConstantForceMix(float)
.CollisionCollectionObject
setSoftnessConstantForceMix(float newValue)
Accessor method to assign float value to inputOutput SFFloat field named softnessConstantForceMix.CollisionCollectionObject
setSoftnessConstantForceMix(SFFloatObject newValue)
Assign typed object value to SFFloat softnessConstantForceMix field, similar tosetSoftnessConstantForceMix(float)
.CollisionCollectionObject
setSoftnessErrorCorrection(double newValue)
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetSoftnessErrorCorrection(float)
.CollisionCollectionObject
setSoftnessErrorCorrection(float newValue)
Accessor method to assign float value to inputOutput SFFloat field named softnessErrorCorrection.CollisionCollectionObject
setSoftnessErrorCorrection(SFFloatObject newValue)
Assign typed object value to SFFloat softnessErrorCorrection field, similar tosetSoftnessErrorCorrection(float)
.CollisionCollectionObject
setSurfaceSpeed(double[] newArray)
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetSurfaceSpeed(float[])
.CollisionCollectionObject
setSurfaceSpeed(double x, double y)
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetSurfaceSpeed(float[])
.CollisionCollectionObject
setSurfaceSpeed(float[] newValue)
Accessor method to assign 2-tuple float array to inputOutput SFVec2f field named surfaceSpeed.CollisionCollectionObject
setSurfaceSpeed(float x, float y)
Assign values to SFVec2f surfaceSpeed field, similar tosetSurfaceSpeed(float[])
.CollisionCollectionObject
setSurfaceSpeed(SFVec2fObject newValue)
Assign typed object value to SFVec2f surfaceSpeed field, similar tosetSurfaceSpeed(float[])
.CollisionCollectionObject
setUSE(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named USE.CollisionCollectionObject
setUSE(SFStringObject newValue)
Assign typed object value to SFString USE field, similar tosetUSE(String)
.CollisionCollectionObject
setUSE(CollisionCollectionObject DEFnode)
Assign a USE reference to another DEF node of same node type, similar tosetUSE(String)
.CollisionCollectionObject
setVisible(boolean newValue)
Accessor method to assign boolean value to inputOutput SFBool field named visible.CollisionCollectionObject
setVisible(SFBoolObject newValue)
Assign typed object value to SFBool visible field, similar tosetVisible(boolean)
.java.lang.String
toStringClassicVRML(int indentLevel)
Recursive method to provide ClassicVRML string serialization.java.lang.String
toStringVRML97(int indentLevel)
Recursive method to provide VRML97 string serialization.java.lang.String
toStringX3D(int indentLevel)
Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.java.lang.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
getContainerFieldAlternateValues, getContainerFieldOverride, isNode, isStatement, isUSE, resetContainerFieldOverride, setConcreteCssClass, setConcreteDEF, setConcreteUSE, setContainerFieldOverride
Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement
clearParentObject, findAncestorElementByName, findAncestorProtoBody, findAncestorSceneObject, findAncestorX3DObject, getPackageName, getParentObject, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorSceneObject, hasAncestorX3DObject, hasParentObject, isValid, setParentObject, toStringClassicVRML, toStringVRML97, toStringX3D
-
Field Details
-
APPLIEDPARAMETERS_BOUNCE
public static final java.lang.String APPLIEDPARAMETERS_BOUNCETooltip: 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). -
APPLIEDPARAMETERS_USER_FRICTION
public static final java.lang.String APPLIEDPARAMETERS_USER_FRICTIONTooltip: 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). -
APPLIEDPARAMETERS_FRICTION_COEFFICIENT_2
public static final java.lang.String APPLIEDPARAMETERS_FRICTION_COEFFICIENT_2Tooltip: 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). -
APPLIEDPARAMETERS_ERROR_REDUCTION
public static final java.lang.String APPLIEDPARAMETERS_ERROR_REDUCTIONTooltip: 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). -
APPLIEDPARAMETERS_CONSTANT_FORCE
public static final java.lang.String APPLIEDPARAMETERS_CONSTANT_FORCETooltip: 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). -
APPLIEDPARAMETERS_SPEED_1
public static final java.lang.String APPLIEDPARAMETERS_SPEED_1Tooltip: 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). -
APPLIEDPARAMETERS_SPEED_2
public static final java.lang.String APPLIEDPARAMETERS_SPEED_2Tooltip: 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). -
APPLIEDPARAMETERS_SLIP_1
public static final java.lang.String APPLIEDPARAMETERS_SLIP_1Tooltip: 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). -
APPLIEDPARAMETERS_SLIP_2
public static final java.lang.String APPLIEDPARAMETERS_SLIP_2Tooltip: 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). -
NAME
public static final java.lang.String NAMEString constant NAME provides name of this element: CollisionCollection.- See Also:
- Constant Field Values
-
COMPONENT
public static final java.lang.String COMPONENTString constant COMPONENT defines X3D component for the CollisionCollection element: RigidBodyPhysics- See Also:
- Constant Field Values
-
LEVEL
public static final int LEVELInteger constant LEVEL provides default X3D RigidBodyPhysics component level for this element: 1- See Also:
- Constant Field Values
-
APPLIEDPARAMETERS_DEFAULT_VALUE
public static final java.util.ArrayList<java.lang.String> APPLIEDPARAMETERS_DEFAULT_VALUEMFString 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_VALUESFVec3f 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_VALUESFBool 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_VALUESFVec3f 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_VALUESFFloat field named bounce has default value 0f (Java syntax) or 0 (XML syntax).- See Also:
- Constant Field Values
-
ENABLED_DEFAULT_VALUE
public static final boolean ENABLED_DEFAULT_VALUESFBool 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_VALUESFVec2f field named frictionCoefficients has default value {0f,0f} (Java syntax) or 0 0 (XML syntax). -
IS_DEFAULT_VALUE
SFNode field named IS has default value null (Java syntax) or NULL (XML syntax). -
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_VALUESFFloat 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_VALUESFVec2f field named slipFactors has default value {0f,0f} (Java syntax) or 0 0 (XML syntax). -
SOFTNESSCONSTANTFORCEMIX_DEFAULT_VALUE
public static final float SOFTNESSCONSTANTFORCEMIX_DEFAULT_VALUESFFloat 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_VALUESFFloat 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_VALUESFVec2f field named surfaceSpeed has default value {0f,0f} (Java syntax) or 0 0 (XML syntax). -
VISIBLE_DEFAULT_VALUE
public static final boolean VISIBLE_DEFAULT_VALUESFBool field named visible has default value true (Java syntax) or true (XML syntax).- See Also:
- Constant Field Values
-
containerField_DEFAULT_VALUE
public static final java.lang.String containerField_DEFAULT_VALUEcontainerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes. -
fromField_APPLIEDPARAMETERS
public static final java.lang.String fromField_APPLIEDPARAMETERSfromField ROUTE name for MFString field named appliedParameters.- See Also:
- Constant Field Values
-
toField_APPLIEDPARAMETERS
public static final java.lang.String toField_APPLIEDPARAMETERStoField ROUTE name for MFString field named appliedParameters.- See Also:
- Constant Field Values
-
fromField_BBOXDISPLAY
public static final java.lang.String fromField_BBOXDISPLAYfromField ROUTE name for SFBool field named bboxDisplay.- See Also:
- Constant Field Values
-
toField_BBOXDISPLAY
public static final java.lang.String toField_BBOXDISPLAYtoField ROUTE name for SFBool field named bboxDisplay.- See Also:
- Constant Field Values
-
fromField_BOUNCE
public static final java.lang.String fromField_BOUNCEfromField ROUTE name for SFFloat field named bounce.- See Also:
- Constant Field Values
-
toField_BOUNCE
public static final java.lang.String toField_BOUNCEtoField ROUTE name for SFFloat field named bounce.- See Also:
- Constant Field Values
-
fromField_COLLIDABLES
public static final java.lang.String fromField_COLLIDABLESfromField ROUTE name for MFNode field named collidables.- See Also:
- Constant Field Values
-
toField_COLLIDABLES
public static final java.lang.String toField_COLLIDABLEStoField ROUTE name for MFNode field named collidables.- See Also:
- Constant Field Values
-
fromField_ENABLED
public static final java.lang.String fromField_ENABLEDfromField ROUTE name for SFBool field named enabled.- See Also:
- Constant Field Values
-
toField_ENABLED
public static final java.lang.String toField_ENABLEDtoField ROUTE name for SFBool field named enabled.- See Also:
- Constant Field Values
-
fromField_FRICTIONCOEFFICIENTS
public static final java.lang.String fromField_FRICTIONCOEFFICIENTSfromField ROUTE name for SFVec2f field named frictionCoefficients.- See Also:
- Constant Field Values
-
toField_FRICTIONCOEFFICIENTS
public static final java.lang.String toField_FRICTIONCOEFFICIENTStoField ROUTE name for SFVec2f field named frictionCoefficients.- See Also:
- Constant Field Values
-
fromField_IS
public static final java.lang.String fromField_ISfromField ROUTE name for SFNode field named IS.- See Also:
- Constant Field Values
-
fromField_METADATA
public static final java.lang.String fromField_METADATAfromField ROUTE name for SFNode field named metadata.- See Also:
- Constant Field Values
-
toField_METADATA
public static final java.lang.String toField_METADATAtoField ROUTE name for SFNode field named metadata.- See Also:
- Constant Field Values
-
fromField_MINBOUNCESPEED
public static final java.lang.String fromField_MINBOUNCESPEEDfromField ROUTE name for SFFloat field named minBounceSpeed.- See Also:
- Constant Field Values
-
toField_MINBOUNCESPEED
public static final java.lang.String toField_MINBOUNCESPEEDtoField ROUTE name for SFFloat field named minBounceSpeed.- See Also:
- Constant Field Values
-
fromField_SLIPFACTORS
public static final java.lang.String fromField_SLIPFACTORSfromField ROUTE name for SFVec2f field named slipFactors.- See Also:
- Constant Field Values
-
toField_SLIPFACTORS
public static final java.lang.String toField_SLIPFACTORStoField ROUTE name for SFVec2f field named slipFactors.- See Also:
- Constant Field Values
-
fromField_SOFTNESSCONSTANTFORCEMIX
public static final java.lang.String fromField_SOFTNESSCONSTANTFORCEMIXfromField ROUTE name for SFFloat field named softnessConstantForceMix.- See Also:
- Constant Field Values
-
toField_SOFTNESSCONSTANTFORCEMIX
public static final java.lang.String toField_SOFTNESSCONSTANTFORCEMIXtoField ROUTE name for SFFloat field named softnessConstantForceMix.- See Also:
- Constant Field Values
-
fromField_SOFTNESSERRORCORRECTION
public static final java.lang.String fromField_SOFTNESSERRORCORRECTIONfromField ROUTE name for SFFloat field named softnessErrorCorrection.- See Also:
- Constant Field Values
-
toField_SOFTNESSERRORCORRECTION
public static final java.lang.String toField_SOFTNESSERRORCORRECTIONtoField ROUTE name for SFFloat field named softnessErrorCorrection.- See Also:
- Constant Field Values
-
fromField_SURFACESPEED
public static final java.lang.String fromField_SURFACESPEEDfromField ROUTE name for SFVec2f field named surfaceSpeed.- See Also:
- Constant Field Values
-
toField_SURFACESPEED
public static final java.lang.String toField_SURFACESPEEDtoField ROUTE name for SFVec2f field named surfaceSpeed.- See Also:
- Constant Field Values
-
fromField_VISIBLE
public static final java.lang.String fromField_VISIBLEfromField ROUTE name for SFBool field named visible.- See Also:
- Constant Field Values
-
toField_VISIBLE
public static final java.lang.String toField_VISIBLEtoField ROUTE name for SFBool field named visible.- See Also:
- Constant Field Values
-
-
Constructor Details
-
CollisionCollectionObject
public CollisionCollectionObject()Constructor for CollisionCollectionObject to initialize member variables with default values. -
CollisionCollectionObject
public CollisionCollectionObject(java.lang.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 java.lang.String getElementName()Provides name of this element: CollisionCollection- Specified by:
getElementName
in classX3DConcreteElement
- Returns:
- name of this element
-
getComponent
public final java.lang.String getComponent()Defines X3D component for the CollisionCollection element: RigidBodyPhysics- Specified by:
getComponent
in classX3DConcreteElement
- Returns:
- X3D component for this element
-
getComponentLevel
public final int getComponentLevel()Provides default X3D component level for this element: 1- Specified by:
getComponentLevel
in classX3DConcreteElement
- Returns:
- default X3D component level for this element
-
getFieldType
public java.lang.String getFieldType(java.lang.String fieldName)Indicate type corresponding to given fieldName.- Specified by:
getFieldType
in classX3DConcreteElement
- Parameters:
fieldName
- name of field in this X3D node- Returns:
- X3D type (SFvec3f etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE if not recognized
- See Also:
ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE
-
getAccessType
public java.lang.String getAccessType(java.lang.String fieldName)Indicate accessType corresponding to given fieldName.- Specified by:
getAccessType
in classX3DConcreteElement
- Parameters:
fieldName
- name of field in this X3D node- Returns:
- X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized
- See Also:
ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE
-
getContainerFieldDefault
public final java.lang.String getContainerFieldDefault()containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.- Specified by:
getContainerFieldDefault
in classX3DConcreteNode
- Returns:
- default containerField value
- See Also:
- X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM)
-
initialize
public final void initialize()Initialize all member variables to default values.- Overrides:
initialize
in classX3DConcreteNode
-
getAppliedParameters
public java.lang.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 interfaceCollisionCollection
- Returns:
- value of appliedParameters field
-
getAppliedParametersList
public java.util.ArrayList<java.lang.String> getAppliedParametersList()Utility method to get ArrayList value of MFString appliedParameters field, similar togetAppliedParameters()
.- Returns:
- value of appliedParameters field
-
getAppliedParametersString
public java.lang.String getAppliedParametersString()Utility method to get String value of MFString appliedParameters field, similar togetAppliedParameters()
.- Returns:
- value of appliedParameters field
-
setAppliedParameters
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 interfaceCollisionCollection
- Parameters:
newValue
- is new value for the appliedParameters field.- Returns:
CollisionCollectionObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setAppliedParameters
Assign typed object value to MFString appliedParameters field, similar tosetAppliedParameters(String[])
.- Parameters:
newValue
- is new value for the appliedParameters field.- Returns:
CollisionCollectionObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setAppliedParameters
Assign single SFString object value to MFString appliedParameters field, similar tosetAppliedParameters(String[])
.- Parameters:
newValue
- is new value for the appliedParameters field.- Returns:
CollisionCollectionObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
MFStringObject.cleanupEnumerationValues(String)
-
setAppliedParameters
Assign singleton String value to MFString appliedParameters field, similar tosetAppliedParameters(String[])
.- Parameters:
newValue
- is new value for the appliedParameters field.- Returns:
CollisionCollectionObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
MFStringObject.cleanupEnumerationValues(String)
-
setAppliedParameters
public CollisionCollectionObject setAppliedParameters(java.util.ArrayList<java.lang.String> newValue)Assign ArrayList value of MFString appliedParameters field, similar tosetAppliedParameters(String[])
.- Parameters:
newValue
- is new value for the appliedParameters field.- Returns:
CollisionCollectionObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
clearAppliedParameters
Utility method to clear MFString value of appliedParameters field.- Returns:
CollisionCollectionObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
addAppliedParameters
Add singleton String value to MFString appliedParameters field.- Parameters:
newValue
- is new value to add to the appliedParameters field.- Returns:
CollisionCollectionObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
MFStringObject.cleanupEnumerationValues(String)
-
addAppliedParameters
Add singleton SFStringObject value to MFString appliedParameters field.- Parameters:
newValue
- is new value to add to the appliedParameters field.- Returns:
CollisionCollectionObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
MFStringObject.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/documents/specifications/19775-1/V3.3/Part01/components/group.html#BoundingBoxes
- Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#X3DBoundedObject
- Specified by:
getBboxCenter
in interfaceCollisionCollection
- Specified by:
getBboxCenter
in interfaceX3DBoundedObject
- Returns:
- value of bboxCenter field
-
setBboxCenter
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/documents/specifications/19775-1/V3.3/Part01/components/group.html#BoundingBoxes
- Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#X3DBoundedObject
- Specified by:
setBboxCenter
in interfaceCollisionCollection
- Specified by:
setBboxCenter
in interfaceX3DBoundedObject
- Parameters:
newValue
- is new value for the bboxCenter field.- Returns:
CollisionCollectionObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBboxCenter
Assign typed object value to SFVec3f bboxCenter field, similar tosetBboxCenter(float[])
.- Parameters:
newValue
- is new value for the bboxCenter field.- Returns:
CollisionCollectionObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBboxCenter
Assign values to SFVec3f bboxCenter field, similar tosetBboxCenter(float[])
.- Parameters:
x
- first componenty
- second componentz
- third component- Returns:
CollisionCollectionObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBboxCenter
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetBboxCenter(float[])
.- Parameters:
x
- first componenty
- second componentz
- third component- Returns:
CollisionCollectionObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBboxCenter
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetBboxCenter(float[])
.- Parameters:
newArray
- is new value for field- Returns:
CollisionCollectionObject
- 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 interfaceCollisionCollection
- Specified by:
getBboxDisplay
in interfaceX3DBoundedObject
- Returns:
- value of bboxDisplay field
-
setBboxDisplay
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 interfaceCollisionCollection
- Specified by:
setBboxDisplay
in interfaceX3DBoundedObject
- Parameters:
newValue
- is new value for the bboxDisplay field.- Returns:
CollisionCollectionObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBboxDisplay
Assign typed object value to SFBool bboxDisplay field, similar tosetBboxDisplay(boolean)
.- Parameters:
newValue
- is new value for the bboxDisplay field.- Returns:
CollisionCollectionObject
- 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: 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/documents/specifications/19775-1/V3.3/Part01/components/group.html#BoundingBoxes
- Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#X3DBoundedObject
- Specified by:
getBboxSize
in interfaceCollisionCollection
- Specified by:
getBboxSize
in interfaceX3DBoundedObject
- Returns:
- value of bboxSize field
-
setBboxSize
Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxSize.
Tooltip: 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/documents/specifications/19775-1/V3.3/Part01/components/group.html#BoundingBoxes
- Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#X3DBoundedObject
- Specified by:
setBboxSize
in interfaceCollisionCollection
- Specified by:
setBboxSize
in interfaceX3DBoundedObject
- Parameters:
newValue
- is new value for the bboxSize field.- Returns:
CollisionCollectionObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBboxSize
Assign typed object value to SFVec3f bboxSize field, similar tosetBboxSize(float[])
.- Parameters:
newValue
- is new value for the bboxSize field.- Returns:
CollisionCollectionObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBboxSize
Assign values to SFVec3f bboxSize field, similar tosetBboxSize(float[])
.- Parameters:
x
- first componenty
- second componentz
- third component- Returns:
CollisionCollectionObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBboxSize
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetBboxSize(float[])
.- Parameters:
x
- first componenty
- second componentz
- third component- Returns:
CollisionCollectionObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBboxSize
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetBboxSize(float[])
.- Parameters:
newArray
- is new value for field- Returns:
CollisionCollectionObject
- 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 interfaceCollisionCollection
- Returns:
- value of bounce field
-
setBounce
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 interfaceCollisionCollection
- Parameters:
newValue
- is new value for the bounce field.- Returns:
CollisionCollectionObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBounce
Assign typed object value to SFFloat bounce field, similar tosetBounce(float)
.- Parameters:
newValue
- is new value for the bounce field.- Returns:
CollisionCollectionObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBounce
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetBounce(float)
.- Parameters:
newValue
- is new value for field- Returns:
CollisionCollectionObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getCollidables
Provide array of X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) 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 interfaceCollisionCollection
- Returns:
- value of collidables field
- See Also:
X3DNBodyCollisionSpaceNode
,X3DNBodyCollidableNode
-
getCollidablesList
Utility method to get ArrayList value of MFNode collidables field, similar togetCollidables()
.- Returns:
- value of collidables field
-
setCollidables
Accessor method to assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field collidables. // newValueInstanceAcceptableNodeTypesTest checks are needed for methods that override/subset X3DNode interfaces #1 boolean isNodeTypeAllowed = (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.sai.RigidBodyPhysics.X3DNBodyCollisionSpaceNode) || (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.sai.RigidBodyPhysics.X3DNBodyCollidableNode); if (!isNodeTypeAllowed) { throw new org.web3d.x3d.sai.InvalidFieldValueException("X3DNode newValue is not instanceof " + "acceptableNodeTypes X3DNBodyCollisionSpaceNode|X3DNBodyCollidableNode; newValue=" + newValue); }
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 interfaceCollisionCollection
- Parameters:
newValue
- is new value for the collidables field.- Returns:
CollisionCollectionObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setCollidables
Assign ArrayList value of MFNode collidables field, similar tosetCollidables(X3DNode[])
.- Parameters:
newValue
- is new value for the collidables field.- Returns:
CollisionCollectionObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addCollidables
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:
CollisionCollectionObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addCollidables
Add single ProtoInstanceObject (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:
CollisionCollectionObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addCollidables
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 interfaceCollisionCollection
- Parameters:
newValue
- is new value array to be appended the collidables field.
-
setCollidables
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 interfaceCollisionCollection
- Parameters:
newValue
- is new node for the collidables field (restricted to X3DNBodyCollisionSpaceNode|X3DNBodyCollidableNode)
-
clearCollidables
Utility method to clear MFNode value of collidables field.- Returns:
CollisionCollectionObject
- 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()
-
getEnabled
public boolean getEnabled()Provide boolean value from inputOutput SFBool field named enabled.
Tooltip: Enables/disables node operation. *- Specified by:
getEnabled
in interfaceCollisionCollection
- Returns:
- value of enabled field
-
setEnabled
Accessor method to assign boolean value to inputOutput SFBool field named enabled.
Tooltip: Enables/disables node operation. *- Specified by:
setEnabled
in interfaceCollisionCollection
- Parameters:
newValue
- is new value for the enabled field.- Returns:
CollisionCollectionObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setEnabled
Assign typed object value to SFBool enabled field, similar tosetEnabled(boolean)
.- Parameters:
newValue
- is new value for the enabled field.- Returns:
CollisionCollectionObject
- 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 interfaceCollisionCollection
- Returns:
- value of frictionCoefficients field
-
setFrictionCoefficients
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 interfaceCollisionCollection
- Parameters:
newValue
- is new value for the frictionCoefficients field.- Returns:
CollisionCollectionObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setFrictionCoefficients
Assign typed object value to SFVec2f frictionCoefficients field, similar tosetFrictionCoefficients(float[])
.- Parameters:
newValue
- is new value for the frictionCoefficients field.- Returns:
CollisionCollectionObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setFrictionCoefficients
Assign values to SFVec2f frictionCoefficients field, similar tosetFrictionCoefficients(float[])
.- Parameters:
x
- first componenty
- second component- Returns:
CollisionCollectionObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setFrictionCoefficients
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetFrictionCoefficients(float[])
.- Parameters:
x
- first componenty
- second component- Returns:
CollisionCollectionObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setFrictionCoefficients
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetFrictionCoefficients(float[])
.- Parameters:
newArray
- is new value for field- Returns:
CollisionCollectionObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getIS
Provide ISObject instance (using a properly typed node) from inputOutput SFNode field IS.- Specified by:
getIS
in classX3DConcreteNode
- Returns:
- value of IS field
- See Also:
- X3D Tooltips: IS, X3D Tooltips: connect
-
setIS
Accessor method to assign ISObject instance (using a properly typed node) to inputOutput SFNode field IS.- Specified by:
setIS
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the IS field.- Returns:
CollisionCollectionObject
- 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
Utility method to clear SFNode value of IS field.- Returns:
CollisionCollectionObject
- 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
Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.- Specified by:
getMetadata
in interfaceCollisionCollection
- Specified by:
getMetadata
in interfaceX3DChildNode
- Specified by:
getMetadata
in interfaceX3DNode
- 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/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
, X3D Scene Authoring Hints: Metadata Nodes
-
setMetadata
Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.- Specified by:
setMetadata
in interfaceCollisionCollection
- Specified by:
setMetadata
in interfaceX3DChildNode
- Specified by:
setMetadata
in interfaceX3DNode
- Specified by:
setMetadata
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the metadata field.- Returns:
CollisionCollectionObject
- 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/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
, X3D Scene Authoring Hints: Metadata Nodes
-
clearMetadata
Utility method to clear SFNode value of metadata field.- Returns:
CollisionCollectionObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setMetadata
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.- Specified by:
setMetadata
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the metadata field.- Returns:
CollisionCollectionObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
setMetadata(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 interfaceCollisionCollection
- Returns:
- value of minBounceSpeed field
-
setMinBounceSpeed
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 interfaceCollisionCollection
- Parameters:
newValue
- is new value for the minBounceSpeed field.- Returns:
CollisionCollectionObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setMinBounceSpeed
Assign typed object value to SFFloat minBounceSpeed field, similar tosetMinBounceSpeed(float)
.- Parameters:
newValue
- is new value for the minBounceSpeed field.- Returns:
CollisionCollectionObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setMinBounceSpeed
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetMinBounceSpeed(float)
.- Parameters:
newValue
- is new value for field- Returns:
CollisionCollectionObject
- 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 interfaceCollisionCollection
- Returns:
- value of slipFactors field
-
setSlipFactors
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 interfaceCollisionCollection
- Parameters:
newValue
- is new value for the slipFactors field.- Returns:
CollisionCollectionObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setSlipFactors
Assign typed object value to SFVec2f slipFactors field, similar tosetSlipFactors(float[])
.- Parameters:
newValue
- is new value for the slipFactors field.- Returns:
CollisionCollectionObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setSlipFactors
Assign values to SFVec2f slipFactors field, similar tosetSlipFactors(float[])
.- Parameters:
x
- first componenty
- second component- Returns:
CollisionCollectionObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setSlipFactors
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetSlipFactors(float[])
.- Parameters:
x
- first componenty
- second component- Returns:
CollisionCollectionObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setSlipFactors
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetSlipFactors(float[])
.- Parameters:
newArray
- is new value for field- Returns:
CollisionCollectionObject
- 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 interfaceCollisionCollection
- Returns:
- value of softnessConstantForceMix field
-
setSoftnessConstantForceMix
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 interfaceCollisionCollection
- Parameters:
newValue
- is new value for the softnessConstantForceMix field.- Returns:
CollisionCollectionObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setSoftnessConstantForceMix
Assign typed object value to SFFloat softnessConstantForceMix field, similar tosetSoftnessConstantForceMix(float)
.- Parameters:
newValue
- is new value for the softnessConstantForceMix field.- Returns:
CollisionCollectionObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setSoftnessConstantForceMix
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetSoftnessConstantForceMix(float)
.- Parameters:
newValue
- is new value for field- Returns:
CollisionCollectionObject
- 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 interfaceCollisionCollection
- Returns:
- value of softnessErrorCorrection field
-
setSoftnessErrorCorrection
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 interfaceCollisionCollection
- Parameters:
newValue
- is new value for the softnessErrorCorrection field.- Returns:
CollisionCollectionObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setSoftnessErrorCorrection
Assign typed object value to SFFloat softnessErrorCorrection field, similar tosetSoftnessErrorCorrection(float)
.- Parameters:
newValue
- is new value for the softnessErrorCorrection field.- Returns:
CollisionCollectionObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setSoftnessErrorCorrection
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetSoftnessErrorCorrection(float)
.- Parameters:
newValue
- is new value for field- Returns:
CollisionCollectionObject
- 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 interfaceCollisionCollection
- Returns:
- value of surfaceSpeed field
-
setSurfaceSpeed
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 interfaceCollisionCollection
- Parameters:
newValue
- is new value for the surfaceSpeed field.- Returns:
CollisionCollectionObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setSurfaceSpeed
Assign typed object value to SFVec2f surfaceSpeed field, similar tosetSurfaceSpeed(float[])
.- Parameters:
newValue
- is new value for the surfaceSpeed field.- Returns:
CollisionCollectionObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setSurfaceSpeed
Assign values to SFVec2f surfaceSpeed field, similar tosetSurfaceSpeed(float[])
.- Parameters:
x
- first componenty
- second component- Returns:
CollisionCollectionObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setSurfaceSpeed
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetSurfaceSpeed(float[])
.- Parameters:
x
- first componenty
- second component- Returns:
CollisionCollectionObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setSurfaceSpeed
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetSurfaceSpeed(float[])
.- Parameters:
newArray
- is new value for field- Returns:
CollisionCollectionObject
- 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 interfaceCollisionCollection
- Specified by:
getVisible
in interfaceX3DBoundedObject
- Returns:
- value of visible field
-
setVisible
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 interfaceCollisionCollection
- Specified by:
setVisible
in interfaceX3DBoundedObject
- Parameters:
newValue
- is new value for the visible field.- Returns:
CollisionCollectionObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setVisible
Assign typed object value to SFBool visible field, similar tosetVisible(boolean)
.- Parameters:
newValue
- is new value for the visible field.- Returns:
CollisionCollectionObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getDEF
public java.lang.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 classX3DConcreteNode
- Returns:
- value of DEF field
- See Also:
- X3D Scene Authoring Hints: Naming Conventions
-
setDEF
Accessor method to assign String value to inputOutput SFString field named DEF.
Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.- Hint: descriptive DEF names improve clarity and help document a model.
- Hint: well-defined names can simplify design and debugging through improved author understanding.
- Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
Note that setting the DEF value clears the USE value.- Specified by:
setDEF
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the DEF field.- Returns:
CollisionCollectionObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setDEF
Assign typed object value to SFString DEF field, similar tosetDEF(String)
.- Parameters:
newValue
- is new value for the DEF field.- Returns:
CollisionCollectionObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getUSE
public java.lang.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 classX3DConcreteNode
- Returns:
- value of USE field
- See Also:
- X3D Scene Authoring Hints: Naming Conventions
-
setUSE
Accessor method to assign String value to inputOutput SFString field named USE.
Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value).- Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
- Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute.
- Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
Note: eachUSE
node is still an independent object, with theUSE
value matching theDEF
value in the preceding object.
Warning: invoking thesetUSE()
method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.
Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.- Specified by:
setUSE
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the USE field.- Returns:
CollisionCollectionObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setUSE
Assign typed object value to SFString USE field, similar tosetUSE(String)
.- Parameters:
newValue
- is new value for the USE field.- Returns:
CollisionCollectionObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getCssClass
public java.lang.String getCssClass()Provide String value from inputOutput SFString field named class.
Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.- Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
- Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
- Overrides:
getCssClass
in classX3DConcreteNode
- Returns:
- value of class field
- See Also:
- W3C Cascading Style Sheets
-
setCssClass
Accessor method to assign String value to inputOutput SFString field named class.
Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.- Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
- Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
- Specified by:
setCssClass
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the class field.- Returns:
CollisionCollectionObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
- W3C Cascading Style Sheets
-
setCssClass
Assign typed object value to SFString cssClass field, similar tosetCssClass(String)
.- Parameters:
newValue
- is new value for the class field.- Returns:
CollisionCollectionObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setUSE
Assign a USE reference to another DEF node of same node type, similar tosetUSE(String)
.
Warning: note that thesetUSE()
method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.
Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.- Parameters:
DEFnode
- must have a DEF value defined- Returns:
CollisionCollectionObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addComments
Add comment as String to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newComment
- initial value- Returns:
CollisionCollectionObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
addComments
Add comments as String[] array to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newComments
- array of comments- Returns:
CollisionCollectionObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
addComments
Add CommentsBlock to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newCommentsBlock
- block of comments to add- Returns:
CollisionCollectionObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
toStringX3D
public java.lang.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 classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- X3D string
- See Also:
X3DObject.FILE_EXTENSION_X3D
,X3DObject.FILE_EXTENSION_XML
,X3DObject.toStringXML()
,X3DObject.toFileXML(String)
,X3DObject.toFileX3D(String)
, X3D XML Encoding, X3D Compressed Binary Encoding: X3D Canonical Form, X3D Canonicalization (C14N) Tool
-
toStringClassicVRML
public java.lang.String toStringClassicVRML(int indentLevel)Recursive method to provide ClassicVRML string serialization.- Specified by:
toStringClassicVRML
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- ClassicVRML string
- See Also:
X3DObject.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 java.lang.String toStringVRML97(int indentLevel)Recursive method to provide VRML97 string serialization.- Specified by:
toStringVRML97
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- VRML97 string
- See Also:
X3DObject.FILE_EXTENSION_VRML97
, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Virtual Reality Modeling Language (VRML) 97 specification, VRML 97 v2.1 Amendment
-
findElementByNameValue
Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.
Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.
Warning: more than one element may be found that has the same name, this method does not handle that case.- Specified by:
findElementByNameValue
in classX3DConcreteElement
- Parameters:
nameValue
- is value of the name field being searched for in this element and child elements(if any)- Returns:
- object reference to found element, null otherwise
- See Also:
findNodeByDEF(String)
,X3DConcreteElement.hasAncestorSceneObject()
,X3DConcreteElement.findAncestorX3DObject()
-
findElementByNameValue
public X3DConcreteElement findElementByNameValue(java.lang.String nameValue, java.lang.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 findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.
Warning: more than one element may be found that has the same name, this method does not handle that case.- Specified by:
findElementByNameValue
in classX3DConcreteElement
- Parameters:
nameValue
- is value of the name field being searched for in this element and child elements(if any)elementName
- identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)- Returns:
- object reference to found element, null otherwise
- See Also:
findNodeByDEF(String)
,X3DConcreteElement.hasAncestorSceneObject()
,X3DConcreteElement.findAncestorX3DObject()
-
hasElementByNameValue
public boolean hasElementByNameValue(java.lang.String nameValue, java.lang.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
Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.
Warning: more than one element may be found that has the same DEF, this method does not handle that case.- Specified by:
findNodeByDEF
in classX3DConcreteElement
- Parameters:
DEFvalue
- is value of the name field being searched for in this element and child elements(if any)- Returns:
- object reference to found node, null otherwise
- See Also:
findElementByNameValue(String)
,X3DConcreteElement.hasAncestorSceneObject()
,X3DConcreteElement.findAncestorX3DObject()
-
hasNodeByDEF
public boolean hasNodeByDEF(java.lang.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 java.lang.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.- Specified by:
validate
in classX3DConcreteElement
- Returns:
- validation results (if any)
-