Class UniversalJoint

java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.RigidBodyPhysics.UniversalJoint
All Implemented Interfaces:
X3DNode, UniversalJoint, X3DRigidJointNode

public class UniversalJoint
extends X3DConcreteNode
implements UniversalJoint
UniversalJoint is like a BallJoint that constrains an extra degree of rotational freedom.

X3D node tooltip: (X3D version 3.2 or later) [X3DRigidJointNode] UniversalJoint is like a BallJoint that constrains an extra degree of rotational freedom. Contains two RigidBody nodes (containerField values body1, body2).
  • Hint: useful in combination with BallJoint.
  • Hint: RigidBodyPhysics component, level 2.

Package hint: This org.web3d.x3d.jsail concrete class is used for implementing a standalone X3D object as a Plain Old Java Object (POJO). If you are writing Java code for use inside an X3D Script node, compile separate code using only the org.web3d.x3d.sai package instead.
See Also:
X3D Abstract Specification: UniversalJoint, X3D Tooltips: UniversalJoint, X3D Scene Authoring Hints
  • Field Details

    • FORCEOUTPUT_ALL

      public static final java.lang.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 java.lang.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 java.lang.String NAME
      String constant NAME provides name of this element: UniversalJoint.
      See Also:
      Constant Field Values
    • COMPONENT

      public static final java.lang.String COMPONENT
      String constant COMPONENT defines X3D component for the UniversalJoint 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).
    • AXIS1_DEFAULT_VALUE

      public static final float[] AXIS1_DEFAULT_VALUE
      SFVec3f field named axis1 has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).
    • AXIS2_DEFAULT_VALUE

      public static final float[] AXIS2_DEFAULT_VALUE
      SFVec3f field named axis2 has default value {0f,0f,0f} (Java syntax) or 0 0 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 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 IS IS_DEFAULT_VALUE
      SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).
    • METADATA_DEFAULT_VALUE

      public static final X3DMetadataObject METADATA_DEFAULT_VALUE
      SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).
    • STOP1BOUNCE_DEFAULT_VALUE

      public static final float STOP1BOUNCE_DEFAULT_VALUE
      SFFloat field named stop1Bounce has default value 0f (Java syntax) or 0 (XML syntax).
      See Also:
      Constant Field Values
    • STOP1ERRORCORRECTION_DEFAULT_VALUE

      public static final float STOP1ERRORCORRECTION_DEFAULT_VALUE
      SFFloat field named stop1ErrorCorrection has default value 0.8f (Java syntax) or 0.8 (XML syntax).
      See Also:
      Constant Field Values
    • STOP2BOUNCE_DEFAULT_VALUE

      public static final float STOP2BOUNCE_DEFAULT_VALUE
      SFFloat field named stop2Bounce has default value 0f (Java syntax) or 0 (XML syntax).
      See Also:
      Constant Field Values
    • STOP2ERRORCORRECTION_DEFAULT_VALUE

      public static final float STOP2ERRORCORRECTION_DEFAULT_VALUE
      SFFloat field named stop2ErrorCorrection has default value 0.8f (Java syntax) or 0.8 (XML syntax).
      See Also:
      Constant Field Values
    • containerField_DEFAULT_VALUE

      public static final java.lang.String containerField_DEFAULT_VALUE
      containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.
      See Also:
      X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM), 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_AXIS1

      public static final java.lang.String fromField_AXIS1
      fromField ROUTE name for SFVec3f field named axis1.
      See Also:
      Constant Field Values
    • toField_AXIS1

      public static final java.lang.String toField_AXIS1
      toField ROUTE name for SFVec3f field named axis1.
      See Also:
      Constant Field Values
    • fromField_AXIS2

      public static final java.lang.String fromField_AXIS2
      fromField ROUTE name for SFVec3f field named axis2.
      See Also:
      Constant Field Values
    • toField_AXIS2

      public static final java.lang.String toField_AXIS2
      toField ROUTE name for SFVec3f field named axis2.
      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_BODY1AXIS

      public static final java.lang.String fromField_BODY1AXIS
      fromField ROUTE name for SFVec3f field named body1Axis.
      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_BODY2AXIS

      public static final java.lang.String fromField_BODY2AXIS
      fromField ROUTE name for SFFloat field named body2Axis.
      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_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_STOP1BOUNCE

      public static final java.lang.String fromField_STOP1BOUNCE
      fromField ROUTE name for SFFloat field named stop1Bounce.
      See Also:
      Constant Field Values
    • toField_STOP1BOUNCE

      public static final java.lang.String toField_STOP1BOUNCE
      toField ROUTE name for SFFloat field named stop1Bounce.
      See Also:
      Constant Field Values
    • fromField_STOP1ERRORCORRECTION

      public static final java.lang.String fromField_STOP1ERRORCORRECTION
      fromField ROUTE name for SFFloat field named stop1ErrorCorrection.
      See Also:
      Constant Field Values
    • toField_STOP1ERRORCORRECTION

      public static final java.lang.String toField_STOP1ERRORCORRECTION
      toField ROUTE name for SFFloat field named stop1ErrorCorrection.
      See Also:
      Constant Field Values
    • fromField_STOP2BOUNCE

      public static final java.lang.String fromField_STOP2BOUNCE
      fromField ROUTE name for SFFloat field named stop2Bounce.
      See Also:
      Constant Field Values
    • toField_STOP2BOUNCE

      public static final java.lang.String toField_STOP2BOUNCE
      toField ROUTE name for SFFloat field named stop2Bounce.
      See Also:
      Constant Field Values
    • fromField_STOP2ERRORCORRECTION

      public static final java.lang.String fromField_STOP2ERRORCORRECTION
      fromField ROUTE name for SFFloat field named stop2ErrorCorrection.
      See Also:
      Constant Field Values
    • toField_STOP2ERRORCORRECTION

      public static final java.lang.String toField_STOP2ERRORCORRECTION
      toField ROUTE name for SFFloat field named stop2ErrorCorrection.
      See Also:
      Constant Field Values
  • Constructor Details

    • UniversalJoint

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

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

    • getElementName

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

      public final java.lang.String getComponent()
      Defines X3D component for the UniversalJoint 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
    • getContainerFieldDefault

      public final java.lang.String getContainerFieldDefault()
      containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.
      Specified by:
      getContainerFieldDefault in class X3DConcreteNode
      Returns:
      default containerField value
      See Also:
      X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM)
    • initialize

      public final void initialize()
      Initialize all member variables to default values.
      Overrides:
      initialize in 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 UniversalJoint
      Returns:
      value of anchorPoint field
    • setAnchorPoint

      public UniversalJoint 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 UniversalJoint
      Parameters:
      newValue - is new value for the anchorPoint field.
      Returns:
      UniversalJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setAnchorPoint

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

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

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

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

      public float[] getAxis1()
      Provide array of 3-tuple float results from inputOutput SFVec3f field named axis1.

      Tooltip: axis1 defines axis vector of joint connection to body1.
      • Hint: 0 0 0 means motor disabled.
      Specified by:
      getAxis1 in interface UniversalJoint
      Returns:
      value of axis1 field
    • setAxis1

      public UniversalJoint setAxis1​(float[] newValue)
      Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named axis1.

      Tooltip: axis1 defines axis vector of joint connection to body1.
      • Hint: 0 0 0 means motor disabled.
      Specified by:
      setAxis1 in interface UniversalJoint
      Parameters:
      newValue - is new value for the axis1 field.
      Returns:
      UniversalJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setAxis1

      public UniversalJoint setAxis1​(SFVec3f newValue)
      Assign typed object value to SFVec3f axis1 field, similar to setAxis1(float[]).
      Parameters:
      newValue - is new value for the axis1 field.
      Returns:
      UniversalJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setAxis1

      public UniversalJoint setAxis1​(float x, float y, float z)
      Assign values to SFVec3f axis1 field, similar to setAxis1(float[]).
      Parameters:
      x - first component
      y - second component
      z - third component
      Returns:
      UniversalJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setAxis1

      public UniversalJoint setAxis1​(double x, double y, double z)
      Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setAxis1(float[]).
      Parameters:
      x - first component
      y - second component
      z - third component
      Returns:
      UniversalJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setAxis1

      public UniversalJoint setAxis1​(double[] newArray)
      Utility method: double-precision set-array accessor for X3D floating-point type, similar to setAxis1(float[]).
      Parameters:
      newArray - is new value for field
      Returns:
      UniversalJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getAxis2

      public float[] getAxis2()
      Provide array of 3-tuple float results from inputOutput SFVec3f field named axis2.

      Tooltip: axis2 defines axis vector of joint connection to body2.
      • Hint: 0 0 0 means motor disabled.
      Specified by:
      getAxis2 in interface UniversalJoint
      Returns:
      value of axis2 field
    • setAxis2

      public UniversalJoint setAxis2​(float[] newValue)
      Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named axis2.

      Tooltip: axis2 defines axis vector of joint connection to body2.
      • Hint: 0 0 0 means motor disabled.
      Specified by:
      setAxis2 in interface UniversalJoint
      Parameters:
      newValue - is new value for the axis2 field.
      Returns:
      UniversalJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setAxis2

      public UniversalJoint setAxis2​(SFVec3f newValue)
      Assign typed object value to SFVec3f axis2 field, similar to setAxis2(float[]).
      Parameters:
      newValue - is new value for the axis2 field.
      Returns:
      UniversalJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setAxis2

      public UniversalJoint setAxis2​(float x, float y, float z)
      Assign values to SFVec3f axis2 field, similar to setAxis2(float[]).
      Parameters:
      x - first component
      y - second component
      z - third component
      Returns:
      UniversalJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setAxis2

      public UniversalJoint setAxis2​(double x, double y, double z)
      Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setAxis2(float[]).
      Parameters:
      x - first component
      y - second component
      z - third component
      Returns:
      UniversalJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setAxis2

      public UniversalJoint setAxis2​(double[] newArray)
      Utility method: double-precision set-array accessor for X3D floating-point type, similar to setAxis2(float[]).
      Parameters:
      newArray - is new value for field
      Returns:
      UniversalJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getBody1

      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 UniversalJoint
      Specified by:
      getBody1 in interface X3DRigidJointNode
      Returns:
      value of body1 field
      See Also:
      getBody1ProtoInstance()
    • setBody1

      public UniversalJoint 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 UniversalJoint
      Specified by:
      setBody1 in interface X3DRigidJointNode
      Parameters:
      newValue - is new value for the body1 field.
      Returns:
      UniversalJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setBody1(ProtoInstance)
    • clearBody1

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

      public UniversalJoint 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:
      UniversalJoint - 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.
      Specified by:
      getBody1AnchorPoint in interface UniversalJoint
      Returns:
      value of body1AnchorPoint field
    • getBody1Axis

      public float[] getBody1Axis()
      Provide array of 3-tuple float results from outputOnly SFVec3f field named body1Axis.
      Specified by:
      getBody1Axis in interface UniversalJoint
      Returns:
      value of body1Axis 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 UniversalJoint
      Specified by:
      getBody2 in interface X3DRigidJointNode
      Returns:
      value of body2 field
      See Also:
      getBody2ProtoInstance()
    • setBody2

      public UniversalJoint 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 UniversalJoint
      Specified by:
      setBody2 in interface X3DRigidJointNode
      Parameters:
      newValue - is new value for the body2 field.
      Returns:
      UniversalJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setBody2(ProtoInstance)
    • clearBody2

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

      public UniversalJoint 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:
      UniversalJoint - 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.
      Specified by:
      getBody2AnchorPoint in interface UniversalJoint
      Returns:
      value of body2AnchorPoint field
    • getBody2Axis

      public float getBody2Axis()
      Provide float value from outputOnly SFFloat field named body2Axis.
      Specified by:
      getBody2Axis in interface UniversalJoint
      Returns:
      value of body2Axis field
    • getForceOutput

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

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


      Available enumeration values for string comparison: ALL, NONE.
      Specified by:
      getForceOutput in interface UniversalJoint
      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
    • getForceOutputString

      public java.lang.String getForceOutputString()
      Utility method to get String value of MFString forceOutput field, similar to getForceOutput().
      Returns:
      value of forceOutput field
    • setForceOutput

      public UniversalJoint 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 UniversalJoint
      Specified by:
      setForceOutput in interface X3DRigidJointNode
      Parameters:
      newValue - is new value for the forceOutput field.
      Returns:
      UniversalJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setForceOutput

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

      public UniversalJoint 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:
      UniversalJoint - 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 UniversalJoint setForceOutput​(java.lang.String newValue)
      Assign singleton String value to MFString forceOutput field, similar to setForceOutput(String[]).
      Parameters:
      newValue - is new value for the forceOutput field.
      Returns:
      UniversalJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      MFString.cleanupEnumerationValues(String)
    • setForceOutput

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

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

      public UniversalJoint addForceOutput​(java.lang.String newValue)
      Add singleton String value to MFString forceOutput field.
      Parameters:
      newValue - is new value to add to the forceOutput field.
      Returns:
      UniversalJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      MFString.cleanupEnumerationValues(String)
    • addForceOutput

      public UniversalJoint addForceOutput​(SFString newValue)
      Add singleton SFString value to MFString forceOutput field.
      Parameters:
      newValue - is new value to add to the forceOutput field.
      Returns:
      UniversalJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      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 UniversalJoint 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:
      UniversalJoint - 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 UniversalJoint clearIS()
      Utility method to clear SFNode value of IS field.
      Returns:
      UniversalJoint - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • hasIS

      public boolean hasIS()
      Indicate whether an object is available for inputOutput SFNode field IS.
      Returns:
      whether a concrete statement or CommentsBlock is available.
      See Also:
      getIS()
    • 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 UniversalJoint
      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/X3Dv4Draft/ISO-IEC19775-1v4-WD2/Part01/components/core.html#Metadata , X3D Scene Authoring Hints: Metadata Nodes
    • setMetadata

      public UniversalJoint 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 UniversalJoint
      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:
      UniversalJoint - 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/X3Dv4Draft/ISO-IEC19775-1v4-WD2/Part01/components/core.html#Metadata , X3D Scene Authoring Hints: Metadata Nodes
    • clearMetadata

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

      public UniversalJoint 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:
      UniversalJoint - 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
    • getStop1Bounce

      public float getStop1Bounce()
      Provide float value within allowed range of [0,1] from inputOutput SFFloat field named stop1Bounce.

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

      public UniversalJoint setStop1Bounce​(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named stop1Bounce.

      Tooltip: [0,1] stop1Bounce is velocity factor for bounce back once stop point is reached.
      • Hint: 0 means no bounce, 1 means return velocity matches.
      Specified by:
      setStop1Bounce in interface UniversalJoint
      Parameters:
      newValue - is new value for the stop1Bounce field.
      Returns:
      UniversalJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setStop1Bounce

      public UniversalJoint setStop1Bounce​(SFFloat newValue)
      Assign typed object value to SFFloat stop1Bounce field, similar to setStop1Bounce(float).
      Parameters:
      newValue - is new value for the stop1Bounce field.
      Returns:
      UniversalJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setStop1Bounce

      public UniversalJoint setStop1Bounce​(double newValue)
      Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setStop1Bounce(float).
      Parameters:
      newValue - is new value for field
      Returns:
      UniversalJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getStop1ErrorCorrection

      public float getStop1ErrorCorrection()
      Provide float value within allowed range of [0,1] from inputOutput SFFloat field named stop1ErrorCorrection.

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

      public UniversalJoint setStop1ErrorCorrection​(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named stop1ErrorCorrection.

      Tooltip: [0,1] stop1ErrorCorrection is fraction of error correction performed during time step once stop point is reached.
      • Hint: 0 means no error correction, 1 means all error corrected in single step.
      Specified by:
      setStop1ErrorCorrection in interface UniversalJoint
      Parameters:
      newValue - is new value for the stop1ErrorCorrection field.
      Returns:
      UniversalJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setStop1ErrorCorrection

      public UniversalJoint setStop1ErrorCorrection​(SFFloat newValue)
      Assign typed object value to SFFloat stop1ErrorCorrection field, similar to setStop1ErrorCorrection(float).
      Parameters:
      newValue - is new value for the stop1ErrorCorrection field.
      Returns:
      UniversalJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setStop1ErrorCorrection

      public UniversalJoint setStop1ErrorCorrection​(double newValue)
      Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setStop1ErrorCorrection(float).
      Parameters:
      newValue - is new value for field
      Returns:
      UniversalJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getStop2Bounce

      public float getStop2Bounce()
      Provide float value within allowed range of [0,1] from inputOutput SFFloat field named stop2Bounce.

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

      public UniversalJoint setStop2Bounce​(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named stop2Bounce.

      Tooltip: [0,1] stop2Bounce is velocity factor for bounce back once stop point is reached.
      • Hint: 0 means no bounce, 1 means return velocity matches.
      Specified by:
      setStop2Bounce in interface UniversalJoint
      Parameters:
      newValue - is new value for the stop2Bounce field.
      Returns:
      UniversalJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setStop2Bounce

      public UniversalJoint setStop2Bounce​(SFFloat newValue)
      Assign typed object value to SFFloat stop2Bounce field, similar to setStop2Bounce(float).
      Parameters:
      newValue - is new value for the stop2Bounce field.
      Returns:
      UniversalJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setStop2Bounce

      public UniversalJoint setStop2Bounce​(double newValue)
      Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setStop2Bounce(float).
      Parameters:
      newValue - is new value for field
      Returns:
      UniversalJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getStop2ErrorCorrection

      public float getStop2ErrorCorrection()
      Provide float value within allowed range of [0,1] from inputOutput SFFloat field named stop2ErrorCorrection.

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

      public UniversalJoint setStop2ErrorCorrection​(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named stop2ErrorCorrection.

      Tooltip: [0,1] stop2ErrorCorrection is fraction of error correction performed during time step once stop point is reached.
      • Hint: 0 means no error correction, 1 means all error corrected in single step.
      Specified by:
      setStop2ErrorCorrection in interface UniversalJoint
      Parameters:
      newValue - is new value for the stop2ErrorCorrection field.
      Returns:
      UniversalJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setStop2ErrorCorrection

      public UniversalJoint setStop2ErrorCorrection​(SFFloat newValue)
      Assign typed object value to SFFloat stop2ErrorCorrection field, similar to setStop2ErrorCorrection(float).
      Parameters:
      newValue - is new value for the stop2ErrorCorrection field.
      Returns:
      UniversalJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setStop2ErrorCorrection

      public UniversalJoint setStop2ErrorCorrection​(double newValue)
      Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setStop2ErrorCorrection(float).
      Parameters:
      newValue - is new value for field
      Returns:
      UniversalJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getDEF

      public java.lang.String getDEF()
      Provide String value from inputOutput SFString field named DEF.

      Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.
      Overrides:
      getDEF in class X3DConcreteNode
      Returns:
      value of DEF field
      See Also:
      X3D Scene Authoring Hints: Naming Conventions
    • setDEF

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

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

      public UniversalJoint 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:
      UniversalJoint - 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 Cascading Style Sheets (CSS) and XML stylesheets.
      Overrides:
      getCssClass in class X3DConcreteNode
      Returns:
      value of class field
      See Also:
      W3C Cascading Style Sheets
    • setCssClass

      public final UniversalJoint 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 Cascading Style Sheets (CSS) and XML stylesheets.
      Specified by:
      setCssClass in class X3DConcreteNode
      Parameters:
      newValue - is new value for the class field.
      Returns:
      UniversalJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      W3C Cascading Style Sheets
    • setCssClass

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

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

      public UniversalJoint addComments​(java.lang.String newComment)
      Add comment as String to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newComment - initial value
      Returns:
      UniversalJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • addComments

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

      public UniversalJoint addComments​(CommentsBlock newCommentsBlock)
      Add CommentsBlock to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newCommentsBlock - block of comments to add
      Returns:
      UniversalJoint - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • toStringX3D

      public java.lang.String toStringX3D​(int indentLevel)
      Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
      Specified by:
      toStringX3D in 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 java.lang.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 java.lang.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​(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 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​(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 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​(java.lang.String nameValue, java.lang.String elementName)
      Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
      Parameters:
      nameValue - is value of the name field being searched for in this element and child elements(if any)
      elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
      Returns:
      whether node is found
      See Also:
      findElementByNameValue(String, String)
    • findNodeByDEF

      public X3DConcreteNode findNodeByDEF​(java.lang.String DEFvalue)
      Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.

      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​(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)