Class SingleAxisHingeJoint

java.lang.Object

org.web3d.x3d.jsail.X3DConcreteElement

org.web3d.x3d.jsail.X3DConcreteNode

org.web3d.x3d.jsail.RigidBodyPhysics.SingleAxisHingeJoint

All Implemented Interfaces:

X3DNode, SingleAxisHingeJoint, X3DRigidJointNode

public class SingleAxisHingeJoint
extends X3DConcreteNode
implements SingleAxisHingeJoint

SingleAxisHingeJoint has single axis about which to rotate, similar to a traditional door hinge. Contains two RigidBody nodes (containerField values body1, body2).

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. SingleAxisHingeJoint node tooltip: (X3D version 3.2 or later) [X3DRigidJointNode] SingleAxisHingeJoint has single axis about which to rotate, similar to a traditional door hinge. Contains two RigidBody nodes (containerField values body1, body2).

• Hint: RigidBodyPhysics component, level 2.

Package hint: This org.web3d.x3d.jsail concrete class is used for implementing a standalone X3D object as a Plain Old Java Object (POJO). If you are writing Java code for use inside an X3D Script node, compile separate code using only the org.web3d.x3d.sai package instead.

See Also:

• X3D Abstract Specification: SingleAxisHingeJoint
• X3D Tooltips: SingleAxisHingeJoint
• X3D Scene Authoring Hints

Field Summary

Fields

Modifier and Type	Field	Description
static final float[]	ANCHORPOINT_DEFAULT_VALUE	SFVec3f field named anchorPoint has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).
static final float[]	AXIS_DEFAULT_VALUE	SFVec3f field named axis has default value {0f,1f,0f} (Java syntax) or 0 1 0 (XML syntax).
static final RigidBody	BODY1_DEFAULT_VALUE	SFNode field named body1 has default value null (Java syntax) or NULL (XML syntax).
static final RigidBody	BODY2_DEFAULT_VALUE	SFNode field named body2 has default value null (Java syntax) or NULL (XML syntax).
static final String	COMPONENT	String constant COMPONENT defines X3D component for the SingleAxisHingeJoint element: RigidBodyPhysics
static final String	containerField_DEFAULT_VALUE	containerField describes typical field relationship of a node to its parent.
static final String	FORCEOUTPUT_ALL	Tooltip: all forceOutput fields computed.
static final ArrayList<String>	FORCEOUTPUT_DEFAULT_VALUE	MFString field named forceOutput has default quoted value new String[] {"NONE"} (Java syntax) or quoted value "NONE" (XML syntax).
static final String	FORCEOUTPUT_NONE	Tooltip: no forceOutput fields computed.
static final String	fromField_ANCHORPOINT	fromField ROUTE name for SFVec3f field named anchorPoint.
static final String	fromField_ANGLE	fromField ROUTE name for SFFloat field named angle.
static final String	fromField_ANGLERATE	fromField ROUTE name for SFFloat field named angleRate.
static final String	fromField_AXIS	fromField ROUTE name for SFVec3f field named axis.
static final String	fromField_BODY1	fromField ROUTE name for SFNode field named body1.
static final String	fromField_BODY1ANCHORPOINT	fromField ROUTE name for SFVec3f field named body1AnchorPoint.
static final String	fromField_BODY2	fromField ROUTE name for SFNode field named body2.
static final String	fromField_BODY2ANCHORPOINT	fromField ROUTE name for SFVec3f field named body2AnchorPoint.
static final String	fromField_FORCEOUTPUT	fromField ROUTE name for MFString field named forceOutput.
static final String	fromField_IS	fromField ROUTE name for SFNode field named IS.
static final String	fromField_MAXANGLE	fromField ROUTE name for SFFloat field named maxAngle.
static final String	fromField_METADATA	fromField ROUTE name for SFNode field named metadata.
static final String	fromField_MINANGLE	fromField ROUTE name for SFFloat field named minAngle.
static final String	fromField_STOPBOUNCE	fromField ROUTE name for SFFloat field named stopBounce.
static final String	fromField_STOPERRORCORRECTION	fromField ROUTE name for SFFloat field named stopErrorCorrection.
static final IS	IS_DEFAULT_VALUE	SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).
static final int	LEVEL	Integer constant LEVEL provides default X3D RigidBodyPhysics component level for this element: 2
static final float	MAXANGLE_DEFAULT_VALUE	SFFloat field named maxAngle has default value 3.141592653f (Java syntax) or 3.141592653 (XML syntax).
static final X3DMetadataObject	METADATA_DEFAULT_VALUE	SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).
static final float	MINANGLE_DEFAULT_VALUE	SFFloat field named minAngle has default value -3.141592653f (Java syntax) or -3.141592653 (XML syntax).
static final String	NAME	String constant NAME provides name of this element: SingleAxisHingeJoint.
static final float	STOPBOUNCE_DEFAULT_VALUE	SFFloat field named stopBounce has default value 0f (Java syntax) or 0 (XML syntax).
static final float	STOPERRORCORRECTION_DEFAULT_VALUE	SFFloat field named stopErrorCorrection has default value 0.8f (Java syntax) or 0.8 (XML syntax).
static final String	toField_ANCHORPOINT	toField ROUTE name for SFVec3f field named anchorPoint.
static final String	toField_AXIS	toField ROUTE name for SFVec3f field named axis.
static final String	toField_BODY1	toField ROUTE name for SFNode field named body1.
static final String	toField_BODY2	toField ROUTE name for SFNode field named body2.
static final String	toField_FORCEOUTPUT	toField ROUTE name for MFString field named forceOutput.
static final String	toField_MAXANGLE	toField ROUTE name for SFFloat field named maxAngle.
static final String	toField_METADATA	toField ROUTE name for SFNode field named metadata.
static final String	toField_MINANGLE	toField ROUTE name for SFFloat field named minAngle.
static final String	toField_STOPBOUNCE	toField ROUTE name for SFFloat field named stopBounce.
static final String	toField_STOPERRORCORRECTION	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

Constructors

Constructor	Description
SingleAxisHingeJoint()	Constructor for SingleAxisHingeJoint to initialize member variables with default values.
SingleAxisHingeJoint(String DEFlabel)	Utility constructor that assigns DEF label after initializing member variables with default values.

Method Summary

