Class UniversalJointObject
java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.RigidBodyPhysics.UniversalJointObject
- All Implemented Interfaces:
X3DNode,UniversalJoint,X3DRigidJointNode
public class UniversalJointObject extends X3DConcreteNode implements UniversalJoint
UniversalJoint is like a BallJoint that constrains an extra degree of rotational freedom.
X3D node tooltip: (X3D version 3.2 or later) [X3DRigidJointNode] UniversalJoint is like a BallJoint that constrains an extra degree of rotational freedom. Contains two RigidBody nodes (containerField values body1, body2).
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) [X3DRigidJointNode] UniversalJoint is like a BallJoint that constrains an extra degree of rotational freedom. Contains two RigidBody nodes (containerField values body1, body2).
- Hint: useful in combination with BallJoint.
- Hint: RigidBodyPhysics component, level 2.
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 float[]ANCHORPOINT_DEFAULT_VALUESFVec3f field named anchorPoint has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).static float[]AXIS1_DEFAULT_VALUESFVec3f field named axis1 has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).static float[]AXIS2_DEFAULT_VALUESFVec3f field named axis2 has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).static RigidBodyObjectBODY1_DEFAULT_VALUESFNode field named body1 has default value null (Java syntax) or NULL (XML syntax).static RigidBodyObjectBODY2_DEFAULT_VALUESFNode field named body2 has default value null (Java syntax) or NULL (XML syntax).static java.lang.StringCOMPONENTString constant COMPONENT defines X3D component for the UniversalJoint element: RigidBodyPhysicsstatic java.lang.StringcontainerField_DEFAULT_VALUEcontainerField describes typical field relationship of a node to its parent.static java.lang.StringFORCEOUTPUT_ALLTooltip: all forceOutput fields computed.static java.util.ArrayList<java.lang.String>FORCEOUTPUT_DEFAULT_VALUEMFString field named forceOutput has default quoted value new String[] {"NONE"} (Java syntax) or quoted value "NONE" (XML syntax).static java.lang.StringFORCEOUTPUT_NONETooltip: no forceOutput fields computed.static java.lang.StringfromField_ANCHORPOINTfromField ROUTE name for SFVec3f field named anchorPoint.static java.lang.StringfromField_AXIS1fromField ROUTE name for SFVec3f field named axis1.static java.lang.StringfromField_AXIS2fromField ROUTE name for SFVec3f field named axis2.static java.lang.StringfromField_BODY1fromField ROUTE name for SFNode field named body1.static java.lang.StringfromField_BODY1ANCHORPOINTfromField ROUTE name for SFVec3f field named body1AnchorPoint.static java.lang.StringfromField_BODY1AXISfromField ROUTE name for SFVec3f field named body1Axis.static java.lang.StringfromField_BODY2fromField ROUTE name for SFNode field named body2.static java.lang.StringfromField_BODY2ANCHORPOINTfromField ROUTE name for SFVec3f field named body2AnchorPoint.static java.lang.StringfromField_BODY2AXISfromField ROUTE name for SFFloat field named body2Axis.static java.lang.StringfromField_FORCEOUTPUTfromField ROUTE name for MFString field named forceOutput.static java.lang.StringfromField_ISfromField ROUTE name for SFNode field named IS.static java.lang.StringfromField_METADATAfromField ROUTE name for SFNode field named metadata.static java.lang.StringfromField_STOP1BOUNCEfromField ROUTE name for SFFloat field named stop1Bounce.static java.lang.StringfromField_STOP1ERRORCORRECTIONfromField ROUTE name for SFFloat field named stop1ErrorCorrection.static java.lang.StringfromField_STOP2BOUNCEfromField ROUTE name for SFFloat field named stop2Bounce.static java.lang.StringfromField_STOP2ERRORCORRECTIONfromField ROUTE name for SFFloat field named stop2ErrorCorrection.static ISObjectIS_DEFAULT_VALUESFNode field named IS has default value null (Java syntax) or NULL (XML syntax).static intLEVELInteger constant LEVEL provides default X3D RigidBodyPhysics component level for this element: 2static 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: UniversalJoint.static floatSTOP1BOUNCE_DEFAULT_VALUESFFloat field named stop1Bounce has default value 0f (Java syntax) or 0 (XML syntax).static floatSTOP1ERRORCORRECTION_DEFAULT_VALUESFFloat field named stop1ErrorCorrection has default value 0.8f (Java syntax) or 0.8 (XML syntax).static floatSTOP2BOUNCE_DEFAULT_VALUESFFloat field named stop2Bounce has default value 0f (Java syntax) or 0 (XML syntax).static floatSTOP2ERRORCORRECTION_DEFAULT_VALUESFFloat field named stop2ErrorCorrection has default value 0.8f (Java syntax) or 0.8 (XML syntax).static java.lang.StringtoField_ANCHORPOINTtoField ROUTE name for SFVec3f field named anchorPoint.static java.lang.StringtoField_AXIS1toField ROUTE name for SFVec3f field named axis1.static java.lang.StringtoField_AXIS2toField ROUTE name for SFVec3f field named axis2.static java.lang.StringtoField_BODY1toField ROUTE name for SFNode field named body1.static java.lang.StringtoField_BODY2toField ROUTE name for SFNode field named body2.static java.lang.StringtoField_FORCEOUTPUTtoField ROUTE name for MFString field named forceOutput.static java.lang.StringtoField_METADATAtoField ROUTE name for SFNode field named metadata.static java.lang.StringtoField_STOP1BOUNCEtoField ROUTE name for SFFloat field named stop1Bounce.static java.lang.StringtoField_STOP1ERRORCORRECTIONtoField ROUTE name for SFFloat field named stop1ErrorCorrection.static java.lang.StringtoField_STOP2BOUNCEtoField ROUTE name for SFFloat field named stop2Bounce.static java.lang.StringtoField_STOP2ERRORCORRECTIONtoField ROUTE name for SFFloat field named stop2ErrorCorrection.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 UniversalJointObject()Constructor for UniversalJointObject to initialize member variables with default values.UniversalJointObject(java.lang.String DEFlabel)Utility constructor that assigns DEF label after initializing member variables with default values. -
Method Summary
Modifier and Type Method Description UniversalJointObjectaddComments(java.lang.String newComment)Add comment as String to contained commentsList.UniversalJointObjectaddComments(java.lang.String[] newComments)Add comments as String[] array to contained commentsList.UniversalJointObjectaddComments(CommentsBlock newCommentsBlock)Add CommentsBlock to contained commentsList.UniversalJointObjectaddForceOutput(java.lang.String newValue)Add singleton String value to MFString forceOutput field.UniversalJointObjectaddForceOutput(SFStringObject newValue)Add singleton SFStringObject value to MFString forceOutput field.UniversalJointObjectclearBody1()Utility method to clear SFNode value of body1 field.UniversalJointObjectclearBody2()Utility method to clear SFNode value of body2 field.UniversalJointObjectclearForceOutput()Utility method to clear MFString value of forceOutput field.UniversalJointObjectclearIS()Utility method to clear SFNode value of IS field.UniversalJointObjectclearMetadata()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.float[]getAnchorPoint()Provide array of 3-tuple float results from inputOutput SFVec3f field named anchorPoint.float[]getAxis1()Provide array of 3-tuple float results from inputOutput SFVec3f field named axis1.float[]getAxis2()Provide array of 3-tuple float results from inputOutput SFVec3f field named axis2.RigidBodygetBody1()Provide RigidBodyObject instance (using a properly typed node) from inputOutput SFNode field body1.float[]getBody1AnchorPoint()Provide array of 3-tuple float results from outputOnly SFVec3f field named body1AnchorPoint.float[]getBody1Axis()Provide array of 3-tuple float results from outputOnly SFVec3f field named body1Axis.RigidBodygetBody2()Provide RigidBodyObject instance (using a properly typed node) from inputOutput SFNode field body2.float[]getBody2AnchorPoint()Provide array of 3-tuple float results from outputOnly SFVec3f field named body2AnchorPoint.floatgetBody2Axis()Provide float value from outputOnly SFFloat field named body2Axis.java.lang.StringgetComponent()Defines X3D component for the UniversalJoint element: RigidBodyPhysicsintgetComponentLevel()Provides default X3D component level for this element: 2java.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.java.lang.StringgetElementName()Provides name of this element: UniversalJointjava.lang.StringgetFieldType(java.lang.String fieldName)Indicate type corresponding to given fieldName.java.lang.String[]getForceOutput()Provide array of String enumeration results (baseType MFString) ['"ALL"' | '"NONE"' | '"etc."'] from inputOutput MFString field named forceOutput.java.util.ArrayList<java.lang.String>getForceOutputList()Utility method to get ArrayList value of MFString forceOutput field, similar togetForceOutput().java.lang.StringgetForceOutputString()Utility method to get String value of MFString forceOutput field, similar togetForceOutput().ISObjectgetIS()Provide ISObject instance (using a properly typed node) from inputOutput SFNode field IS.X3DMetadataObjectgetMetadata()Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.floatgetStop1Bounce()Provide float value within allowed range of [0,1] from inputOutput SFFloat field named stop1Bounce.floatgetStop1ErrorCorrection()Provide float value within allowed range of [0,1] from inputOutput SFFloat field named stop1ErrorCorrection.floatgetStop2Bounce()Provide float value within allowed range of [0,1] from inputOutput SFFloat field named stop2Bounce.floatgetStop2ErrorCorrection()Provide float value within allowed range of [0,1] from inputOutput SFFloat field named stop2ErrorCorrection.java.lang.StringgetUSE()Provide String value from inputOutput SFString field named USE.booleanhasBody1()Indicate whether an object is available for inputOutput SFNode field body1.booleanhasBody2()Indicate whether an object is available for inputOutput SFNode field body2.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.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.UniversalJointObjectsetAnchorPoint(double[] newArray)Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetAnchorPoint(float[]).UniversalJointObjectsetAnchorPoint(double x, double y, double z)Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetAnchorPoint(float[]).UniversalJointObjectsetAnchorPoint(float[] newValue)Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named anchorPoint.UniversalJointObjectsetAnchorPoint(float x, float y, float z)Assign values to SFVec3f anchorPoint field, similar tosetAnchorPoint(float[]).UniversalJointObjectsetAnchorPoint(SFVec3fObject newValue)Assign typed object value to SFVec3f anchorPoint field, similar tosetAnchorPoint(float[]).UniversalJointObjectsetAxis1(double[] newArray)Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetAxis1(float[]).UniversalJointObjectsetAxis1(double x, double y, double z)Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetAxis1(float[]).UniversalJointObjectsetAxis1(float[] newValue)Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named axis1.UniversalJointObjectsetAxis1(float x, float y, float z)Assign values to SFVec3f axis1 field, similar tosetAxis1(float[]).UniversalJointObjectsetAxis1(SFVec3fObject newValue)Assign typed object value to SFVec3f axis1 field, similar tosetAxis1(float[]).UniversalJointObjectsetAxis2(double[] newArray)Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetAxis2(float[]).UniversalJointObjectsetAxis2(double x, double y, double z)Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetAxis2(float[]).UniversalJointObjectsetAxis2(float[] newValue)Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named axis2.UniversalJointObjectsetAxis2(float x, float y, float z)Assign values to SFVec3f axis2 field, similar tosetAxis2(float[]).UniversalJointObjectsetAxis2(SFVec3fObject newValue)Assign typed object value to SFVec3f axis2 field, similar tosetAxis2(float[]).UniversalJointObjectsetBody1(ProtoInstanceObject newValue)Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field body1.UniversalJointObjectsetBody1(RigidBody newValue)Accessor method to assign RigidBodyObject instance (using a properly typed node) to inputOutput SFNode field body1.UniversalJointObjectsetBody2(ProtoInstanceObject newValue)Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field body2.UniversalJointObjectsetBody2(RigidBody newValue)Accessor method to assign RigidBodyObject instance (using a properly typed node) to inputOutput SFNode field body2.UniversalJointObjectsetCssClass(java.lang.String newValue)Accessor method to assign String value to inputOutput SFString field named class.UniversalJointObjectsetCssClass(SFStringObject newValue)Assign typed object value to SFString cssClass field, similar tosetCssClass(String).UniversalJointObjectsetDEF(java.lang.String newValue)Accessor method to assign String value to inputOutput SFString field named DEF.UniversalJointObjectsetDEF(SFStringObject newValue)Assign typed object value to SFString DEF field, similar tosetDEF(String).UniversalJointObjectsetForceOutput(java.lang.String newValue)Assign singleton String value to MFString forceOutput field, similar tosetForceOutput(String[]).UniversalJointObjectsetForceOutput(java.lang.String[] newValue)Accessor method to assign String enumeration array (""ALL"" | ""NONE"") to inputOutput MFString field named forceOutput.UniversalJointObjectsetForceOutput(java.util.ArrayList<java.lang.String> newValue)Assign ArrayList value of MFString forceOutput field, similar tosetForceOutput(String[]).UniversalJointObjectsetForceOutput(MFStringObject newValue)Assign typed object value to MFString forceOutput field, similar tosetForceOutput(String[]).UniversalJointObjectsetForceOutput(SFStringObject newValue)Assign single SFString object value to MFString forceOutput field, similar tosetForceOutput(String[]).UniversalJointObjectsetIS(ISObject newValue)Accessor method to assign ISObject instance (using a properly typed node) to inputOutput SFNode field IS.UniversalJointObjectsetMetadata(ProtoInstanceObject newValue)Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.UniversalJointObjectsetMetadata(X3DMetadataObject newValue)Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.UniversalJointObjectsetStop1Bounce(double newValue)Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetStop1Bounce(float).UniversalJointObjectsetStop1Bounce(float newValue)Accessor method to assign float value to inputOutput SFFloat field named stop1Bounce.UniversalJointObjectsetStop1Bounce(SFFloatObject newValue)Assign typed object value to SFFloat stop1Bounce field, similar tosetStop1Bounce(float).UniversalJointObjectsetStop1ErrorCorrection(double newValue)Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetStop1ErrorCorrection(float).UniversalJointObjectsetStop1ErrorCorrection(float newValue)Accessor method to assign float value to inputOutput SFFloat field named stop1ErrorCorrection.UniversalJointObjectsetStop1ErrorCorrection(SFFloatObject newValue)Assign typed object value to SFFloat stop1ErrorCorrection field, similar tosetStop1ErrorCorrection(float).UniversalJointObjectsetStop2Bounce(double newValue)Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetStop2Bounce(float).UniversalJointObjectsetStop2Bounce(float newValue)Accessor method to assign float value to inputOutput SFFloat field named stop2Bounce.UniversalJointObjectsetStop2Bounce(SFFloatObject newValue)Assign typed object value to SFFloat stop2Bounce field, similar tosetStop2Bounce(float).UniversalJointObjectsetStop2ErrorCorrection(double newValue)Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetStop2ErrorCorrection(float).UniversalJointObjectsetStop2ErrorCorrection(float newValue)Accessor method to assign float value to inputOutput SFFloat field named stop2ErrorCorrection.UniversalJointObjectsetStop2ErrorCorrection(SFFloatObject newValue)Assign typed object value to SFFloat stop2ErrorCorrection field, similar tosetStop2ErrorCorrection(float).UniversalJointObjectsetUSE(java.lang.String newValue)Accessor method to assign String value to inputOutput SFString field named USE.UniversalJointObjectsetUSE(SFStringObject newValue)Assign typed object value to SFString USE field, similar tosetUSE(String).UniversalJointObjectsetUSE(UniversalJointObject 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
-
FORCEOUTPUT_ALL
public static final java.lang.String FORCEOUTPUT_ALLTooltip: all forceOutput fields computed. MFString field named forceOutput with X3DUOM simpleType forceOutputValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "ALL" (Java syntax) or '"ALL"' (XML syntax). -
FORCEOUTPUT_NONE
public static final java.lang.String FORCEOUTPUT_NONETooltip: no forceOutput fields computed. MFString field named forceOutput with X3DUOM simpleType forceOutputValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "NONE" (Java syntax) or '"NONE"' (XML syntax). -
NAME
public static final java.lang.String NAMEString constant NAME provides name of this element: UniversalJoint.- See Also:
- Constant Field Values
-
COMPONENT
public static final java.lang.String COMPONENTString constant COMPONENT defines X3D component for the UniversalJoint 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
-
ANCHORPOINT_DEFAULT_VALUE
public static final float[] ANCHORPOINT_DEFAULT_VALUESFVec3f field named anchorPoint has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax). -
AXIS1_DEFAULT_VALUE
public static final float[] AXIS1_DEFAULT_VALUESFVec3f field named axis1 has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax). -
AXIS2_DEFAULT_VALUE
public static final float[] AXIS2_DEFAULT_VALUESFVec3f field named axis2 has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax). -
BODY1_DEFAULT_VALUE
SFNode field named body1 has default value null (Java syntax) or NULL (XML syntax). -
BODY2_DEFAULT_VALUE
SFNode field named body2 has default value null (Java syntax) or NULL (XML syntax). -
FORCEOUTPUT_DEFAULT_VALUE
public static final java.util.ArrayList<java.lang.String> FORCEOUTPUT_DEFAULT_VALUEMFString field named forceOutput has default quoted value new String[] {"NONE"} (Java syntax) or quoted value "NONE" (XML syntax). -
IS_DEFAULT_VALUE
SFNode field named IS has default value null (Java syntax) or NULL (XML syntax). -
METADATA_DEFAULT_VALUE
SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax). -
STOP1BOUNCE_DEFAULT_VALUE
public static final float STOP1BOUNCE_DEFAULT_VALUESFFloat field named stop1Bounce has default value 0f (Java syntax) or 0 (XML syntax).- See Also:
- Constant Field Values
-
STOP1ERRORCORRECTION_DEFAULT_VALUE
public static final float STOP1ERRORCORRECTION_DEFAULT_VALUESFFloat field named stop1ErrorCorrection has default value 0.8f (Java syntax) or 0.8 (XML syntax).- See Also:
- Constant Field Values
-
STOP2BOUNCE_DEFAULT_VALUE
public static final float STOP2BOUNCE_DEFAULT_VALUESFFloat field named stop2Bounce has default value 0f (Java syntax) or 0 (XML syntax).- See Also:
- Constant Field Values
-
STOP2ERRORCORRECTION_DEFAULT_VALUE
public static final float STOP2ERRORCORRECTION_DEFAULT_VALUESFFloat field named stop2ErrorCorrection has default value 0.8f (Java syntax) or 0.8 (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_ANCHORPOINT
public static final java.lang.String fromField_ANCHORPOINTfromField ROUTE name for SFVec3f field named anchorPoint.- See Also:
- Constant Field Values
-
toField_ANCHORPOINT
public static final java.lang.String toField_ANCHORPOINTtoField ROUTE name for SFVec3f field named anchorPoint.- See Also:
- Constant Field Values
-
fromField_AXIS1
public static final java.lang.String fromField_AXIS1fromField ROUTE name for SFVec3f field named axis1.- See Also:
- Constant Field Values
-
toField_AXIS1
public static final java.lang.String toField_AXIS1toField ROUTE name for SFVec3f field named axis1.- See Also:
- Constant Field Values
-
fromField_AXIS2
public static final java.lang.String fromField_AXIS2fromField ROUTE name for SFVec3f field named axis2.- See Also:
- Constant Field Values
-
toField_AXIS2
public static final java.lang.String toField_AXIS2toField ROUTE name for SFVec3f field named axis2.- See Also:
- Constant Field Values
-
fromField_BODY1
public static final java.lang.String fromField_BODY1fromField ROUTE name for SFNode field named body1.- See Also:
- Constant Field Values
-
toField_BODY1
public static final java.lang.String toField_BODY1toField ROUTE name for SFNode field named body1.- See Also:
- Constant Field Values
-
fromField_BODY1ANCHORPOINT
public static final java.lang.String fromField_BODY1ANCHORPOINTfromField ROUTE name for SFVec3f field named body1AnchorPoint.- See Also:
- Constant Field Values
-
fromField_BODY1AXIS
public static final java.lang.String fromField_BODY1AXISfromField ROUTE name for SFVec3f field named body1Axis.- See Also:
- Constant Field Values
-
fromField_BODY2
public static final java.lang.String fromField_BODY2fromField ROUTE name for SFNode field named body2.- See Also:
- Constant Field Values
-
toField_BODY2
public static final java.lang.String toField_BODY2toField ROUTE name for SFNode field named body2.- See Also:
- Constant Field Values
-
fromField_BODY2ANCHORPOINT
public static final java.lang.String fromField_BODY2ANCHORPOINTfromField ROUTE name for SFVec3f field named body2AnchorPoint.- See Also:
- Constant Field Values
-
fromField_BODY2AXIS
public static final java.lang.String fromField_BODY2AXISfromField ROUTE name for SFFloat field named body2Axis.- See Also:
- Constant Field Values
-
fromField_FORCEOUTPUT
public static final java.lang.String fromField_FORCEOUTPUTfromField ROUTE name for MFString field named forceOutput.- See Also:
- Constant Field Values
-
toField_FORCEOUTPUT
public static final java.lang.String toField_FORCEOUTPUTtoField ROUTE name for MFString field named forceOutput.- See Also:
- Constant Field Values
-
fromField_IS
public static final java.lang.String fromField_ISfromField ROUTE name for SFNode field named IS.- See Also:
- Constant Field Values
-
fromField_METADATA
public static final java.lang.String fromField_METADATAfromField ROUTE name for SFNode field named metadata.- See Also:
- Constant Field Values
-
toField_METADATA
public static final java.lang.String toField_METADATAtoField ROUTE name for SFNode field named metadata.- See Also:
- Constant Field Values
-
fromField_STOP1BOUNCE
public static final java.lang.String fromField_STOP1BOUNCEfromField ROUTE name for SFFloat field named stop1Bounce.- See Also:
- Constant Field Values
-
toField_STOP1BOUNCE
public static final java.lang.String toField_STOP1BOUNCEtoField ROUTE name for SFFloat field named stop1Bounce.- See Also:
- Constant Field Values
-
fromField_STOP1ERRORCORRECTION
public static final java.lang.String fromField_STOP1ERRORCORRECTIONfromField ROUTE name for SFFloat field named stop1ErrorCorrection.- See Also:
- Constant Field Values
-
toField_STOP1ERRORCORRECTION
public static final java.lang.String toField_STOP1ERRORCORRECTIONtoField ROUTE name for SFFloat field named stop1ErrorCorrection.- See Also:
- Constant Field Values
-
fromField_STOP2BOUNCE
public static final java.lang.String fromField_STOP2BOUNCEfromField ROUTE name for SFFloat field named stop2Bounce.- See Also:
- Constant Field Values
-
toField_STOP2BOUNCE
public static final java.lang.String toField_STOP2BOUNCEtoField ROUTE name for SFFloat field named stop2Bounce.- See Also:
- Constant Field Values
-
fromField_STOP2ERRORCORRECTION
public static final java.lang.String fromField_STOP2ERRORCORRECTIONfromField ROUTE name for SFFloat field named stop2ErrorCorrection.- See Also:
- Constant Field Values
-
toField_STOP2ERRORCORRECTION
public static final java.lang.String toField_STOP2ERRORCORRECTIONtoField ROUTE name for SFFloat field named stop2ErrorCorrection.- See Also:
- Constant Field Values
-
-
Constructor Details
-
UniversalJointObject
public UniversalJointObject()Constructor for UniversalJointObject to initialize member variables with default values. -
UniversalJointObject
public UniversalJointObject(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: UniversalJoint- Specified by:
getElementNamein classX3DConcreteElement- Returns:
- name of this element
-
getComponent
public final java.lang.String getComponent()Defines X3D component for the UniversalJoint 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
-
getAnchorPoint
public float[] getAnchorPoint()Provide array of 3-tuple float results from inputOutput SFVec3f field named anchorPoint.
Tooltip: anchorPoint is joint center, specified in world coordinates. *- Specified by:
getAnchorPointin interfaceUniversalJoint- Returns:
- value of anchorPoint field
-
setAnchorPoint
Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named anchorPoint.
Tooltip: anchorPoint is joint center, specified in world coordinates. *- Specified by:
setAnchorPointin interfaceUniversalJoint- Parameters:
newValue- is new value for the anchorPoint field.- Returns:
UniversalJointObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setAnchorPoint
Assign typed object value to SFVec3f anchorPoint field, similar tosetAnchorPoint(float[]).- Parameters:
newValue- is new value for the anchorPoint field.- Returns:
UniversalJointObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setAnchorPoint
Assign values to SFVec3f anchorPoint field, similar tosetAnchorPoint(float[]).- Parameters:
x- first componenty- second componentz- third component- Returns:
UniversalJointObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setAnchorPoint
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetAnchorPoint(float[]).- Parameters:
x- first componenty- second componentz- third component- Returns:
UniversalJointObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setAnchorPoint
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetAnchorPoint(float[]).- Parameters:
newArray- is new value for field- Returns:
UniversalJointObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getAxis1
public float[] getAxis1()Provide array of 3-tuple float results from inputOutput SFVec3f field named axis1.
Tooltip: axis1 defines axis vector of joint connection to body1.- Hint: 0 0 0 means motor disabled.
- Specified by:
getAxis1in interfaceUniversalJoint- Returns:
- value of axis1 field
-
setAxis1
Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named axis1.
Tooltip: axis1 defines axis vector of joint connection to body1.- Hint: 0 0 0 means motor disabled.
- Specified by:
setAxis1in interfaceUniversalJoint- Parameters:
newValue- is new value for the axis1 field.- Returns:
UniversalJointObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setAxis1
Assign typed object value to SFVec3f axis1 field, similar tosetAxis1(float[]).- Parameters:
newValue- is new value for the axis1 field.- Returns:
UniversalJointObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setAxis1
Assign values to SFVec3f axis1 field, similar tosetAxis1(float[]).- Parameters:
x- first componenty- second componentz- third component- Returns:
UniversalJointObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setAxis1
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetAxis1(float[]).- Parameters:
x- first componenty- second componentz- third component- Returns:
UniversalJointObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setAxis1
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetAxis1(float[]).- Parameters:
newArray- is new value for field- Returns:
UniversalJointObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getAxis2
public float[] getAxis2()Provide array of 3-tuple float results from inputOutput SFVec3f field named axis2.
Tooltip: axis2 defines axis vector of joint connection to body2.- Hint: 0 0 0 means motor disabled.
- Specified by:
getAxis2in interfaceUniversalJoint- Returns:
- value of axis2 field
-
setAxis2
Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named axis2.
Tooltip: axis2 defines axis vector of joint connection to body2.- Hint: 0 0 0 means motor disabled.
- Specified by:
setAxis2in interfaceUniversalJoint- Parameters:
newValue- is new value for the axis2 field.- Returns:
UniversalJointObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setAxis2
Assign typed object value to SFVec3f axis2 field, similar tosetAxis2(float[]).- Parameters:
newValue- is new value for the axis2 field.- Returns:
UniversalJointObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setAxis2
Assign values to SFVec3f axis2 field, similar tosetAxis2(float[]).- Parameters:
x- first componenty- second componentz- third component- Returns:
UniversalJointObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setAxis2
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetAxis2(float[]).- Parameters:
x- first componenty- second componentz- third component- Returns:
UniversalJointObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setAxis2
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetAxis2(float[]).- Parameters:
newArray- is new value for field- Returns:
UniversalJointObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getBody1
Provide RigidBodyObject instance (using a properly typed node) from inputOutput SFNode field body1.- Specified by:
getBody1in interfaceUniversalJoint- Specified by:
getBody1in interfaceX3DRigidJointNode- Returns:
- value of body1 field
- See Also:
getBody1ProtoInstance()
-
setBody1
Accessor method to assign RigidBodyObject instance (using a properly typed node) to inputOutput SFNode field body1.- Specified by:
setBody1in interfaceUniversalJoint- Specified by:
setBody1in interfaceX3DRigidJointNode- Parameters:
newValue- is new value for the body1 field.- Returns:
UniversalJointObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
setBody1(ProtoInstanceObject)
-
clearBody1
Utility method to clear SFNode value of body1 field.- Returns:
UniversalJointObject- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setBody1
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field body1.- Parameters:
newValue- is new value for the body1 field.- Returns:
UniversalJointObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
setBody1(RigidBody)
-
hasBody1
public boolean hasBody1()Indicate whether an object is available for inputOutput SFNode field body1.- Returns:
- whether a properly typed node or ProtoInstance or CommentsBlock is available.
- See Also:
getBody1(),getBody1ProtoInstance()
-
getBody1AnchorPoint
public float[] getBody1AnchorPoint()Provide array of 3-tuple float results from outputOnly SFVec3f field named body1AnchorPoint.- Specified by:
getBody1AnchorPointin interfaceUniversalJoint- Returns:
- value of body1AnchorPoint field
-
getBody1Axis
public float[] getBody1Axis()Provide array of 3-tuple float results from outputOnly SFVec3f field named body1Axis.- Specified by:
getBody1Axisin interfaceUniversalJoint- Returns:
- value of body1Axis field
-
getBody2
Provide RigidBodyObject instance (using a properly typed node) from inputOutput SFNode field body2.- Specified by:
getBody2in interfaceUniversalJoint- Specified by:
getBody2in interfaceX3DRigidJointNode- Returns:
- value of body2 field
- See Also:
getBody2ProtoInstance()
-
setBody2
Accessor method to assign RigidBodyObject instance (using a properly typed node) to inputOutput SFNode field body2.- Specified by:
setBody2in interfaceUniversalJoint- Specified by:
setBody2in interfaceX3DRigidJointNode- Parameters:
newValue- is new value for the body2 field.- Returns:
UniversalJointObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
setBody2(ProtoInstanceObject)
-
clearBody2
Utility method to clear SFNode value of body2 field.- Returns:
UniversalJointObject- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setBody2
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field body2.- Parameters:
newValue- is new value for the body2 field.- Returns:
UniversalJointObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
setBody2(RigidBody)
-
hasBody2
public boolean hasBody2()Indicate whether an object is available for inputOutput SFNode field body2.- Returns:
- whether a properly typed node or ProtoInstance or CommentsBlock is available.
- See Also:
getBody2(),getBody2ProtoInstance()
-
getBody2AnchorPoint
public float[] getBody2AnchorPoint()Provide array of 3-tuple float results from outputOnly SFVec3f field named body2AnchorPoint.- Specified by:
getBody2AnchorPointin interfaceUniversalJoint- Returns:
- value of body2AnchorPoint field
-
getBody2Axis
public float getBody2Axis()Provide float value from outputOnly SFFloat field named body2Axis.- Specified by:
getBody2Axisin interfaceUniversalJoint- Returns:
- value of body2Axis field
-
getForceOutput
public java.lang.String[] getForceOutput()Provide array of String enumeration results (baseType MFString) ['"ALL"' | '"NONE"' | '"etc."'] from inputOutput MFString field named forceOutput.
Tooltip: forceOutput controls which output fields are generated for the next frame. Values are ALL, NONE, or exact names of output fields updated at start of next frame. *
Available enumeration values for string comparison:ALL,NONE.- Specified by:
getForceOutputin interfaceUniversalJoint- Specified by:
getForceOutputin interfaceX3DRigidJointNode- Returns:
- value of forceOutput field
-
getForceOutputList
public java.util.ArrayList<java.lang.String> getForceOutputList()Utility method to get ArrayList value of MFString forceOutput field, similar togetForceOutput().- Returns:
- value of forceOutput field
-
getForceOutputString
public java.lang.String getForceOutputString()Utility method to get String value of MFString forceOutput field, similar togetForceOutput().- Returns:
- value of forceOutput field
-
setForceOutput
Accessor method to assign String enumeration array (""ALL"" | ""NONE"") to inputOutput MFString field named forceOutput.
Hint: authors have option to choose from an extendible list of predefined enumeration values (ALL,NONE).
Tooltip: forceOutput controls which output fields are generated for the next frame. Values are ALL, NONE, or exact names of output fields updated at start of next frame. *- Specified by:
setForceOutputin interfaceUniversalJoint- Specified by:
setForceOutputin interfaceX3DRigidJointNode- Parameters:
newValue- is new value for the forceOutput field.- Returns:
UniversalJointObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setForceOutput
Assign typed object value to MFString forceOutput field, similar tosetForceOutput(String[]).- Parameters:
newValue- is new value for the forceOutput field.- Returns:
UniversalJointObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setForceOutput
Assign single SFString object value to MFString forceOutput field, similar tosetForceOutput(String[]).- Parameters:
newValue- is new value for the forceOutput field.- Returns:
UniversalJointObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
MFStringObject.cleanupEnumerationValues(String)
-
setForceOutput
Assign singleton String value to MFString forceOutput field, similar tosetForceOutput(String[]).- Parameters:
newValue- is new value for the forceOutput field.- Returns:
UniversalJointObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
MFStringObject.cleanupEnumerationValues(String)
-
setForceOutput
Assign ArrayList value of MFString forceOutput field, similar tosetForceOutput(String[]).- Parameters:
newValue- is new value for the forceOutput field.- Returns:
UniversalJointObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
clearForceOutput
Utility method to clear MFString value of forceOutput field.- Returns:
UniversalJointObject- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
addForceOutput
Add singleton String value to MFString forceOutput field.- Parameters:
newValue- is new value to add to the forceOutput field.- Returns:
UniversalJointObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
MFStringObject.cleanupEnumerationValues(String)
-
addForceOutput
Add singleton SFStringObject value to MFString forceOutput field.- Parameters:
newValue- is new value to add to the forceOutput field.- Returns:
UniversalJointObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
MFStringObject.cleanupEnumerationValues(String)
-
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:
UniversalJointObject- 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:
UniversalJointObject- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
hasIS
public boolean hasIS()Indicate whether an object is available for inputOutput SFNode field IS.- Returns:
- whether a concrete statement or CommentsBlock is available.
- See Also:
getIS()
-
getMetadata
Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.- Specified by:
getMetadatain interfaceUniversalJoint- Specified by:
getMetadatain interfaceX3DNode- Specified by:
getMetadatain interfaceX3DRigidJointNode- 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 interfaceUniversalJoint- Specified by:
setMetadatain interfaceX3DNode- Specified by:
setMetadatain interfaceX3DRigidJointNode- Specified by:
setMetadatain classX3DConcreteNode- Parameters:
newValue- is new value for the metadata field.- Returns:
UniversalJointObject- 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:
UniversalJointObject- 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:
UniversalJointObject- 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
-
getStop1Bounce
public float getStop1Bounce()Provide float value within allowed range of [0,1] from inputOutput SFFloat field named stop1Bounce.
Tooltip: [0,1] stop1Bounce is velocity factor for bounce back once stop point is reached.- Hint: 0 means no bounce, 1 means return velocity matches.
- Specified by:
getStop1Bouncein interfaceUniversalJoint- Returns:
- value of stop1Bounce field
-
setStop1Bounce
Accessor method to assign float value to inputOutput SFFloat field named stop1Bounce.
Tooltip: [0,1] stop1Bounce is velocity factor for bounce back once stop point is reached.- Hint: 0 means no bounce, 1 means return velocity matches.
- Specified by:
setStop1Bouncein interfaceUniversalJoint- Parameters:
newValue- is new value for the stop1Bounce field.- Returns:
UniversalJointObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setStop1Bounce
Assign typed object value to SFFloat stop1Bounce field, similar tosetStop1Bounce(float).- Parameters:
newValue- is new value for the stop1Bounce field.- Returns:
UniversalJointObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setStop1Bounce
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetStop1Bounce(float).- Parameters:
newValue- is new value for field- Returns:
UniversalJointObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getStop1ErrorCorrection
public float getStop1ErrorCorrection()Provide float value within allowed range of [0,1] from inputOutput SFFloat field named stop1ErrorCorrection.
Tooltip: [0,1] stop1ErrorCorrection is fraction of error correction performed during time step once stop point is reached.- Hint: 0 means no error correction, 1 means all error corrected in single step.
- Specified by:
getStop1ErrorCorrectionin interfaceUniversalJoint- Returns:
- value of stop1ErrorCorrection field
-
setStop1ErrorCorrection
Accessor method to assign float value to inputOutput SFFloat field named stop1ErrorCorrection.
Tooltip: [0,1] stop1ErrorCorrection is fraction of error correction performed during time step once stop point is reached.- Hint: 0 means no error correction, 1 means all error corrected in single step.
- Specified by:
setStop1ErrorCorrectionin interfaceUniversalJoint- Parameters:
newValue- is new value for the stop1ErrorCorrection field.- Returns:
UniversalJointObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setStop1ErrorCorrection
Assign typed object value to SFFloat stop1ErrorCorrection field, similar tosetStop1ErrorCorrection(float).- Parameters:
newValue- is new value for the stop1ErrorCorrection field.- Returns:
UniversalJointObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setStop1ErrorCorrection
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetStop1ErrorCorrection(float).- Parameters:
newValue- is new value for field- Returns:
UniversalJointObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getStop2Bounce
public float getStop2Bounce()Provide float value within allowed range of [0,1] from inputOutput SFFloat field named stop2Bounce.
Tooltip: [0,1] stop2Bounce is velocity factor for bounce back once stop point is reached.- Hint: 0 means no bounce, 1 means return velocity matches.
- Specified by:
getStop2Bouncein interfaceUniversalJoint- Returns:
- value of stop2Bounce field
-
setStop2Bounce
Accessor method to assign float value to inputOutput SFFloat field named stop2Bounce.
Tooltip: [0,1] stop2Bounce is velocity factor for bounce back once stop point is reached.- Hint: 0 means no bounce, 1 means return velocity matches.
- Specified by:
setStop2Bouncein interfaceUniversalJoint- Parameters:
newValue- is new value for the stop2Bounce field.- Returns:
UniversalJointObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setStop2Bounce
Assign typed object value to SFFloat stop2Bounce field, similar tosetStop2Bounce(float).- Parameters:
newValue- is new value for the stop2Bounce field.- Returns:
UniversalJointObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setStop2Bounce
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetStop2Bounce(float).- Parameters:
newValue- is new value for field- Returns:
UniversalJointObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getStop2ErrorCorrection
public float getStop2ErrorCorrection()Provide float value within allowed range of [0,1] from inputOutput SFFloat field named stop2ErrorCorrection.
Tooltip: [0,1] stop2ErrorCorrection is fraction of error correction performed during time step once stop point is reached.- Hint: 0 means no error correction, 1 means all error corrected in single step.
- Specified by:
getStop2ErrorCorrectionin interfaceUniversalJoint- Returns:
- value of stop2ErrorCorrection field
-
setStop2ErrorCorrection
Accessor method to assign float value to inputOutput SFFloat field named stop2ErrorCorrection.
Tooltip: [0,1] stop2ErrorCorrection is fraction of error correction performed during time step once stop point is reached.- Hint: 0 means no error correction, 1 means all error corrected in single step.
- Specified by:
setStop2ErrorCorrectionin interfaceUniversalJoint- Parameters:
newValue- is new value for the stop2ErrorCorrection field.- Returns:
UniversalJointObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setStop2ErrorCorrection
Assign typed object value to SFFloat stop2ErrorCorrection field, similar tosetStop2ErrorCorrection(float).- Parameters:
newValue- is new value for the stop2ErrorCorrection field.- Returns:
UniversalJointObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setStop2ErrorCorrection
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetStop2ErrorCorrection(float).- Parameters:
newValue- is new value for field- Returns:
UniversalJointObject- 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:
UniversalJointObject- 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:
UniversalJointObject- 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:
UniversalJointObject- 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:
UniversalJointObject- 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:
UniversalJointObject- 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:
UniversalJointObject- 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:
UniversalJointObject- 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:
UniversalJointObject- 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:
UniversalJointObject- 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:
UniversalJointObject- 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)
-