Class RigidBodyCollectionObject
java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.RigidBodyPhysics.RigidBodyCollectionObject
- All Implemented Interfaces:
X3DChildNode,X3DNode,RigidBodyCollection
public class RigidBodyCollectionObject extends X3DConcreteNode implements RigidBodyCollection
RigidBodyCollection represents a system of bodies that interact within a single physics model.
X3D 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.
X3D 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.
-
Field Summary
Fields Modifier and Type Field Description static booleanAUTODISABLE_DEFAULT_VALUESFBool field named autoDisable has default value false (Java syntax) or false (XML syntax).static CollisionCollectionObjectCOLLIDER_DEFAULT_VALUESFNode field named collider has default value null (Java syntax) or NULL (XML syntax).static java.lang.StringCOMPONENTString constant COMPONENT defines X3D component for the RigidBodyCollection element: RigidBodyPhysicsstatic floatCONSTANTFORCEMIX_DEFAULT_VALUESFFloat field named constantForceMix has default value 0.0001f (Java syntax) or 0.0001 (XML syntax).static floatCONTACTSURFACETHICKNESS_DEFAULT_VALUESFFloat field named contactSurfaceThickness has default value 0f (Java syntax) or 0 (XML syntax).static java.lang.StringcontainerField_DEFAULT_VALUEcontainerField describes typical field relationship of a node to its parent.static floatDISABLEANGULARSPEED_DEFAULT_VALUESFFloat field named disableAngularSpeed has default value 0f (Java syntax) or 0 (XML syntax).static floatDISABLELINEARSPEED_DEFAULT_VALUESFFloat field named disableLinearSpeed has default value 0f (Java syntax) or 0 (XML syntax).static doubleDISABLETIME_DEFAULT_VALUESFTime field named disableTime has default value 0 (Java syntax) or 0 (XML syntax).static booleanENABLED_DEFAULT_VALUESFBool field named enabled has default value true (Java syntax) or true (XML syntax).static floatERRORCORRECTION_DEFAULT_VALUESFFloat field named errorCorrection has default value 0.8f (Java syntax) or 0.8 (XML syntax).static java.lang.StringfromField_AUTODISABLEfromField ROUTE name for SFBool field named autoDisable.static java.lang.StringfromField_BODIESfromField ROUTE name for MFNode field named bodies.static java.lang.StringfromField_CONSTANTFORCEMIXfromField ROUTE name for SFFloat field named constantForceMix.static java.lang.StringfromField_CONTACTSURFACETHICKNESSfromField ROUTE name for SFFloat field named contactSurfaceThickness.static java.lang.StringfromField_DISABLEANGULARSPEEDfromField ROUTE name for SFFloat field named disableAngularSpeed.static java.lang.StringfromField_DISABLELINEARSPEEDfromField ROUTE name for SFFloat field named disableLinearSpeed.static java.lang.StringfromField_DISABLETIMEfromField ROUTE name for SFTime field named disableTime.static java.lang.StringfromField_ENABLEDfromField ROUTE name for SFBool field named enabled.static java.lang.StringfromField_ERRORCORRECTIONfromField ROUTE name for SFFloat field named errorCorrection.static java.lang.StringfromField_GRAVITYfromField ROUTE name for SFVec3f field named gravity.static java.lang.StringfromField_ISfromField ROUTE name for SFNode field named IS.static java.lang.StringfromField_ITERATIONSfromField ROUTE name for SFInt32 field named iterations.static java.lang.StringfromField_JOINTSfromField ROUTE name for MFNode field named joints.static java.lang.StringfromField_MAXCORRECTIONSPEEDfromField ROUTE name for SFFloat field named maxCorrectionSpeed.static java.lang.StringfromField_METADATAfromField ROUTE name for SFNode field named metadata.static java.lang.StringfromField_PREFERACCURACYfromField ROUTE name for SFBool field named preferAccuracy.static float[]GRAVITY_DEFAULT_VALUESFVec3f field named gravity has default value {0f,-9.8f,0f} (Java syntax) or 0 -9.8 0 (XML syntax).static ISObjectIS_DEFAULT_VALUESFNode field named IS has default value null (Java syntax) or NULL (XML syntax).static intITERATIONS_DEFAULT_VALUESFInt32 field named iterations has default value 10 (Java syntax) or 10 (XML syntax).static intLEVELInteger constant LEVEL provides default X3D RigidBodyPhysics component level for this element: 2static floatMAXCORRECTIONSPEED_DEFAULT_VALUESFFloat field named maxCorrectionSpeed has default value -1f (Java syntax) or -1 (XML syntax).static X3DMetadataObjectMETADATA_DEFAULT_VALUESFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).static java.lang.StringNAMEString constant NAME provides name of this element: RigidBodyCollection.static booleanPREFERACCURACY_DEFAULT_VALUESFBool field named preferAccuracy has default value false (Java syntax) or false (XML syntax).static java.lang.StringtoField_AUTODISABLEtoField ROUTE name for SFBool field named autoDisable.static java.lang.StringtoField_BODIEStoField ROUTE name for MFNode field named bodies.static java.lang.StringtoField_CONSTANTFORCEMIXtoField ROUTE name for SFFloat field named constantForceMix.static java.lang.StringtoField_CONTACTSURFACETHICKNESStoField ROUTE name for SFFloat field named contactSurfaceThickness.static java.lang.StringtoField_DISABLEANGULARSPEEDtoField ROUTE name for SFFloat field named disableAngularSpeed.static java.lang.StringtoField_DISABLELINEARSPEEDtoField ROUTE name for SFFloat field named disableLinearSpeed.static java.lang.StringtoField_DISABLETIMEtoField ROUTE name for SFTime field named disableTime.static java.lang.StringtoField_ENABLEDtoField ROUTE name for SFBool field named enabled.static java.lang.StringtoField_ERRORCORRECTIONtoField ROUTE name for SFFloat field named errorCorrection.static java.lang.StringtoField_GRAVITYtoField ROUTE name for SFVec3f field named gravity.static java.lang.StringtoField_ITERATIONStoField ROUTE name for SFInt32 field named iterations.static java.lang.StringtoField_JOINTStoField ROUTE name for MFNode field named joints.static java.lang.StringtoField_MAXCORRECTIONSPEEDtoField ROUTE name for SFFloat field named maxCorrectionSpeed.static java.lang.StringtoField_METADATAtoField ROUTE name for SFNode field named metadata.static java.lang.StringtoField_PREFERACCURACYtoField ROUTE name for SFBool field named preferAccuracy.static java.lang.StringtoField_SET_CONTACTStoField ROUTE name for MFNode field named set_contacts.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 RigidBodyCollectionObject()Constructor for RigidBodyCollectionObject to initialize member variables with default values.RigidBodyCollectionObject(java.lang.String DEFlabel)Utility constructor that assigns DEF label after initializing member variables with default values. -
Method Summary
Modifier and Type Method Description RigidBodyCollectionObjectaddBodies(ProtoInstanceObject newValue)Add single ProtoInstanceObject (with appropriate node type and containerField value) to MFNode array for bodies field.RigidBodyCollectionObjectaddBodies(RigidBodyObject newValue)Add single child node to existing array of bodies nodes (if any).voidaddBodies(X3DNode[] newValue)Add array of child bodies nodes to array of existing nodes (if any).RigidBodyCollectionObjectaddComments(java.lang.String newComment)Add comment as String to contained commentsList.RigidBodyCollectionObjectaddComments(java.lang.String[] newComments)Add comments as String[] array to contained commentsList.RigidBodyCollectionObjectaddComments(CommentsBlock newCommentsBlock)Add CommentsBlock to contained commentsList.RigidBodyCollectionObjectaddJoints(ProtoInstanceObject newValue)Add single ProtoInstanceObject (with appropriate node type and containerField value) to MFNode array for joints field.RigidBodyCollectionObjectaddJoints(X3DNode newValue)Add single child node to existing array of joints nodes (if any).voidaddJoints(X3DNode[] newValue)Add array of child joints nodes to array of existing nodes (if any).RigidBodyCollectionObjectclearBodies()Utility method to clear MFNode value of bodies field.RigidBodyCollectionObjectclearCollider()Utility method to clear SFNode value of collider field.RigidBodyCollectionObjectclearIS()Utility method to clear SFNode value of IS field.RigidBodyCollectionObjectclearJoints()Utility method to clear MFNode value of joints field.RigidBodyCollectionObjectclearMetadata()Utility method to clear SFNode value of metadata field.X3DConcreteElementfindElementByNameValue(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.X3DConcreteElementfindElementByNameValue(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.X3DConcreteNodefindNodeByDEF(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.StringgetAccessType(java.lang.String fieldName)Indicate accessType corresponding to given fieldName.booleangetAutoDisable()Provide boolean value from inputOutput SFBool field named autoDisable.X3DNode[]getBodies()Provide array of RigidBodyObject results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field bodies.java.util.ArrayList<X3DNode>getBodiesList()Utility method to get ArrayList value of MFNode bodies field, similar togetBodies().CollisionCollectiongetCollider()Provide CollisionCollectionObject instance (using a properly typed node) from initializeOnly SFNode field collider.java.lang.StringgetComponent()Defines X3D component for the RigidBodyCollection element: RigidBodyPhysicsintgetComponentLevel()Provides default X3D component level for this element: 2floatgetConstantForceMix()Provide float value from inputOutput SFFloat field named constantForceMix.floatgetContactSurfaceThickness()Provide float value from inputOutput SFFloat field named contactSurfaceThickness.java.lang.StringgetContainerFieldDefault()containerField describes typical field relationship of a node to its parent.java.lang.StringgetCssClass()Provide String value from inputOutput SFString field named class.java.lang.StringgetDEF()Provide String value from inputOutput SFString field named DEF.floatgetDisableAngularSpeed()Provide float value from inputOutput SFFloat field named disableAngularSpeed.floatgetDisableLinearSpeed()Provide float value from inputOutput SFFloat field named disableLinearSpeed.doublegetDisableTime()Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named disableTime.java.lang.StringgetElementName()Provides name of this element: RigidBodyCollectionbooleangetEnabled()Provide boolean value from inputOutput SFBool field named enabled.floatgetErrorCorrection()Provide float value from inputOutput SFFloat field named errorCorrection.java.lang.StringgetFieldType(java.lang.String fieldName)Indicate type corresponding to given fieldName.float[]getGravity()Provide array of 3-tuple float results from inputOutput SFVec3f field named gravity.ISObjectgetIS()Provide ISObject instance (using a properly typed node) from inputOutput SFNode field IS.intgetIterations()Provide int value from inputOutput SFInt32 field named iterations.X3DNode[]getJoints()Provide array of X3DRigidJointNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field joints.java.util.ArrayList<X3DNode>getJointsList()Utility method to get ArrayList value of MFNode joints field, similar togetJoints().floatgetMaxCorrectionSpeed()Provide float value from inputOutput SFFloat field named maxCorrectionSpeed.X3DMetadataObjectgetMetadata()Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.booleangetPreferAccuracy()Provide boolean value from inputOutput SFBool field named preferAccuracy.java.lang.StringgetUSE()Provide String value from inputOutput SFString field named USE.booleanhasBodies()Indicate whether an object is available for inputOutput MFNode field bodies.booleanhasCollider()Indicate whether an object is available for initializeOnly SFNode field collider.booleanhasElementByNameValue(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.booleanhasIS()Indicate whether an object is available for inputOutput SFNode field IS.booleanhasJoints()Indicate whether an object is available for inputOutput MFNode field joints.booleanhasMetadata()Indicate whether an object is available for inputOutput SFNode field metadata.booleanhasNodeByDEF(java.lang.String DEFvalue)Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.voidinitialize()Initialize all member variables to default values.RigidBodyCollectionObjectsetAutoDisable(boolean newValue)Accessor method to assign boolean value to inputOutput SFBool field named autoDisable.RigidBodyCollectionObjectsetAutoDisable(SFBoolObject newValue)Assign typed object value to SFBool autoDisable field, similar tosetAutoDisable(boolean).RigidBodyCollectionObjectsetBodies(java.util.ArrayList<RigidBodyObject> newValue)Assign ArrayList value of MFNode bodies field, similar tosetBodies(X3DNode[]).voidsetBodies(X3DNode newValue)Set single child bodies node, replacing prior array of existing nodes (if any).RigidBodyCollectionObjectsetBodies(X3DNode[] newValue)Accessor method to assign RigidBodyObject array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field bodies.RigidBodyCollectionObjectsetCollider(ProtoInstanceObject newValue)Assign ProtoInstance (using a properly typed node) to initializeOnly SFNode field collider.RigidBodyCollectionObjectsetCollider(CollisionCollection newValue)Accessor method to assign CollisionCollectionObject instance (using a properly typed node) to initializeOnly SFNode field collider.RigidBodyCollectionObjectsetConstantForceMix(double newValue)Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetConstantForceMix(float).RigidBodyCollectionObjectsetConstantForceMix(float newValue)Accessor method to assign float value to inputOutput SFFloat field named constantForceMix.RigidBodyCollectionObjectsetConstantForceMix(SFFloatObject newValue)Assign typed object value to SFFloat constantForceMix field, similar tosetConstantForceMix(float).RigidBodyCollectionObjectsetContactSurfaceThickness(double newValue)Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetContactSurfaceThickness(float).RigidBodyCollectionObjectsetContactSurfaceThickness(float newValue)Accessor method to assign float value to inputOutput SFFloat field named contactSurfaceThickness.RigidBodyCollectionObjectsetContactSurfaceThickness(SFFloatObject newValue)Assign typed object value to SFFloat contactSurfaceThickness field, similar tosetContactSurfaceThickness(float).RigidBodyCollectionObjectsetCssClass(java.lang.String newValue)Accessor method to assign String value to inputOutput SFString field named class.RigidBodyCollectionObjectsetCssClass(SFStringObject newValue)Assign typed object value to SFString cssClass field, similar tosetCssClass(String).RigidBodyCollectionObjectsetDEF(java.lang.String newValue)Accessor method to assign String value to inputOutput SFString field named DEF.RigidBodyCollectionObjectsetDEF(SFStringObject newValue)Assign typed object value to SFString DEF field, similar tosetDEF(String).RigidBodyCollectionObjectsetDisableAngularSpeed(double newValue)Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetDisableAngularSpeed(float).RigidBodyCollectionObjectsetDisableAngularSpeed(float newValue)Accessor method to assign float value to inputOutput SFFloat field named disableAngularSpeed.RigidBodyCollectionObjectsetDisableAngularSpeed(SFFloatObject newValue)Assign typed object value to SFFloat disableAngularSpeed field, similar tosetDisableAngularSpeed(float).RigidBodyCollectionObjectsetDisableLinearSpeed(double newValue)Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetDisableLinearSpeed(float).RigidBodyCollectionObjectsetDisableLinearSpeed(float newValue)Accessor method to assign float value to inputOutput SFFloat field named disableLinearSpeed.RigidBodyCollectionObjectsetDisableLinearSpeed(SFFloatObject newValue)Assign typed object value to SFFloat disableLinearSpeed field, similar tosetDisableLinearSpeed(float).RigidBodyCollectionObjectsetDisableTime(double newValue)Accessor method to assign double value in seconds to inputOutput SFTime field named disableTime.RigidBodyCollectionObjectsetDisableTime(SFTimeObject newValue)Assign typed object value to SFTime disableTime field, similar tosetDisableTime(double).RigidBodyCollectionObjectsetEnabled(boolean newValue)Accessor method to assign boolean value to inputOutput SFBool field named enabled.RigidBodyCollectionObjectsetEnabled(SFBoolObject newValue)Assign typed object value to SFBool enabled field, similar tosetEnabled(boolean).RigidBodyCollectionObjectsetErrorCorrection(double newValue)Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetErrorCorrection(float).RigidBodyCollectionObjectsetErrorCorrection(float newValue)Accessor method to assign float value to inputOutput SFFloat field named errorCorrection.RigidBodyCollectionObjectsetErrorCorrection(SFFloatObject newValue)Assign typed object value to SFFloat errorCorrection field, similar tosetErrorCorrection(float).RigidBodyCollectionObjectsetGravity(double[] newArray)Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetGravity(float[]).RigidBodyCollectionObjectsetGravity(double x, double y, double z)Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetGravity(float[]).RigidBodyCollectionObjectsetGravity(float[] newValue)Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named gravity.RigidBodyCollectionObjectsetGravity(float x, float y, float z)Assign values to SFVec3f gravity field, similar tosetGravity(float[]).RigidBodyCollectionObjectsetGravity(SFVec3fObject newValue)Assign typed object value to SFVec3f gravity field, similar tosetGravity(float[]).RigidBodyCollectionObjectsetIS(ISObject newValue)Accessor method to assign ISObject instance (using a properly typed node) to inputOutput SFNode field IS.RigidBodyCollectionObjectsetIterations(int newValue)Accessor method to assign int value to inputOutput SFInt32 field named iterations.RigidBodyCollectionObjectsetIterations(SFInt32Object newValue)Assign typed object value to SFInt32 iterations field, similar tosetIterations(int).RigidBodyCollectionObjectsetJoints(java.util.ArrayList<X3DRigidJointNode> newValue)Assign ArrayList value of MFNode joints field, similar tosetJoints(X3DNode[]).voidsetJoints(X3DNode newValue)Set single child joints node, replacing prior array of existing nodes (if any).RigidBodyCollectionObjectsetJoints(X3DNode[] newValue)Accessor method to assign X3DRigidJointNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field joints.RigidBodyCollectionObjectsetMaxCorrectionSpeed(double newValue)Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetMaxCorrectionSpeed(float).RigidBodyCollectionObjectsetMaxCorrectionSpeed(float newValue)Accessor method to assign float value to inputOutput SFFloat field named maxCorrectionSpeed.RigidBodyCollectionObjectsetMaxCorrectionSpeed(SFFloatObject newValue)Assign typed object value to SFFloat maxCorrectionSpeed field, similar tosetMaxCorrectionSpeed(float).RigidBodyCollectionObjectsetMetadata(ProtoInstanceObject newValue)Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.RigidBodyCollectionObjectsetMetadata(X3DMetadataObject newValue)Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.RigidBodyCollectionObjectsetPreferAccuracy(boolean newValue)Accessor method to assign boolean value to inputOutput SFBool field named preferAccuracy.RigidBodyCollectionObjectsetPreferAccuracy(SFBoolObject newValue)Assign typed object value to SFBool preferAccuracy field, similar tosetPreferAccuracy(boolean).RigidBodyCollectionObjectsetUSE(java.lang.String newValue)Accessor method to assign String value to inputOutput SFString field named USE.RigidBodyCollectionObjectsetUSE(SFStringObject newValue)Assign typed object value to SFString USE field, similar tosetUSE(String).RigidBodyCollectionObjectsetUSE(RigidBodyCollectionObject DEFnode)Assign a USE reference to another DEF node of same node type, similar tosetUSE(String).java.lang.StringtoStringClassicVRML(int indentLevel)Recursive method to provide ClassicVRML string serialization.java.lang.StringtoStringVRML97(int indentLevel)Recursive method to provide VRML97 string serialization.java.lang.StringtoStringX3D(int indentLevel)Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.java.lang.Stringvalidate()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, setContainerFieldOverrideMethods 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
-
NAME
public static final java.lang.String NAMEString constant NAME provides name of this element: RigidBodyCollection.- See Also:
- Constant Field Values
-
COMPONENT
public static final java.lang.String COMPONENTString constant COMPONENT defines X3D component for the RigidBodyCollection element: RigidBodyPhysics- See Also:
- Constant Field Values
-
LEVEL
public static final int LEVELInteger constant LEVEL provides default X3D RigidBodyPhysics component level for this element: 2- See Also:
- Constant Field Values
-
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:
- Constant Field Values
-
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:
- Constant Field Values
-
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:
- Constant Field Values
-
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:
- Constant Field Values
-
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:
- Constant Field Values
-
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:
- 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
-
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:
- Constant Field Values
-
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:
- Constant Field Values
-
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:
- Constant Field Values
-
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:
- 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_AUTODISABLE
public static final java.lang.String fromField_AUTODISABLEfromField ROUTE name for SFBool field named autoDisable.- See Also:
- Constant Field Values
-
toField_AUTODISABLE
public static final java.lang.String toField_AUTODISABLEtoField ROUTE name for SFBool field named autoDisable.- See Also:
- Constant Field Values
-
fromField_BODIES
public static final java.lang.String fromField_BODIESfromField ROUTE name for MFNode field named bodies.- See Also:
- Constant Field Values
-
toField_BODIES
public static final java.lang.String toField_BODIEStoField ROUTE name for MFNode field named bodies.- See Also:
- Constant Field Values
-
fromField_CONSTANTFORCEMIX
public static final java.lang.String fromField_CONSTANTFORCEMIXfromField ROUTE name for SFFloat field named constantForceMix.- See Also:
- Constant Field Values
-
toField_CONSTANTFORCEMIX
public static final java.lang.String toField_CONSTANTFORCEMIXtoField ROUTE name for SFFloat field named constantForceMix.- See Also:
- Constant Field Values
-
fromField_CONTACTSURFACETHICKNESS
public static final java.lang.String fromField_CONTACTSURFACETHICKNESSfromField ROUTE name for SFFloat field named contactSurfaceThickness.- See Also:
- Constant Field Values
-
toField_CONTACTSURFACETHICKNESS
public static final java.lang.String toField_CONTACTSURFACETHICKNESStoField ROUTE name for SFFloat field named contactSurfaceThickness.- See Also:
- Constant Field Values
-
fromField_DISABLEANGULARSPEED
public static final java.lang.String fromField_DISABLEANGULARSPEEDfromField ROUTE name for SFFloat field named disableAngularSpeed.- See Also:
- Constant Field Values
-
toField_DISABLEANGULARSPEED
public static final java.lang.String toField_DISABLEANGULARSPEEDtoField ROUTE name for SFFloat field named disableAngularSpeed.- See Also:
- Constant Field Values
-
fromField_DISABLELINEARSPEED
public static final java.lang.String fromField_DISABLELINEARSPEEDfromField ROUTE name for SFFloat field named disableLinearSpeed.- See Also:
- Constant Field Values
-
toField_DISABLELINEARSPEED
public static final java.lang.String toField_DISABLELINEARSPEEDtoField ROUTE name for SFFloat field named disableLinearSpeed.- See Also:
- Constant Field Values
-
fromField_DISABLETIME
public static final java.lang.String fromField_DISABLETIMEfromField ROUTE name for SFTime field named disableTime.- See Also:
- Constant Field Values
-
toField_DISABLETIME
public static final java.lang.String toField_DISABLETIMEtoField ROUTE name for SFTime field named disableTime.- 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_ERRORCORRECTION
public static final java.lang.String fromField_ERRORCORRECTIONfromField ROUTE name for SFFloat field named errorCorrection.- See Also:
- Constant Field Values
-
toField_ERRORCORRECTION
public static final java.lang.String toField_ERRORCORRECTIONtoField ROUTE name for SFFloat field named errorCorrection.- See Also:
- Constant Field Values
-
fromField_GRAVITY
public static final java.lang.String fromField_GRAVITYfromField ROUTE name for SFVec3f field named gravity.- See Also:
- Constant Field Values
-
toField_GRAVITY
public static final java.lang.String toField_GRAVITYtoField ROUTE name for SFVec3f field named gravity.- 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_ITERATIONS
public static final java.lang.String fromField_ITERATIONSfromField ROUTE name for SFInt32 field named iterations.- See Also:
- Constant Field Values
-
toField_ITERATIONS
public static final java.lang.String toField_ITERATIONStoField ROUTE name for SFInt32 field named iterations.- See Also:
- Constant Field Values
-
fromField_JOINTS
public static final java.lang.String fromField_JOINTSfromField ROUTE name for MFNode field named joints.- See Also:
- Constant Field Values
-
toField_JOINTS
public static final java.lang.String toField_JOINTStoField ROUTE name for MFNode field named joints.- See Also:
- Constant Field Values
-
fromField_MAXCORRECTIONSPEED
public static final java.lang.String fromField_MAXCORRECTIONSPEEDfromField ROUTE name for SFFloat field named maxCorrectionSpeed.- See Also:
- Constant Field Values
-
toField_MAXCORRECTIONSPEED
public static final java.lang.String toField_MAXCORRECTIONSPEEDtoField ROUTE name for SFFloat field named maxCorrectionSpeed.- 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_PREFERACCURACY
public static final java.lang.String fromField_PREFERACCURACYfromField ROUTE name for SFBool field named preferAccuracy.- See Also:
- Constant Field Values
-
toField_PREFERACCURACY
public static final java.lang.String toField_PREFERACCURACYtoField ROUTE name for SFBool field named preferAccuracy.- See Also:
- Constant Field Values
-
toField_SET_CONTACTS
public static final java.lang.String toField_SET_CONTACTStoField ROUTE name for MFNode field named set_contacts.- See Also:
- Constant Field Values
-
-
Constructor Details
-
RigidBodyCollectionObject
public RigidBodyCollectionObject()Constructor for RigidBodyCollectionObject to initialize member variables with default values. -
RigidBodyCollectionObject
public RigidBodyCollectionObject(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: RigidBodyCollection- Specified by:
getElementNamein classX3DConcreteElement- Returns:
- name of this element
-
getComponent
public final java.lang.String getComponent()Defines X3D component for the RigidBodyCollection element: RigidBodyPhysics- Specified by:
getComponentin classX3DConcreteElement- Returns:
- X3D component for this element
-
getComponentLevel
public final int getComponentLevel()Provides default X3D component level for this element: 2- Specified by:
getComponentLevelin 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:
getFieldTypein 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:
getAccessTypein 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:
getContainerFieldDefaultin 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:
initializein classX3DConcreteNode
-
getAutoDisable
public boolean getAutoDisable()Provide boolean value from inputOutput SFBool field named autoDisable.
Tooltip: autoDisable toggles operation of disableAngularSpeed, disableLinearSpeed, disableTime. *- Specified by:
getAutoDisablein 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:
setAutoDisablein interfaceRigidBodyCollection- Parameters:
newValue- is new value for the autoDisable field.- Returns:
RigidBodyCollectionObject- 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:
RigidBodyCollectionObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getBodies
Provide array of RigidBodyObject results (using an array consisting of properly typed nodes or ProtoInstanceObjects) 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:
getBodiesin interfaceRigidBodyCollection- Returns:
- value of bodies field
- See Also:
RigidBodyObject
-
getBodiesList
Utility method to get ArrayList value of MFNode bodies field, similar togetBodies().- Returns:
- value of bodies field
-
setBodies
Accessor method to assign RigidBodyObject array (using an array consisting of properly typed nodes or ProtoInstanceObjects) 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:
setBodiesin interfaceRigidBodyCollection- Parameters:
newValue- is new value for the bodies field.- Returns:
RigidBodyCollectionObject- 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(X3DNode[]).- Parameters:
newValue- is new value for the bodies field.- Returns:
RigidBodyCollectionObject- 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:
RigidBodyCollectionObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addBodies
Add single ProtoInstanceObject (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:
RigidBodyCollectionObject- 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:
addBodiesin 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:
setBodiesin interfaceRigidBodyCollection- Parameters:
newValue- is new node for the bodies field (restricted to RigidBody)
-
clearBodies
Utility method to clear MFNode value of bodies field.- Returns:
RigidBodyCollectionObject- 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:
getBodies()
-
getCollider
Provide CollisionCollectionObject instance (using a properly typed node) from initializeOnly SFNode field collider.- Specified by:
getColliderin interfaceRigidBodyCollection- Returns:
- value of collider field
- See Also:
Tooltip: [CollisionCollection] The collider field associates a collision collection with this rigid body collection allowing seamless updates and integration without the need to use the X3D event model. *
-
setCollider
Accessor method to assign CollisionCollectionObject instance (using a properly typed node) to initializeOnly SFNode field collider.- Specified by:
setColliderin interfaceRigidBodyCollection- Parameters:
newValue- is new value for the collider field.- Returns:
RigidBodyCollectionObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
Tooltip: [CollisionCollection] The collider field associates a collision collection with this rigid body collection allowing seamless updates and integration without the need to use the X3D event model. *
-
clearCollider
Utility method to clear SFNode value of collider field.- Returns:
RigidBodyCollectionObject- 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:
RigidBodyCollectionObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
setCollider(CollisionCollection)
-
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:
getCollider(),getColliderProtoInstance()
-
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:
getConstantForceMixin 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:
setConstantForceMixin interfaceRigidBodyCollection- Parameters:
newValue- is new value for the constantForceMix field.- Returns:
RigidBodyCollectionObject- 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:
RigidBodyCollectionObject- 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:
RigidBodyCollectionObject- 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:
getContactSurfaceThicknessin 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:
setContactSurfaceThicknessin interfaceRigidBodyCollection- Parameters:
newValue- is new value for the contactSurfaceThickness field.- Returns:
RigidBodyCollectionObject- 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:
RigidBodyCollectionObject- 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:
RigidBodyCollectionObject- 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:
getDisableAngularSpeedin 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:
setDisableAngularSpeedin interfaceRigidBodyCollection- Parameters:
newValue- is new value for the disableAngularSpeed field.- Returns:
RigidBodyCollectionObject- 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:
RigidBodyCollectionObject- 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:
RigidBodyCollectionObject- 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:
getDisableLinearSpeedin 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:
setDisableLinearSpeedin interfaceRigidBodyCollection- Parameters:
newValue- is new value for the disableLinearSpeed field.- Returns:
RigidBodyCollectionObject- 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:
RigidBodyCollectionObject- 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:
RigidBodyCollectionObject- 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:
getDisableTimein 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:
setDisableTimein interfaceRigidBodyCollection- Parameters:
newValue- is new value for the disableTime field.- Returns:
RigidBodyCollectionObject- 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:
RigidBodyCollectionObject- 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:
getEnabledin 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:
setEnabledin interfaceRigidBodyCollection- Parameters:
newValue- is new value for the enabled field.- Returns:
RigidBodyCollectionObject- 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:
RigidBodyCollectionObject- 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:
getErrorCorrectionin 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:
setErrorCorrectionin interfaceRigidBodyCollection- Parameters:
newValue- is new value for the errorCorrection field.- Returns:
RigidBodyCollectionObject- 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:
RigidBodyCollectionObject- 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:
RigidBodyCollectionObject- 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:
getGravityin 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:
setGravityin interfaceRigidBodyCollection- Parameters:
newValue- is new value for the gravity field.- Returns:
RigidBodyCollectionObject- 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:
RigidBodyCollectionObject- 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:
RigidBodyCollectionObject- 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:
RigidBodyCollectionObject- 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:
RigidBodyCollectionObject- 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:
getISin 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:
setISin classX3DConcreteNode- Parameters:
newValue- is new value for the IS field.- Returns:
RigidBodyCollectionObject- 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:
RigidBodyCollectionObject- 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()
-
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:
getIterationsin 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:
setIterationsin interfaceRigidBodyCollection- Parameters:
newValue- is new value for the iterations field.- Returns:
RigidBodyCollectionObject- 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:
RigidBodyCollectionObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getJoints
Provide array of X3DRigidJointNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) 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:
getJointsin interfaceRigidBodyCollection- Returns:
- value of joints field
- See Also:
X3DRigidJointNode
-
getJointsList
Utility method to get ArrayList value of MFNode joints field, similar togetJoints().- Returns:
- value of joints field
-
setJoints
Accessor method to assign X3DRigidJointNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) 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:
setJointsin interfaceRigidBodyCollection- Parameters:
newValue- is new value for the joints field.- Returns:
RigidBodyCollectionObject- 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(X3DNode[]).- Parameters:
newValue- is new value for the joints field.- Returns:
RigidBodyCollectionObject- 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:
RigidBodyCollectionObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addJoints
Add single ProtoInstanceObject (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:
RigidBodyCollectionObject- 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:
addJointsin 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:
setJointsin interfaceRigidBodyCollection- Parameters:
newValue- is new node for the joints field (restricted to X3DRigidJointNode)
-
clearJoints
Utility method to clear MFNode value of joints field.- Returns:
RigidBodyCollectionObject- 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:
getJoints()
-
getMaxCorrectionSpeed
public float getMaxCorrectionSpeed()Provide float value from inputOutput SFFloat field named maxCorrectionSpeed.
Tooltip: [0,+infinity) or -1, maxCorrectionSpeed . *- Specified by:
getMaxCorrectionSpeedin 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:
setMaxCorrectionSpeedin interfaceRigidBodyCollection- Parameters:
newValue- is new value for the maxCorrectionSpeed field.- Returns:
RigidBodyCollectionObject- 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:
RigidBodyCollectionObject- 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:
RigidBodyCollectionObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getMetadata
Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.- Specified by:
getMetadatain interfaceRigidBodyCollection- Specified by:
getMetadatain interfaceX3DChildNode- Specified by:
getMetadatain 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:
setMetadatain interfaceRigidBodyCollection- Specified by:
setMetadatain interfaceX3DChildNode- Specified by:
setMetadatain interfaceX3DNode- Specified by:
setMetadatain classX3DConcreteNode- Parameters:
newValue- is new value for the metadata field.- Returns:
RigidBodyCollectionObject- 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:
RigidBodyCollectionObject- 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:
setMetadatain classX3DConcreteNode- Parameters:
newValue- is new value for the metadata field.- Returns:
RigidBodyCollectionObject- 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
-
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:
getPreferAccuracyin 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:
setPreferAccuracyin interfaceRigidBodyCollection- Parameters:
newValue- is new value for the preferAccuracy field.- Returns:
RigidBodyCollectionObject- 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:
RigidBodyCollectionObject- 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:
getDEFin 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:
setDEFin classX3DConcreteNode- Parameters:
newValue- is new value for the DEF field.- Returns:
RigidBodyCollectionObject- 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:
RigidBodyCollectionObject- 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:
getUSEin 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: eachUSEnode is still an independent object, with theUSEvalue matching theDEFvalue 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:
setUSEin classX3DConcreteNode- Parameters:
newValue- is new value for the USE field.- Returns:
RigidBodyCollectionObject- 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:
RigidBodyCollectionObject- 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:
getCssClassin 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:
setCssClassin classX3DConcreteNode- Parameters:
newValue- is new value for the class field.- Returns:
RigidBodyCollectionObject- 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:
RigidBodyCollectionObject- 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:
RigidBodyCollectionObject- 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:
addCommentsin classX3DConcreteElement- Parameters:
newComment- initial value- Returns:
RigidBodyCollectionObject- 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:
addCommentsin classX3DConcreteElement- Parameters:
newComments- array of comments- Returns:
RigidBodyCollectionObject- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
addComments
Add CommentsBlock to contained commentsList.- Specified by:
addCommentsin classX3DConcreteElement- Parameters:
newCommentsBlock- block of comments to add- Returns:
RigidBodyCollectionObject- 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:
toStringX3Din 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:
toStringClassicVRMLin 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:
toStringVRML97in 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:
findElementByNameValuein 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:
findElementByNameValuein 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:
findNodeByDEFin 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:
validatein classX3DConcreteElement- Returns:
- validation results (if any)
-