Class UniversalJoint
java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.RigidBodyPhysics.UniversalJoint
- All Implemented Interfaces:
X3DNode
,UniversalJoint
,X3DRigidJointNode
UniversalJoint is like a BallJoint that constrains an extra degree of rotational freedom.
Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the
Package hint: This org.web3d.x3d.jsail concrete class is used for implementing a standalone X3D object as a Plain Old Java Object (POJO). If you are writing Java code for use inside an X3D Script node, compile separate code using only the org.web3d.x3d.sai package instead.
Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the
org.web3d.x3d.jsail
classes.
UniversalJoint 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.
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final float[]
SFVec3f field named anchorPoint has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).static final float[]
SFVec3f field named axis1 has default value {1f,0f,0f} (Java syntax) or 1 0 0 (XML syntax).static final float[]
SFVec3f field named axis2 has default value {0f,1f,0f} (Java syntax) or 0 1 0 (XML syntax).static final RigidBody
SFNode field named body1 has default value null (Java syntax) or NULL (XML syntax).static final RigidBody
SFNode field named body2 has default value null (Java syntax) or NULL (XML syntax).static final String
String constant COMPONENT defines X3D component for the UniversalJoint element: RigidBodyPhysicsstatic final String
containerField describes typical field relationship of a node to its parent.static final String
Tooltip: all forceOutput fields computed.MFString field named forceOutput has default quoted value new String[] {"NONE"} (Java syntax) or quoted value "NONE" (XML syntax).static final String
Tooltip: no forceOutput fields computed.static final String
fromField ROUTE name for SFVec3f field named anchorPoint.static final String
fromField ROUTE name for SFVec3f field named axis1.static final String
fromField ROUTE name for SFVec3f field named axis2.static final String
fromField ROUTE name for SFNode field named body1.static final String
fromField ROUTE name for SFVec3f field named body1AnchorPoint.static final String
fromField ROUTE name for SFVec3f field named body1Axis.static final String
fromField ROUTE name for SFNode field named body2.static final String
fromField ROUTE name for SFVec3f field named body2AnchorPoint.static final String
fromField ROUTE name for SFVec3f field named body2Axis.static final String
fromField ROUTE name for MFString field named forceOutput.static final String
fromField ROUTE name for SFNode field named IS.static final String
fromField ROUTE name for SFNode field named metadata.static final String
fromField ROUTE name for SFFloat field named stop1Bounce.static final String
fromField ROUTE name for SFFloat field named stop1ErrorCorrection.static final String
fromField ROUTE name for SFFloat field named stop2Bounce.static final String
fromField ROUTE name for SFFloat field named stop2ErrorCorrection.static final IS
SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).static final int
Integer constant LEVEL provides default X3D RigidBodyPhysics component level for this element: 2static final X3DMetadataObject
SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).static final String
String constant NAME provides name of this element: UniversalJoint.static final float
SFFloat field named stop1Bounce has default value 0f (Java syntax) or 0 (XML syntax).static final float
SFFloat field named stop1ErrorCorrection has default value 0.8f (Java syntax) or 0.8 (XML syntax).static final float
SFFloat field named stop2Bounce has default value 0f (Java syntax) or 0 (XML syntax).static final float
SFFloat field named stop2ErrorCorrection has default value 0.8f (Java syntax) or 0.8 (XML syntax).static final String
toField ROUTE name for SFVec3f field named anchorPoint.static final String
toField ROUTE name for SFVec3f field named axis1.static final String
toField ROUTE name for SFVec3f field named axis2.static final String
toField ROUTE name for SFNode field named body1.static final String
toField ROUTE name for SFNode field named body2.static final String
toField ROUTE name for MFString field named forceOutput.static final String
toField ROUTE name for SFNode field named metadata.static final String
toField ROUTE name for SFFloat field named stop1Bounce.static final String
toField ROUTE name for SFFloat field named stop1ErrorCorrection.static final String
toField ROUTE name for SFFloat field named stop2Bounce.static final String
toField ROUTE name for SFFloat field named stop2ErrorCorrection.Fields inherited from class org.web3d.x3d.jsail.X3DConcreteNode
containerField_ALLOWED_VALUES, containerFieldOverride, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE
Fields inherited from class org.web3d.x3d.jsail.X3DConcreteElement
CLASS_DEFAULT_VALUE, ID_DEFAULT_VALUE, STYLE_DEFAULT_VALUE, validationResult
-
Constructor Summary
ConstructorDescriptionConstructor for UniversalJoint to initialize member variables with default values.UniversalJoint
(String DEFlabel) Utility constructor that assigns DEF label after initializing member variables with default values. -
Method Summary
Modifier and TypeMethodDescriptionaddComments
(String newComment) Add comment as String to contained commentsList.addComments
(String[] newComments) Add comments as String[] array to contained commentsList.addComments
(CommentsBlock newCommentsBlock) Add CommentsBlock to contained commentsList.addForceOutput
(String newValue) Add singleton String value to MFString forceOutput field.addForceOutput
(SFString newValue) Add singleton SFString value to MFString forceOutput field.Utility method to clear SFNode value of body1 field.Utility method to clear SFNode value of body2 field.Utility method to clear MFString value of forceOutput field.clearIS()
Utility method to clear SFNode value of IS field.Utility method to clear SFNode value of metadata field.findElementByNameValue
(String nameValue) Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.findElementByNameValue
(String nameValue, String elementName) Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.findNodeByDEF
(String DEFvalue) Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.getAccessType
(String fieldName) Indicate accessType corresponding to given fieldName.float[]
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.getBody1()
Provide org.web3d.x3d.sai.RigidBodyPhysics.RigidBody instance (using a properly typed node) from inputOutput SFNode field body1.float[]
Provide array of 3-tuple float results from outputOnly SFVec3f field named body1AnchorPoint.float[]
Provide array of 3-tuple float results from outputOnly SFVec3f field named body1Axis.getBody2()
Provide org.web3d.x3d.sai.RigidBodyPhysics.RigidBody instance (using a properly typed node) from inputOutput SFNode field body2.float[]
Provide array of 3-tuple float results from outputOnly SFVec3f field named body2AnchorPoint.float[]
Provide array of 3-tuple float results from outputOnly SFVec3f field named body2Axis.final String
Defines X3D component for the UniversalJoint element: RigidBodyPhysicsfinal int
Provides default X3D component level for this element: 2final String
containerField describes typical field relationship of a node to its parent.Provide String value from inputOutput SFString field named class.Provide String value from inputOutput SFString field named style.getDEF()
Provide String value from inputOutput SFString field named DEF.final String
Provides name of this element: UniversalJointgetFieldType
(String fieldName) Indicate type corresponding to given fieldName.String[]
Provide array of String enumeration results (baseType MFString) ['"ALL"' | '"NONE"' | '"etc."'] from inputOutput MFString field named forceOutput.Utility method to get ArrayList value of MFString forceOutput field, similar togetForceOutput()
.Utility method to get String value of MFString forceOutput field, similar togetForceOutput()
.Provide String value from inputOutput SFString field named id.getIS()
Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.float
Provide float value within allowed range of [0,1] from inputOutput SFFloat field named stop1Bounce.float
Provide float value within allowed range of [0,1] from inputOutput SFFloat field named stop1ErrorCorrection.float
Provide float value within allowed range of [0,1] from inputOutput SFFloat field named stop2Bounce.float
Provide float value within allowed range of [0,1] from inputOutput SFFloat field named stop2ErrorCorrection.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
(String nameValue, String elementName) Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.boolean
hasIS()
Indicate whether an object is available for inputOutput SFNode field IS.boolean
Indicate whether an object is available for inputOutput SFNode field metadata.boolean
hasNodeByDEF
(String DEFvalue) Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.final void
Initialize all member variables to default values.setAnchorPoint
(double[] newArray) Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetAnchorPoint(float[])
.setAnchorPoint
(double x, double y, double z) Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetAnchorPoint(float[])
.setAnchorPoint
(float[] newValue) Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named anchorPoint.setAnchorPoint
(float x, float y, float z) Assign values to SFVec3f anchorPoint field, similar tosetAnchorPoint(float[])
.setAnchorPoint
(SFVec3f newValue) Assign typed object value to SFVec3f anchorPoint field, similar tosetAnchorPoint(float[])
.setAxis1
(double[] newArray) Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetAxis1(float[])
.setAxis1
(double x, double y, double z) Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetAxis1(float[])
.setAxis1
(float[] newValue) Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named axis1.setAxis1
(float x, float y, float z) Assign values to SFVec3f axis1 field, similar tosetAxis1(float[])
.Assign typed object value to SFVec3f axis1 field, similar tosetAxis1(float[])
.setAxis2
(double[] newArray) Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetAxis2(float[])
.setAxis2
(double x, double y, double z) Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetAxis2(float[])
.setAxis2
(float[] newValue) Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named axis2.setAxis2
(float x, float y, float z) Assign values to SFVec3f axis2 field, similar tosetAxis2(float[])
.Assign typed object value to SFVec3f axis2 field, similar tosetAxis2(float[])
.setBody1
(ProtoInstance newValue) Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field body1.Accessor method to assign org.web3d.x3d.sai.RigidBodyPhysics.RigidBody instance (using a properly typed node) to inputOutput SFNode field body1.setBody2
(ProtoInstance newValue) Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field body2.Accessor method to assign org.web3d.x3d.sai.RigidBodyPhysics.RigidBody instance (using a properly typed node) to inputOutput SFNode field body2.final UniversalJoint
setCssClass
(String newValue) Accessor method to assign String value to inputOutput SFString field named class.setCssClass
(SFString newValue) Assign typed object value to SFString cssClass field, similar tosetCssClass(String)
.final UniversalJoint
setCssStyle
(String newValue) Accessor method to assign String value to inputOutput SFString field named style.setCssStyle
(SFString newValue) Assign typed object value to SFString cssClass field, similar tosetCssStyle(String)
.final UniversalJoint
Accessor method to assign String value to inputOutput SFString field named DEF.Assign typed object value to SFString DEF field, similar tosetDEF(String)
.setForceOutput
(String newValue) Assign singleton String value to MFString forceOutput field, similar tosetForceOutput(String[])
.setForceOutput
(String[] newValue) Accessor method to assign String enumeration array (""ALL"" | ""NONE"") to inputOutput MFString field named forceOutput.setForceOutput
(ArrayList<String> newValue) Assign ArrayList value of MFString forceOutput field, similar tosetForceOutput(String[])
.setForceOutput
(MFString newValue) Assign typed object value to MFString forceOutput field, similar tosetForceOutput(String[])
.setForceOutput
(SFString newValue) Assign single SFString object value to MFString forceOutput field, similar tosetForceOutput(String[])
.final UniversalJoint
Accessor method to assign String value to inputOutput SFString field named id.Assign typed object value to SFString HtmlID field, similar tosetHtmlID(String)
.Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.setMetadata
(ProtoInstance newValue) Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.setMetadata
(X3DMetadataObject newValue) Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.setStop1Bounce
(double newValue) Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetStop1Bounce(float)
.setStop1Bounce
(float newValue) Accessor method to assign float value to inputOutput SFFloat field named stop1Bounce.setStop1Bounce
(SFFloat newValue) Assign typed object value to SFFloat stop1Bounce field, similar tosetStop1Bounce(float)
.setStop1ErrorCorrection
(double newValue) Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetStop1ErrorCorrection(float)
.setStop1ErrorCorrection
(float newValue) Accessor method to assign float value to inputOutput SFFloat field named stop1ErrorCorrection.setStop1ErrorCorrection
(SFFloat newValue) Assign typed object value to SFFloat stop1ErrorCorrection field, similar tosetStop1ErrorCorrection(float)
.setStop2Bounce
(double newValue) Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetStop2Bounce(float)
.setStop2Bounce
(float newValue) Accessor method to assign float value to inputOutput SFFloat field named stop2Bounce.setStop2Bounce
(SFFloat newValue) Assign typed object value to SFFloat stop2Bounce field, similar tosetStop2Bounce(float)
.setStop2ErrorCorrection
(double newValue) Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetStop2ErrorCorrection(float)
.setStop2ErrorCorrection
(float newValue) Accessor method to assign float value to inputOutput SFFloat field named stop2ErrorCorrection.setStop2ErrorCorrection
(SFFloat newValue) Assign typed object value to SFFloat stop2ErrorCorrection field, similar tosetStop2ErrorCorrection(float)
.final UniversalJoint
Accessor method to assign String value to inputOutput SFString field named USE.Assign typed object value to SFString USE field, similar tosetUSE(String)
.setUSE
(UniversalJoint DEFnode) Assign a USE reference to another DEF node of same node type, similar tosetUSE(String)
.toStringClassicVRML
(int indentLevel) Recursive method to provide ClassicVRML string serialization.toStringVRML97
(int indentLevel) Recursive method to provide VRML97 string serialization.toStringX3D
(int indentLevel) Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.validate()
Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.Methods inherited from class org.web3d.x3d.jsail.X3DConcreteNode
getContainerFieldAllowedValues, getContainerFieldOverride, getName, hasDEF, hasNameField, hasUSE, includesNameField, isNode, isStatement, resetContainerFieldOverride, setConcreteDEF, setConcreteUSE, setContainerFieldOverride
Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement
addComments, clearParent, findAncestorElementByName, findAncestorProtoBody, findAncestorScene, findAncestorX3D, getPackageName, getParent, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorScene, hasAncestorX3D, hasParent, isValid, setConcreteCssClass, setConcreteCssStyle, setConcreteHtmlID, setParent, toStringClassicVRML, toStringVRML97, toStringX3D
-
Field Details
-
FORCEOUTPUT_ALL
Tooltip: 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).- See Also:
-
FORCEOUTPUT_NONE
Tooltip: 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).- See Also:
-
NAME
String constant NAME provides name of this element: UniversalJoint.- See Also:
-
COMPONENT
String constant COMPONENT defines X3D component for the UniversalJoint element: RigidBodyPhysics- See Also:
-
LEVEL
public static final int LEVELInteger constant LEVEL provides default X3D RigidBodyPhysics component level for this element: 2- See Also:
-
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 {1f,0f,0f} (Java syntax) or 1 0 0 (XML syntax). -
AXIS2_DEFAULT_VALUE
public static final float[] AXIS2_DEFAULT_VALUESFVec3f field named axis2 has default value {0f,1f,0f} (Java syntax) or 0 1 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
-
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:
-
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:
-
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:
-
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:
-
containerField_DEFAULT_VALUE
containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, this default value is provided for informational purposes only.
containerField_DEFAULT_VALUE = "joints";
containerField_ALLOWED_VALUES = {"joints" }; type xs:NMTOKEN- See Also:
-
fromField_ANCHORPOINT
fromField ROUTE name for SFVec3f field named anchorPoint.- See Also:
-
toField_ANCHORPOINT
toField ROUTE name for SFVec3f field named anchorPoint.- See Also:
-
fromField_AXIS1
fromField ROUTE name for SFVec3f field named axis1.- See Also:
-
toField_AXIS1
toField ROUTE name for SFVec3f field named axis1.- See Also:
-
fromField_AXIS2
fromField ROUTE name for SFVec3f field named axis2.- See Also:
-
toField_AXIS2
toField ROUTE name for SFVec3f field named axis2.- See Also:
-
fromField_BODY1
fromField ROUTE name for SFNode field named body1.- See Also:
-
toField_BODY1
-
fromField_BODY1ANCHORPOINT
fromField ROUTE name for SFVec3f field named body1AnchorPoint.- See Also:
-
fromField_BODY1AXIS
fromField ROUTE name for SFVec3f field named body1Axis.- See Also:
-
fromField_BODY2
fromField ROUTE name for SFNode field named body2.- See Also:
-
toField_BODY2
-
fromField_BODY2ANCHORPOINT
fromField ROUTE name for SFVec3f field named body2AnchorPoint.- See Also:
-
fromField_BODY2AXIS
fromField ROUTE name for SFVec3f field named body2Axis.- See Also:
-
fromField_FORCEOUTPUT
fromField ROUTE name for MFString field named forceOutput.- See Also:
-
toField_FORCEOUTPUT
toField ROUTE name for MFString field named forceOutput.- See Also:
-
fromField_IS
-
fromField_METADATA
fromField ROUTE name for SFNode field named metadata.- See Also:
-
toField_METADATA
toField ROUTE name for SFNode field named metadata.- See Also:
-
fromField_STOP1BOUNCE
fromField ROUTE name for SFFloat field named stop1Bounce.- See Also:
-
toField_STOP1BOUNCE
toField ROUTE name for SFFloat field named stop1Bounce.- See Also:
-
fromField_STOP1ERRORCORRECTION
fromField ROUTE name for SFFloat field named stop1ErrorCorrection.- See Also:
-
toField_STOP1ERRORCORRECTION
toField ROUTE name for SFFloat field named stop1ErrorCorrection.- See Also:
-
fromField_STOP2BOUNCE
fromField ROUTE name for SFFloat field named stop2Bounce.- See Also:
-
toField_STOP2BOUNCE
toField ROUTE name for SFFloat field named stop2Bounce.- See Also:
-
fromField_STOP2ERRORCORRECTION
fromField ROUTE name for SFFloat field named stop2ErrorCorrection.- See Also:
-
toField_STOP2ERRORCORRECTION
toField ROUTE name for SFFloat field named stop2ErrorCorrection.- See Also:
-
-
Constructor Details
-
UniversalJoint
public UniversalJoint()Constructor for UniversalJoint to initialize member variables with default values. -
UniversalJoint
Utility constructor that assigns DEF label after initializing member variables with default values.- Parameters:
DEFlabel
- unique DEF name for this X3D node
-
-
Method Details
-
getElementName
Provides name of this element: UniversalJoint- Specified by:
getElementName
in classX3DConcreteElement
- Returns:
- name of this element
-
getComponent
Defines X3D component for the UniversalJoint element: RigidBodyPhysics- Specified by:
getComponent
in classX3DConcreteElement
- Returns:
- X3D component for this element
-
getComponentLevel
public final int getComponentLevel()Provides default X3D component level for this element: 2- Specified by:
getComponentLevel
in classX3DConcreteElement
- Returns:
- default X3D component level for this element
-
getFieldType
Indicate type corresponding to given fieldName.- Specified by:
getFieldType
in classX3DConcreteElement
- Parameters:
fieldName
- name of field in this X3D node- Returns:
- X3D type (SFvec3f etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE if not recognized
- See Also:
-
getAccessType
Indicate accessType corresponding to given fieldName.- Specified by:
getAccessType
in classX3DConcreteElement
- Parameters:
fieldName
- name of field in this X3D node- Returns:
- X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized
- See Also:
-
getContainerFieldDefault
containerField describes typical field relationship of a node to its parent. Programmer usage is not ordinarily needed when using this API, since this default value is provided for informational purposes only.- Specified by:
getContainerFieldDefault
in classX3DConcreteNode
- Returns:
- default containerField value
- See Also:
-
initialize
public final void initialize()Initialize all member variables to default values.- Overrides:
initialize
in classX3DConcreteNode
-
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 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:
setAnchorPoint
in interfaceUniversalJoint
- Parameters:
newValue
- is new value for the anchorPoint field.- Returns:
UniversalJoint
- 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:
UniversalJoint
- 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:
UniversalJoint
- 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:
UniversalJoint
- 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:
UniversalJoint
- 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 about this axis.
- Specified by:
getAxis1
in 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 about this axis.
- Specified by:
setAxis1
in interfaceUniversalJoint
- Parameters:
newValue
- is new value for the axis1 field.- Returns:
UniversalJoint
- 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:
UniversalJoint
- 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:
UniversalJoint
- 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:
UniversalJoint
- 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:
UniversalJoint
- 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 about this axis.
- Specified by:
getAxis2
in 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 about this axis.
- Specified by:
setAxis2
in interfaceUniversalJoint
- Parameters:
newValue
- is new value for the axis2 field.- Returns:
UniversalJoint
- 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:
UniversalJoint
- 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:
UniversalJoint
- 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:
UniversalJoint
- 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:
UniversalJoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getBody1
Provide org.web3d.x3d.sai.RigidBodyPhysics.RigidBody instance (using a properly typed node) from inputOutput SFNode field body1.- Specified by:
getBody1
in interfaceUniversalJoint
- Specified by:
getBody1
in interfaceX3DRigidJointNode
- Returns:
- value of body1 field
- See Also:
-
setBody1
Accessor method to assign org.web3d.x3d.sai.RigidBodyPhysics.RigidBody instance (using a properly typed node) to inputOutput SFNode field body1.- Specified by:
setBody1
in interfaceUniversalJoint
- Specified by:
setBody1
in interfaceX3DRigidJointNode
- Parameters:
newValue
- is new value for the body1 field.- Returns:
UniversalJoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
clearBody1
Utility method to clear SFNode value of body1 field.- Returns:
UniversalJoint
- 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:
UniversalJoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
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:
-
getBody1AnchorPoint
public float[] getBody1AnchorPoint()Provide array of 3-tuple float results from outputOnly SFVec3f field named body1AnchorPoint.
Tooltip: body1AnchorPoint describes anchorPoint position relative to local coordinate reference frame.- Hint: can detect separation if body1AnchorPoint!=body2AnchorPoint.
- Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
- Specified by:
getBody1AnchorPoint
in interfaceUniversalJoint
- Returns:
- value of body1AnchorPoint field
-
getBody1Axis
public float[] getBody1Axis()Provide array of 3-tuple float results from outputOnly SFVec3f field named body1Axis.
Tooltip: body1Axis describes report the current location of the anchor point relative to the corresponding body. This can be used to determine if the joint has broken.- Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
- Specified by:
getBody1Axis
in interfaceUniversalJoint
- Returns:
- value of body1Axis field
-
getBody2
Provide org.web3d.x3d.sai.RigidBodyPhysics.RigidBody instance (using a properly typed node) from inputOutput SFNode field body2.- Specified by:
getBody2
in interfaceUniversalJoint
- Specified by:
getBody2
in interfaceX3DRigidJointNode
- Returns:
- value of body2 field
- See Also:
-
setBody2
Accessor method to assign org.web3d.x3d.sai.RigidBodyPhysics.RigidBody instance (using a properly typed node) to inputOutput SFNode field body2.- Specified by:
setBody2
in interfaceUniversalJoint
- Specified by:
setBody2
in interfaceX3DRigidJointNode
- Parameters:
newValue
- is new value for the body2 field.- Returns:
UniversalJoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
clearBody2
Utility method to clear SFNode value of body2 field.- Returns:
UniversalJoint
- 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:
UniversalJoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
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:
-
getBody2AnchorPoint
public float[] getBody2AnchorPoint()Provide array of 3-tuple float results from outputOnly SFVec3f field named body2AnchorPoint.
Tooltip: body2AnchorPoint describes anchorPoint position relative to local coordinate reference frame.- Hint: can detect separation if body1AnchorPoint!=body2AnchorPoint.
- Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
- Specified by:
getBody2AnchorPoint
in interfaceUniversalJoint
- Returns:
- value of body2AnchorPoint field
-
getBody2Axis
public float[] getBody2Axis()Provide array of 3-tuple float results from outputOnly SFVec3f field named body2Axis.
Tooltip: body1Axis describes report the current location of the anchor point relative to the corresponding body. This can be used to determine if the joint has broken.- Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
- Specified by:
getBody2Axis
in interfaceUniversalJoint
- Returns:
- value of body2Axis field
-
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 interfaceUniversalJoint
- Specified by:
getForceOutput
in interfaceX3DRigidJointNode
- Returns:
- value of forceOutput field
-
getForceOutputList
Utility method to get ArrayList value of MFString forceOutput field, similar togetForceOutput()
.- Returns:
- value of forceOutput field
-
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 interfaceUniversalJoint
- Specified by:
setForceOutput
in interfaceX3DRigidJointNode
- Parameters:
newValue
- is new value for the forceOutput field.- Returns:
UniversalJoint
- 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:
UniversalJoint
- 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:
UniversalJoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
setForceOutput
Assign singleton String value to MFString forceOutput field, similar tosetForceOutput(String[])
.- Parameters:
newValue
- is new value for the forceOutput field.- Returns:
UniversalJoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
setForceOutput
Assign ArrayList value of MFString forceOutput field, similar tosetForceOutput(String[])
.- Parameters:
newValue
- is new value for the forceOutput field.- Returns:
UniversalJoint
- 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. This method does not initialize withFORCEOUTPUT_DEFAULT_VALUE.- Returns:
UniversalJoint
- 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:
UniversalJoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
addForceOutput
Add singleton SFString value to MFString forceOutput field.- Parameters:
newValue
- is new value to add to the forceOutput field.- Returns:
UniversalJoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
getIS
Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.- Specified by:
getIS
in classX3DConcreteNode
- Returns:
- value of IS field
- See Also:
-
setIS
Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.- Specified by:
setIS
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the IS field.- Returns:
UniversalJoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
clearIS
Utility method to clear SFNode value of IS field.- Returns:
UniversalJoint
- 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:
-
getMetadata
Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.- Specified by:
getMetadata
in interfaceUniversalJoint
- Specified by:
getMetadata
in interfaceX3DNode
- Specified by:
getMetadata
in interfaceX3DRigidJointNode
- Returns:
- value of metadata field
- See Also:
-
setMetadata
Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.- Specified by:
setMetadata
in interfaceUniversalJoint
- 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:
UniversalJoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
clearMetadata
Utility method to clear SFNode value of metadata field.- Returns:
UniversalJoint
- 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:
UniversalJoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
hasMetadata
public boolean hasMetadata()Indicate whether an object is available for inputOutput SFNode field metadata.- Returns:
- whether a properly typed node or ProtoInstance or CommentsBlock is available.
- See Also:
-
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:
getStop1Bounce
in 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:
setStop1Bounce
in interfaceUniversalJoint
- Parameters:
newValue
- is new value for the stop1Bounce field.- Returns:
UniversalJoint
- 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:
UniversalJoint
- 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:
UniversalJoint
- 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:
getStop1ErrorCorrection
in 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:
setStop1ErrorCorrection
in interfaceUniversalJoint
- Parameters:
newValue
- is new value for the stop1ErrorCorrection field.- Returns:
UniversalJoint
- 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:
UniversalJoint
- 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:
UniversalJoint
- 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:
getStop2Bounce
in 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:
setStop2Bounce
in interfaceUniversalJoint
- Parameters:
newValue
- is new value for the stop2Bounce field.- Returns:
UniversalJoint
- 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:
UniversalJoint
- 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:
UniversalJoint
- 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:
getStop2ErrorCorrection
in 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:
setStop2ErrorCorrection
in interfaceUniversalJoint
- Parameters:
newValue
- is new value for the stop2ErrorCorrection field.- Returns:
UniversalJoint
- 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:
UniversalJoint
- 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:
UniversalJoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getDEF
Provide String value from inputOutput SFString field named DEF.
Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.- Hint: descriptive DEF names improve clarity and help document a model.
- Hint: well-defined names can simplify design and debugging through improved author understanding.
- Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
- Overrides:
getDEF
in classX3DConcreteNode
- Returns:
- value of DEF field
- See Also:
-
setDEF
Accessor method to assign String value to inputOutput SFString field named DEF.
Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.- Hint: descriptive DEF names improve clarity and help document a model.
- Hint: well-defined names can simplify design and debugging through improved author understanding.
- Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
Note that setting the DEF value clears the USE value.- Specified by:
setDEF
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the DEF field.- Returns:
UniversalJoint
- 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:
UniversalJoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getUSE
Provide String value from inputOutput SFString field named USE.
Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value).- Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
- Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute.
- Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
- Overrides:
getUSE
in classX3DConcreteNode
- Returns:
- value of USE field
- See Also:
-
setUSE
Accessor method to assign String value to inputOutput SFString field named USE.
Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value).- Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
- Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute.
- Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
Note: eachUSE
node is still an independent object, with theUSE
value matching theDEF
value in the preceding object.
Warning: invoking thesetUSE()
method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.
Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.- Specified by:
setUSE
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the USE field.- Returns:
UniversalJoint
- 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:
UniversalJoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getCssClass
Provide String value from inputOutput SFString field named class.- Overrides:
getCssClass
in classX3DConcreteElement
- Returns:
- value of class field
- See Also:
-
setCssClass
Accessor method to assign String value to inputOutput SFString field named class.- Specified by:
setCssClass
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the class field.- Returns:
UniversalJoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
setCssClass
Assign typed object value to SFString cssClass field, similar tosetCssClass(String)
.- Parameters:
newValue
- is new value for the class field.- Returns:
UniversalJoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getHtmlID
Provide String value from inputOutput SFString field named id.- Overrides:
getHtmlID
in classX3DConcreteElement
- Returns:
- value of id field
- See Also:
-
setHtmlID
Accessor method to assign String value to inputOutput SFString field named id.- Specified by:
setHtmlID
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the id field.- Returns:
UniversalJoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
setHtmlID
Assign typed object value to SFString HtmlID field, similar tosetHtmlID(String)
.- Parameters:
newValue
- is new value for the id field.- Returns:
UniversalJoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getCssStyle
Provide String value from inputOutput SFString field named style.- Overrides:
getCssStyle
in classX3DConcreteElement
- Returns:
- value of style field
- See Also:
-
setCssStyle
Accessor method to assign String value to inputOutput SFString field named style.- Specified by:
setCssStyle
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the style field.- Returns:
UniversalJoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
setCssStyle
Assign typed object value to SFString cssClass field, similar tosetCssStyle(String)
.- Parameters:
newValue
- is new value for the style field.- Returns:
UniversalJoint
- 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:
UniversalJoint
- 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:
UniversalJoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
addComments
Add comments as String[] array to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newComments
- array of comments- Returns:
UniversalJoint
- 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:
UniversalJoint
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
toStringX3D
Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.- Specified by:
toStringX3D
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- X3D string
- See Also:
-
toStringClassicVRML
Recursive method to provide ClassicVRML string serialization.- Specified by:
toStringClassicVRML
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- ClassicVRML string
- See Also:
-
toStringVRML97
Recursive method to provide VRML97 string serialization.- Specified by:
toStringVRML97
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- VRML97 string
- See Also:
-
findElementByNameValue
Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.
Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.
Warning: more than one element may be found that has the same name, this method does not handle that case.- Specified by:
findElementByNameValue
in classX3DConcreteElement
- Parameters:
nameValue
- is value of the name field being searched for in this element and child elements(if any)- Returns:
- object reference to found element, null otherwise
- See Also:
-
findElementByNameValue
Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.
Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.
Warning: more than one element may be found that has the same name, this method does not handle that case.- Specified by:
findElementByNameValue
in classX3DConcreteElement
- Parameters:
nameValue
- is value of the name field being searched for in this element and child elements(if any)elementName
- identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)- Returns:
- object reference to found element, null otherwise
- See Also:
-
hasElementByNameValue
Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.- Parameters:
nameValue
- is value of the name field being searched for in this element and child elements(if any)elementName
- identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)- Returns:
- whether node is found
- See Also:
-
findNodeByDEF
Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.
Warning: more than one element may be found that has the same DEF, this method does not handle that case.- Specified by:
findNodeByDEF
in classX3DConcreteElement
- Parameters:
DEFvalue
- is value of the name field being searched for in this element and child elements(if any)- Returns:
- object reference to found node, null otherwise
- See Also:
-
hasNodeByDEF
Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.- Parameters:
DEFvalue
- is value of the name field being searched for in this element and child elements(if any)- Returns:
- whether node is found
- See Also:
-
validate
Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values. TODO document specific validation methods.- Specified by:
validate
in classX3DConcreteElement
- Returns:
- validation results (if any)
-