Modifier and Type	Method	Description
SingleAxisHingeJoint	addComments(String newComment)	Add comment as String to contained commentsList.
SingleAxisHingeJoint	addComments(String[] newComments)	Add comments as String[] array to contained commentsList.
SingleAxisHingeJoint	addComments(CommentsBlock newCommentsBlock)	Add CommentsBlock to contained commentsList.
SingleAxisHingeJoint	addForceOutput(String newValue)	Add singleton String value to MFString forceOutput field.
SingleAxisHingeJoint	addForceOutput(SFString newValue)	Add singleton SFString value to MFString forceOutput field.
SingleAxisHingeJoint	clearBody1()	Utility method to clear SFNode value of body1 field.
SingleAxisHingeJoint	clearBody2()	Utility method to clear SFNode value of body2 field.
SingleAxisHingeJoint	clearForceOutput()	Utility method to clear MFString value of forceOutput field.
SingleAxisHingeJoint	clearIS()	Utility method to clear SFNode value of IS field.
SingleAxisHingeJoint	clearMetadata()	Utility method to clear SFNode value of metadata field.
X3DConcreteElement	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.
X3DConcreteElement	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.
X3DConcreteNode	findNodeByDEF(String DEFvalue)	Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
String	getAccessType(String fieldName)	Indicate accessType corresponding to given fieldName.
float[]	getAnchorPoint()	Provide array of 3-tuple float results from inputOutput SFVec3f field named anchorPoint.
float	getAngle()	Provide float value unit axis, angle (in radians) from outputOnly SFFloat field named angle.
float	getAngleRate()	Provide float value unit axis, angle (in radians) from outputOnly SFFloat field named angleRate.
float[]	getAxis()	Provide array of 3-tuple float results from inputOutput SFVec3f field named axis.
RigidBody	getBody1()	Provide org.web3d.x3d.sai.RigidBodyPhysics.RigidBody instance (using a properly typed node) from inputOutput SFNode field body1.
float[]	getBody1AnchorPoint()	Provide array of 3-tuple float results from outputOnly SFVec3f field named body1AnchorPoint.
RigidBody	getBody2()	Provide org.web3d.x3d.sai.RigidBodyPhysics.RigidBody instance (using a properly typed node) from inputOutput SFNode field body2.
float[]	getBody2AnchorPoint()	Provide array of 3-tuple float results from outputOnly SFVec3f field named body2AnchorPoint.
final String	getComponent()	Defines X3D component for the SingleAxisHingeJoint element: RigidBodyPhysics
final int	getComponentLevel()	Provides default X3D component level for this element: 2
final String	getContainerFieldDefault()	containerField describes typical field relationship of a node to its parent.
String	getCssClass()	Provide String value from inputOutput SFString field named class.
String	getCssStyle()	Provide String value from inputOutput SFString field named style.
String	getDEF()	Provide String value from inputOutput SFString field named DEF.
final String	getElementName()	Provides name of this element: SingleAxisHingeJoint
String	getFieldType(String fieldName)	Indicate type corresponding to given fieldName.
String[]	getForceOutput()	Provide array of String enumeration results (baseType MFString) ['"ALL"' | '"NONE"' | '"etc."'] from inputOutput MFString field named forceOutput.
ArrayList<String>	getForceOutputList()	Utility method to get ArrayList value of MFString forceOutput field, similar to getForceOutput().
String	getForceOutputString()	Utility method to get String value of MFString forceOutput field, similar to getForceOutput().
String	getHtmlID()	Provide String value from inputOutput SFString field named id.
IS	getIS()	Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.
float	getMaxAngle()	Provide float value unit axis, angle (in radians) from inputOutput SFFloat field named maxAngle.
X3DMetadataObject	getMetadata()	Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
float	getMinAngle()	Provide float value unit axis, angle (in radians) from inputOutput SFFloat field named minAngle.
float	getStopBounce()	Provide float value from inputOutput SFFloat field named stopBounce.
float	getStopErrorCorrection()	Provide float value from inputOutput SFFloat field named stopErrorCorrection.
String	getUSE()	Provide String value from inputOutput SFString field named USE.
boolean	hasBody1()	Indicate whether an object is available for inputOutput SFNode field body1.
boolean	hasBody2()	Indicate whether an object is available for inputOutput SFNode field body2.
boolean	hasElementByNameValue(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	hasMetadata()	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()	Initialize all member variables to default values.
SingleAxisHingeJoint	setAnchorPoint(double[] newArray)	Utility method: double-precision set-array accessor for X3D floating-point type, similar to setAnchorPoint(float[]).
SingleAxisHingeJoint	setAnchorPoint(double x, double y, double z)	Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setAnchorPoint(float[]).
SingleAxisHingeJoint	setAnchorPoint(float[] newValue)	Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named anchorPoint.
SingleAxisHingeJoint	setAnchorPoint(float x, float y, float z)	Assign values to SFVec3f anchorPoint field, similar to setAnchorPoint(float[]).
SingleAxisHingeJoint	setAnchorPoint(SFVec3f newValue)	Assign typed object value to SFVec3f anchorPoint field, similar to setAnchorPoint(float[]).
SingleAxisHingeJoint	setAxis(double[] newArray)	Utility method: double-precision set-array accessor for X3D floating-point type, similar to setAxis(float[]).
SingleAxisHingeJoint	setAxis(double x, double y, double z)	Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setAxis(float[]).
SingleAxisHingeJoint	setAxis(float[] newValue)	Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named axis.
SingleAxisHingeJoint	setAxis(float x, float y, float z)	Assign values to SFVec3f axis field, similar to setAxis(float[]).
SingleAxisHingeJoint	setAxis(SFVec3f newValue)	Assign typed object value to SFVec3f axis field, similar to setAxis(float[]).
SingleAxisHingeJoint	setBody1(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field body1.
SingleAxisHingeJoint	setBody1(RigidBody newValue)	Accessor method to assign org.web3d.x3d.sai.RigidBodyPhysics.RigidBody instance (using a properly typed node) to inputOutput SFNode field body1.
SingleAxisHingeJoint	setBody2(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field body2.
SingleAxisHingeJoint	setBody2(RigidBody newValue)	Accessor method to assign org.web3d.x3d.sai.RigidBodyPhysics.RigidBody instance (using a properly typed node) to inputOutput SFNode field body2.
final SingleAxisHingeJoint	setCssClass(String newValue)	Accessor method to assign String value to inputOutput SFString field named class.
SingleAxisHingeJoint	setCssClass(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssClass(String).
final SingleAxisHingeJoint	setCssStyle(String newValue)	Accessor method to assign String value to inputOutput SFString field named style.
SingleAxisHingeJoint	setCssStyle(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssStyle(String).
final SingleAxisHingeJoint	setDEF(String newValue)	Accessor method to assign String value to inputOutput SFString field named DEF.
SingleAxisHingeJoint	setDEF(SFString newValue)	Assign typed object value to SFString DEF field, similar to setDEF(String).
SingleAxisHingeJoint	setForceOutput(String newValue)	Assign singleton String value to MFString forceOutput field, similar to setForceOutput(String[]).
SingleAxisHingeJoint	setForceOutput(String[] newValue)	Accessor method to assign String enumeration array (""ALL"" | ""NONE"") to inputOutput MFString field named forceOutput.
SingleAxisHingeJoint	setForceOutput(ArrayList<String> newValue)	Assign ArrayList value of MFString forceOutput field, similar to setForceOutput(String[]).
SingleAxisHingeJoint	setForceOutput(MFString newValue)	Assign typed object value to MFString forceOutput field, similar to setForceOutput(String[]).
SingleAxisHingeJoint	setForceOutput(SFString newValue)	Assign single SFString object value to MFString forceOutput field, similar to setForceOutput(String[]).
final SingleAxisHingeJoint	setHtmlID(String newValue)	Accessor method to assign String value to inputOutput SFString field named id.
SingleAxisHingeJoint	setHtmlID(SFString newValue)	Assign typed object value to SFString HtmlID field, similar to setHtmlID(String).
SingleAxisHingeJoint	setIS(IS newValue)	Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
SingleAxisHingeJoint	setMaxAngle(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setMaxAngle(float).
SingleAxisHingeJoint	setMaxAngle(float newValue)	Accessor method to assign float value unit axis, angle (in radians) to inputOutput SFFloat field named maxAngle.
SingleAxisHingeJoint	setMaxAngle(SFFloat newValue)	Assign typed object value to SFFloat maxAngle field, similar to setMaxAngle(float).
SingleAxisHingeJoint	setMetadata(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
SingleAxisHingeJoint	setMetadata(X3DMetadataObject newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
SingleAxisHingeJoint	setMinAngle(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setMinAngle(float).
SingleAxisHingeJoint	setMinAngle(float newValue)	Accessor method to assign float value unit axis, angle (in radians) to inputOutput SFFloat field named minAngle.
SingleAxisHingeJoint	setMinAngle(SFFloat newValue)	Assign typed object value to SFFloat minAngle field, similar to setMinAngle(float).
SingleAxisHingeJoint	setStopBounce(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setStopBounce(float).
SingleAxisHingeJoint	setStopBounce(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named stopBounce.
SingleAxisHingeJoint	setStopBounce(SFFloat newValue)	Assign typed object value to SFFloat stopBounce field, similar to setStopBounce(float).
SingleAxisHingeJoint	setStopErrorCorrection(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setStopErrorCorrection(float).
SingleAxisHingeJoint	setStopErrorCorrection(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named stopErrorCorrection.
SingleAxisHingeJoint	setStopErrorCorrection(SFFloat newValue)	Assign typed object value to SFFloat stopErrorCorrection field, similar to setStopErrorCorrection(float).
final SingleAxisHingeJoint	setUSE(String newValue)	Accessor method to assign String value to inputOutput SFString field named USE.
SingleAxisHingeJoint	setUSE(SFString newValue)	Assign typed object value to SFString USE field, similar to setUSE(String).
SingleAxisHingeJoint	setUSE(SingleAxisHingeJoint DEFnode)	Assign a USE reference to another DEF node of same node type, similar to setUSE(String).
String	toStringClassicVRML(int indentLevel)	Recursive method to provide ClassicVRML string serialization.
String	toStringVRML97(int indentLevel)	Recursive method to provide VRML97 string serialization.
String	toStringX3D(int indentLevel)	Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
String	validate()	Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteNode

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

FORCEOUTPUT_ALL

public static final String 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:

• XML Schema: forceOutputValues
• Constant Field Values

FORCEOUTPUT_NONE

public static final String 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:

• XML Schema: forceOutputValues
• Constant Field Values

NAME

public static final String NAME

String constant NAME provides name of this element: SingleAxisHingeJoint.

See Also:

• Constant Field Values

COMPONENT

public static final String COMPONENT

String constant COMPONENT defines X3D component for the SingleAxisHingeJoint element: RigidBodyPhysics

See Also:

• Constant Field Values

LEVEL

public static final int LEVEL

Integer constant LEVEL provides default X3D RigidBodyPhysics component level for this element: 2

See Also:

• Constant Field Values

ANCHORPOINT_DEFAULT_VALUE

public static final float[] ANCHORPOINT_DEFAULT_VALUE

SFVec3f field named anchorPoint has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).

AXIS_DEFAULT_VALUE

public static final float[] AXIS_DEFAULT_VALUE

SFVec3f field named axis has default value {0f,1f,0f} (Java syntax) or 0 1 0 (XML syntax).

BODY1_DEFAULT_VALUE

public static final RigidBody BODY1_DEFAULT_VALUE

SFNode field named body1 has default value null (Java syntax) or NULL (XML syntax).

BODY2_DEFAULT_VALUE

public static final RigidBody BODY2_DEFAULT_VALUE

SFNode field named body2 has default value null (Java syntax) or NULL (XML syntax).

FORCEOUTPUT_DEFAULT_VALUE

public static final ArrayList<String> FORCEOUTPUT_DEFAULT_VALUE

MFString field named forceOutput has default quoted value new String[] {"NONE"} (Java syntax) or quoted value "NONE" (XML syntax).

IS_DEFAULT_VALUE

public static final IS IS_DEFAULT_VALUE

SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).

MAXANGLE_DEFAULT_VALUE

public static final float MAXANGLE_DEFAULT_VALUE

SFFloat field named maxAngle has default value 3.141592653f (Java syntax) or 3.141592653 (XML syntax).

See Also:

• Constant Field Values

METADATA_DEFAULT_VALUE

public static final X3DMetadataObject METADATA_DEFAULT_VALUE

SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).

MINANGLE_DEFAULT_VALUE

public static final float MINANGLE_DEFAULT_VALUE

SFFloat field named minAngle has default value -3.141592653f (Java syntax) or -3.141592653 (XML syntax).

See Also:

• Constant Field Values

STOPBOUNCE_DEFAULT_VALUE

public static final float STOPBOUNCE_DEFAULT_VALUE

SFFloat field named stopBounce has default value 0f (Java syntax) or 0 (XML syntax).

See Also:

• Constant Field Values

STOPERRORCORRECTION_DEFAULT_VALUE

public static final float STOPERRORCORRECTION_DEFAULT_VALUE

SFFloat field named stopErrorCorrection has default value 0.8f (Java syntax) or 0.8 (XML syntax).

See Also:

• Constant Field Values

containerField_DEFAULT_VALUE

public static final String 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:

• X3D Scene Authoring Hints: containerField
• X3D Scene Authoring Hints: validation choices for containerField
• X3D Unified Object Model (X3DUOM)
• Constant Field Values

fromField_ANCHORPOINT

public static final String fromField_ANCHORPOINT

fromField ROUTE name for SFVec3f field named anchorPoint.

See Also:

• Constant Field Values

toField_ANCHORPOINT

public static final String toField_ANCHORPOINT

toField ROUTE name for SFVec3f field named anchorPoint.

See Also:

• Constant Field Values

fromField_ANGLE

public static final String fromField_ANGLE

fromField ROUTE name for SFFloat field named angle.

See Also:

• Constant Field Values

fromField_ANGLERATE

public static final String fromField_ANGLERATE

fromField ROUTE name for SFFloat field named angleRate.

See Also:

• Constant Field Values

fromField_AXIS

public static final String fromField_AXIS

fromField ROUTE name for SFVec3f field named axis.

See Also:

• Constant Field Values

toField_AXIS

public static final String toField_AXIS

toField ROUTE name for SFVec3f field named axis.

See Also:

• Constant Field Values

fromField_BODY1

public static final String fromField_BODY1

fromField ROUTE name for SFNode field named body1.

See Also:

• Constant Field Values

toField_BODY1

public static final String toField_BODY1

toField ROUTE name for SFNode field named body1.

See Also:

• Constant Field Values

fromField_BODY1ANCHORPOINT

public static final String fromField_BODY1ANCHORPOINT

fromField ROUTE name for SFVec3f field named body1AnchorPoint.

See Also:

• Constant Field Values

fromField_BODY2

public static final String fromField_BODY2

fromField ROUTE name for SFNode field named body2.

See Also:

• Constant Field Values

toField_BODY2

public static final String toField_BODY2

toField ROUTE name for SFNode field named body2.

See Also:

• Constant Field Values

fromField_BODY2ANCHORPOINT

public static final String fromField_BODY2ANCHORPOINT

fromField ROUTE name for SFVec3f field named body2AnchorPoint.

See Also:

• Constant Field Values

fromField_FORCEOUTPUT

public static final String fromField_FORCEOUTPUT

fromField ROUTE name for MFString field named forceOutput.

See Also:

• Constant Field Values

toField_FORCEOUTPUT

public static final String toField_FORCEOUTPUT

toField ROUTE name for MFString field named forceOutput.

See Also:

• Constant Field Values

fromField_IS

public static final String fromField_IS

fromField ROUTE name for SFNode field named IS.

See Also:

• Constant Field Values

fromField_MAXANGLE

public static final String fromField_MAXANGLE

fromField ROUTE name for SFFloat field named maxAngle.

See Also:

• Constant Field Values

toField_MAXANGLE

public static final String toField_MAXANGLE

toField ROUTE name for SFFloat field named maxAngle.

See Also:

• Constant Field Values

fromField_METADATA

public static final String fromField_METADATA

fromField ROUTE name for SFNode field named metadata.

See Also:

• Constant Field Values

toField_METADATA

public static final String toField_METADATA

toField ROUTE name for SFNode field named metadata.

See Also:

• Constant Field Values

fromField_MINANGLE

public static final String fromField_MINANGLE

fromField ROUTE name for SFFloat field named minAngle.

See Also:

• Constant Field Values

toField_MINANGLE

public static final String toField_MINANGLE

toField ROUTE name for SFFloat field named minAngle.

See Also:

• Constant Field Values

fromField_STOPBOUNCE

public static final String fromField_STOPBOUNCE

fromField ROUTE name for SFFloat field named stopBounce.

See Also:

• Constant Field Values

toField_STOPBOUNCE

public static final String toField_STOPBOUNCE

toField ROUTE name for SFFloat field named stopBounce.

See Also:

• Constant Field Values

fromField_STOPERRORCORRECTION

public static final String fromField_STOPERRORCORRECTION

fromField ROUTE name for SFFloat field named stopErrorCorrection.

See Also:

• Constant Field Values

toField_STOPERRORCORRECTION

public static final String toField_STOPERRORCORRECTION

toField ROUTE name for SFFloat field named stopErrorCorrection.

See Also:

• Constant Field Values

Constructor Details

SingleAxisHingeJoint

public SingleAxisHingeJoint()

Constructor for SingleAxisHingeJoint to initialize member variables with default values.

SingleAxisHingeJoint

public SingleAxisHingeJoint(String DEFlabel)

Utility constructor that assigns DEF label after initializing member variables with default values.

Parameters:

DEFlabel - unique DEF name for this X3D node

Method Details

getElementName

public final String getElementName()

Provides name of this element: SingleAxisHingeJoint

Specified by:

getElementName in class X3DConcreteElement

Returns:

name of this element

getComponent

public final String getComponent()

Defines X3D component for the SingleAxisHingeJoint element: RigidBodyPhysics

Specified by:

getComponent in class X3DConcreteElement

Returns:

X3D component for this element

getComponentLevel

public final int getComponentLevel()

Provides default X3D component level for this element: 2

Specified by:

getComponentLevel in class X3DConcreteElement

Returns:

default X3D component level for this element

getFieldType

public String getFieldType(String fieldName)

Indicate type corresponding to given fieldName.

Specified by:

getFieldType in class X3DConcreteElement

Parameters:

fieldName - name of field in this X3D node

Returns:

X3D type (SFvec3f etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE if not recognized

See Also:

• ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE

getAccessType

public String getAccessType(String fieldName)

Indicate accessType corresponding to given fieldName.

Specified by:

getAccessType in class X3DConcreteElement

Parameters:

fieldName - name of field in this X3D node

Returns:

X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized

See Also:

• ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE

getContainerFieldDefault

public final String 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 class X3DConcreteNode

Returns:

default containerField value

See Also:

• containerField_DEFAULT_VALUE
• X3DConcreteNode.containerField_ALLOWED_VALUES
• X3D Scene Authoring Hints: containerField
• X3D Scene Authoring Hints: validation choices for containerField
• X3D Unified Object Model (X3DUOM)

initialize

public final void initialize()

Initialize all member variables to default values.

Overrides:

initialize in class X3DConcreteNode

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 interface SingleAxisHingeJoint

Returns:

value of anchorPoint field

setAnchorPoint

public SingleAxisHingeJoint setAnchorPoint(float[] newValue)

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 interface SingleAxisHingeJoint

Parameters:

newValue - is new value for the anchorPoint field.

Returns:

SingleAxisHingeJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setAnchorPoint

public SingleAxisHingeJoint setAnchorPoint(SFVec3f newValue)

Assign typed object value to SFVec3f anchorPoint field, similar to setAnchorPoint(float[]).

Parameters:

newValue - is new value for the anchorPoint field.

Returns:

SingleAxisHingeJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setAnchorPoint

public SingleAxisHingeJoint setAnchorPoint(float x,
 float y,
 float z)

Assign values to SFVec3f anchorPoint field, similar to setAnchorPoint(float[]).

Parameters:

x - first component

y - second component

z - third component

Returns:

SingleAxisHingeJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setAnchorPoint

public SingleAxisHingeJoint setAnchorPoint(double x,
 double y,
 double z)

Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setAnchorPoint(float[]).

Parameters:

x - first component

y - second component

z - third component

Returns:

SingleAxisHingeJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setAnchorPoint

public SingleAxisHingeJoint setAnchorPoint(double[] newArray)

Utility method: double-precision set-array accessor for X3D floating-point type, similar to setAnchorPoint(float[]).

Parameters:

newArray - is new value for field

Returns:

SingleAxisHingeJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getAngle

public float getAngle()

Provide float value unit axis, angle (in radians) from outputOnly SFFloat field named angle.

Specified by:

getAngle in interface SingleAxisHingeJoint

Returns:

value of angle field

getAngleRate

public float getAngleRate()

Provide float value unit axis, angle (in radians) from outputOnly SFFloat field named angleRate.

Specified by:

getAngleRate in interface SingleAxisHingeJoint

Returns:

value of angleRate field

getAxis

public float[] getAxis()

Provide array of 3-tuple float results from inputOutput SFVec3f field named axis.

Tooltip: axis defines vector of joint connection between body1 and body2. *

Specified by:

getAxis in interface SingleAxisHingeJoint

Returns:

value of axis field

setAxis

public SingleAxisHingeJoint setAxis(float[] newValue)

Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named axis.

Tooltip: axis defines vector of joint connection between body1 and body2. *

Specified by:

setAxis in interface SingleAxisHingeJoint

Parameters:

newValue - is new value for the axis field.

Returns:

SingleAxisHingeJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setAxis

public SingleAxisHingeJoint setAxis(SFVec3f newValue)

Assign typed object value to SFVec3f axis field, similar to setAxis(float[]).

Parameters:

newValue - is new value for the axis field.

Returns:

SingleAxisHingeJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setAxis

public SingleAxisHingeJoint setAxis(float x,
 float y,
 float z)

Assign values to SFVec3f axis field, similar to setAxis(float[]).

Parameters:

x - first component

y - second component

z - third component

Returns:

SingleAxisHingeJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setAxis

public SingleAxisHingeJoint setAxis(double x,
 double y,
 double z)

Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setAxis(float[]).

Parameters:

x - first component

y - second component

z - third component

Returns:

SingleAxisHingeJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setAxis

public SingleAxisHingeJoint setAxis(double[] newArray)

Utility method: double-precision set-array accessor for X3D floating-point type, similar to setAxis(float[]).

Parameters:

newArray - is new value for field

Returns:

SingleAxisHingeJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getBody1

public RigidBody getBody1()

Provide org.web3d.x3d.sai.RigidBodyPhysics.RigidBody instance (using a properly typed node) from inputOutput SFNode field body1.

Specified by:

getBody1 in interface SingleAxisHingeJoint

Specified by:

getBody1 in interface X3DRigidJointNode

Returns:

value of body1 field

See Also:

• 
  
  Tooltip: [RigidBody] The body1 and body2 fields indicate the two RigidBody nodes connected by this joint. *
  

setBody1

public SingleAxisHingeJoint setBody1(RigidBody newValue)

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 interface SingleAxisHingeJoint

Specified by:

setBody1 in interface X3DRigidJointNode

Parameters:

newValue - is new value for the body1 field.

Returns:

SingleAxisHingeJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• 
  
  Tooltip: [RigidBody] The body1 and body2 fields indicate the two RigidBody nodes connected by this joint. *
  

clearBody1

public SingleAxisHingeJoint clearBody1()

Utility method to clear SFNode value of body1 field.

Returns:

SingleAxisHingeJoint - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

setBody1

public SingleAxisHingeJoint setBody1(ProtoInstance newValue)

Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field body1.

Parameters:

newValue - is new value for the body1 field.

Returns:

SingleAxisHingeJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• setBody1(org.web3d.x3d.sai.RigidBodyPhysics.RigidBody)

hasBody1

public boolean hasBody1()

Indicate whether an object is available for inputOutput SFNode field body1.

Returns:

whether a properly typed node or ProtoInstance or CommentsBlock is available.

See Also:

• getBody1()
• getBody1ProtoInstance()

getBody1AnchorPoint

public float[] getBody1AnchorPoint()

Provide array of 3-tuple float results from outputOnly SFVec3f field named body1AnchorPoint.

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 interface SingleAxisHingeJoint

Returns:

value of body1AnchorPoint field

getBody2

public RigidBody getBody2()

Provide org.web3d.x3d.sai.RigidBodyPhysics.RigidBody instance (using a properly typed node) from inputOutput SFNode field body2.

Specified by:

getBody2 in interface SingleAxisHingeJoint

Specified by:

getBody2 in interface X3DRigidJointNode

Returns:

value of body2 field

See Also:

• 
  
  Tooltip: [RigidBody] The body1 and body2 fields indicate the two RigidBody nodes connected by this joint. *
  

setBody2

public SingleAxisHingeJoint setBody2(RigidBody newValue)

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 interface SingleAxisHingeJoint

Specified by:

setBody2 in interface X3DRigidJointNode

Parameters:

newValue - is new value for the body2 field.

Returns:

SingleAxisHingeJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• 
  
  Tooltip: [RigidBody] The body1 and body2 fields indicate the two RigidBody nodes connected by this joint. *
  

clearBody2

public SingleAxisHingeJoint clearBody2()

Utility method to clear SFNode value of body2 field.

Returns:

SingleAxisHingeJoint - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

setBody2

public SingleAxisHingeJoint setBody2(ProtoInstance newValue)

Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field body2.

Parameters:

newValue - is new value for the body2 field.

Returns:

SingleAxisHingeJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• setBody2(org.web3d.x3d.sai.RigidBodyPhysics.RigidBody)

hasBody2

public boolean hasBody2()

Indicate whether an object is available for inputOutput SFNode field body2.

Returns:

whether a properly typed node or ProtoInstance or CommentsBlock is available.

See Also:

• getBody2()
• getBody2ProtoInstance()

getBody2AnchorPoint

public float[] getBody2AnchorPoint()

Provide array of 3-tuple float results from outputOnly SFVec3f field named body2AnchorPoint.

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 interface SingleAxisHingeJoint

Returns:

value of body2AnchorPoint field

getForceOutput

public String[] getForceOutput()

Provide array of String enumeration results (baseType MFString) ['"ALL"' | '"NONE"' | '"etc."'] from inputOutput MFString field named forceOutput.

Tooltip: forceOutput controls which output fields are generated for the next frame. Values are ALL, NONE, or exact names of output fields updated at start of next frame. *


Available enumeration values for string comparison: ALL, NONE.

Specified by:

getForceOutput in interface SingleAxisHingeJoint

Specified by:

getForceOutput in interface X3DRigidJointNode

Returns:

value of forceOutput field

getForceOutputList

public ArrayList<String> getForceOutputList()

Utility method to get ArrayList value of MFString forceOutput field, similar to getForceOutput().

Returns:

value of forceOutput field

getForceOutputString

public String getForceOutputString()

Utility method to get String value of MFString forceOutput field, similar to getForceOutput().

Returns:

value of forceOutput field

setForceOutput

public SingleAxisHingeJoint setForceOutput(String[] newValue)

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 interface SingleAxisHingeJoint

Specified by:

setForceOutput in interface X3DRigidJointNode

Parameters:

newValue - is new value for the forceOutput field.

Returns:

SingleAxisHingeJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setForceOutput

public SingleAxisHingeJoint setForceOutput(MFString newValue)

Assign typed object value to MFString forceOutput field, similar to setForceOutput(String[]).

Parameters:

newValue - is new value for the forceOutput field.

Returns:

SingleAxisHingeJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setForceOutput

public SingleAxisHingeJoint setForceOutput(SFString newValue)

Assign single SFString object value to MFString forceOutput field, similar to setForceOutput(String[]).

Parameters:

newValue - is new value for the forceOutput field.

Returns:

SingleAxisHingeJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• MFString.cleanupEnumerationValues(String)

setForceOutput

public SingleAxisHingeJoint setForceOutput(String newValue)

Assign singleton String value to MFString forceOutput field, similar to setForceOutput(String[]).

Parameters:

newValue - is new value for the forceOutput field.

Returns:

SingleAxisHingeJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• MFString.cleanupEnumerationValues(String)

setForceOutput

public SingleAxisHingeJoint setForceOutput(ArrayList<String> newValue)

Assign ArrayList value of MFString forceOutput field, similar to setForceOutput(String[]).

Parameters:

newValue - is new value for the forceOutput field.

Returns:

SingleAxisHingeJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

clearForceOutput

public SingleAxisHingeJoint clearForceOutput()

Utility method to clear MFString value of forceOutput field. This method does not initialize withFORCEOUTPUT_DEFAULT_VALUE.

Returns:

SingleAxisHingeJoint - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

addForceOutput

public SingleAxisHingeJoint addForceOutput(String newValue)

Add singleton String value to MFString forceOutput field.

Parameters:

newValue - is new value to add to the forceOutput field.

Returns:

SingleAxisHingeJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• MFString.cleanupEnumerationValues(String)

addForceOutput

public SingleAxisHingeJoint addForceOutput(SFString newValue)

Add singleton SFString value to MFString forceOutput field.

Parameters:

newValue - is new value to add to the forceOutput field.

Returns:

SingleAxisHingeJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• MFString.cleanupEnumerationValues(String)

getIS

public IS getIS()

Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.

Specified by:

getIS in class X3DConcreteNode

Returns:

value of IS field

See Also:

• X3D Tooltips: IS
• X3D Tooltips: connect

setIS

public SingleAxisHingeJoint setIS(IS newValue)

Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.

Specified by:

setIS in class X3DConcreteNode

Parameters:

newValue - is new value for the IS field.

Returns:

SingleAxisHingeJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• X3D Tooltips: IS
• X3D Tooltips: connect

clearIS

public SingleAxisHingeJoint clearIS()

Utility method to clear SFNode value of IS field.

Returns:

SingleAxisHingeJoint - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

hasIS

public boolean hasIS()

Indicate whether an object is available for inputOutput SFNode field IS.

Returns:

whether a concrete statement or CommentsBlock is available.

See Also:

• getIS()

getMaxAngle

public float getMaxAngle()

Provide float value unit axis, angle (in radians) from inputOutput SFFloat field named maxAngle.

Tooltip: [-pi,pi] maxAngle is maximum rotation angle for hinge.

• Hint: radian units for angular measure https://en.wikipedia.org/wiki/Radian

Specified by:

getMaxAngle in interface SingleAxisHingeJoint

Returns:

value of maxAngle field

setMaxAngle

public SingleAxisHingeJoint setMaxAngle(float newValue)

Accessor method to assign float value unit axis, angle (in radians) to inputOutput SFFloat field named maxAngle.

Tooltip: [-pi,pi] maxAngle is maximum rotation angle for hinge.

• Hint: radian units for angular measure https://en.wikipedia.org/wiki/Radian

Specified by:

setMaxAngle in interface SingleAxisHingeJoint

Parameters:

newValue - is new value for the maxAngle field.

Returns:

SingleAxisHingeJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setMaxAngle

public SingleAxisHingeJoint setMaxAngle(SFFloat newValue)

Assign typed object value to SFFloat maxAngle field, similar to setMaxAngle(float).

Parameters:

newValue - is new value for the maxAngle field.

Returns:

SingleAxisHingeJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setMaxAngle

public SingleAxisHingeJoint setMaxAngle(double newValue)

Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setMaxAngle(float).

Parameters:

newValue - is new value for field

Returns:

SingleAxisHingeJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getMetadata

public X3DMetadataObject getMetadata()

Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.

Specified by:

getMetadata in interface SingleAxisHingeJoint

Specified by:

getMetadata in interface X3DNode

Specified by:

getMetadata in interface X3DRigidJointNode

Returns:

value of metadata field

See Also:

• 
  
  Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
  • Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/core.html#Metadata
• X3D Scene Authoring Hints: Metadata Nodes

setMetadata

public SingleAxisHingeJoint setMetadata(X3DMetadataObject newValue)

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 interface SingleAxisHingeJoint

Specified by:

setMetadata in interface X3DNode

Specified by:

setMetadata in interface X3DRigidJointNode

Specified by:

setMetadata in class X3DConcreteNode

Parameters:

newValue - is new value for the metadata field.

Returns:

SingleAxisHingeJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• 
  
  Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
  • Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/core.html#Metadata
• X3D Scene Authoring Hints: Metadata Nodes

clearMetadata

public SingleAxisHingeJoint clearMetadata()

Utility method to clear SFNode value of metadata field.

Returns:

SingleAxisHingeJoint - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

setMetadata

public SingleAxisHingeJoint setMetadata(ProtoInstance newValue)

Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.

Specified by:

setMetadata in class X3DConcreteNode

Parameters:

newValue - is new value for the metadata field.

Returns:

SingleAxisHingeJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• setMetadata(org.web3d.x3d.sai.Core.X3DMetadataObject)

hasMetadata

public boolean hasMetadata()

Indicate whether an object is available for inputOutput SFNode field metadata.

Returns:

whether a properly typed node or ProtoInstance or CommentsBlock is available.

See Also:

• getMetadata()
• getMetadataProtoInstance()
• X3D Scene Authoring Hints: Metadata Nodes

getMinAngle

public float getMinAngle()

Provide float value unit axis, angle (in radians) from inputOutput SFFloat field named minAngle.

Tooltip: [-pi,pi] minAngle is minimum rotation angle for hinge.

• Hint: radian units for angular measure https://en.wikipedia.org/wiki/Radian

Specified by:

getMinAngle in interface SingleAxisHingeJoint

Returns:

value of minAngle field

setMinAngle

public SingleAxisHingeJoint setMinAngle(float newValue)

Accessor method to assign float value unit axis, angle (in radians) to inputOutput SFFloat field named minAngle.

Tooltip: [-pi,pi] minAngle is minimum rotation angle for hinge.

• Hint: radian units for angular measure https://en.wikipedia.org/wiki/Radian

Specified by:

setMinAngle in interface SingleAxisHingeJoint

Parameters:

newValue - is new value for the minAngle field.

Returns:

SingleAxisHingeJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setMinAngle

public SingleAxisHingeJoint setMinAngle(SFFloat newValue)

Assign typed object value to SFFloat minAngle field, similar to setMinAngle(float).

Parameters:

newValue - is new value for the minAngle field.

Returns:

SingleAxisHingeJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setMinAngle

public SingleAxisHingeJoint setMinAngle(double newValue)

Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setMinAngle(float).

Parameters:

newValue - is new value for field

Returns:

SingleAxisHingeJoint - 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 interface SingleAxisHingeJoint

Returns:

value of stopBounce field

setStopBounce

public SingleAxisHingeJoint setStopBounce(float newValue)

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 interface SingleAxisHingeJoint

Parameters:

newValue - is new value for the stopBounce field.

Returns:

SingleAxisHingeJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setStopBounce

public SingleAxisHingeJoint setStopBounce(SFFloat newValue)

Assign typed object value to SFFloat stopBounce field, similar to setStopBounce(float).

Parameters:

newValue - is new value for the stopBounce field.

Returns:

SingleAxisHingeJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setStopBounce

public SingleAxisHingeJoint setStopBounce(double newValue)

Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setStopBounce(float).

Parameters:

newValue - is new value for field

Returns:

SingleAxisHingeJoint - 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 interface SingleAxisHingeJoint

Returns:

value of stopErrorCorrection field

setStopErrorCorrection

public SingleAxisHingeJoint setStopErrorCorrection(float newValue)

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 interface SingleAxisHingeJoint

Parameters:

newValue - is new value for the stopErrorCorrection field.

Returns:

SingleAxisHingeJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setStopErrorCorrection

public SingleAxisHingeJoint setStopErrorCorrection(SFFloat newValue)

Assign typed object value to SFFloat stopErrorCorrection field, similar to setStopErrorCorrection(float).

Parameters:

newValue - is new value for the stopErrorCorrection field.

Returns:

SingleAxisHingeJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setStopErrorCorrection

public SingleAxisHingeJoint setStopErrorCorrection(double newValue)

Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setStopErrorCorrection(float).

Parameters:

newValue - is new value for field

Returns:

SingleAxisHingeJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getDEF

public String getDEF()

Provide String value from inputOutput SFString field named DEF.

Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.

• Hint: descriptive DEF names improve clarity and help document a model.
• Hint: well-defined names can simplify design and debugging through improved author understanding.
• Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions

Overrides:

getDEF in class X3DConcreteNode

Returns:

value of DEF field

See Also:

• X3D Scene Authoring Hints: Naming Conventions

setDEF

public final SingleAxisHingeJoint setDEF(String newValue)

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 class X3DConcreteNode

Parameters:

newValue - is new value for the DEF field.

Returns:

SingleAxisHingeJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setDEF

public SingleAxisHingeJoint setDEF(SFString newValue)

Assign typed object value to SFString DEF field, similar to setDEF(String).

Parameters:

newValue - is new value for the DEF field.

Returns:

SingleAxisHingeJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getUSE

public String getUSE()

Provide String value from inputOutput SFString field named USE.

Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value).

• Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
• Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute.
• Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.

Overrides:

getUSE in class X3DConcreteNode

Returns:

value of USE field

See Also:

• X3D Scene Authoring Hints: Naming Conventions

setUSE

public final SingleAxisHingeJoint setUSE(String newValue)

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: each USE node is still an independent object, with the USE value matching the DEF value in the preceding object.

Warning: invoking the setUSE() 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 class X3DConcreteNode

Parameters:

newValue - is new value for the USE field.

Returns:

SingleAxisHingeJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setUSE

public SingleAxisHingeJoint setUSE(SFString newValue)

Assign typed object value to SFString USE field, similar to setUSE(String).

Parameters:

newValue - is new value for the USE field.

Returns:

SingleAxisHingeJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getCssClass

public String getCssClass()

Provide String value from inputOutput SFString field named class.

Overrides:

getCssClass in class X3DConcreteElement

Returns:

value of class field

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssClass

public final SingleAxisHingeJoint setCssClass(String newValue)

Accessor method to assign String value to inputOutput SFString field named class.

Specified by:

setCssClass in class X3DConcreteNode

Parameters:

newValue - is new value for the class field.

Returns:

SingleAxisHingeJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssClass

public SingleAxisHingeJoint setCssClass(SFString newValue)

Assign typed object value to SFString cssClass field, similar to setCssClass(String).

Parameters:

newValue - is new value for the class field.

Returns:

SingleAxisHingeJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getHtmlID

public String getHtmlID()

Provide String value from inputOutput SFString field named id.

Overrides:

getHtmlID in class X3DConcreteElement

Returns:

value of id field

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setHtmlID

public final SingleAxisHingeJoint setHtmlID(String newValue)

Accessor method to assign String value to inputOutput SFString field named id.

Specified by:

setHtmlID in class X3DConcreteNode

Parameters:

newValue - is new value for the id field.

Returns:

SingleAxisHingeJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
  Warning: the id attribute is in a distinct separate namespace from DEF identifiers and thus not applicable for USE nodes, ROUTE statements, or Script references.
• X3D Architecture Annex L - HTML authoring guidelines, L.3.1 Content definition and page presentation
• HTML 5.2 W3C Recommendation
• Document Object Model (DOM) Technical Reports
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setHtmlID

public SingleAxisHingeJoint setHtmlID(SFString newValue)

Assign typed object value to SFString HtmlID field, similar to setHtmlID(String).

Parameters:

newValue - is new value for the id field.

Returns:

SingleAxisHingeJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getCssStyle

public String getCssStyle()

Provide String value from inputOutput SFString field named style.

Overrides:

getCssStyle in class X3DConcreteElement

Returns:

value of style field

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssStyle

public final SingleAxisHingeJoint setCssStyle(String newValue)

Accessor method to assign String value to inputOutput SFString field named style.

Specified by:

setCssStyle in class X3DConcreteNode

Parameters:

newValue - is new value for the style field.

Returns:

SingleAxisHingeJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssStyle

public SingleAxisHingeJoint setCssStyle(SFString newValue)

Assign typed object value to SFString cssClass field, similar to setCssStyle(String).

Parameters:

newValue - is new value for the style field.

Returns:

SingleAxisHingeJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setUSE

public SingleAxisHingeJoint setUSE(SingleAxisHingeJoint DEFnode)

Assign a USE reference to another DEF node of same node type, similar to setUSE(String).

Warning: note that the setUSE() 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:

SingleAxisHingeJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

addComments

public SingleAxisHingeJoint addComments(String newComment)

Add comment as String to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComment - initial value

Returns:

SingleAxisHingeJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• X3D Architecture, clause 7.2.5.1 Organization

addComments

public SingleAxisHingeJoint addComments(String[] newComments)

Add comments as String[] array to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComments - array of comments

Returns:

SingleAxisHingeJoint - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

addComments

public SingleAxisHingeJoint addComments(CommentsBlock newCommentsBlock)

Add CommentsBlock to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newCommentsBlock - block of comments to add

Returns:

SingleAxisHingeJoint - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

toStringX3D

public String toStringX3D(int indentLevel)

Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.

Specified by:

toStringX3D in class X3DConcreteElement

Parameters:

indentLevel - number of levels of indentation for this element

Returns:

X3D string

See Also:

• X3D.FILE_EXTENSION_X3D
• X3D.FILE_EXTENSION_XML
• X3D.toStringXML()
• X3D.toFileXML(String)
• X3D.toFileX3D(String)
• X3D XML Encoding
• X3D Compressed Binary Encoding: X3D Canonical Form
• X3D Canonicalization (C14N) Tool

toStringClassicVRML

public String toStringClassicVRML(int indentLevel)

Recursive method to provide ClassicVRML string serialization.

Specified by:

toStringClassicVRML in class X3DConcreteElement

Parameters:

indentLevel - number of levels of indentation for this element

Returns:

ClassicVRML string

See Also:

• X3D.FILE_EXTENSION_CLASSICVRML
• X3D Resources: Virtual Reality Modeling Language (VRML) 97
• Extensible 3D (X3D) encodings Part 2: Classic VRML encoding
• Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Annex A: Grammar

toStringVRML97

public String toStringVRML97(int indentLevel)

Recursive method to provide VRML97 string serialization.

Specified by:

toStringVRML97 in class X3DConcreteElement

Parameters:

indentLevel - number of levels of indentation for this element

Returns:

VRML97 string

See Also:

• X3D.FILE_EXTENSION_VRML97
• X3D Resources: Virtual Reality Modeling Language (VRML) 97
• Virtual Reality Modeling Language (VRML) 97 specification
• VRML 97 v2.1 Amendment

findElementByNameValue

public X3DConcreteElement 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. 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 class X3DConcreteElement

Parameters:

nameValue - is value of the name field being searched for in this element and child elements(if any)

Returns:

object reference to found element, null otherwise

See Also:

• findNodeByDEF(String)
• X3DConcreteElement.hasAncestorScene()
• X3DConcreteElement.findAncestorX3D()

findElementByNameValue

public X3DConcreteElement 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. 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 class X3DConcreteElement

Parameters:

nameValue - is value of the name field being searched for in this element and child elements(if any)

elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)

Returns:

object reference to found element, null otherwise

See Also:

• findNodeByDEF(String)
• X3DConcreteElement.hasAncestorScene()
• X3DConcreteElement.findAncestorX3D()

hasElementByNameValue

public 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.

Parameters:

nameValue - is value of the name field being searched for in this element and child elements(if any)

elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)

Returns:

whether node is found

See Also:

• findElementByNameValue(String, String)

findNodeByDEF

public X3DConcreteNode findNodeByDEF(String DEFvalue)

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 class X3DConcreteElement

Parameters:

DEFvalue - is value of the name field being searched for in this element and child elements(if any)

Returns:

object reference to found node, null otherwise

See Also:

• findElementByNameValue(String)
• X3DConcreteElement.hasAncestorScene()
• X3DConcreteElement.findAncestorX3D()

hasNodeByDEF

public boolean hasNodeByDEF(String DEFvalue)

Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.

Parameters:

DEFvalue - is value of the name field being searched for in this element and child elements(if any)

Returns:

whether node is found

See Also:

• findNodeByDEF(String)

validate

public String validate()

Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values. TODO document specific validation methods.

Specified by:

validate in class X3DConcreteElement

Returns:

validation results (if any)