Class RigidBodyCollection
java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.RigidBodyPhysics.RigidBodyCollection
- All Implemented Interfaces:
X3DChildNode
,X3DNode
,X3DBoundedObject
,RigidBodyCollection
RigidBodyCollection represents a system of bodies that interact within a single physics model.
Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the
Package hint: This org.web3d.x3d.jsail concrete class is used for implementing a standalone X3D object as a Plain Old Java Object (POJO). If you are writing Java code for use inside an X3D Script node, compile separate code using only the org.web3d.x3d.sai package instead.
Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the
org.web3d.x3d.jsail
classes.
RigidBodyCollection node tooltip: (X3D version 3.2 or later) [X3DChildNode] RigidBodyCollection represents a system of bodies that interact within a single physics model. * Package hint: This org.web3d.x3d.jsail concrete class is used for implementing a standalone X3D object as a Plain Old Java Object (POJO). If you are writing Java code for use inside an X3D Script node, compile separate code using only the org.web3d.x3d.sai package instead.
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final boolean
SFBool field named autoDisable has default value false (Java syntax) or false (XML syntax).static final float[]
SFVec3f field named bboxCenter has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).static final boolean
SFBool field named bboxDisplay has default value false (Java syntax) or false (XML syntax).static final float[]
SFVec3f field named bboxSize has default value {-1f,-1f,-1f} (Java syntax) or -1 -1 -1 (XML syntax).static final CollisionCollection
SFNode field named collider has default value null (Java syntax) or NULL (XML syntax).static final String
String constant COMPONENT defines X3D component for the RigidBodyCollection element: RigidBodyPhysicsstatic final float
SFFloat field named constantForceMix has default value 0.0001f (Java syntax) or 0.0001 (XML syntax).static final float
SFFloat field named contactSurfaceThickness has default value 0f (Java syntax) or 0 (XML syntax).static final String
containerField describes typical field relationship of a node to its parent.static final float
SFFloat field named disableAngularSpeed has default value 0f (Java syntax) or 0 (XML syntax).static final float
SFFloat field named disableLinearSpeed has default value 0f (Java syntax) or 0 (XML syntax).static final double
SFTime field named disableTime has default value 0 (Java syntax) or 0 (XML syntax).static final boolean
SFBool field named enabled has default value true (Java syntax) or true (XML syntax).static final float
SFFloat field named errorCorrection has default value 0.8f (Java syntax) or 0.8 (XML syntax).static final String
fromField ROUTE name for SFBool field named autoDisable.static final String
fromField ROUTE name for SFBool field named bboxDisplay.static final String
fromField ROUTE name for MFNode field named bodies.static final String
fromField ROUTE name for SFFloat field named constantForceMix.static final String
fromField ROUTE name for SFFloat field named contactSurfaceThickness.static final String
fromField ROUTE name for SFFloat field named disableAngularSpeed.static final String
fromField ROUTE name for SFFloat field named disableLinearSpeed.static final String
fromField ROUTE name for SFTime field named disableTime.static final String
fromField ROUTE name for SFBool field named enabled.static final String
fromField ROUTE name for SFFloat field named errorCorrection.static final String
fromField ROUTE name for SFVec3f field named gravity.static final String
fromField ROUTE name for SFNode field named IS.static final String
fromField ROUTE name for SFInt32 field named iterations.static final String
fromField ROUTE name for MFNode field named joints.static final String
fromField ROUTE name for SFFloat field named maxCorrectionSpeed.static final String
fromField ROUTE name for SFNode field named metadata.static final String
fromField ROUTE name for SFBool field named preferAccuracy.static final String
fromField ROUTE name for SFBool field named visible.static final float[]
SFVec3f field named gravity has default value {0f,-9.8f,0f} (Java syntax) or 0 -9.8 0 (XML syntax).static final IS
SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).static final int
SFInt32 field named iterations has default value 10 (Java syntax) or 10 (XML syntax).static final int
Integer constant LEVEL provides default X3D RigidBodyPhysics component level for this element: 2static final float
SFFloat field named maxCorrectionSpeed has default value -1f (Java syntax) or -1 (XML syntax).static final X3DMetadataObject
SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).static final String
String constant NAME provides name of this element: RigidBodyCollection.static final boolean
SFBool field named preferAccuracy has default value false (Java syntax) or false (XML syntax).static final String
toField ROUTE name for SFBool field named autoDisable.static final String
toField ROUTE name for SFBool field named bboxDisplay.static final String
toField ROUTE name for MFNode field named bodies.static final String
toField ROUTE name for SFFloat field named constantForceMix.static final String
toField ROUTE name for SFFloat field named contactSurfaceThickness.static final String
toField ROUTE name for SFFloat field named disableAngularSpeed.static final String
toField ROUTE name for SFFloat field named disableLinearSpeed.static final String
toField ROUTE name for SFTime field named disableTime.static final String
toField ROUTE name for SFBool field named enabled.static final String
toField ROUTE name for SFFloat field named errorCorrection.static final String
toField ROUTE name for SFVec3f field named gravity.static final String
toField ROUTE name for SFInt32 field named iterations.static final String
toField ROUTE name for MFNode field named joints.static final String
toField ROUTE name for SFFloat field named maxCorrectionSpeed.static final String
toField ROUTE name for SFNode field named metadata.static final String
toField ROUTE name for SFBool field named preferAccuracy.static final String
toField ROUTE name for MFNode field named set_contacts.static final String
toField ROUTE name for SFBool field named visible.static final boolean
SFBool field named visible has default value true (Java syntax) or true (XML syntax).Fields inherited from class org.web3d.x3d.jsail.X3DConcreteNode
containerField_ALLOWED_VALUES, containerFieldOverride, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE
Fields inherited from class org.web3d.x3d.jsail.X3DConcreteElement
CLASS_DEFAULT_VALUE, ID_DEFAULT_VALUE, STYLE_DEFAULT_VALUE, validationResult
-
Constructor Summary
ConstructorDescriptionConstructor for RigidBodyCollection to initialize member variables with default values.RigidBodyCollection
(String DEFlabel) Utility constructor that assigns DEF label after initializing member variables with default values. -
Method Summary
Modifier and TypeMethodDescriptionaddBodies
(ProtoInstance newValue) Add single ProtoInstance (with appropriate node type and containerField value) to MFNode array for bodies field.Add single child node to existing array of bodies nodes (if any).void
Add array of child bodies nodes to array of existing nodes (if any).addComments
(String newComment) Add comment as String to contained commentsList.addComments
(String[] newComments) Add comments as String[] array to contained commentsList.addComments
(CommentsBlock newCommentsBlock) Add CommentsBlock to contained commentsList.addJoints
(ProtoInstance newValue) Add single ProtoInstance (with appropriate node type and containerField value) to MFNode array for joints field.Add single child node to existing array of joints nodes (if any).void
Add array of child joints nodes to array of existing nodes (if any).Utility method to clear MFNode value of bodies field.Utility method to clear SFNode value of collider field.clearIS()
Utility method to clear SFNode value of IS field.Utility method to clear MFNode value of joints field.Utility method to clear SFNode value of metadata field.findElementByNameValue
(String nameValue) Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.findElementByNameValue
(String nameValue, String elementName) Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.findNodeByDEF
(String DEFvalue) Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.getAccessType
(String fieldName) Indicate accessType corresponding to given fieldName.boolean
Provide boolean value from inputOutput SFBool field named autoDisable.float[]
Provide array of 3-tuple float results from initializeOnly SFVec3f field named bboxCenter.boolean
Provide boolean value from inputOutput SFBool field named bboxDisplay.float[]
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.X3DNode[]
Provide array of org.web3d.x3d.sai.RigidBodyPhysics.RigidBody results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field bodies.Utility method to get ArrayList value of MFNode bodies field, similar togetBodies()
.Provide org.web3d.x3d.sai.RigidBodyPhysics.CollisionCollection instance (using a properly typed node) from initializeOnly SFNode field collider.final String
Defines X3D component for the RigidBodyCollection element: RigidBodyPhysicsfinal int
Provides default X3D component level for this element: 2float
Provide float value from inputOutput SFFloat field named constantForceMix.float
Provide float value from inputOutput SFFloat field named contactSurfaceThickness.final String
containerField describes typical field relationship of a node to its parent.Provide String value from inputOutput SFString field named class.Provide String value from inputOutput SFString field named style.getDEF()
Provide String value from inputOutput SFString field named DEF.float
Provide float value from inputOutput SFFloat field named disableAngularSpeed.float
Provide float value from inputOutput SFFloat field named disableLinearSpeed.double
Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named disableTime.final String
Provides name of this element: RigidBodyCollectionboolean
Provide boolean value from inputOutput SFBool field named enabled.float
Provide float value from inputOutput SFFloat field named errorCorrection.getFieldType
(String fieldName) Indicate type corresponding to given fieldName.float[]
Provide array of 3-tuple float results from inputOutput SFVec3f field named gravity.Provide String value from inputOutput SFString field named id.getIS()
Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.int
Provide int value from inputOutput SFInt32 field named iterations.X3DNode[]
Provide array of org.web3d.x3d.sai.RigidBodyPhysics.X3DRigidJointNode results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field joints.Utility method to get ArrayList value of MFNode joints field, similar togetJoints()
.float
Provide float value from inputOutput SFFloat field named maxCorrectionSpeed.Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.boolean
Provide boolean value from inputOutput SFBool field named preferAccuracy.getUSE()
Provide String value from inputOutput SFString field named USE.boolean
Provide boolean value from inputOutput SFBool field named visible.boolean
Indicate whether an object is available for inputOutput MFNode field bodies.boolean
Indicate whether an object is available for initializeOnly SFNode field collider.boolean
hasElementByNameValue
(String nameValue, String elementName) Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.boolean
hasIS()
Indicate whether an object is available for inputOutput SFNode field IS.boolean
Indicate whether an object is available for inputOutput MFNode field joints.boolean
Indicate whether an object is available for inputOutput SFNode field metadata.boolean
hasNodeByDEF
(String DEFvalue) Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.final void
Initialize all member variables to default values.setAutoDisable
(boolean newValue) Accessor method to assign boolean value to inputOutput SFBool field named autoDisable.setAutoDisable
(SFBool newValue) Assign typed object value to SFBool autoDisable field, similar tosetAutoDisable(boolean)
.setBboxCenter
(double[] newArray) Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetBboxCenter(float[])
.setBboxCenter
(double x, double y, double z) Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetBboxCenter(float[])
.setBboxCenter
(float[] newValue) Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxCenter.setBboxCenter
(float x, float y, float z) Assign values to SFVec3f bboxCenter field, similar tosetBboxCenter(float[])
.setBboxCenter
(SFVec3f newValue) Assign typed object value to SFVec3f bboxCenter field, similar tosetBboxCenter(float[])
.setBboxDisplay
(boolean newValue) Accessor method to assign boolean value to inputOutput SFBool field named bboxDisplay.setBboxDisplay
(SFBool newValue) Assign typed object value to SFBool bboxDisplay field, similar tosetBboxDisplay(boolean)
.setBboxSize
(double[] newArray) Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetBboxSize(float[])
.setBboxSize
(double x, double y, double z) Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetBboxSize(float[])
.setBboxSize
(float[] newValue) Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxSize.setBboxSize
(float x, float y, float z) Assign values to SFVec3f bboxSize field, similar tosetBboxSize(float[])
.setBboxSize
(SFVec3f newValue) Assign typed object value to SFVec3f bboxSize field, similar tosetBboxSize(float[])
.Assign ArrayList value of MFNode bodies field, similar tosetBodies(org.web3d.x3d.sai.Core.X3DNode[])
.void
Set single child bodies node, replacing prior array of existing nodes (if any).Accessor method to assign org.web3d.x3d.sai.RigidBodyPhysics.RigidBody array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field bodies.setCollider
(ProtoInstance newValue) Assign ProtoInstance (using a properly typed node) to initializeOnly SFNode field collider.setCollider
(CollisionCollection newValue) Accessor method to assign org.web3d.x3d.sai.RigidBodyPhysics.CollisionCollection instance (using a properly typed node) to initializeOnly SFNode field collider.setConstantForceMix
(double newValue) Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetConstantForceMix(float)
.setConstantForceMix
(float newValue) Accessor method to assign float value to inputOutput SFFloat field named constantForceMix.setConstantForceMix
(SFFloat newValue) Assign typed object value to SFFloat constantForceMix field, similar tosetConstantForceMix(float)
.setContactSurfaceThickness
(double newValue) Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetContactSurfaceThickness(float)
.setContactSurfaceThickness
(float newValue) Accessor method to assign float value to inputOutput SFFloat field named contactSurfaceThickness.setContactSurfaceThickness
(SFFloat newValue) Assign typed object value to SFFloat contactSurfaceThickness field, similar tosetContactSurfaceThickness(float)
.final RigidBodyCollection
setCssClass
(String newValue) Accessor method to assign String value to inputOutput SFString field named class.setCssClass
(SFString newValue) Assign typed object value to SFString cssClass field, similar tosetCssClass(String)
.final RigidBodyCollection
setCssStyle
(String newValue) Accessor method to assign String value to inputOutput SFString field named style.setCssStyle
(SFString newValue) Assign typed object value to SFString cssClass field, similar tosetCssStyle(String)
.final RigidBodyCollection
Accessor method to assign String value to inputOutput SFString field named DEF.Assign typed object value to SFString DEF field, similar tosetDEF(String)
.setDisableAngularSpeed
(double newValue) Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetDisableAngularSpeed(float)
.setDisableAngularSpeed
(float newValue) Accessor method to assign float value to inputOutput SFFloat field named disableAngularSpeed.setDisableAngularSpeed
(SFFloat newValue) Assign typed object value to SFFloat disableAngularSpeed field, similar tosetDisableAngularSpeed(float)
.setDisableLinearSpeed
(double newValue) Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetDisableLinearSpeed(float)
.setDisableLinearSpeed
(float newValue) Accessor method to assign float value to inputOutput SFFloat field named disableLinearSpeed.setDisableLinearSpeed
(SFFloat newValue) Assign typed object value to SFFloat disableLinearSpeed field, similar tosetDisableLinearSpeed(float)
.setDisableTime
(double newValue) Accessor method to assign double value in seconds to inputOutput SFTime field named disableTime.setDisableTime
(SFTime newValue) Assign typed object value to SFTime disableTime field, similar tosetDisableTime(double)
.setEnabled
(boolean newValue) Accessor method to assign boolean value to inputOutput SFBool field named enabled.setEnabled
(SFBool newValue) Assign typed object value to SFBool enabled field, similar tosetEnabled(boolean)
.setErrorCorrection
(double newValue) Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetErrorCorrection(float)
.setErrorCorrection
(float newValue) Accessor method to assign float value to inputOutput SFFloat field named errorCorrection.setErrorCorrection
(SFFloat newValue) Assign typed object value to SFFloat errorCorrection field, similar tosetErrorCorrection(float)
.setGravity
(double[] newArray) Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetGravity(float[])
.setGravity
(double x, double y, double z) Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetGravity(float[])
.setGravity
(float[] newValue) Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named gravity.setGravity
(float x, float y, float z) Assign values to SFVec3f gravity field, similar tosetGravity(float[])
.setGravity
(SFVec3f newValue) Assign typed object value to SFVec3f gravity field, similar tosetGravity(float[])
.final RigidBodyCollection
Accessor method to assign String value to inputOutput SFString field named id.Assign typed object value to SFString HtmlID field, similar tosetHtmlID(String)
.Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.setIterations
(int newValue) Accessor method to assign int value to inputOutput SFInt32 field named iterations.setIterations
(SFInt32 newValue) Assign typed object value to SFInt32 iterations field, similar tosetIterations(int)
.setJoints
(ArrayList<X3DRigidJointNode> newValue) Assign ArrayList value of MFNode joints field, similar tosetJoints(org.web3d.x3d.sai.Core.X3DNode[])
.void
Set single child joints node, replacing prior array of existing nodes (if any).Accessor method to assign org.web3d.x3d.sai.RigidBodyPhysics.X3DRigidJointNode array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field joints.setMaxCorrectionSpeed
(double newValue) Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetMaxCorrectionSpeed(float)
.setMaxCorrectionSpeed
(float newValue) Accessor method to assign float value to inputOutput SFFloat field named maxCorrectionSpeed.setMaxCorrectionSpeed
(SFFloat newValue) Assign typed object value to SFFloat maxCorrectionSpeed field, similar tosetMaxCorrectionSpeed(float)
.setMetadata
(ProtoInstance newValue) Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.setMetadata
(X3DMetadataObject newValue) Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.setPreferAccuracy
(boolean newValue) Accessor method to assign boolean value to inputOutput SFBool field named preferAccuracy.setPreferAccuracy
(SFBool newValue) Assign typed object value to SFBool preferAccuracy field, similar tosetPreferAccuracy(boolean)
.final RigidBodyCollection
Accessor method to assign String value to inputOutput SFString field named USE.Assign typed object value to SFString USE field, similar tosetUSE(String)
.setUSE
(RigidBodyCollection DEFnode) Assign a USE reference to another DEF node of same node type, similar tosetUSE(String)
.setVisible
(boolean newValue) Accessor method to assign boolean value to inputOutput SFBool field named visible.setVisible
(SFBool newValue) Assign typed object value to SFBool visible field, similar tosetVisible(boolean)
.toStringClassicVRML
(int indentLevel) Recursive method to provide ClassicVRML string serialization.toStringVRML97
(int indentLevel) Recursive method to provide VRML97 string serialization.toStringX3D
(int indentLevel) Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.validate()
Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.Methods inherited from class org.web3d.x3d.jsail.X3DConcreteNode
getContainerFieldAllowedValues, getContainerFieldOverride, getName, hasDEF, hasNameField, hasUSE, includesNameField, isNode, isStatement, resetContainerFieldOverride, setConcreteDEF, setConcreteUSE, setContainerFieldOverride
Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement
addComments, clearParent, findAncestorElementByName, findAncestorProtoBody, findAncestorScene, findAncestorX3D, getPackageName, getParent, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorScene, hasAncestorX3D, hasParent, isValid, setConcreteCssClass, setConcreteCssStyle, setConcreteHtmlID, setParent, toStringClassicVRML, toStringVRML97, toStringX3D
-
Field Details
-
NAME
String constant NAME provides name of this element: RigidBodyCollection.- See Also:
-
COMPONENT
String constant COMPONENT defines X3D component for the RigidBodyCollection element: RigidBodyPhysics- See Also:
-
LEVEL
public static final int LEVELInteger constant LEVEL provides default X3D RigidBodyPhysics component level for this element: 2- See Also:
-
AUTODISABLE_DEFAULT_VALUE
public static final boolean AUTODISABLE_DEFAULT_VALUESFBool field named autoDisable has default value false (Java syntax) or false (XML syntax).- See Also:
-
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:
-
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). -
COLLIDER_DEFAULT_VALUE
SFNode field named collider has default value null (Java syntax) or NULL (XML syntax). -
CONSTANTFORCEMIX_DEFAULT_VALUE
public static final float CONSTANTFORCEMIX_DEFAULT_VALUESFFloat field named constantForceMix has default value 0.0001f (Java syntax) or 0.0001 (XML syntax).- See Also:
-
CONTACTSURFACETHICKNESS_DEFAULT_VALUE
public static final float CONTACTSURFACETHICKNESS_DEFAULT_VALUESFFloat field named contactSurfaceThickness has default value 0f (Java syntax) or 0 (XML syntax).- See Also:
-
DISABLEANGULARSPEED_DEFAULT_VALUE
public static final float DISABLEANGULARSPEED_DEFAULT_VALUESFFloat field named disableAngularSpeed has default value 0f (Java syntax) or 0 (XML syntax).- See Also:
-
DISABLELINEARSPEED_DEFAULT_VALUE
public static final float DISABLELINEARSPEED_DEFAULT_VALUESFFloat field named disableLinearSpeed has default value 0f (Java syntax) or 0 (XML syntax).- See Also:
-
DISABLETIME_DEFAULT_VALUE
public static final double DISABLETIME_DEFAULT_VALUESFTime field named disableTime has default value 0 (Java syntax) or 0 (XML syntax).- See Also:
-
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:
-
ERRORCORRECTION_DEFAULT_VALUE
public static final float ERRORCORRECTION_DEFAULT_VALUESFFloat field named errorCorrection has default value 0.8f (Java syntax) or 0.8 (XML syntax).- See Also:
-
GRAVITY_DEFAULT_VALUE
public static final float[] GRAVITY_DEFAULT_VALUESFVec3f field named gravity has default value {0f,-9.8f,0f} (Java syntax) or 0 -9.8 0 (XML syntax). -
IS_DEFAULT_VALUE
SFNode field named IS has default value null (Java syntax) or NULL (XML syntax). -
ITERATIONS_DEFAULT_VALUE
public static final int ITERATIONS_DEFAULT_VALUESFInt32 field named iterations has default value 10 (Java syntax) or 10 (XML syntax).- See Also:
-
MAXCORRECTIONSPEED_DEFAULT_VALUE
public static final float MAXCORRECTIONSPEED_DEFAULT_VALUESFFloat field named maxCorrectionSpeed has default value -1f (Java syntax) or -1 (XML syntax).- See Also:
-
METADATA_DEFAULT_VALUE
SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax). -
PREFERACCURACY_DEFAULT_VALUE
public static final boolean PREFERACCURACY_DEFAULT_VALUESFBool field named preferAccuracy has default value false (Java syntax) or false (XML syntax).- See Also:
-
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:
-
containerField_DEFAULT_VALUE
containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, this default value is provided for informational purposes only.
containerField_DEFAULT_VALUE = "children";
containerField_ALLOWED_VALUES = {"children" }; type xs:NMTOKEN- See Also:
-
fromField_AUTODISABLE
fromField ROUTE name for SFBool field named autoDisable.- See Also:
-
toField_AUTODISABLE
toField ROUTE name for SFBool field named autoDisable.- See Also:
-
fromField_BBOXDISPLAY
fromField ROUTE name for SFBool field named bboxDisplay.- See Also:
-
toField_BBOXDISPLAY
toField ROUTE name for SFBool field named bboxDisplay.- See Also:
-
fromField_BODIES
fromField ROUTE name for MFNode field named bodies.- See Also:
-
toField_BODIES
toField ROUTE name for MFNode field named bodies.- See Also:
-
fromField_CONSTANTFORCEMIX
fromField ROUTE name for SFFloat field named constantForceMix.- See Also:
-
toField_CONSTANTFORCEMIX
toField ROUTE name for SFFloat field named constantForceMix.- See Also:
-
fromField_CONTACTSURFACETHICKNESS
fromField ROUTE name for SFFloat field named contactSurfaceThickness.- See Also:
-
toField_CONTACTSURFACETHICKNESS
toField ROUTE name for SFFloat field named contactSurfaceThickness.- See Also:
-
fromField_DISABLEANGULARSPEED
fromField ROUTE name for SFFloat field named disableAngularSpeed.- See Also:
-
toField_DISABLEANGULARSPEED
toField ROUTE name for SFFloat field named disableAngularSpeed.- See Also:
-
fromField_DISABLELINEARSPEED
fromField ROUTE name for SFFloat field named disableLinearSpeed.- See Also:
-
toField_DISABLELINEARSPEED
toField ROUTE name for SFFloat field named disableLinearSpeed.- See Also:
-
fromField_DISABLETIME
fromField ROUTE name for SFTime field named disableTime.- See Also:
-
toField_DISABLETIME
toField ROUTE name for SFTime field named disableTime.- See Also:
-
fromField_ENABLED
fromField ROUTE name for SFBool field named enabled.- See Also:
-
toField_ENABLED
toField ROUTE name for SFBool field named enabled.- See Also:
-
fromField_ERRORCORRECTION
fromField ROUTE name for SFFloat field named errorCorrection.- See Also:
-
toField_ERRORCORRECTION
toField ROUTE name for SFFloat field named errorCorrection.- See Also:
-
fromField_GRAVITY
fromField ROUTE name for SFVec3f field named gravity.- See Also:
-
toField_GRAVITY
toField ROUTE name for SFVec3f field named gravity.- See Also:
-
fromField_IS
-
fromField_ITERATIONS
fromField ROUTE name for SFInt32 field named iterations.- See Also:
-
toField_ITERATIONS
toField ROUTE name for SFInt32 field named iterations.- See Also:
-
fromField_JOINTS
fromField ROUTE name for MFNode field named joints.- See Also:
-
toField_JOINTS
toField ROUTE name for MFNode field named joints.- See Also:
-
fromField_MAXCORRECTIONSPEED
fromField ROUTE name for SFFloat field named maxCorrectionSpeed.- See Also:
-
toField_MAXCORRECTIONSPEED
toField ROUTE name for SFFloat field named maxCorrectionSpeed.- See Also:
-
fromField_METADATA
fromField ROUTE name for SFNode field named metadata.- See Also:
-
toField_METADATA
toField ROUTE name for SFNode field named metadata.- See Also:
-
fromField_PREFERACCURACY
fromField ROUTE name for SFBool field named preferAccuracy.- See Also:
-
toField_PREFERACCURACY
toField ROUTE name for SFBool field named preferAccuracy.- See Also:
-
toField_SET_CONTACTS
toField ROUTE name for MFNode field named set_contacts.- See Also:
-
fromField_VISIBLE
fromField ROUTE name for SFBool field named visible.- See Also:
-
toField_VISIBLE
toField ROUTE name for SFBool field named visible.- See Also:
-
-
Constructor Details
-
RigidBodyCollection
public RigidBodyCollection()Constructor for RigidBodyCollection to initialize member variables with default values. -
RigidBodyCollection
Utility constructor that assigns DEF label after initializing member variables with default values.- Parameters:
DEFlabel
- unique DEF name for this X3D node
-
-
Method Details
-
getElementName
Provides name of this element: RigidBodyCollection- Specified by:
getElementName
in classX3DConcreteElement
- Returns:
- name of this element
-
getComponent
Defines X3D component for the RigidBodyCollection 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: 2- Specified by:
getComponentLevel
in classX3DConcreteElement
- Returns:
- default X3D component level for this element
-
getFieldType
Indicate type corresponding to given fieldName.- Specified by:
getFieldType
in classX3DConcreteElement
- Parameters:
fieldName
- name of field in this X3D node- Returns:
- X3D type (SFvec3f etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE if not recognized
- See Also:
-
getAccessType
Indicate accessType corresponding to given fieldName.- Specified by:
getAccessType
in classX3DConcreteElement
- Parameters:
fieldName
- name of field in this X3D node- Returns:
- X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized
- See Also:
-
getContainerFieldDefault
containerField describes typical field relationship of a node to its parent. Programmer usage is not ordinarily needed when using this API, since this default value is provided for informational purposes only.- Specified by:
getContainerFieldDefault
in classX3DConcreteNode
- Returns:
- default containerField value
- See Also:
-
initialize
public final void initialize()Initialize all member variables to default values.- Overrides:
initialize
in classX3DConcreteNode
-
getAutoDisable
public boolean getAutoDisable()Provide boolean value from inputOutput SFBool field named autoDisable.
Tooltip: autoDisable toggles operation of disableAngularSpeed, disableLinearSpeed, disableTime. *- Specified by:
getAutoDisable
in interfaceRigidBodyCollection
- Returns:
- value of autoDisable field
-
setAutoDisable
Accessor method to assign boolean value to inputOutput SFBool field named autoDisable.
Tooltip: autoDisable toggles operation of disableAngularSpeed, disableLinearSpeed, disableTime. *- Specified by:
setAutoDisable
in interfaceRigidBodyCollection
- Parameters:
newValue
- is new value for the autoDisable field.- Returns:
RigidBodyCollection
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setAutoDisable
Assign typed object value to SFBool autoDisable field, similar tosetAutoDisable(boolean)
.- Parameters:
newValue
- is new value for the autoDisable field.- Returns:
RigidBodyCollection
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getBboxCenter
public float[] getBboxCenter()Provide array of 3-tuple float results from initializeOnly SFVec3f field named bboxCenter.
Tooltip: Bounding box center accompanies bboxSize and provides an optional hint for bounding box position offset from origin of local coordinate system.- Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with a corresponding cost of increased file size.
- Hint: X3D Architecture, 10.2.2 Bounding boxes https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/grouping.html#BoundingBoxes
- Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/grouping.html#X3DBoundedObject
- Specified by:
getBboxCenter
in interfaceRigidBodyCollection
- 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/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/grouping.html#BoundingBoxes
- Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/grouping.html#X3DBoundedObject
- Specified by:
setBboxCenter
in interfaceRigidBodyCollection
- Specified by:
setBboxCenter
in interfaceX3DBoundedObject
- Parameters:
newValue
- is new value for the bboxCenter field.- Returns:
RigidBodyCollection
- 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:
RigidBodyCollection
- 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:
RigidBodyCollection
- 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:
RigidBodyCollection
- 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:
RigidBodyCollection
- 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 interfaceRigidBodyCollection
- 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 interfaceRigidBodyCollection
- Specified by:
setBboxDisplay
in interfaceX3DBoundedObject
- Parameters:
newValue
- is new value for the bboxDisplay field.- Returns:
RigidBodyCollection
- 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:
RigidBodyCollection
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getBboxSize
public float[] getBboxSize()Provide array of 3-tuple float results within allowed range of [0,infinity), or default value [-1 -1 -1], from initializeOnly SFVec3f field named bboxSize.
Tooltip: or [0,+infinity) Bounding box size is usually omitted, and can easily be calculated automatically by an X3D player at scene-loading time with minimal computational cost. Bounding box size can also be defined as an optional authoring hint that suggests an optimization or constraint.- Hint: can be useful for collision computations or inverse-kinematics (IK) engines.
- Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with a corresponding cost of increased file size.
- Hint: X3D Architecture, 10.2.2 Bounding boxes https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/grouping.html#BoundingBoxes
- Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/grouping.html#X3DBoundedObject
- Specified by:
getBboxSize
in interfaceRigidBodyCollection
- 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: or [0,+infinity) Bounding box size is usually omitted, and can easily be calculated automatically by an X3D player at scene-loading time with minimal computational cost. Bounding box size can also be defined as an optional authoring hint that suggests an optimization or constraint.- Hint: can be useful for collision computations or inverse-kinematics (IK) engines.
- Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with a corresponding cost of increased file size.
- Hint: X3D Architecture, 10.2.2 Bounding boxes https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/grouping.html#BoundingBoxes
- Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/grouping.html#X3DBoundedObject
- Specified by:
setBboxSize
in interfaceRigidBodyCollection
- Specified by:
setBboxSize
in interfaceX3DBoundedObject
- Parameters:
newValue
- is new value for the bboxSize field.- Returns:
RigidBodyCollection
- 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:
RigidBodyCollection
- 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:
RigidBodyCollection
- 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:
RigidBodyCollection
- 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:
RigidBodyCollection
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getBodies
Provide array of org.web3d.x3d.sai.RigidBodyPhysics.RigidBody results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field bodies.
Tooltip: [RigidBody] Collection of top-level nodes that comprise a set of bodies evaluated as a single set of interactions. *
Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to RigidBody.- Specified by:
getBodies
in interfaceRigidBodyCollection
- Returns:
- value of bodies field
- See Also:
-
getBodiesList
Utility method to get ArrayList value of MFNode bodies field, similar togetBodies()
.- Returns:
- value of bodies field
-
setBodies
Accessor method to assign org.web3d.x3d.sai.RigidBodyPhysics.RigidBody array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field bodies.
Tooltip: [RigidBody] Collection of top-level nodes that comprise a set of bodies evaluated as a single set of interactions. *
Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to RigidBody.- Specified by:
setBodies
in interfaceRigidBodyCollection
- Parameters:
newValue
- is new value for the bodies field.- Returns:
RigidBodyCollection
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBodies
Assign ArrayList value of MFNode bodies field, similar tosetBodies(org.web3d.x3d.sai.Core.X3DNode[])
.- Parameters:
newValue
- is new value for the bodies field.- Returns:
RigidBodyCollection
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addBodies
Add single child node to existing array of bodies nodes (if any).
Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to RigidBody and ProtoInstance.- Parameters:
newValue
- is new value to be appended the bodies field.- Returns:
RigidBodyCollection
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addBodies
Add single ProtoInstance (with appropriate node type and containerField value) to MFNode array for bodies 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:
RigidBodyCollection
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addBodies
Add array of child bodies nodes to array of existing nodes (if any).
Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to RigidBody.- Specified by:
addBodies
in interfaceRigidBodyCollection
- Parameters:
newValue
- is new value array to be appended the bodies field.
-
setBodies
Set single child bodies node, replacing prior array of existing nodes (if any).
Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are restricted to RigidBody.- Specified by:
setBodies
in interfaceRigidBodyCollection
- Parameters:
newValue
- is new node for the bodies field (restricted to RigidBody)
-
clearBodies
Utility method to clear MFNode value of bodies field. This method does not initialize withBODIES_DEFAULT_VALUE.- Returns:
RigidBodyCollection
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
hasBodies
public boolean hasBodies()Indicate whether an object is available for inputOutput MFNode field bodies.- Returns:
- whether a properly typed node or ProtoInstance array or CommentsBlock is available.
- See Also:
-
getCollider
Provide org.web3d.x3d.sai.RigidBodyPhysics.CollisionCollection instance (using a properly typed node) from initializeOnly SFNode field collider.- Specified by:
getCollider
in interfaceRigidBodyCollection
- Returns:
- value of collider field
- See Also:
-
setCollider
Accessor method to assign org.web3d.x3d.sai.RigidBodyPhysics.CollisionCollection instance (using a properly typed node) to initializeOnly SFNode field collider.- Specified by:
setCollider
in interfaceRigidBodyCollection
- Parameters:
newValue
- is new value for the collider field.- Returns:
RigidBodyCollection
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
clearCollider
Utility method to clear SFNode value of collider field.- Returns:
RigidBodyCollection
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setCollider
Assign ProtoInstance (using a properly typed node) to initializeOnly SFNode field collider.- Parameters:
newValue
- is new value for the collider field.- Returns:
RigidBodyCollection
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
hasCollider
public boolean hasCollider()Indicate whether an object is available for initializeOnly SFNode field collider.- Returns:
- whether a properly typed node or ProtoInstance or CommentsBlock is available.
- See Also:
-
getConstantForceMix
public float getConstantForceMix()Provide float value from inputOutput SFFloat field named constantForceMix.
Tooltip: [0,+infinity) constantForceMix modifies damping calculations by violating normal constraints while applying small, constant forces in those calculations.- Hint: this allows joints and bodies to be a fraction springy, and helps to eliminate numerical instability.
- Hint: spring-driven or spongy connections can be emulated by combined use of errorCorrection and constantForceMix.
- Specified by:
getConstantForceMix
in interfaceRigidBodyCollection
- Returns:
- value of constantForceMix field
-
setConstantForceMix
Accessor method to assign float value to inputOutput SFFloat field named constantForceMix.
Tooltip: [0,+infinity) constantForceMix modifies damping calculations by violating normal constraints while applying small, constant forces in those calculations.- Hint: this allows joints and bodies to be a fraction springy, and helps to eliminate numerical instability.
- Hint: spring-driven or spongy connections can be emulated by combined use of errorCorrection and constantForceMix.
- Specified by:
setConstantForceMix
in interfaceRigidBodyCollection
- Parameters:
newValue
- is new value for the constantForceMix field.- Returns:
RigidBodyCollection
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setConstantForceMix
Assign typed object value to SFFloat constantForceMix field, similar tosetConstantForceMix(float)
.- Parameters:
newValue
- is new value for the constantForceMix field.- Returns:
RigidBodyCollection
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setConstantForceMix
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetConstantForceMix(float)
.- Parameters:
newValue
- is new value for field- Returns:
RigidBodyCollection
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getContactSurfaceThickness
public float getContactSurfaceThickness()Provide float value from inputOutput SFFloat field named contactSurfaceThickness.
Tooltip: [0,+infinity) contactSurfaceThickness defines how far bodies may interpenetrate after a collision, allowing simulation of softer bodies that deform somewhat during collision. *- Specified by:
getContactSurfaceThickness
in interfaceRigidBodyCollection
- Returns:
- value of contactSurfaceThickness field
-
setContactSurfaceThickness
Accessor method to assign float value to inputOutput SFFloat field named contactSurfaceThickness.
Tooltip: [0,+infinity) contactSurfaceThickness defines how far bodies may interpenetrate after a collision, allowing simulation of softer bodies that deform somewhat during collision. *- Specified by:
setContactSurfaceThickness
in interfaceRigidBodyCollection
- Parameters:
newValue
- is new value for the contactSurfaceThickness field.- Returns:
RigidBodyCollection
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setContactSurfaceThickness
Assign typed object value to SFFloat contactSurfaceThickness field, similar tosetContactSurfaceThickness(float)
.- Parameters:
newValue
- is new value for the contactSurfaceThickness field.- Returns:
RigidBodyCollection
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setContactSurfaceThickness
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetContactSurfaceThickness(float)
.- Parameters:
newValue
- is new value for field- Returns:
RigidBodyCollection
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getDisableAngularSpeed
public float getDisableAngularSpeed()Provide float value from inputOutput SFFloat field named disableAngularSpeed.
Tooltip: [0,+infinity) disableAngularSpeed defines lower-limit tolerance value when body is considered at rest and not part of rigid body calculations, reducing numeric instabilities.- Hint: only activated if autoDisable='true'.
- Specified by:
getDisableAngularSpeed
in interfaceRigidBodyCollection
- Returns:
- value of disableAngularSpeed field
-
setDisableAngularSpeed
Accessor method to assign float value to inputOutput SFFloat field named disableAngularSpeed.
Tooltip: [0,+infinity) disableAngularSpeed defines lower-limit tolerance value when body is considered at rest and not part of rigid body calculations, reducing numeric instabilities.- Hint: only activated if autoDisable='true'.
- Specified by:
setDisableAngularSpeed
in interfaceRigidBodyCollection
- Parameters:
newValue
- is new value for the disableAngularSpeed field.- Returns:
RigidBodyCollection
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setDisableAngularSpeed
Assign typed object value to SFFloat disableAngularSpeed field, similar tosetDisableAngularSpeed(float)
.- Parameters:
newValue
- is new value for the disableAngularSpeed field.- Returns:
RigidBodyCollection
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setDisableAngularSpeed
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetDisableAngularSpeed(float)
.- Parameters:
newValue
- is new value for field- Returns:
RigidBodyCollection
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getDisableLinearSpeed
public float getDisableLinearSpeed()Provide float value from inputOutput SFFloat field named disableLinearSpeed.
Tooltip: [0,+infinity) disableLinearSpeed defines lower-limit tolerance value when body is considered at rest and not part of rigid body calculation, reducing numeric instabilitiess.- Hint: only activated if autoDisable='true'.
- Specified by:
getDisableLinearSpeed
in interfaceRigidBodyCollection
- Returns:
- value of disableLinearSpeed field
-
setDisableLinearSpeed
Accessor method to assign float value to inputOutput SFFloat field named disableLinearSpeed.
Tooltip: [0,+infinity) disableLinearSpeed defines lower-limit tolerance value when body is considered at rest and not part of rigid body calculation, reducing numeric instabilitiess.- Hint: only activated if autoDisable='true'.
- Specified by:
setDisableLinearSpeed
in interfaceRigidBodyCollection
- Parameters:
newValue
- is new value for the disableLinearSpeed field.- Returns:
RigidBodyCollection
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setDisableLinearSpeed
Assign typed object value to SFFloat disableLinearSpeed field, similar tosetDisableLinearSpeed(float)
.- Parameters:
newValue
- is new value for the disableLinearSpeed field.- Returns:
RigidBodyCollection
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setDisableLinearSpeed
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetDisableLinearSpeed(float)
.- Parameters:
newValue
- is new value for field- Returns:
RigidBodyCollection
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getDisableTime
public double getDisableTime()Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named disableTime.
Tooltip: [0,+infinity) disableTime defines interval when body becomes at rest and not part of rigid body calculations, reducing numeric instabilities.- Hint: only activated if autoDisable='true'
- Hint: disableTime is an SFTime duration interval, not an absolute clock time.
- Specified by:
getDisableTime
in interfaceRigidBodyCollection
- Returns:
- value of disableTime field
-
setDisableTime
Accessor method to assign double value in seconds to inputOutput SFTime field named disableTime.
Tooltip: [0,+infinity) disableTime defines interval when body becomes at rest and not part of rigid body calculations, reducing numeric instabilities.- Hint: only activated if autoDisable='true'
- Hint: disableTime is an SFTime duration interval, not an absolute clock time.
- Specified by:
setDisableTime
in interfaceRigidBodyCollection
- Parameters:
newValue
- is new value for the disableTime field.- Returns:
RigidBodyCollection
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setDisableTime
Assign typed object value to SFTime disableTime field, similar tosetDisableTime(double)
.- Parameters:
newValue
- is new value for the disableTime field.- Returns:
RigidBodyCollection
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getEnabled
public boolean getEnabled()Provide boolean value from inputOutput SFBool field named enabled.
Tooltip: Enables/disables node operation. *- Specified by:
getEnabled
in interfaceRigidBodyCollection
- 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 interfaceRigidBodyCollection
- Parameters:
newValue
- is new value for the enabled field.- Returns:
RigidBodyCollection
- 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:
RigidBodyCollection
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getErrorCorrection
public float getErrorCorrection()Provide float value from inputOutput SFFloat field named errorCorrection.
Tooltip: [0,1] errorCorrection describes how quickly intersection errors due to floating-point inaccuracies are resolved (0=no correction, 1=all corrected in single step). *- Specified by:
getErrorCorrection
in interfaceRigidBodyCollection
- Returns:
- value of errorCorrection field
-
setErrorCorrection
Accessor method to assign float value to inputOutput SFFloat field named errorCorrection.
Tooltip: [0,1] errorCorrection describes how quickly intersection errors due to floating-point inaccuracies are resolved (0=no correction, 1=all corrected in single step). *- Specified by:
setErrorCorrection
in interfaceRigidBodyCollection
- Parameters:
newValue
- is new value for the errorCorrection field.- Returns:
RigidBodyCollection
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setErrorCorrection
Assign typed object value to SFFloat errorCorrection field, similar tosetErrorCorrection(float)
.- Parameters:
newValue
- is new value for the errorCorrection field.- Returns:
RigidBodyCollection
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setErrorCorrection
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetErrorCorrection(float)
.- Parameters:
newValue
- is new value for field- Returns:
RigidBodyCollection
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getGravity
public float[] getGravity()Provide array of 3-tuple float results from inputOutput SFVec3f field named gravity.
Tooltip: gravity indicates direction and strength of local gravity vector for this collection of bodies (units m/sec^2). *- Specified by:
getGravity
in interfaceRigidBodyCollection
- Returns:
- value of gravity field
-
setGravity
Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named gravity.
Tooltip: gravity indicates direction and strength of local gravity vector for this collection of bodies (units m/sec^2). *- Specified by:
setGravity
in interfaceRigidBodyCollection
- Parameters:
newValue
- is new value for the gravity field.- Returns:
RigidBodyCollection
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setGravity
Assign typed object value to SFVec3f gravity field, similar tosetGravity(float[])
.- Parameters:
newValue
- is new value for the gravity field.- Returns:
RigidBodyCollection
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setGravity
Assign values to SFVec3f gravity field, similar tosetGravity(float[])
.- Parameters:
x
- first componenty
- second componentz
- third component- Returns:
RigidBodyCollection
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setGravity
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetGravity(float[])
.- Parameters:
x
- first componenty
- second componentz
- third component- Returns:
RigidBodyCollection
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setGravity
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetGravity(float[])
.- Parameters:
newArray
- is new value for field- Returns:
RigidBodyCollection
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getIS
Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.- Specified by:
getIS
in classX3DConcreteNode
- Returns:
- value of IS field
- See Also:
-
setIS
Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.- Specified by:
setIS
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the IS field.- Returns:
RigidBodyCollection
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
clearIS
Utility method to clear SFNode value of IS field.- Returns:
RigidBodyCollection
- 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:
-
getIterations
public int getIterations()Provide int value from inputOutput SFInt32 field named iterations.
Tooltip: [0,+infinity) iterations controls number of iterations performed over collectioned joints and bodies during each evaluation. *- Specified by:
getIterations
in interfaceRigidBodyCollection
- Returns:
- value of iterations field
-
setIterations
Accessor method to assign int value to inputOutput SFInt32 field named iterations.
Tooltip: [0,+infinity) iterations controls number of iterations performed over collectioned joints and bodies during each evaluation. *- Specified by:
setIterations
in interfaceRigidBodyCollection
- Parameters:
newValue
- is new value for the iterations field.- Returns:
RigidBodyCollection
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setIterations
Assign typed object value to SFInt32 iterations field, similar tosetIterations(int)
.- Parameters:
newValue
- is new value for the iterations field.- Returns:
RigidBodyCollection
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getJoints
Provide array of org.web3d.x3d.sai.RigidBodyPhysics.X3DRigidJointNode results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field joints.
Tooltip: [X3DRigidJointNode] The joints field is used to register all joints between bodies contained in this collection.- Warning: If a joint is connected between bodies in two different collections, the result is implementation-dependent.
- Warning: If a joint instance is registered with more than one collection, the results are implementation dependent.
- Warning: Joints not registered with any collection are not evaluated.
Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DRigidJointNode.- Specified by:
getJoints
in interfaceRigidBodyCollection
- Returns:
- value of joints field
- See Also:
-
getJointsList
Utility method to get ArrayList value of MFNode joints field, similar togetJoints()
.- Returns:
- value of joints field
-
setJoints
Accessor method to assign org.web3d.x3d.sai.RigidBodyPhysics.X3DRigidJointNode array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field joints.
Tooltip: [X3DRigidJointNode] The joints field is used to register all joints between bodies contained in this collection.- Warning: If a joint is connected between bodies in two different collections, the result is implementation-dependent.
- Warning: If a joint instance is registered with more than one collection, the results are implementation dependent.
- Warning: Joints not registered with any collection are not evaluated.
Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DRigidJointNode.- Specified by:
setJoints
in interfaceRigidBodyCollection
- Parameters:
newValue
- is new value for the joints field.- Returns:
RigidBodyCollection
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setJoints
Assign ArrayList value of MFNode joints field, similar tosetJoints(org.web3d.x3d.sai.Core.X3DNode[])
.- Parameters:
newValue
- is new value for the joints field.- Returns:
RigidBodyCollection
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addJoints
Add single child node to existing array of joints nodes (if any).
Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DRigidJointNode and ProtoInstance.- Parameters:
newValue
- is new value to be appended the joints field.- Returns:
RigidBodyCollection
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addJoints
Add single ProtoInstance (with appropriate node type and containerField value) to MFNode array for joints 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:
RigidBodyCollection
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addJoints
Add array of child joints nodes to array of existing nodes (if any).
Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DRigidJointNode.- Specified by:
addJoints
in interfaceRigidBodyCollection
- Parameters:
newValue
- is new value array to be appended the joints field.
-
setJoints
Set single child joints node, replacing prior array of existing nodes (if any).
Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are restricted to X3DRigidJointNode.- Specified by:
setJoints
in interfaceRigidBodyCollection
- Parameters:
newValue
- is new node for the joints field (restricted to X3DRigidJointNode)
-
clearJoints
Utility method to clear MFNode value of joints field. This method does not initialize withJOINTS_DEFAULT_VALUE.- Returns:
RigidBodyCollection
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
hasJoints
public boolean hasJoints()Indicate whether an object is available for inputOutput MFNode field joints.- Returns:
- whether a properly typed node or ProtoInstance array or CommentsBlock is available.
- See Also:
-
getMaxCorrectionSpeed
public float getMaxCorrectionSpeed()Provide float value from inputOutput SFFloat field named maxCorrectionSpeed.
Tooltip: [0,+infinity) or -1, maxCorrectionSpeed . *- Specified by:
getMaxCorrectionSpeed
in interfaceRigidBodyCollection
- Returns:
- value of maxCorrectionSpeed field
-
setMaxCorrectionSpeed
Accessor method to assign float value to inputOutput SFFloat field named maxCorrectionSpeed.
Tooltip: [0,+infinity) or -1, maxCorrectionSpeed . *- Specified by:
setMaxCorrectionSpeed
in interfaceRigidBodyCollection
- Parameters:
newValue
- is new value for the maxCorrectionSpeed field.- Returns:
RigidBodyCollection
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setMaxCorrectionSpeed
Assign typed object value to SFFloat maxCorrectionSpeed field, similar tosetMaxCorrectionSpeed(float)
.- Parameters:
newValue
- is new value for the maxCorrectionSpeed field.- Returns:
RigidBodyCollection
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setMaxCorrectionSpeed
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetMaxCorrectionSpeed(float)
.- Parameters:
newValue
- is new value for field- Returns:
RigidBodyCollection
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getMetadata
Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.- Specified by:
getMetadata
in interfaceRigidBodyCollection
- Specified by:
getMetadata
in interfaceX3DChildNode
- Specified by:
getMetadata
in interfaceX3DNode
- Returns:
- value of metadata field
- See Also:
-
setMetadata
Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.- Specified by:
setMetadata
in interfaceRigidBodyCollection
- 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:
RigidBodyCollection
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
clearMetadata
Utility method to clear SFNode value of metadata field.- Returns:
RigidBodyCollection
- 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:
RigidBodyCollection
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
hasMetadata
public boolean hasMetadata()Indicate whether an object is available for inputOutput SFNode field metadata.- Returns:
- whether a properly typed node or ProtoInstance or CommentsBlock is available.
- See Also:
-
getPreferAccuracy
public boolean getPreferAccuracy()Provide boolean value from inputOutput SFBool field named preferAccuracy.
Tooltip: preferAccuracy provides hint for performance preference: higher accuracy or faster computational speed. *- Specified by:
getPreferAccuracy
in interfaceRigidBodyCollection
- Returns:
- value of preferAccuracy field
-
setPreferAccuracy
Accessor method to assign boolean value to inputOutput SFBool field named preferAccuracy.
Tooltip: preferAccuracy provides hint for performance preference: higher accuracy or faster computational speed. *- Specified by:
setPreferAccuracy
in interfaceRigidBodyCollection
- Parameters:
newValue
- is new value for the preferAccuracy field.- Returns:
RigidBodyCollection
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setPreferAccuracy
Assign typed object value to SFBool preferAccuracy field, similar tosetPreferAccuracy(boolean)
.- Parameters:
newValue
- is new value for the preferAccuracy field.- Returns:
RigidBodyCollection
- 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 interfaceRigidBodyCollection
- 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 interfaceRigidBodyCollection
- Specified by:
setVisible
in interfaceX3DBoundedObject
- Parameters:
newValue
- is new value for the visible field.- Returns:
RigidBodyCollection
- 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:
RigidBodyCollection
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getDEF
Provide String value from inputOutput SFString field named DEF.
Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.- Hint: descriptive DEF names improve clarity and help document a model.
- Hint: well-defined names can simplify design and debugging through improved author understanding.
- Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
- Overrides:
getDEF
in classX3DConcreteNode
- Returns:
- value of DEF field
- See Also:
-
setDEF
Accessor method to assign String value to inputOutput SFString field named DEF.
Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.- Hint: descriptive DEF names improve clarity and help document a model.
- Hint: well-defined names can simplify design and debugging through improved author understanding.
- Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
Note that setting the DEF value clears the USE value.- Specified by:
setDEF
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the DEF field.- Returns:
RigidBodyCollection
- 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:
RigidBodyCollection
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getUSE
Provide String value from inputOutput SFString field named USE.
Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value).- Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
- Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute.
- Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
- Overrides:
getUSE
in classX3DConcreteNode
- Returns:
- value of USE field
- See Also:
-
setUSE
Accessor method to assign String value to inputOutput SFString field named USE.
Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value).- Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
- Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute.
- Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
Note: eachUSE
node is still an independent object, with theUSE
value matching theDEF
value in the preceding object.
Warning: invoking thesetUSE()
method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.
Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.- Specified by:
setUSE
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the USE field.- Returns:
RigidBodyCollection
- 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:
RigidBodyCollection
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getCssClass
Provide String value from inputOutput SFString field named class.- Overrides:
getCssClass
in classX3DConcreteElement
- Returns:
- value of class field
- See Also:
-
setCssClass
Accessor method to assign String value to inputOutput SFString field named class.- Specified by:
setCssClass
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the class field.- Returns:
RigidBodyCollection
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
setCssClass
Assign typed object value to SFString cssClass field, similar tosetCssClass(String)
.- Parameters:
newValue
- is new value for the class field.- Returns:
RigidBodyCollection
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getHtmlID
Provide String value from inputOutput SFString field named id.- Overrides:
getHtmlID
in classX3DConcreteElement
- Returns:
- value of id field
- See Also:
-
setHtmlID
Accessor method to assign String value to inputOutput SFString field named id.- Specified by:
setHtmlID
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the id field.- Returns:
RigidBodyCollection
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
setHtmlID
Assign typed object value to SFString HtmlID field, similar tosetHtmlID(String)
.- Parameters:
newValue
- is new value for the id field.- Returns:
RigidBodyCollection
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getCssStyle
Provide String value from inputOutput SFString field named style.- Overrides:
getCssStyle
in classX3DConcreteElement
- Returns:
- value of style field
- See Also:
-
setCssStyle
Accessor method to assign String value to inputOutput SFString field named style.- Specified by:
setCssStyle
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the style field.- Returns:
RigidBodyCollection
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
setCssStyle
Assign typed object value to SFString cssClass field, similar tosetCssStyle(String)
.- Parameters:
newValue
- is new value for the style field.- Returns:
RigidBodyCollection
- 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:
RigidBodyCollection
- 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:
RigidBodyCollection
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
addComments
Add comments as String[] array to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newComments
- array of comments- Returns:
RigidBodyCollection
- 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:
RigidBodyCollection
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
toStringX3D
Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.- Specified by:
toStringX3D
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- X3D string
- See Also:
-
toStringClassicVRML
Recursive method to provide ClassicVRML string serialization.- Specified by:
toStringClassicVRML
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- ClassicVRML string
- See Also:
-
toStringVRML97
Recursive method to provide VRML97 string serialization.- Specified by:
toStringVRML97
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- VRML97 string
- See Also:
-
findElementByNameValue
Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.
Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.
Warning: more than one element may be found that has the same name, this method does not handle that case.- Specified by:
findElementByNameValue
in classX3DConcreteElement
- Parameters:
nameValue
- is value of the name field being searched for in this element and child elements(if any)- Returns:
- object reference to found element, null otherwise
- See Also:
-
findElementByNameValue
Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.
Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.
Warning: more than one element may be found that has the same name, this method does not handle that case.- Specified by:
findElementByNameValue
in classX3DConcreteElement
- Parameters:
nameValue
- is value of the name field being searched for in this element and child elements(if any)elementName
- identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)- Returns:
- object reference to found element, null otherwise
- See Also:
-
hasElementByNameValue
Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.- Parameters:
nameValue
- is value of the name field being searched for in this element and child elements(if any)elementName
- identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)- Returns:
- whether node is found
- See Also:
-
findNodeByDEF
Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.
Warning: more than one element may be found that has the same DEF, this method does not handle that case.- Specified by:
findNodeByDEF
in classX3DConcreteElement
- Parameters:
DEFvalue
- is value of the name field being searched for in this element and child elements(if any)- Returns:
- object reference to found node, null otherwise
- See Also:
-
hasNodeByDEF
Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.- Parameters:
DEFvalue
- is value of the name field being searched for in this element and child elements(if any)- Returns:
- whether node is found
- See Also:
-
validate
Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values. TODO document specific validation methods.- Specified by:
validate
in classX3DConcreteElement
- Returns:
- validation results (if any)
-