Class SliderJoint
java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.RigidBodyPhysics.SliderJoint
- All Implemented Interfaces:
X3DNode
,SliderJoint
,X3DRigidJointNode
SliderJoint constrains all movement between body1 and body2 along a single axis. Contains two RigidBody nodes (containerField values body1, body2).
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.
SliderJoint node tooltip: (X3D version 3.2 or later) [X3DRigidJointNode] SliderJoint constrains all movement between body1 and body2 along a single axis. 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.
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final float[]
SFVec3f field named axis 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 SliderJoint 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 axis.static final String
fromField ROUTE name for SFNode field named body1.static final String
fromField ROUTE name for SFNode field named body2.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 SFFloat field named maxSeparation.static final String
fromField ROUTE name for SFNode field named metadata.static final String
fromField ROUTE name for SFFloat field named minSeparation.static final String
fromField ROUTE name for SFFloat field named separation.static final String
fromField ROUTE name for SFFloat field named separationRate.static final String
fromField ROUTE name for SFFloat field named sliderForce.static final String
fromField ROUTE name for SFFloat field named stopBounce.static final String
fromField ROUTE name for SFFloat field named stopErrorCorrection.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 float
SFFloat field named maxSeparation has default value 1f (Java syntax) or 1 (XML syntax).static final X3DMetadataObject
SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).static final float
SFFloat field named minSeparation has default value 0f (Java syntax) or 0 (XML syntax).static final String
String constant NAME provides name of this element: SliderJoint.static final float
SFFloat field named sliderForce has default value 0f (Java syntax) or 0 (XML syntax).static final float
SFFloat field named stopBounce has default value 0f (Java syntax) or 0 (XML syntax).static final float
SFFloat field named stopErrorCorrection has default value 1f (Java syntax) or 1 (XML syntax).static final String
toField ROUTE name for SFVec3f field named axis.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 SFFloat field named maxSeparation.static final String
toField ROUTE name for SFNode field named metadata.static final String
toField ROUTE name for SFFloat field named minSeparation.static final String
toField ROUTE name for SFFloat field named sliderForce.static final String
toField ROUTE name for SFFloat field named stopBounce.static final String
toField ROUTE name for SFFloat field named stopErrorCorrection.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 SliderJoint to initialize member variables with default values.SliderJoint
(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[]
getAxis()
Provide array of 3-tuple float results from inputOutput SFVec3f field named axis.getBody1()
Provide org.web3d.x3d.sai.RigidBodyPhysics.RigidBody instance (using a properly typed node) from inputOutput SFNode field body1.getBody2()
Provide org.web3d.x3d.sai.RigidBodyPhysics.RigidBody instance (using a properly typed node) from inputOutput SFNode field body2.final String
Defines X3D component for the SliderJoint 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: SliderJointgetFieldType
(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.float
Provide float value from inputOutput SFFloat field named maxSeparation.Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.float
Provide float value from inputOutput SFFloat field named minSeparation.float
Provide float value from outputOnly SFFloat field named separation.float
Provide float value from outputOnly SFFloat field named separationRate.float
Provide float value from inputOutput SFFloat field named sliderForce.float
Provide float value from inputOutput SFFloat field named stopBounce.float
Provide float value from inputOutput SFFloat field named stopErrorCorrection.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.setAxis
(double[] newArray) Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetAxis(float[])
.setAxis
(double x, double y, double z) Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetAxis(float[])
.setAxis
(float[] newValue) Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named axis.setAxis
(float x, float y, float z) Assign values to SFVec3f axis field, similar tosetAxis(float[])
.Assign typed object value to SFVec3f axis field, similar tosetAxis(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 SliderJoint
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 SliderJoint
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 SliderJoint
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 SliderJoint
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.setMaxSeparation
(double newValue) Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetMaxSeparation(float)
.setMaxSeparation
(float newValue) Accessor method to assign float value to inputOutput SFFloat field named maxSeparation.setMaxSeparation
(SFFloat newValue) Assign typed object value to SFFloat maxSeparation field, similar tosetMaxSeparation(float)
.setMetadata
(ProtoInstance newValue) Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.setMetadata
(X3DMetadataObject newValue) Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.setMinSeparation
(double newValue) Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetMinSeparation(float)
.setMinSeparation
(float newValue) Accessor method to assign float value to inputOutput SFFloat field named minSeparation.setMinSeparation
(SFFloat newValue) Assign typed object value to SFFloat minSeparation field, similar tosetMinSeparation(float)
.setSliderForce
(double newValue) Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetSliderForce(float)
.setSliderForce
(float newValue) Accessor method to assign float value to inputOutput SFFloat field named sliderForce.setSliderForce
(SFFloat newValue) Assign typed object value to SFFloat sliderForce field, similar tosetSliderForce(float)
.setStopBounce
(double newValue) Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetStopBounce(float)
.setStopBounce
(float newValue) Accessor method to assign float value to inputOutput SFFloat field named stopBounce.setStopBounce
(SFFloat newValue) Assign typed object value to SFFloat stopBounce field, similar tosetStopBounce(float)
.setStopErrorCorrection
(double newValue) Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetStopErrorCorrection(float)
.setStopErrorCorrection
(float newValue) Accessor method to assign float value to inputOutput SFFloat field named stopErrorCorrection.setStopErrorCorrection
(SFFloat newValue) Assign typed object value to SFFloat stopErrorCorrection field, similar tosetStopErrorCorrection(float)
.final SliderJoint
Accessor method to assign String value to inputOutput SFString field named USE.Assign typed object value to SFString USE field, similar tosetUSE(String)
.setUSE
(SliderJoint 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: SliderJoint.- See Also:
-
COMPONENT
String constant COMPONENT defines X3D component for the SliderJoint element: RigidBodyPhysics- See Also:
-
LEVEL
public static final int LEVELInteger constant LEVEL provides default X3D RigidBodyPhysics component level for this element: 2- See Also:
-
AXIS_DEFAULT_VALUE
public static final float[] AXIS_DEFAULT_VALUESFVec3f field named axis 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). -
MAXSEPARATION_DEFAULT_VALUE
public static final float MAXSEPARATION_DEFAULT_VALUESFFloat field named maxSeparation has default value 1f (Java syntax) or 1 (XML syntax).- See Also:
-
METADATA_DEFAULT_VALUE
SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax). -
MINSEPARATION_DEFAULT_VALUE
public static final float MINSEPARATION_DEFAULT_VALUESFFloat field named minSeparation has default value 0f (Java syntax) or 0 (XML syntax).- See Also:
-
SLIDERFORCE_DEFAULT_VALUE
public static final float SLIDERFORCE_DEFAULT_VALUESFFloat field named sliderForce has default value 0f (Java syntax) or 0 (XML syntax).- See Also:
-
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:
-
STOPERRORCORRECTION_DEFAULT_VALUE
public static final float STOPERRORCORRECTION_DEFAULT_VALUESFFloat field named stopErrorCorrection has default value 1f (Java syntax) or 1 (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_AXIS
fromField ROUTE name for SFVec3f field named axis.- See Also:
-
toField_AXIS
-
fromField_BODY1
fromField ROUTE name for SFNode field named body1.- See Also:
-
toField_BODY1
-
fromField_BODY2
fromField ROUTE name for SFNode field named body2.- See Also:
-
toField_BODY2
-
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_MAXSEPARATION
fromField ROUTE name for SFFloat field named maxSeparation.- See Also:
-
toField_MAXSEPARATION
toField ROUTE name for SFFloat field named maxSeparation.- See Also:
-
fromField_METADATA
fromField ROUTE name for SFNode field named metadata.- See Also:
-
toField_METADATA
toField ROUTE name for SFNode field named metadata.- See Also:
-
fromField_MINSEPARATION
fromField ROUTE name for SFFloat field named minSeparation.- See Also:
-
toField_MINSEPARATION
toField ROUTE name for SFFloat field named minSeparation.- See Also:
-
fromField_SEPARATION
fromField ROUTE name for SFFloat field named separation.- See Also:
-
fromField_SEPARATIONRATE
fromField ROUTE name for SFFloat field named separationRate.- See Also:
-
fromField_SLIDERFORCE
fromField ROUTE name for SFFloat field named sliderForce.- See Also:
-
toField_SLIDERFORCE
toField ROUTE name for SFFloat field named sliderForce.- See Also:
-
fromField_STOPBOUNCE
fromField ROUTE name for SFFloat field named stopBounce.- See Also:
-
toField_STOPBOUNCE
toField ROUTE name for SFFloat field named stopBounce.- See Also:
-
fromField_STOPERRORCORRECTION
fromField ROUTE name for SFFloat field named stopErrorCorrection.- See Also:
-
toField_STOPERRORCORRECTION
toField ROUTE name for SFFloat field named stopErrorCorrection.- See Also:
-
-
Constructor Details
-
SliderJoint
public SliderJoint()Constructor for SliderJoint to initialize member variables with default values. -
SliderJoint
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: SliderJoint- Specified by:
getElementName
in classX3DConcreteElement
- Returns:
- name of this element
-
getComponent
Defines X3D component for the SliderJoint 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
-
getAxis
public float[] getAxis()Provide array of 3-tuple float results from inputOutput SFVec3f field named axis.
Tooltip: [0,1] axis is normalized vector specifying direction of motion. *- Specified by:
getAxis
in interfaceSliderJoint
- Returns:
- value of axis field
-
setAxis
Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named axis.
Tooltip: [0,1] axis is normalized vector specifying direction of motion. *- Specified by:
setAxis
in interfaceSliderJoint
- Parameters:
newValue
- is new value for the axis field.- Returns:
SliderJoint
- 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:
SliderJoint
- 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:
SliderJoint
- 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:
SliderJoint
- 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:
SliderJoint
- 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 interfaceSliderJoint
- 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 interfaceSliderJoint
- Specified by:
setBody1
in interfaceX3DRigidJointNode
- Parameters:
newValue
- is new value for the body1 field.- Returns:
SliderJoint
- 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:
SliderJoint
- 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:
SliderJoint
- 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:
-
getBody2
Provide org.web3d.x3d.sai.RigidBodyPhysics.RigidBody instance (using a properly typed node) from inputOutput SFNode field body2.- Specified by:
getBody2
in interfaceSliderJoint
- 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 interfaceSliderJoint
- Specified by:
setBody2
in interfaceX3DRigidJointNode
- Parameters:
newValue
- is new value for the body2 field.- Returns:
SliderJoint
- 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:
SliderJoint
- 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:
SliderJoint
- 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:
-
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 interfaceSliderJoint
- 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 interfaceSliderJoint
- Specified by:
setForceOutput
in interfaceX3DRigidJointNode
- Parameters:
newValue
- is new value for the forceOutput field.- Returns:
SliderJoint
- 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:
SliderJoint
- 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:
SliderJoint
- 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:
SliderJoint
- 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:
SliderJoint
- 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:
SliderJoint
- 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:
SliderJoint
- 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:
SliderJoint
- 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:
SliderJoint
- 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:
SliderJoint
- 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:
-
getMaxSeparation
public float getMaxSeparation()Provide float value from inputOutput SFFloat field named maxSeparation.
Tooltip: maxSeparation is maximum separation distance between the two bodies.- Hint: if (minSeparation is less than maxSeparation) then no stop is effective.
- Specified by:
getMaxSeparation
in interfaceSliderJoint
- Returns:
- value of maxSeparation field
-
setMaxSeparation
Accessor method to assign float value to inputOutput SFFloat field named maxSeparation.
Tooltip: maxSeparation is maximum separation distance between the two bodies.- Hint: if (minSeparation is less than maxSeparation) then no stop is effective.
- Specified by:
setMaxSeparation
in interfaceSliderJoint
- Parameters:
newValue
- is new value for the maxSeparation field.- Returns:
SliderJoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setMaxSeparation
Assign typed object value to SFFloat maxSeparation field, similar tosetMaxSeparation(float)
.- Parameters:
newValue
- is new value for the maxSeparation field.- Returns:
SliderJoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setMaxSeparation
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetMaxSeparation(float)
.- Parameters:
newValue
- is new value for field- Returns:
SliderJoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getMetadata
Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.- Specified by:
getMetadata
in interfaceSliderJoint
- 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 interfaceSliderJoint
- 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:
SliderJoint
- 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:
SliderJoint
- 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:
SliderJoint
- 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:
-
getMinSeparation
public float getMinSeparation()Provide float value from inputOutput SFFloat field named minSeparation.
Tooltip: minSeparation is minimum separation distance between the two bodies.- Hint: if (minSeparation is less than maxSeparation) then no stop is effective.
- Specified by:
getMinSeparation
in interfaceSliderJoint
- Returns:
- value of minSeparation field
-
setMinSeparation
Accessor method to assign float value to inputOutput SFFloat field named minSeparation.
Tooltip: minSeparation is minimum separation distance between the two bodies.- Hint: if (minSeparation is less than maxSeparation) then no stop is effective.
- Specified by:
setMinSeparation
in interfaceSliderJoint
- Parameters:
newValue
- is new value for the minSeparation field.- Returns:
SliderJoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setMinSeparation
Assign typed object value to SFFloat minSeparation field, similar tosetMinSeparation(float)
.- Parameters:
newValue
- is new value for the minSeparation field.- Returns:
SliderJoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setMinSeparation
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetMinSeparation(float)
.- Parameters:
newValue
- is new value for field- Returns:
SliderJoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getSeparation
public float getSeparation()Provide float value from outputOnly SFFloat field named separation.
Tooltip: separation indicates final separation distance between the two bodies.- 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:
getSeparation
in interfaceSliderJoint
- Returns:
- value of separation field
-
getSeparationRate
public float getSeparationRate()Provide float value from outputOnly SFFloat field named separationRate.
Tooltip: separationRate indicates change in separation distance over time between the two bodies.- 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:
getSeparationRate
in interfaceSliderJoint
- Returns:
- value of separationRate field
-
getSliderForce
public float getSliderForce()Provide float value from inputOutput SFFloat field named sliderForce.
Tooltip: [-infinity,infinity] sliderForce value is used to apply a force (specified in force base units) along the axis of the slider in equal and opposite directions to the two bodies. A positive value applies a force such that the two bodies accelerate away from each other, while a negative value applies a force such that the two bodies accelerate toward each other. *- Specified by:
getSliderForce
in interfaceSliderJoint
- Returns:
- value of sliderForce field
-
setSliderForce
Accessor method to assign float value to inputOutput SFFloat field named sliderForce.
Tooltip: [-infinity,infinity] sliderForce value is used to apply a force (specified in force base units) along the axis of the slider in equal and opposite directions to the two bodies. A positive value applies a force such that the two bodies accelerate away from each other, while a negative value applies a force such that the two bodies accelerate toward each other. *- Specified by:
setSliderForce
in interfaceSliderJoint
- Parameters:
newValue
- is new value for the sliderForce field.- Returns:
SliderJoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setSliderForce
Assign typed object value to SFFloat sliderForce field, similar tosetSliderForce(float)
.- Parameters:
newValue
- is new value for the sliderForce field.- Returns:
SliderJoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setSliderForce
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetSliderForce(float)
.- Parameters:
newValue
- is new value for field- Returns:
SliderJoint
- 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 interfaceSliderJoint
- 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 interfaceSliderJoint
- Parameters:
newValue
- is new value for the stopBounce field.- Returns:
SliderJoint
- 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:
SliderJoint
- 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:
SliderJoint
- 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 interfaceSliderJoint
- 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 interfaceSliderJoint
- Parameters:
newValue
- is new value for the stopErrorCorrection field.- Returns:
SliderJoint
- 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:
SliderJoint
- 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:
SliderJoint
- 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:
SliderJoint
- 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:
SliderJoint
- 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.do NOT include DEF (or any other attribute values) when using a USE attribute!.
- 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.do NOT include DEF (or any other attribute values) when using a USE attribute!.
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:
SliderJoint
- 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:
SliderJoint
- 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:
SliderJoint
- 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:
SliderJoint
- 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:
SliderJoint
- 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:
SliderJoint
- 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:
SliderJoint
- 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:
SliderJoint
- 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:
SliderJoint
- 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:
SliderJoint
- 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:
SliderJoint
- 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:
SliderJoint
- 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)
-