Class SingleAxisHingeJointObject
java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.RigidBodyPhysics.SingleAxisHingeJointObject
- All Implemented Interfaces:
X3DNode
,SingleAxisHingeJoint
,X3DRigidJointNode
public class SingleAxisHingeJointObject extends X3DConcreteNode implements SingleAxisHingeJoint
SingleAxisHingeJoint has single axis about which to rotate, similar to a traditional door hinge. Contains two RigidBody nodes (containerField values body1, body2).
X3D node tooltip: (X3D version 3.2 or later) [X3DRigidJointNode] SingleAxisHingeJoint has single axis about which to rotate, similar to a traditional door hinge. 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] SingleAxisHingeJoint has single axis about which to rotate, similar to a traditional door hinge. Contains two RigidBody nodes (containerField values body1, body2).
- 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_VALUE
SFVec3f field named anchorPoint has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).static float[]
AXIS_DEFAULT_VALUE
SFVec3f field named axis has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).static RigidBodyObject
BODY1_DEFAULT_VALUE
SFNode field named body1 has default value null (Java syntax) or NULL (XML syntax).static RigidBodyObject
BODY2_DEFAULT_VALUE
SFNode field named body2 has default value null (Java syntax) or NULL (XML syntax).static java.lang.String
COMPONENT
String constant COMPONENT defines X3D component for the SingleAxisHingeJoint element: RigidBodyPhysicsstatic java.lang.String
containerField_DEFAULT_VALUE
containerField describes typical field relationship of a node to its parent.static java.lang.String
FORCEOUTPUT_ALL
Tooltip: all forceOutput fields computed.static java.util.ArrayList<java.lang.String>
FORCEOUTPUT_DEFAULT_VALUE
MFString field named forceOutput has default quoted value new String[] {"NONE"} (Java syntax) or quoted value "NONE" (XML syntax).static java.lang.String
FORCEOUTPUT_NONE
Tooltip: no forceOutput fields computed.static java.lang.String
fromField_ANCHORPOINT
fromField ROUTE name for SFVec3f field named anchorPoint.static java.lang.String
fromField_ANGLE
fromField ROUTE name for SFFloat field named angle.static java.lang.String
fromField_ANGLERATE
fromField ROUTE name for SFFloat field named angleRate.static java.lang.String
fromField_AXIS
fromField ROUTE name for SFVec3f field named axis.static java.lang.String
fromField_BODY1
fromField ROUTE name for SFNode field named body1.static java.lang.String
fromField_BODY1ANCHORPOINT
fromField ROUTE name for SFVec3f field named body1AnchorPoint.static java.lang.String
fromField_BODY2
fromField ROUTE name for SFNode field named body2.static java.lang.String
fromField_BODY2ANCHORPOINT
fromField ROUTE name for SFVec3f field named body2AnchorPoint.static java.lang.String
fromField_FORCEOUTPUT
fromField ROUTE name for MFString field named forceOutput.static java.lang.String
fromField_IS
fromField ROUTE name for SFNode field named IS.static java.lang.String
fromField_MAXANGLE
fromField ROUTE name for SFFloat field named maxAngle.static java.lang.String
fromField_METADATA
fromField ROUTE name for SFNode field named metadata.static java.lang.String
fromField_MINANGLE
fromField ROUTE name for SFFloat field named minAngle.static java.lang.String
fromField_STOPBOUNCE
fromField ROUTE name for SFFloat field named stopBounce.static java.lang.String
fromField_STOPERRORCORRECTION
fromField ROUTE name for SFFloat field named stopErrorCorrection.static ISObject
IS_DEFAULT_VALUE
SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).static int
LEVEL
Integer constant LEVEL provides default X3D RigidBodyPhysics component level for this element: 2static float
MAXANGLE_DEFAULT_VALUE
SFFloat field named maxAngle has default value 3.141592653f (Java syntax) or 3.141592653 (XML syntax).static X3DMetadataObject
METADATA_DEFAULT_VALUE
SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).static float
MINANGLE_DEFAULT_VALUE
SFFloat field named minAngle has default value -3.141592653f (Java syntax) or -3.141592653 (XML syntax).static java.lang.String
NAME
String constant NAME provides name of this element: SingleAxisHingeJoint.static float
STOPBOUNCE_DEFAULT_VALUE
SFFloat field named stopBounce has default value 0f (Java syntax) or 0 (XML syntax).static float
STOPERRORCORRECTION_DEFAULT_VALUE
SFFloat field named stopErrorCorrection has default value 0.8f (Java syntax) or 0.8 (XML syntax).static java.lang.String
toField_ANCHORPOINT
toField ROUTE name for SFVec3f field named anchorPoint.static java.lang.String
toField_AXIS
toField ROUTE name for SFVec3f field named axis.static java.lang.String
toField_BODY1
toField ROUTE name for SFNode field named body1.static java.lang.String
toField_BODY2
toField ROUTE name for SFNode field named body2.static java.lang.String
toField_FORCEOUTPUT
toField ROUTE name for MFString field named forceOutput.static java.lang.String
toField_MAXANGLE
toField ROUTE name for SFFloat field named maxAngle.static java.lang.String
toField_METADATA
toField ROUTE name for SFNode field named metadata.static java.lang.String
toField_MINANGLE
toField ROUTE name for SFFloat field named minAngle.static java.lang.String
toField_STOPBOUNCE
toField ROUTE name for SFFloat field named stopBounce.static java.lang.String
toField_STOPERRORCORRECTION
toField ROUTE name for SFFloat field named stopErrorCorrection.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 SingleAxisHingeJointObject()
Constructor for SingleAxisHingeJointObject to initialize member variables with default values.SingleAxisHingeJointObject(java.lang.String DEFlabel)
Utility constructor that assigns DEF label after initializing member variables with default values. -
Method Summary
Modifier and Type Method Description SingleAxisHingeJointObject
addComments(java.lang.String newComment)
Add comment as String to contained commentsList.SingleAxisHingeJointObject
addComments(java.lang.String[] newComments)
Add comments as String[] array to contained commentsList.SingleAxisHingeJointObject
addComments(CommentsBlock newCommentsBlock)
Add CommentsBlock to contained commentsList.SingleAxisHingeJointObject
addForceOutput(java.lang.String newValue)
Add singleton String value to MFString forceOutput field.SingleAxisHingeJointObject
addForceOutput(SFStringObject newValue)
Add singleton SFStringObject value to MFString forceOutput field.SingleAxisHingeJointObject
clearBody1()
Utility method to clear SFNode value of body1 field.SingleAxisHingeJointObject
clearBody2()
Utility method to clear SFNode value of body2 field.SingleAxisHingeJointObject
clearForceOutput()
Utility method to clear MFString value of forceOutput field.SingleAxisHingeJointObject
clearIS()
Utility method to clear SFNode value of IS field.SingleAxisHingeJointObject
clearMetadata()
Utility method to clear SFNode value of metadata field.X3DConcreteElement
findElementByNameValue(java.lang.String nameValue)
Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.X3DConcreteElement
findElementByNameValue(java.lang.String nameValue, java.lang.String elementName)
Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.X3DConcreteNode
findNodeByDEF(java.lang.String DEFvalue)
Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.java.lang.String
getAccessType(java.lang.String fieldName)
Indicate accessType corresponding to given fieldName.float[]
getAnchorPoint()
Provide array of 3-tuple float results from inputOutput SFVec3f field named anchorPoint.float
getAngle()
Provide float value unit axis, angle (in radians) from outputOnly SFFloat field named angle.float
getAngleRate()
Provide float value unit axis, angle (in radians) from outputOnly SFFloat field named angleRate.float[]
getAxis()
Provide array of 3-tuple float results from inputOutput SFVec3f field named axis.RigidBody
getBody1()
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.RigidBody
getBody2()
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.java.lang.String
getComponent()
Defines X3D component for the SingleAxisHingeJoint element: RigidBodyPhysicsint
getComponentLevel()
Provides default X3D component level for this element: 2java.lang.String
getContainerFieldDefault()
containerField describes typical field relationship of a node to its parent.java.lang.String
getCssClass()
Provide String value from inputOutput SFString field named class.java.lang.String
getDEF()
Provide String value from inputOutput SFString field named DEF.java.lang.String
getElementName()
Provides name of this element: SingleAxisHingeJointjava.lang.String
getFieldType(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.String
getForceOutputString()
Utility method to get String value of MFString forceOutput field, similar togetForceOutput()
.ISObject
getIS()
Provide ISObject instance (using a properly typed node) from inputOutput SFNode field IS.float
getMaxAngle()
Provide float value unit axis, angle (in radians) from inputOutput SFFloat field named maxAngle.X3DMetadataObject
getMetadata()
Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.float
getMinAngle()
Provide float value unit axis, angle (in radians) from inputOutput SFFloat field named minAngle.float
getStopBounce()
Provide float value from inputOutput SFFloat field named stopBounce.float
getStopErrorCorrection()
Provide float value from inputOutput SFFloat field named stopErrorCorrection.java.lang.String
getUSE()
Provide String value from inputOutput SFString field named USE.boolean
hasBody1()
Indicate whether an object is available for inputOutput SFNode field body1.boolean
hasBody2()
Indicate whether an object is available for inputOutput SFNode field body2.boolean
hasElementByNameValue(java.lang.String nameValue, java.lang.String elementName)
Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.boolean
hasIS()
Indicate whether an object is available for inputOutput SFNode field IS.boolean
hasMetadata()
Indicate whether an object is available for inputOutput SFNode field metadata.boolean
hasNodeByDEF(java.lang.String DEFvalue)
Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.void
initialize()
Initialize all member variables to default values.SingleAxisHingeJointObject
setAnchorPoint(double[] newArray)
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetAnchorPoint(float[])
.SingleAxisHingeJointObject
setAnchorPoint(double x, double y, double z)
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetAnchorPoint(float[])
.SingleAxisHingeJointObject
setAnchorPoint(float[] newValue)
Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named anchorPoint.SingleAxisHingeJointObject
setAnchorPoint(float x, float y, float z)
Assign values to SFVec3f anchorPoint field, similar tosetAnchorPoint(float[])
.SingleAxisHingeJointObject
setAnchorPoint(SFVec3fObject newValue)
Assign typed object value to SFVec3f anchorPoint field, similar tosetAnchorPoint(float[])
.SingleAxisHingeJointObject
setAxis(double[] newArray)
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetAxis(float[])
.SingleAxisHingeJointObject
setAxis(double x, double y, double z)
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetAxis(float[])
.SingleAxisHingeJointObject
setAxis(float[] newValue)
Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named axis.SingleAxisHingeJointObject
setAxis(float x, float y, float z)
Assign values to SFVec3f axis field, similar tosetAxis(float[])
.SingleAxisHingeJointObject
setAxis(SFVec3fObject newValue)
Assign typed object value to SFVec3f axis field, similar tosetAxis(float[])
.SingleAxisHingeJointObject
setBody1(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field body1.SingleAxisHingeJointObject
setBody1(RigidBody newValue)
Accessor method to assign RigidBodyObject instance (using a properly typed node) to inputOutput SFNode field body1.SingleAxisHingeJointObject
setBody2(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field body2.SingleAxisHingeJointObject
setBody2(RigidBody newValue)
Accessor method to assign RigidBodyObject instance (using a properly typed node) to inputOutput SFNode field body2.SingleAxisHingeJointObject
setCssClass(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named class.SingleAxisHingeJointObject
setCssClass(SFStringObject newValue)
Assign typed object value to SFString cssClass field, similar tosetCssClass(String)
.SingleAxisHingeJointObject
setDEF(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named DEF.SingleAxisHingeJointObject
setDEF(SFStringObject newValue)
Assign typed object value to SFString DEF field, similar tosetDEF(String)
.SingleAxisHingeJointObject
setForceOutput(java.lang.String newValue)
Assign singleton String value to MFString forceOutput field, similar tosetForceOutput(String[])
.SingleAxisHingeJointObject
setForceOutput(java.lang.String[] newValue)
Accessor method to assign String enumeration array (""ALL"" | ""NONE"") to inputOutput MFString field named forceOutput.SingleAxisHingeJointObject
setForceOutput(java.util.ArrayList<java.lang.String> newValue)
Assign ArrayList value of MFString forceOutput field, similar tosetForceOutput(String[])
.SingleAxisHingeJointObject
setForceOutput(MFStringObject newValue)
Assign typed object value to MFString forceOutput field, similar tosetForceOutput(String[])
.SingleAxisHingeJointObject
setForceOutput(SFStringObject newValue)
Assign single SFString object value to MFString forceOutput field, similar tosetForceOutput(String[])
.SingleAxisHingeJointObject
setIS(ISObject newValue)
Accessor method to assign ISObject instance (using a properly typed node) to inputOutput SFNode field IS.SingleAxisHingeJointObject
setMaxAngle(double newValue)
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetMaxAngle(float)
.SingleAxisHingeJointObject
setMaxAngle(float newValue)
Accessor method to assign float value unit axis, angle (in radians) to inputOutput SFFloat field named maxAngle.SingleAxisHingeJointObject
setMaxAngle(SFFloatObject newValue)
Assign typed object value to SFFloat maxAngle field, similar tosetMaxAngle(float)
.SingleAxisHingeJointObject
setMetadata(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.SingleAxisHingeJointObject
setMetadata(X3DMetadataObject newValue)
Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.SingleAxisHingeJointObject
setMinAngle(double newValue)
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetMinAngle(float)
.SingleAxisHingeJointObject
setMinAngle(float newValue)
Accessor method to assign float value unit axis, angle (in radians) to inputOutput SFFloat field named minAngle.SingleAxisHingeJointObject
setMinAngle(SFFloatObject newValue)
Assign typed object value to SFFloat minAngle field, similar tosetMinAngle(float)
.SingleAxisHingeJointObject
setStopBounce(double newValue)
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetStopBounce(float)
.SingleAxisHingeJointObject
setStopBounce(float newValue)
Accessor method to assign float value to inputOutput SFFloat field named stopBounce.SingleAxisHingeJointObject
setStopBounce(SFFloatObject newValue)
Assign typed object value to SFFloat stopBounce field, similar tosetStopBounce(float)
.SingleAxisHingeJointObject
setStopErrorCorrection(double newValue)
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetStopErrorCorrection(float)
.SingleAxisHingeJointObject
setStopErrorCorrection(float newValue)
Accessor method to assign float value to inputOutput SFFloat field named stopErrorCorrection.SingleAxisHingeJointObject
setStopErrorCorrection(SFFloatObject newValue)
Assign typed object value to SFFloat stopErrorCorrection field, similar tosetStopErrorCorrection(float)
.SingleAxisHingeJointObject
setUSE(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named USE.SingleAxisHingeJointObject
setUSE(SFStringObject newValue)
Assign typed object value to SFString USE field, similar tosetUSE(String)
.SingleAxisHingeJointObject
setUSE(SingleAxisHingeJointObject DEFnode)
Assign a USE reference to another DEF node of same node type, similar tosetUSE(String)
.java.lang.String
toStringClassicVRML(int indentLevel)
Recursive method to provide ClassicVRML string serialization.java.lang.String
toStringVRML97(int indentLevel)
Recursive method to provide VRML97 string serialization.java.lang.String
toStringX3D(int indentLevel)
Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.java.lang.String
validate()
Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.Methods inherited from class org.web3d.x3d.jsail.X3DConcreteNode
getContainerFieldAlternateValues, getContainerFieldOverride, isNode, isStatement, isUSE, resetContainerFieldOverride, setConcreteCssClass, setConcreteDEF, setConcreteUSE, setContainerFieldOverride
Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement
clearParentObject, findAncestorElementByName, findAncestorProtoBody, findAncestorSceneObject, findAncestorX3DObject, getPackageName, getParentObject, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorSceneObject, hasAncestorX3DObject, hasParentObject, isValid, setParentObject, toStringClassicVRML, toStringVRML97, toStringX3D
-
Field Details
-
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: SingleAxisHingeJoint.- See Also:
- Constant Field Values
-
COMPONENT
public static final java.lang.String COMPONENTString constant COMPONENT defines X3D component for the SingleAxisHingeJoint 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). -
AXIS_DEFAULT_VALUE
public static final float[] AXIS_DEFAULT_VALUESFVec3f field named axis 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). -
MAXANGLE_DEFAULT_VALUE
public static final float MAXANGLE_DEFAULT_VALUESFFloat field named maxAngle has default value 3.141592653f (Java syntax) or 3.141592653 (XML syntax).- See Also:
- Constant Field Values
-
METADATA_DEFAULT_VALUE
SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax). -
MINANGLE_DEFAULT_VALUE
public static final float MINANGLE_DEFAULT_VALUESFFloat field named minAngle has default value -3.141592653f (Java syntax) or -3.141592653 (XML syntax).- See Also:
- Constant Field Values
-
STOPBOUNCE_DEFAULT_VALUE
public static final float STOPBOUNCE_DEFAULT_VALUESFFloat field named stopBounce has default value 0f (Java syntax) or 0 (XML syntax).- See Also:
- Constant Field Values
-
STOPERRORCORRECTION_DEFAULT_VALUE
public static final float STOPERRORCORRECTION_DEFAULT_VALUESFFloat field named stopErrorCorrection 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_ANGLE
public static final java.lang.String fromField_ANGLEfromField ROUTE name for SFFloat field named angle.- See Also:
- Constant Field Values
-
fromField_ANGLERATE
public static final java.lang.String fromField_ANGLERATEfromField ROUTE name for SFFloat field named angleRate.- See Also:
- Constant Field Values
-
fromField_AXIS
public static final java.lang.String fromField_AXISfromField ROUTE name for SFVec3f field named axis.- See Also:
- Constant Field Values
-
toField_AXIS
public static final java.lang.String toField_AXIStoField ROUTE name for SFVec3f field named axis.- 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_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_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_MAXANGLE
public static final java.lang.String fromField_MAXANGLEfromField ROUTE name for SFFloat field named maxAngle.- See Also:
- Constant Field Values
-
toField_MAXANGLE
public static final java.lang.String toField_MAXANGLEtoField ROUTE name for SFFloat field named maxAngle.- 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_MINANGLE
public static final java.lang.String fromField_MINANGLEfromField ROUTE name for SFFloat field named minAngle.- See Also:
- Constant Field Values
-
toField_MINANGLE
public static final java.lang.String toField_MINANGLEtoField ROUTE name for SFFloat field named minAngle.- See Also:
- Constant Field Values
-
fromField_STOPBOUNCE
public static final java.lang.String fromField_STOPBOUNCEfromField ROUTE name for SFFloat field named stopBounce.- See Also:
- Constant Field Values
-
toField_STOPBOUNCE
public static final java.lang.String toField_STOPBOUNCEtoField ROUTE name for SFFloat field named stopBounce.- See Also:
- Constant Field Values
-
fromField_STOPERRORCORRECTION
public static final java.lang.String fromField_STOPERRORCORRECTIONfromField ROUTE name for SFFloat field named stopErrorCorrection.- See Also:
- Constant Field Values
-
toField_STOPERRORCORRECTION
public static final java.lang.String toField_STOPERRORCORRECTIONtoField ROUTE name for SFFloat field named stopErrorCorrection.- See Also:
- Constant Field Values
-
-
Constructor Details
-
SingleAxisHingeJointObject
public SingleAxisHingeJointObject()Constructor for SingleAxisHingeJointObject to initialize member variables with default values. -
SingleAxisHingeJointObject
public SingleAxisHingeJointObject(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: SingleAxisHingeJoint- Specified by:
getElementName
in classX3DConcreteElement
- Returns:
- name of this element
-
getComponent
public final java.lang.String getComponent()Defines X3D component for the SingleAxisHingeJoint element: RigidBodyPhysics- Specified by:
getComponent
in classX3DConcreteElement
- Returns:
- X3D component for this element
-
getComponentLevel
public final int getComponentLevel()Provides default X3D component level for this element: 2- Specified by:
getComponentLevel
in classX3DConcreteElement
- Returns:
- default X3D component level for this element
-
getFieldType
public java.lang.String getFieldType(java.lang.String fieldName)Indicate type corresponding to given fieldName.- Specified by:
getFieldType
in classX3DConcreteElement
- Parameters:
fieldName
- name of field in this X3D node- Returns:
- X3D type (SFvec3f etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE if not recognized
- See Also:
ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE
-
getAccessType
public java.lang.String getAccessType(java.lang.String fieldName)Indicate accessType corresponding to given fieldName.- Specified by:
getAccessType
in classX3DConcreteElement
- Parameters:
fieldName
- name of field in this X3D node- Returns:
- X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized
- See Also:
ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE
-
getContainerFieldDefault
public final java.lang.String getContainerFieldDefault()containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.- Specified by:
getContainerFieldDefault
in classX3DConcreteNode
- Returns:
- default containerField value
- See Also:
- X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM)
-
initialize
public final void initialize()Initialize all member variables to default values.- Overrides:
initialize
in classX3DConcreteNode
-
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:
getAnchorPoint
in interfaceSingleAxisHingeJoint
- 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:
setAnchorPoint
in interfaceSingleAxisHingeJoint
- Parameters:
newValue
- is new value for the anchorPoint field.- Returns:
SingleAxisHingeJointObject
- 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:
SingleAxisHingeJointObject
- 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:
SingleAxisHingeJointObject
- 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:
SingleAxisHingeJointObject
- 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:
SingleAxisHingeJointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getAngle
public float getAngle()Provide float value unit axis, angle (in radians) from outputOnly SFFloat field named angle.- Specified by:
getAngle
in interfaceSingleAxisHingeJoint
- Returns:
- value of angle field
-
getAngleRate
public float getAngleRate()Provide float value unit axis, angle (in radians) from outputOnly SFFloat field named angleRate.- Specified by:
getAngleRate
in interfaceSingleAxisHingeJoint
- Returns:
- value of angleRate field
-
getAxis
public float[] getAxis()Provide array of 3-tuple float results from inputOutput SFVec3f field named axis.
Tooltip: axis defines vector of joint connection between body1 and body2. *- Specified by:
getAxis
in interfaceSingleAxisHingeJoint
- Returns:
- value of axis field
-
setAxis
Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named axis.
Tooltip: axis defines vector of joint connection between body1 and body2. *- Specified by:
setAxis
in interfaceSingleAxisHingeJoint
- Parameters:
newValue
- is new value for the axis field.- Returns:
SingleAxisHingeJointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setAxis
Assign typed object value to SFVec3f axis field, similar tosetAxis(float[])
.- Parameters:
newValue
- is new value for the axis field.- Returns:
SingleAxisHingeJointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setAxis
Assign values to SFVec3f axis field, similar tosetAxis(float[])
.- Parameters:
x
- first componenty
- second componentz
- third component- Returns:
SingleAxisHingeJointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setAxis
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetAxis(float[])
.- Parameters:
x
- first componenty
- second componentz
- third component- Returns:
SingleAxisHingeJointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setAxis
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetAxis(float[])
.- Parameters:
newArray
- is new value for field- Returns:
SingleAxisHingeJointObject
- 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:
getBody1
in interfaceSingleAxisHingeJoint
- Specified by:
getBody1
in 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:
setBody1
in interfaceSingleAxisHingeJoint
- Specified by:
setBody1
in interfaceX3DRigidJointNode
- Parameters:
newValue
- is new value for the body1 field.- Returns:
SingleAxisHingeJointObject
- 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:
SingleAxisHingeJointObject
- 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:
SingleAxisHingeJointObject
- 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:
getBody1AnchorPoint
in interfaceSingleAxisHingeJoint
- Returns:
- value of body1AnchorPoint field
-
getBody2
Provide RigidBodyObject instance (using a properly typed node) from inputOutput SFNode field body2.- Specified by:
getBody2
in interfaceSingleAxisHingeJoint
- Specified by:
getBody2
in 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:
setBody2
in interfaceSingleAxisHingeJoint
- Specified by:
setBody2
in interfaceX3DRigidJointNode
- Parameters:
newValue
- is new value for the body2 field.- Returns:
SingleAxisHingeJointObject
- 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:
SingleAxisHingeJointObject
- 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:
SingleAxisHingeJointObject
- 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:
getBody2AnchorPoint
in interfaceSingleAxisHingeJoint
- Returns:
- value of body2AnchorPoint 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:
getForceOutput
in interfaceSingleAxisHingeJoint
- Specified by:
getForceOutput
in 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:
setForceOutput
in interfaceSingleAxisHingeJoint
- Specified by:
setForceOutput
in interfaceX3DRigidJointNode
- Parameters:
newValue
- is new value for the forceOutput field.- Returns:
SingleAxisHingeJointObject
- 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:
SingleAxisHingeJointObject
- 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:
SingleAxisHingeJointObject
- 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:
SingleAxisHingeJointObject
- 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:
SingleAxisHingeJointObject
- 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:
SingleAxisHingeJointObject
- 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:
SingleAxisHingeJointObject
- 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:
SingleAxisHingeJointObject
- 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:
getIS
in classX3DConcreteNode
- Returns:
- value of IS field
- See Also:
- X3D Tooltips: IS, X3D Tooltips: connect
-
setIS
Accessor method to assign ISObject instance (using a properly typed node) to inputOutput SFNode field IS.- Specified by:
setIS
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the IS field.- Returns:
SingleAxisHingeJointObject
- 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:
SingleAxisHingeJointObject
- 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()
-
getMaxAngle
public float getMaxAngle()Provide float value unit axis, angle (in radians) from inputOutput SFFloat field named maxAngle.
Tooltip: [-pi,pi] maxAngle is maximum rotation angle for hinge.- Specified by:
getMaxAngle
in interfaceSingleAxisHingeJoint
- Returns:
- value of maxAngle field
-
setMaxAngle
Accessor method to assign float value unit axis, angle (in radians) to inputOutput SFFloat field named maxAngle.
Tooltip: [-pi,pi] maxAngle is maximum rotation angle for hinge.- Specified by:
setMaxAngle
in interfaceSingleAxisHingeJoint
- Parameters:
newValue
- is new value for the maxAngle field.- Returns:
SingleAxisHingeJointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setMaxAngle
Assign typed object value to SFFloat maxAngle field, similar tosetMaxAngle(float)
.- Parameters:
newValue
- is new value for the maxAngle field.- Returns:
SingleAxisHingeJointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setMaxAngle
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetMaxAngle(float)
.- Parameters:
newValue
- is new value for field- Returns:
SingleAxisHingeJointObject
- 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:
getMetadata
in interfaceSingleAxisHingeJoint
- Specified by:
getMetadata
in interfaceX3DNode
- Specified by:
getMetadata
in 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:
setMetadata
in interfaceSingleAxisHingeJoint
- Specified by:
setMetadata
in interfaceX3DNode
- Specified by:
setMetadata
in interfaceX3DRigidJointNode
- Specified by:
setMetadata
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the metadata field.- Returns:
SingleAxisHingeJointObject
- 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:
SingleAxisHingeJointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setMetadata
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.- Specified by:
setMetadata
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the metadata field.- Returns:
SingleAxisHingeJointObject
- 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
-
getMinAngle
public float getMinAngle()Provide float value unit axis, angle (in radians) from inputOutput SFFloat field named minAngle.
Tooltip: [-pi,pi] minAngle is minimum rotation angle for hinge.- Specified by:
getMinAngle
in interfaceSingleAxisHingeJoint
- Returns:
- value of minAngle field
-
setMinAngle
Accessor method to assign float value unit axis, angle (in radians) to inputOutput SFFloat field named minAngle.
Tooltip: [-pi,pi] minAngle is minimum rotation angle for hinge.- Specified by:
setMinAngle
in interfaceSingleAxisHingeJoint
- Parameters:
newValue
- is new value for the minAngle field.- Returns:
SingleAxisHingeJointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setMinAngle
Assign typed object value to SFFloat minAngle field, similar tosetMinAngle(float)
.- Parameters:
newValue
- is new value for the minAngle field.- Returns:
SingleAxisHingeJointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setMinAngle
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetMinAngle(float)
.- Parameters:
newValue
- is new value for field- Returns:
SingleAxisHingeJointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getStopBounce
public float getStopBounce()Provide float value from inputOutput SFFloat field named stopBounce.
Tooltip: [0,1] stopBounce is velocity factor for bounce back once stop point is reached.- Hint: 0 means no bounce, 1 means return velocity matches.
- Specified by:
getStopBounce
in interfaceSingleAxisHingeJoint
- Returns:
- value of stopBounce field
-
setStopBounce
Accessor method to assign float value to inputOutput SFFloat field named stopBounce.
Tooltip: [0,1] stopBounce is velocity factor for bounce back once stop point is reached.- Hint: 0 means no bounce, 1 means return velocity matches.
- Specified by:
setStopBounce
in interfaceSingleAxisHingeJoint
- Parameters:
newValue
- is new value for the stopBounce field.- Returns:
SingleAxisHingeJointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setStopBounce
Assign typed object value to SFFloat stopBounce field, similar tosetStopBounce(float)
.- Parameters:
newValue
- is new value for the stopBounce field.- Returns:
SingleAxisHingeJointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setStopBounce
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetStopBounce(float)
.- Parameters:
newValue
- is new value for field- Returns:
SingleAxisHingeJointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getStopErrorCorrection
public float getStopErrorCorrection()Provide float value from inputOutput SFFloat field named stopErrorCorrection.
Tooltip: [0,1] stopErrorCorrection 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:
getStopErrorCorrection
in interfaceSingleAxisHingeJoint
- Returns:
- value of stopErrorCorrection field
-
setStopErrorCorrection
Accessor method to assign float value to inputOutput SFFloat field named stopErrorCorrection.
Tooltip: [0,1] stopErrorCorrection 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:
setStopErrorCorrection
in interfaceSingleAxisHingeJoint
- Parameters:
newValue
- is new value for the stopErrorCorrection field.- Returns:
SingleAxisHingeJointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setStopErrorCorrection
Assign typed object value to SFFloat stopErrorCorrection field, similar tosetStopErrorCorrection(float)
.- Parameters:
newValue
- is new value for the stopErrorCorrection field.- Returns:
SingleAxisHingeJointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setStopErrorCorrection
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetStopErrorCorrection(float)
.- Parameters:
newValue
- is new value for field- Returns:
SingleAxisHingeJointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getDEF
public java.lang.String getDEF()Provide String value from inputOutput SFString field named DEF.
Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.- Hint: descriptive DEF names improve clarity and help document a model.
- Hint: well-defined names can simplify design and debugging through improved author understanding.
- Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
- Overrides:
getDEF
in classX3DConcreteNode
- Returns:
- value of DEF field
- See Also:
- X3D Scene Authoring Hints: Naming Conventions
-
setDEF
Accessor method to assign String value to inputOutput SFString field named DEF.
Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.- Hint: descriptive DEF names improve clarity and help document a model.
- Hint: well-defined names can simplify design and debugging through improved author understanding.
- Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
Note that setting the DEF value clears the USE value.- Specified by:
setDEF
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the DEF field.- Returns:
SingleAxisHingeJointObject
- 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:
SingleAxisHingeJointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getUSE
public java.lang.String getUSE()Provide String value from inputOutput SFString field named USE.
Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value).- Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
- Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute.
- Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
- Overrides:
getUSE
in classX3DConcreteNode
- Returns:
- value of USE field
- See Also:
- X3D Scene Authoring Hints: Naming Conventions
-
setUSE
Accessor method to assign String value to inputOutput SFString field named USE.
Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value).- Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
- Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute.
- Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
Note: eachUSE
node is still an independent object, with theUSE
value matching theDEF
value in the preceding object.
Warning: invoking thesetUSE()
method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.
Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.- Specified by:
setUSE
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the USE field.- Returns:
SingleAxisHingeJointObject
- 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:
SingleAxisHingeJointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getCssClass
public java.lang.String getCssClass()Provide String value from inputOutput SFString field named class.
Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.- Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
- Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
- Overrides:
getCssClass
in classX3DConcreteNode
- Returns:
- value of class field
- See Also:
- W3C Cascading Style Sheets
-
setCssClass
Accessor method to assign String value to inputOutput SFString field named class.
Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.- Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
- Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
- Specified by:
setCssClass
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the class field.- Returns:
SingleAxisHingeJointObject
- 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:
SingleAxisHingeJointObject
- 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:
SingleAxisHingeJointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addComments
Add comment as String to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newComment
- initial value- Returns:
SingleAxisHingeJointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
addComments
Add comments as String[] array to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newComments
- array of comments- Returns:
SingleAxisHingeJointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
addComments
Add CommentsBlock to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newCommentsBlock
- block of comments to add- Returns:
SingleAxisHingeJointObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
toStringX3D
public java.lang.String toStringX3D(int indentLevel)Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.- Specified by:
toStringX3D
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- X3D string
- See Also:
X3DObject.FILE_EXTENSION_X3D
,X3DObject.FILE_EXTENSION_XML
,X3DObject.toStringXML()
,X3DObject.toFileXML(String)
,X3DObject.toFileX3D(String)
, X3D XML Encoding, X3D Compressed Binary Encoding: X3D Canonical Form, X3D Canonicalization (C14N) Tool
-
toStringClassicVRML
public java.lang.String toStringClassicVRML(int indentLevel)Recursive method to provide ClassicVRML string serialization.- Specified by:
toStringClassicVRML
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- ClassicVRML string
- See Also:
X3DObject.FILE_EXTENSION_CLASSICVRML
, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Annex A: Grammar
-
toStringVRML97
public java.lang.String toStringVRML97(int indentLevel)Recursive method to provide VRML97 string serialization.- Specified by:
toStringVRML97
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- VRML97 string
- See Also:
X3DObject.FILE_EXTENSION_VRML97
, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Virtual Reality Modeling Language (VRML) 97 specification, VRML 97 v2.1 Amendment
-
findElementByNameValue
Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.
Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.
Warning: more than one element may be found that has the same name, this method does not handle that case.- Specified by:
findElementByNameValue
in classX3DConcreteElement
- Parameters:
nameValue
- is value of the name field being searched for in this element and child elements(if any)- Returns:
- object reference to found element, null otherwise
- See Also:
findNodeByDEF(String)
,X3DConcreteElement.hasAncestorSceneObject()
,X3DConcreteElement.findAncestorX3DObject()
-
findElementByNameValue
public X3DConcreteElement findElementByNameValue(java.lang.String nameValue, java.lang.String elementName)Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.
Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.
Warning: more than one element may be found that has the same name, this method does not handle that case.- Specified by:
findElementByNameValue
in classX3DConcreteElement
- Parameters:
nameValue
- is value of the name field being searched for in this element and child elements(if any)elementName
- identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)- Returns:
- object reference to found element, null otherwise
- See Also:
findNodeByDEF(String)
,X3DConcreteElement.hasAncestorSceneObject()
,X3DConcreteElement.findAncestorX3DObject()
-
hasElementByNameValue
public boolean hasElementByNameValue(java.lang.String nameValue, java.lang.String elementName)Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.- Parameters:
nameValue
- is value of the name field being searched for in this element and child elements(if any)elementName
- identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)- Returns:
- whether node is found
- See Also:
findElementByNameValue(String, String)
-
findNodeByDEF
Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.
Warning: more than one element may be found that has the same DEF, this method does not handle that case.- Specified by:
findNodeByDEF
in classX3DConcreteElement
- Parameters:
DEFvalue
- is value of the name field being searched for in this element and child elements(if any)- Returns:
- object reference to found node, null otherwise
- See Also:
findElementByNameValue(String)
,X3DConcreteElement.hasAncestorSceneObject()
,X3DConcreteElement.findAncestorX3DObject()
-
hasNodeByDEF
public boolean hasNodeByDEF(java.lang.String DEFvalue)Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.- Parameters:
DEFvalue
- is value of the name field being searched for in this element and child elements(if any)- Returns:
- whether node is found
- See Also:
findNodeByDEF(String)
-
validate
public java.lang.String validate()Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.- Specified by:
validate
in classX3DConcreteElement
- Returns:
- validation results (if any)
-