Class MotorJoint

All Implemented Interfaces:
X3DNode, MotorJoint, X3DRigidJointNode

public class MotorJoint extends X3DConcreteNode implements MotorJoint
MotorJoint drives relative angular velocities between body1 and body2 within a common reference frame.

X3D node tooltip: (X3D version 3.2 or later) [X3DRigidJointNode] MotorJoint drives relative angular velocities between body1 and body2 within a common reference frame. 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: MotorJoint, X3D Tooltips: MotorJoint, X3D Scene Authoring Hints
  • Field Details

    • FORCEOUTPUT_ALL

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

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

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

      public static final String COMPONENT
      String constant COMPONENT defines X3D component for the MotorJoint 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
    • AUTOCALC_DEFAULT_VALUE

      public static final boolean AUTOCALC_DEFAULT_VALUE
      SFBool field named autoCalc has default value false (Java syntax) or false (XML syntax).
      See Also:
      Constant Field Values
    • AXIS1ANGLE_DEFAULT_VALUE

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

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

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

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

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

      public static final float AXIS3TORQUE_DEFAULT_VALUE
      SFFloat field named axis3Torque has default value 0f (Java syntax) or 0 (XML syntax).
      See Also:
      Constant Field Values
    • 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).
    • ENABLEDAXES_DEFAULT_VALUE

      public static final int ENABLEDAXES_DEFAULT_VALUE
      SFInt32 field named enabledAxes has default value 1 (Java syntax) or 1 (XML syntax).
      See Also:
      Constant Field Values
    • FORCEOUTPUT_DEFAULT_VALUE

      public static final ArrayList<String> FORCEOUTPUT_DEFAULT_VALUE
      MFString field named forceOutput has default quoted value new String[] {"NONE"} (Java syntax) or quoted value "NONE" (XML syntax).
    • IS_DEFAULT_VALUE

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

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

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

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

      public static final float[] MOTOR3AXIS_DEFAULT_VALUE
      SFVec3f field named motor3Axis has default value {0f,0f,0f} (Java syntax) or 0 0 0 (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
    • STOP3BOUNCE_DEFAULT_VALUE

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

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

      public static final String containerField_DEFAULT_VALUE
      containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.
      See Also:
      X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM), Constant Field Values
    • fromField_AXIS1ANGLE

      public static final String fromField_AXIS1ANGLE
      fromField ROUTE name for SFFloat field named axis1Angle.
      See Also:
      Constant Field Values
    • toField_AXIS1ANGLE

      public static final String toField_AXIS1ANGLE
      toField ROUTE name for SFFloat field named axis1Angle.
      See Also:
      Constant Field Values
    • fromField_AXIS1TORQUE

      public static final String fromField_AXIS1TORQUE
      fromField ROUTE name for SFFloat field named axis1Torque.
      See Also:
      Constant Field Values
    • toField_AXIS1TORQUE

      public static final String toField_AXIS1TORQUE
      toField ROUTE name for SFFloat field named axis1Torque.
      See Also:
      Constant Field Values
    • fromField_AXIS2ANGLE

      public static final String fromField_AXIS2ANGLE
      fromField ROUTE name for SFFloat field named axis2Angle.
      See Also:
      Constant Field Values
    • toField_AXIS2ANGLE

      public static final String toField_AXIS2ANGLE
      toField ROUTE name for SFFloat field named axis2Angle.
      See Also:
      Constant Field Values
    • fromField_AXIS2TORQUE

      public static final String fromField_AXIS2TORQUE
      fromField ROUTE name for SFFloat field named axis2Torque.
      See Also:
      Constant Field Values
    • toField_AXIS2TORQUE

      public static final String toField_AXIS2TORQUE
      toField ROUTE name for SFFloat field named axis2Torque.
      See Also:
      Constant Field Values
    • fromField_AXIS3ANGLE

      public static final String fromField_AXIS3ANGLE
      fromField ROUTE name for SFFloat field named axis3Angle.
      See Also:
      Constant Field Values
    • toField_AXIS3ANGLE

      public static final String toField_AXIS3ANGLE
      toField ROUTE name for SFFloat field named axis3Angle.
      See Also:
      Constant Field Values
    • fromField_AXIS3TORQUE

      public static final String fromField_AXIS3TORQUE
      fromField ROUTE name for SFFloat field named axis3Torque.
      See Also:
      Constant Field Values
    • toField_AXIS3TORQUE

      public static final String toField_AXIS3TORQUE
      toField ROUTE name for SFFloat field named axis3Torque.
      See Also:
      Constant Field Values
    • fromField_BODY1

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

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

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

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

      public static final String fromField_ENABLEDAXES
      fromField ROUTE name for SFInt32 field named enabledAxes.
      See Also:
      Constant Field Values
    • toField_ENABLEDAXES

      public static final String toField_ENABLEDAXES
      toField ROUTE name for SFInt32 field named enabledAxes.
      See Also:
      Constant Field Values
    • fromField_FORCEOUTPUT

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

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

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

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

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

      public static final String fromField_MOTOR1ANGLE
      fromField ROUTE name for SFFloat field named motor1Angle.
      See Also:
      Constant Field Values
    • fromField_MOTOR1ANGLERATE

      public static final String fromField_MOTOR1ANGLERATE
      fromField ROUTE name for SFFloat field named motor1AngleRate.
      See Also:
      Constant Field Values
    • fromField_MOTOR1AXIS

      public static final String fromField_MOTOR1AXIS
      fromField ROUTE name for SFVec3f field named motor1Axis.
      See Also:
      Constant Field Values
    • toField_MOTOR1AXIS

      public static final String toField_MOTOR1AXIS
      toField ROUTE name for SFVec3f field named motor1Axis.
      See Also:
      Constant Field Values
    • fromField_MOTOR2ANGLE

      public static final String fromField_MOTOR2ANGLE
      fromField ROUTE name for SFFloat field named motor2Angle.
      See Also:
      Constant Field Values
    • fromField_MOTOR2ANGLERATE

      public static final String fromField_MOTOR2ANGLERATE
      fromField ROUTE name for SFFloat field named motor2AngleRate.
      See Also:
      Constant Field Values
    • fromField_MOTOR2AXIS

      public static final String fromField_MOTOR2AXIS
      fromField ROUTE name for SFVec3f field named motor2Axis.
      See Also:
      Constant Field Values
    • toField_MOTOR2AXIS

      public static final String toField_MOTOR2AXIS
      toField ROUTE name for SFVec3f field named motor2Axis.
      See Also:
      Constant Field Values
    • fromField_MOTOR3ANGLE

      public static final String fromField_MOTOR3ANGLE
      fromField ROUTE name for SFFloat field named motor3Angle.
      See Also:
      Constant Field Values
    • fromField_MOTOR3ANGLERATE

      public static final String fromField_MOTOR3ANGLERATE
      fromField ROUTE name for SFFloat field named motor3AngleRate.
      See Also:
      Constant Field Values
    • fromField_MOTOR3AXIS

      public static final String fromField_MOTOR3AXIS
      fromField ROUTE name for SFVec3f field named motor3Axis.
      See Also:
      Constant Field Values
    • toField_MOTOR3AXIS

      public static final String toField_MOTOR3AXIS
      toField ROUTE name for SFVec3f field named motor3Axis.
      See Also:
      Constant Field Values
    • fromField_STOP1BOUNCE

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

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

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

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

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

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

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

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

      public static final String fromField_STOP3BOUNCE
      fromField ROUTE name for SFFloat field named stop3Bounce.
      See Also:
      Constant Field Values
    • toField_STOP3BOUNCE

      public static final String toField_STOP3BOUNCE
      toField ROUTE name for SFFloat field named stop3Bounce.
      See Also:
      Constant Field Values
    • fromField_STOP3ERRORCORRECTION

      public static final String fromField_STOP3ERRORCORRECTION
      fromField ROUTE name for SFFloat field named stop3ErrorCorrection.
      See Also:
      Constant Field Values
    • toField_STOP3ERRORCORRECTION

      public static final String toField_STOP3ERRORCORRECTION
      toField ROUTE name for SFFloat field named stop3ErrorCorrection.
      See Also:
      Constant Field Values
  • Constructor Details

    • MotorJoint

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

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

    • getElementName

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

      public final String getComponent()
      Defines X3D component for the MotorJoint element: RigidBodyPhysics
      Specified by:
      getComponent in class X3DConcreteElement
      Returns:
      X3D component for this element
    • getComponentLevel

      public final int getComponentLevel()
      Provides default X3D component level for this element: 2
      Specified by:
      getComponentLevel in class X3DConcreteElement
      Returns:
      default X3D component level for this element
    • getFieldType

      public String getFieldType(String fieldName)
      Indicate type corresponding to given fieldName.
      Specified by:
      getFieldType in class X3DConcreteElement
      Parameters:
      fieldName - name of field in this X3D node
      Returns:
      X3D type (SFvec3f etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE if not recognized
      See Also:
      ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE
    • getAccessType

      public String getAccessType(String fieldName)
      Indicate accessType corresponding to given fieldName.
      Specified by:
      getAccessType in class X3DConcreteElement
      Parameters:
      fieldName - name of field in this X3D node
      Returns:
      X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized
      See Also:
      ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE
    • getContainerFieldDefault

      public final String getContainerFieldDefault()
      containerField describes typical field relationship of a node to its parent. 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
    • getAutoCalc

      public boolean getAutoCalc()
      Provide boolean value from initializeOnly SFBool field named autoCalc.

      Tooltip: autoCalc controls whether user manually provides individual angle rotations each frame (false) or if angle values are automatically calculated by motor implementations (true). *
      Specified by:
      getAutoCalc in interface MotorJoint
      Returns:
      value of autoCalc field
    • setAutoCalc

      public MotorJoint setAutoCalc(boolean newValue)
      Accessor method to assign boolean value to initializeOnly SFBool field named autoCalc.

      Tooltip: autoCalc controls whether user manually provides individual angle rotations each frame (false) or if angle values are automatically calculated by motor implementations (true). *
      Specified by:
      setAutoCalc in interface MotorJoint
      Parameters:
      newValue - is new value for the autoCalc field.
      Returns:
      MotorJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setAutoCalc

      public MotorJoint setAutoCalc(SFBool newValue)
      Assign typed object value to SFBool autoCalc field, similar to setAutoCalc(boolean).
      Parameters:
      newValue - is new value for the autoCalc field.
      Returns:
      MotorJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getAxis1Angle

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

      Tooltip: axis1Angle (radians) is rotation angle for corresponding motor axis when in user-calculated mode.
      Specified by:
      getAxis1Angle in interface MotorJoint
      Returns:
      value of axis1Angle field
    • setAxis1Angle

      public MotorJoint setAxis1Angle(float newValue)
      Accessor method to assign float value unit axis, angle (in radians) to inputOutput SFFloat field named axis1Angle.

      Tooltip: axis1Angle (radians) is rotation angle for corresponding motor axis when in user-calculated mode.
      Specified by:
      setAxis1Angle in interface MotorJoint
      Parameters:
      newValue - is new value for the axis1Angle field.
      Returns:
      MotorJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setAxis1Angle

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

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

      public float getAxis1Torque()
      Provide float value from inputOutput SFFloat field named axis1Torque.

      Tooltip: axis1Torque is rotational torque applied by corresponding motor axis when in user-calculated mode. *
      Specified by:
      getAxis1Torque in interface MotorJoint
      Returns:
      value of axis1Torque field
    • setAxis1Torque

      public MotorJoint setAxis1Torque(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named axis1Torque.

      Tooltip: axis1Torque is rotational torque applied by corresponding motor axis when in user-calculated mode. *
      Specified by:
      setAxis1Torque in interface MotorJoint
      Parameters:
      newValue - is new value for the axis1Torque field.
      Returns:
      MotorJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setAxis1Torque

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

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

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

      Tooltip: axis2Angle (radians) is rotation angle for corresponding motor axis when in user-calculated mode.
      Specified by:
      getAxis2Angle in interface MotorJoint
      Returns:
      value of axis2Angle field
    • setAxis2Angle

      public MotorJoint setAxis2Angle(float newValue)
      Accessor method to assign float value unit axis, angle (in radians) to inputOutput SFFloat field named axis2Angle.

      Tooltip: axis2Angle (radians) is rotation angle for corresponding motor axis when in user-calculated mode.
      Specified by:
      setAxis2Angle in interface MotorJoint
      Parameters:
      newValue - is new value for the axis2Angle field.
      Returns:
      MotorJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setAxis2Angle

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

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

      public float getAxis2Torque()
      Provide float value from inputOutput SFFloat field named axis2Torque.

      Tooltip: axis2Torque is rotational torque applied by corresponding motor axis when in user-calculated mode. *
      Specified by:
      getAxis2Torque in interface MotorJoint
      Returns:
      value of axis2Torque field
    • setAxis2Torque

      public MotorJoint setAxis2Torque(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named axis2Torque.

      Tooltip: axis2Torque is rotational torque applied by corresponding motor axis when in user-calculated mode. *
      Specified by:
      setAxis2Torque in interface MotorJoint
      Parameters:
      newValue - is new value for the axis2Torque field.
      Returns:
      MotorJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setAxis2Torque

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

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

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

      Tooltip: axis3Angle (radians) is rotation angle for corresponding motor axis when in user-calculated mode.
      Specified by:
      getAxis3Angle in interface MotorJoint
      Returns:
      value of axis3Angle field
    • setAxis3Angle

      public MotorJoint setAxis3Angle(float newValue)
      Accessor method to assign float value unit axis, angle (in radians) to inputOutput SFFloat field named axis3Angle.

      Tooltip: axis3Angle (radians) is rotation angle for corresponding motor axis when in user-calculated mode.
      Specified by:
      setAxis3Angle in interface MotorJoint
      Parameters:
      newValue - is new value for the axis3Angle field.
      Returns:
      MotorJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setAxis3Angle

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

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

      public float getAxis3Torque()
      Provide float value from inputOutput SFFloat field named axis3Torque.

      Tooltip: axis3Torque is rotational torque applied by corresponding motor axis when in user-calculated mode. *
      Specified by:
      getAxis3Torque in interface MotorJoint
      Returns:
      value of axis3Torque field
    • setAxis3Torque

      public MotorJoint setAxis3Torque(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named axis3Torque.

      Tooltip: axis3Torque is rotational torque applied by corresponding motor axis when in user-calculated mode. *
      Specified by:
      setAxis3Torque in interface MotorJoint
      Parameters:
      newValue - is new value for the axis3Torque field.
      Returns:
      MotorJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setAxis3Torque

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

      public MotorJoint setAxis3Torque(double newValue)
      Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setAxis3Torque(float).
      Parameters:
      newValue - is new value for field
      Returns:
      MotorJoint - 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 MotorJoint
      Specified by:
      getBody1 in interface X3DRigidJointNode
      Returns:
      value of body1 field
      See Also:
      getBody1ProtoInstance()
    • setBody1

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

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

      public MotorJoint 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:
      MotorJoint - 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()
    • 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 MotorJoint
      Specified by:
      getBody2 in interface X3DRigidJointNode
      Returns:
      value of body2 field
      See Also:
      getBody2ProtoInstance()
    • setBody2

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

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

      public MotorJoint 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:
      MotorJoint - 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()
    • getEnabledAxes

      public int getEnabledAxes()
      Provide int value within allowed range of [0,3] from inputOutput SFInt32 field named enabledAxes.

      Tooltip: [0,3] enabledAxes indicates which motor axes are active. (0) none, (1) axis 1, (2) axes 1 and 2, (3) all three axes. *
      Specified by:
      getEnabledAxes in interface MotorJoint
      Returns:
      value of enabledAxes field
    • setEnabledAxes

      public MotorJoint setEnabledAxes(int newValue)
      Accessor method to assign int value to inputOutput SFInt32 field named enabledAxes.

      Tooltip: [0,3] enabledAxes indicates which motor axes are active. (0) none, (1) axis 1, (2) axes 1 and 2, (3) all three axes. *
      Specified by:
      setEnabledAxes in interface MotorJoint
      Parameters:
      newValue - is new value for the enabledAxes field.
      Returns:
      MotorJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setEnabledAxes

      public MotorJoint setEnabledAxes(SFInt32 newValue)
      Assign typed object value to SFInt32 enabledAxes field, similar to setEnabledAxes(int).
      Parameters:
      newValue - is new value for the enabledAxes field.
      Returns:
      MotorJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getForceOutput

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

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


      Available enumeration values for string comparison: ALL, NONE.
      Specified by:
      getForceOutput in interface MotorJoint
      Specified by:
      getForceOutput in interface X3DRigidJointNode
      Returns:
      value of forceOutput field
    • getForceOutputList

      public ArrayList<String> getForceOutputList()
      Utility method to get ArrayList value of MFString forceOutput field, similar to getForceOutput().
      Returns:
      value of forceOutput field
    • getForceOutputString

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

      public MotorJoint setForceOutput(String[] newValue)
      Accessor method to assign String enumeration array (""ALL"" | ""NONE"") to inputOutput MFString field named forceOutput.

      Hint: authors have option to choose from an extendible list of predefined enumeration values (ALL, NONE).

      Tooltip: forceOutput controls which output fields are generated for the next frame. Values are ALL, NONE, or exact names of output fields updated at start of next frame. *
      Specified by:
      setForceOutput in interface MotorJoint
      Specified by:
      setForceOutput in interface X3DRigidJointNode
      Parameters:
      newValue - is new value for the forceOutput field.
      Returns:
      MotorJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setForceOutput

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

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

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

      public MotorJoint addForceOutput(String newValue)
      Add singleton String value to MFString forceOutput field.
      Parameters:
      newValue - is new value to add to the forceOutput field.
      Returns:
      MotorJoint - 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 MotorJoint addForceOutput(SFString newValue)
      Add singleton SFString value to MFString forceOutput field.
      Parameters:
      newValue - is new value to add to the forceOutput field.
      Returns:
      MotorJoint - 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 MotorJoint 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:
      MotorJoint - 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 MotorJoint clearIS()
      Utility method to clear SFNode value of IS field.
      Returns:
      MotorJoint - 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 MotorJoint
      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-WD3/Part01/components/core.html#Metadata , X3D Scene Authoring Hints: Metadata Nodes
    • setMetadata

      public MotorJoint 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 MotorJoint
      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:
      MotorJoint - 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-WD3/Part01/components/core.html#Metadata , X3D Scene Authoring Hints: Metadata Nodes
    • clearMetadata

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

      public MotorJoint 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:
      MotorJoint - 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
    • getMotor1Angle

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

      Tooltip: motor1Angle provides calculated angle of rotation (radians) for this motor joint from last frame.
      • Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
      • Hint: radian units for angular measure https://en.wikipedia.org/wiki/Radian
      Specified by:
      getMotor1Angle in interface MotorJoint
      Returns:
      value of motor1Angle field
    • getMotor1AngleRate

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

      Tooltip: motor1AngleRate provides calculated anglular rotation rate (radians/second) for this motor joint from last frame.
      • Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
      Specified by:
      getMotor1AngleRate in interface MotorJoint
      Returns:
      value of motor1AngleRate field
    • getMotor1Axis

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

      Tooltip: motor1Axis defines axis vector of corresponding motor axis.
      • Hint: 0 0 0 means motor disabled.
      Specified by:
      getMotor1Axis in interface MotorJoint
      Returns:
      value of motor1Axis field
    • setMotor1Axis

      public MotorJoint setMotor1Axis(float[] newValue)
      Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named motor1Axis.

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

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

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

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

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

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

      Tooltip: motor2Angle provides calculated angle of rotation (radians) for this motor joint from last frame.
      • Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
      • Hint: radian units for angular measure https://en.wikipedia.org/wiki/Radian
      Specified by:
      getMotor2Angle in interface MotorJoint
      Returns:
      value of motor2Angle field
    • getMotor2AngleRate

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

      Tooltip: motor2AngleRate provides calculated anglular rotation rate (radians/second) for this motor joint from last frame.
      • Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
      Specified by:
      getMotor2AngleRate in interface MotorJoint
      Returns:
      value of motor2AngleRate field
    • getMotor2Axis

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

      Tooltip: motor2Axis defines axis vector of corresponding motor axis.
      • Hint: 0 0 0 means motor disabled.
      Specified by:
      getMotor2Axis in interface MotorJoint
      Returns:
      value of motor2Axis field
    • setMotor2Axis

      public MotorJoint setMotor2Axis(float[] newValue)
      Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named motor2Axis.

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

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

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

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

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

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

      Tooltip: motor3Angle provides calculated angle of rotation (radians) for this motor joint from last frame.
      • Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
      • Hint: radian units for angular measure https://en.wikipedia.org/wiki/Radian
      Specified by:
      getMotor3Angle in interface MotorJoint
      Returns:
      value of motor3Angle field
    • getMotor3AngleRate

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

      Tooltip: motor3AngleRate provides calculated anglular rotation rate (radians/second) for this motor joint from last frame.
      • Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
      Specified by:
      getMotor3AngleRate in interface MotorJoint
      Returns:
      value of motor3AngleRate field
    • getMotor3Axis

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

      Tooltip: motor3Axis defines axis vector of corresponding motor axis.
      • Hint: 0 0 0 means motor disabled.
      Specified by:
      getMotor3Axis in interface MotorJoint
      Returns:
      value of motor3Axis field
    • setMotor3Axis

      public MotorJoint setMotor3Axis(float[] newValue)
      Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named motor3Axis.

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

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

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

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

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

      public float getStop1Bounce()
      Provide float value 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 MotorJoint
      Returns:
      value of stop1Bounce field
    • setStop1Bounce

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

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

      public MotorJoint 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:
      MotorJoint - 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 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 MotorJoint
      Returns:
      value of stop1ErrorCorrection field
    • setStop1ErrorCorrection

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

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

      public MotorJoint 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:
      MotorJoint - 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 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 MotorJoint
      Returns:
      value of stop2Bounce field
    • setStop2Bounce

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

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

      public MotorJoint 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:
      MotorJoint - 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 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 MotorJoint
      Returns:
      value of stop2ErrorCorrection field
    • setStop2ErrorCorrection

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

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

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

      public float getStop3Bounce()
      Provide float value from inputOutput SFFloat field named stop3Bounce.

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

      public MotorJoint setStop3Bounce(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named stop3Bounce.

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

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

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

      public float getStop3ErrorCorrection()
      Provide float value from inputOutput SFFloat field named stop3ErrorCorrection.

      Tooltip: [0,1] stop3ErrorCorrection 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:
      getStop3ErrorCorrection in interface MotorJoint
      Returns:
      value of stop3ErrorCorrection field
    • setStop3ErrorCorrection

      public MotorJoint setStop3ErrorCorrection(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named stop3ErrorCorrection.

      Tooltip: [0,1] stop3ErrorCorrection 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:
      setStop3ErrorCorrection in interface MotorJoint
      Parameters:
      newValue - is new value for the stop3ErrorCorrection field.
      Returns:
      MotorJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setStop3ErrorCorrection

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

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

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

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

      public final MotorJoint setDEF(String newValue)
      Accessor method to assign String value to inputOutput SFString field named DEF.

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

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

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

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

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

      public final MotorJoint setUSE(String newValue)
      Accessor method to assign String value to inputOutput SFString field named USE.

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


      Note: each USE node is still an independent object, with the USE value matching the DEF value in the preceding object.

      Warning: invoking the setUSE() method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.

      Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.
      Specified by:
      setUSE in class X3DConcreteNode
      Parameters:
      newValue - is new value for the USE field.
      Returns:
      MotorJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setUSE

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

      public String getCssClass()
      Provide String value from inputOutput SFString field named class.
      Overrides:
      getCssClass in class X3DConcreteNode
      Returns:
      value of class field
      See Also:
      X3D Architecture Annex L, HTML authoring guidelines, CSS considerations, W3C Cascading Style Sheets, W3C CSS Snapshot, Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets
    • setCssClass

      public final MotorJoint setCssClass(String newValue)
      Accessor method to assign String value to inputOutput SFString field named class.
      Specified by:
      setCssClass in class X3DConcreteNode
      Parameters:
      newValue - is new value for the class field.
      Returns:
      MotorJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      X3D Architecture Annex L, HTML authoring guidelines, CSS considerations, W3C Cascading Style Sheets, W3C CSS Snapshot, Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets
    • setCssClass

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

      public String getCssStyle()
      Provide String value from inputOutput SFString field named style.
      Overrides:
      getCssStyle in class X3DConcreteNode
      Returns:
      value of style field
      See Also:
      X3D Architecture Annex L, HTML authoring guidelines, CSS considerations, W3C Cascading Style Sheets, W3C CSS Snapshot, Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets
    • setCssStyle

      public final MotorJoint setCssStyle(String newValue)
      Accessor method to assign String value to inputOutput SFString field named style.
      Specified by:
      setCssStyle in class X3DConcreteNode
      Parameters:
      newValue - is new value for the style field.
      Returns:
      MotorJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      X3D Architecture Annex L, HTML authoring guidelines, CSS considerations, W3C Cascading Style Sheets, W3C CSS Snapshot, Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets
    • setCssStyle

      public MotorJoint setCssStyle(SFString newValue)
      Assign typed object value to SFString cssClass field, similar to setCssStyle(String).
      Parameters:
      newValue - is new value for the style field.
      Returns:
      MotorJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setUSE

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

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

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

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

      public String toStringX3D(int indentLevel)
      Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
      Specified by:
      toStringX3D in class X3DConcreteElement
      Parameters:
      indentLevel - number of levels of indentation for this element
      Returns:
      X3D string
      See Also:
      X3D.FILE_EXTENSION_X3D, X3D.FILE_EXTENSION_XML, X3D.toStringXML(), X3D.toFileXML(String), X3D.toFileX3D(String), X3D XML Encoding, X3D Compressed Binary Encoding: X3D Canonical Form, X3D Canonicalization (C14N) Tool
    • toStringClassicVRML

      public String toStringClassicVRML(int indentLevel)
      Recursive method to provide ClassicVRML string serialization.
      Specified by:
      toStringClassicVRML in class X3DConcreteElement
      Parameters:
      indentLevel - number of levels of indentation for this element
      Returns:
      ClassicVRML string
      See Also:
      X3D.FILE_EXTENSION_CLASSICVRML, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Annex A: Grammar
    • toStringVRML97

      public String toStringVRML97(int indentLevel)
      Recursive method to provide VRML97 string serialization.
      Specified by:
      toStringVRML97 in class X3DConcreteElement
      Parameters:
      indentLevel - number of levels of indentation for this element
      Returns:
      VRML97 string
      See Also:
      X3D.FILE_EXTENSION_VRML97, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Virtual Reality Modeling Language (VRML) 97 specification, VRML 97 v2.1 Amendment
    • findElementByNameValue

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

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

      Warning: more than one element may be found that has the same name, this method does not handle that case.
      Specified by:
      findElementByNameValue in class X3DConcreteElement
      Parameters:
      nameValue - is value of the name field being searched for in this element and child elements(if any)
      Returns:
      object reference to found element, null otherwise
      See Also:
      findNodeByDEF(String), X3DConcreteElement.hasAncestorScene(), X3DConcreteElement.findAncestorX3D()
    • findElementByNameValue

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

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

      Warning: more than one element may be found that has the same name, this method does not handle that case.
      Specified by:
      findElementByNameValue in class X3DConcreteElement
      Parameters:
      nameValue - is value of the name field being searched for in this element and child elements(if any)
      elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
      Returns:
      object reference to found element, null otherwise
      See Also:
      findNodeByDEF(String), X3DConcreteElement.hasAncestorScene(), X3DConcreteElement.findAncestorX3D()
    • hasElementByNameValue

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

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

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

      Warning: more than one element may be found that has the same DEF, this method does not handle that case.
      Specified by:
      findNodeByDEF in class X3DConcreteElement
      Parameters:
      DEFvalue - is value of the name field being searched for in this element and child elements(if any)
      Returns:
      object reference to found node, null otherwise
      See Also:
      findElementByNameValue(String), X3DConcreteElement.hasAncestorScene(), X3DConcreteElement.findAncestorX3D()
    • hasNodeByDEF

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

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