Class SingleAxisHingeJointObject

    • Field Detail

      • FORCEOUTPUT_ALL

        public static final java.lang.String FORCEOUTPUT_ALL
        MFString field named forceOutput with X3DUOM baseType forceOutputValues is an array that can include this quoted enumeration value (and alternate values) "ALL" (Java syntax) or '"ALL"' (XML syntax).
        See Also:
        forceOutputValues, Constant Field Values
      • FORCEOUTPUT_NONE

        public static final java.lang.String FORCEOUTPUT_NONE
        MFString field named forceOutput with X3DUOM baseType forceOutputValues is an array that can include this quoted enumeration value (and alternate values) "NONE" (Java syntax) or '"NONE"' (XML syntax).
        See Also:
        forceOutputValues, Constant Field Values
      • NAME

        public static final java.lang.String NAME
        String constant NAME provides name of this element: SingleAxisHingeJoint.
        See Also:
        Constant Field Values
      • COMPONENT

        public static final java.lang.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,0f,0f} (Java syntax) or 0 0 0 (XML syntax).
      • BODY1_DEFAULT_VALUE

        public static final RigidBodyObject BODY1_DEFAULT_VALUE
        SFNode field named body1 has default value null (Java syntax) or NULL (XML syntax).
      • BODY2_DEFAULT_VALUE

        public static final RigidBodyObject BODY2_DEFAULT_VALUE
        SFNode field named body2 has default value null (Java syntax) or NULL (XML syntax).
      • FORCEOUTPUT_DEFAULT_VALUE

        public static final java.util.ArrayList<java.lang.String> FORCEOUTPUT_DEFAULT_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 ISObject 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
      • fromField_ANCHORPOINT

        public static final java.lang.String fromField_ANCHORPOINT
        fromField ROUTE name for SFVec3f field named anchorPoint.
        See Also:
        Constant Field Values
      • toField_ANCHORPOINT

        public static final java.lang.String toField_ANCHORPOINT
        toField ROUTE name for SFVec3f field named anchorPoint.
        See Also:
        Constant Field Values
      • fromField_ANGLE

        public static final java.lang.String fromField_ANGLE
        fromField ROUTE name for SFFloat field named angle.
        See Also:
        Constant Field Values
      • fromField_ANGLERATE

        public static final java.lang.String fromField_ANGLERATE
        fromField ROUTE name for SFFloat field named angleRate.
        See Also:
        Constant Field Values
      • fromField_AXIS

        public static final java.lang.String fromField_AXIS
        fromField ROUTE name for SFVec3f field named axis.
        See Also:
        Constant Field Values
      • toField_AXIS

        public static final java.lang.String toField_AXIS
        toField ROUTE name for SFVec3f field named axis.
        See Also:
        Constant Field Values
      • fromField_BODY1

        public static final java.lang.String fromField_BODY1
        fromField ROUTE name for SFNode field named body1.
        See Also:
        Constant Field Values
      • toField_BODY1

        public static final java.lang.String toField_BODY1
        toField ROUTE name for SFNode field named body1.
        See Also:
        Constant Field Values
      • fromField_BODY1ANCHORPOINT

        public static final java.lang.String fromField_BODY1ANCHORPOINT
        fromField ROUTE name for SFVec3f field named body1AnchorPoint.
        See Also:
        Constant Field Values
      • fromField_BODY2

        public static final java.lang.String fromField_BODY2
        fromField ROUTE name for SFNode field named body2.
        See Also:
        Constant Field Values
      • toField_BODY2

        public static final java.lang.String toField_BODY2
        toField ROUTE name for SFNode field named body2.
        See Also:
        Constant Field Values
      • fromField_BODY2ANCHORPOINT

        public static final java.lang.String fromField_BODY2ANCHORPOINT
        fromField ROUTE name for SFVec3f field named body2AnchorPoint.
        See Also:
        Constant Field Values
      • fromField_FORCEOUTPUT

        public static final java.lang.String fromField_FORCEOUTPUT
        fromField ROUTE name for MFString field named forceOutput.
        See Also:
        Constant Field Values
      • toField_FORCEOUTPUT

        public static final java.lang.String toField_FORCEOUTPUT
        toField ROUTE name for MFString field named forceOutput.
        See Also:
        Constant Field Values
      • fromField_IS

        public static final java.lang.String fromField_IS
        fromField ROUTE name for SFNode field named IS.
        See Also:
        Constant Field Values
      • fromField_MAXANGLE

        public static final java.lang.String fromField_MAXANGLE
        fromField ROUTE name for SFFloat field named maxAngle.
        See Also:
        Constant Field Values
      • toField_MAXANGLE

        public static final java.lang.String toField_MAXANGLE
        toField ROUTE name for SFFloat field named maxAngle.
        See Also:
        Constant Field Values
      • fromField_METADATA

        public static final java.lang.String fromField_METADATA
        fromField ROUTE name for SFNode field named metadata.
        See Also:
        Constant Field Values
      • toField_METADATA

        public static final java.lang.String toField_METADATA
        toField ROUTE name for SFNode field named metadata.
        See Also:
        Constant Field Values
      • fromField_MINANGLE

        public static final java.lang.String fromField_MINANGLE
        fromField ROUTE name for SFFloat field named minAngle.
        See Also:
        Constant Field Values
      • toField_MINANGLE

        public static final java.lang.String toField_MINANGLE
        toField ROUTE name for SFFloat field named minAngle.
        See Also:
        Constant Field Values
      • fromField_STOPBOUNCE

        public static final java.lang.String fromField_STOPBOUNCE
        fromField ROUTE name for SFFloat field named stopBounce.
        See Also:
        Constant Field Values
      • toField_STOPBOUNCE

        public static final java.lang.String toField_STOPBOUNCE
        toField ROUTE name for SFFloat field named stopBounce.
        See Also:
        Constant Field Values
      • fromField_STOPERRORCORRECTION

        public static final java.lang.String fromField_STOPERRORCORRECTION
        fromField ROUTE name for SFFloat field named stopErrorCorrection.
        See Also:
        Constant Field Values
      • toField_STOPERRORCORRECTION

        public static final java.lang.String toField_STOPERRORCORRECTION
        toField ROUTE name for SFFloat field named stopErrorCorrection.
        See Also:
        Constant Field Values
    • Constructor Detail

      • SingleAxisHingeJointObject

        public SingleAxisHingeJointObject()
        Constructor for SingleAxisHingeJointObject to initialize member variables with default values.
      • SingleAxisHingeJointObject

        public SingleAxisHingeJointObject​(java.lang.String DEFlabel)
        Utility constructor that assigns DEF label after initializing member variables with default values.
        Parameters:
        DEFlabel - unique DEF name for this X3D node
    • Method Detail

      • getElementName

        public final java.lang.String getElementName()
        Provides name of this element: SingleAxisHingeJoint
        Specified by:
        getElementName in class X3DConcreteElement
        Returns:
        name of this element
      • getComponent

        public final java.lang.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 java.lang.String getFieldType​(java.lang.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 java.lang.String getAccessType​(java.lang.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
      • 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 SingleAxisHingeJointObject 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:
        SingleAxisHingeJointObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setAnchorPoint

        public SingleAxisHingeJointObject 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:
        SingleAxisHingeJointObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setAnchorPoint

        public SingleAxisHingeJointObject 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:
        SingleAxisHingeJointObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setAnchorPoint

        public SingleAxisHingeJointObject 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:
        SingleAxisHingeJointObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • getAngle

        public float getAngle()
        Provide float value unit axis, angle (in radians) from outputOnly SFFloat field named angle.
        Specified by:
        getAngle in 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 SingleAxisHingeJointObject 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:
        SingleAxisHingeJointObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setAxis

        public SingleAxisHingeJointObject 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:
        SingleAxisHingeJointObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setAxis

        public SingleAxisHingeJointObject 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:
        SingleAxisHingeJointObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setAxis

        public SingleAxisHingeJointObject 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:
        SingleAxisHingeJointObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • getBody1

        public RigidBody getBody1()
        Provide RigidBodyObject 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:
        getBody1ProtoInstance()
      • clearBody1

        public SingleAxisHingeJointObject clearBody1()
        Utility method to clear SFNode value of body1 field.
        Returns:
        SingleAxisHingeJointObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • hasBody1

        public boolean hasBody1()
        Indicate whether an object is available for inputOutput SFNode field body1.
        Returns:
        whether a properly typed node or ProtoInstance or CommentsBlock is available.
        See Also:
        getBody1(), getBody1ProtoInstance()
      • getBody1AnchorPoint

        public float[] getBody1AnchorPoint()
        Provide array of 3-tuple float results from outputOnly SFVec3f field named body1AnchorPoint.
        Specified by:
        getBody1AnchorPoint in interface SingleAxisHingeJoint
        Returns:
        value of body1AnchorPoint field
      • getBody2

        public RigidBody getBody2()
        Provide RigidBodyObject 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:
        getBody2ProtoInstance()
      • clearBody2

        public SingleAxisHingeJointObject clearBody2()
        Utility method to clear SFNode value of body2 field.
        Returns:
        SingleAxisHingeJointObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • hasBody2

        public boolean hasBody2()
        Indicate whether an object is available for inputOutput SFNode field body2.
        Returns:
        whether a properly typed node or ProtoInstance or CommentsBlock is available.
        See Also:
        getBody2(), getBody2ProtoInstance()
      • getBody2AnchorPoint

        public float[] getBody2AnchorPoint()
        Provide array of 3-tuple float results from outputOnly SFVec3f field named body2AnchorPoint.
        Specified by:
        getBody2AnchorPoint in interface SingleAxisHingeJoint
        Returns:
        value of body2AnchorPoint field
      • getForceOutput

        public java.lang.String[] getForceOutput()
        Provide array of String enumeration results ( baseType forceOutputValues) [""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 java.util.ArrayList<java.lang.String> getForceOutputList()
        Utility method to get ArrayList value of MFString forceOutput field, similar to getForceOutput().
        Returns:
        value of forceOutput field
      • setForceOutput

        public SingleAxisHingeJointObject setForceOutput​(java.lang.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:
        SingleAxisHingeJointObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setForceOutput

        public SingleAxisHingeJointObject setForceOutput​(java.util.ArrayList<java.lang.String> newValue)
        Assign ArrayList value of MFString forceOutput field, similar to setForceOutput(String[]).
        Parameters:
        newValue - is new value for the forceOutput field.
        Returns:
        SingleAxisHingeJointObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • clearForceOutput

        public SingleAxisHingeJointObject clearForceOutput()
        Utility method to clear MFString value of forceOutput field.
        Returns:
        SingleAxisHingeJointObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • hasIS

        public boolean hasIS()
        Indicate whether an object is available for inputOutput SFNode field IS.
        Returns:
        whether a concrete statement or CommentsBlock is available.
        See Also:
        getIS()
      • getMaxAngle

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

        Tooltip: [-pi,pi] maxAngle is maximum rotation angle for hinge.
        Specified by:
        getMaxAngle in interface SingleAxisHingeJoint
        Returns:
        value of maxAngle field
      • setMaxAngle

        public SingleAxisHingeJointObject 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:
        SingleAxisHingeJointObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • clearMetadata

        public SingleAxisHingeJointObject clearMetadata()
        Utility method to clear SFNode value of metadata field.
        Returns:
        SingleAxisHingeJointObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • hasMetadata

        public boolean hasMetadata()
        Indicate whether an object is available for inputOutput SFNode field metadata.
        Returns:
        whether a properly typed node or ProtoInstance or CommentsBlock is available.
        See Also:
        getMetadata(), getMetadataProtoInstance(), X3D Scene Authoring Hints: Metadata Nodes
      • getMinAngle

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

        Tooltip: [-pi,pi] minAngle is minimum rotation angle for hinge.
        Specified by:
        getMinAngle in interface SingleAxisHingeJoint
        Returns:
        value of minAngle field
      • setMinAngle

        public SingleAxisHingeJointObject 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:
        SingleAxisHingeJointObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • getStopBounce

        public float getStopBounce()
        Provide float value from inputOutput SFFloat field named stopBounce.

        Tooltip: [0,1] stopBounce is velocity factor for bounce back once stop point is reached.
        • Hint: 0 means no bounce, 1 means return velocity matches.
        Specified by:
        getStopBounce in interface SingleAxisHingeJoint
        Returns:
        value of stopBounce field
      • setStopBounce

        public SingleAxisHingeJointObject 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:
        SingleAxisHingeJointObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setStopBounce

        public SingleAxisHingeJointObject 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:
        SingleAxisHingeJointObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • getStopErrorCorrection

        public float getStopErrorCorrection()
        Provide float value from inputOutput SFFloat field named stopErrorCorrection.

        Tooltip: [0,1] stopErrorCorrection is fraction of error correction performed during time step once stop point is reached.
        • Hint: 0 means no error correction, 1 means all error corrected in single step.
        Specified by:
        getStopErrorCorrection in interface SingleAxisHingeJoint
        Returns:
        value of stopErrorCorrection field
      • setStopErrorCorrection

        public SingleAxisHingeJointObject 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:
        SingleAxisHingeJointObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setStopErrorCorrection

        public SingleAxisHingeJointObject 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:
        SingleAxisHingeJointObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setDEF

        public final SingleAxisHingeJointObject setDEF​(java.lang.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.

        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:
        SingleAxisHingeJointObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • getUSE

        public java.lang.String getUSE()
        Provide String value from inputOutput SFString field named USE.

        Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value).
        • Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
        • Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute.
        • Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
        Overrides:
        getUSE in class X3DConcreteNode
        Returns:
        value of USE field
        See Also:
        X3D Scene Authoring Hints: Naming Conventions
      • setUSE

        public final SingleAxisHingeJointObject setUSE​(java.lang.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:
        SingleAxisHingeJointObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • getCssClass

        public java.lang.String getCssClass()
        Provide String value from inputOutput SFString field named class.

        Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
        • Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
        • Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
        Overrides:
        getCssClass in class X3DConcreteNode
        Returns:
        value of class field
        See Also:
        W3C Cascading Style Sheets
      • setCssClass

        public final SingleAxisHingeJointObject setCssClass​(java.lang.String newValue)
        Accessor method to assign String value to inputOutput SFString field named class.

        Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
        • Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
        • Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
        Specified by:
        setCssClass in class X3DConcreteNode
        Parameters:
        newValue - is new value for the class field.
        Returns:
        SingleAxisHingeJointObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
        See Also:
        W3C Cascading Style Sheets
      • setUSE

        public SingleAxisHingeJointObject setUSE​(SingleAxisHingeJointObject 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:
        SingleAxisHingeJointObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • addComments

        public SingleAxisHingeJointObject addComments​(java.lang.String[] newComments)
        Add comments as String[] array to contained commentsList.
        Specified by:
        addComments in class X3DConcreteElement
        Parameters:
        newComments - array of comments
        Returns:
        SingleAxisHingeJointObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • findElementByNameValue

        public X3DConcreteElement findElementByNameValue​(java.lang.String nameValue)
        Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.

        Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.

        Warning: more than one element may be found that has the same name, this method does not handle that case.
        Specified by:
        findElementByNameValue in 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.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
      • findElementByNameValue

        public X3DConcreteElement findElementByNameValue​(java.lang.String nameValue,
                                                         java.lang.String elementName)
        Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.

        Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.

        Warning: more than one element may be found that has the same name, this method does not handle that case.
        Specified by:
        findElementByNameValue in 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.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
      • hasElementByNameValue

        public boolean hasElementByNameValue​(java.lang.String nameValue,
                                             java.lang.String elementName)
        Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
        Parameters:
        nameValue - is value of the name field being searched for in this element and child elements(if any)
        elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
        Returns:
        whether node is found
        See Also:
        findElementByNameValue(String, String)
      • hasNodeByDEF

        public boolean hasNodeByDEF​(java.lang.String DEFvalue)
        Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
        Parameters:
        DEFvalue - is value of the name field being searched for in this element and child elements(if any)
        Returns:
        whether node is found
        See Also:
        findNodeByDEF(String)
      • validate

        public java.lang.String validate()
        Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.
        Specified by:
        validate in class X3DConcreteElement
        Returns:
        validation results (if any)