Class MotorJointObject

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

public class MotorJointObject
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

  • Constructor Details

    • MotorJointObject

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

      public MotorJointObject​(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: MotorJoint
      Specified by:
      getElementName in class X3DConcreteElement
      Returns:
      name of this element
    • getComponent

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

      public MotorJointObject setAutoCalc​(SFBoolObject newValue)
      Assign typed object value to SFBool autoCalc field, similar to setAutoCalc(boolean).
      Parameters:
      newValue - is new value for the autoCalc field.
      Returns:
      MotorJointObject - 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 MotorJointObject 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:
      MotorJointObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setAxis1Angle

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

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

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

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

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

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

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

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

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

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

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

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

      public RigidBody getBody1()
      Provide RigidBodyObject instance (using a properly typed node) from inputOutput SFNode field body1.
      Specified by:
      getBody1 in interface MotorJoint
      Specified by:
      getBody1 in interface X3DRigidJointNode
      Returns:
      value of body1 field
      See Also:
      getBody1ProtoInstance()
    • setBody1

      public MotorJointObject setBody1​(RigidBody newValue)
      Accessor method to assign RigidBodyObject 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:
      MotorJointObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setBody1(ProtoInstanceObject)
    • clearBody1

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

      public MotorJointObject setBody1​(ProtoInstanceObject newValue)
      Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field body1.
      Parameters:
      newValue - is new value for the body1 field.
      Returns:
      MotorJointObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setBody1(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 RigidBodyObject 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 MotorJointObject setBody2​(RigidBody newValue)
      Accessor method to assign RigidBodyObject 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:
      MotorJointObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setBody2(ProtoInstanceObject)
    • clearBody2

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

      public MotorJointObject setBody2​(ProtoInstanceObject newValue)
      Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field body2.
      Parameters:
      newValue - is new value for the body2 field.
      Returns:
      MotorJointObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setBody2(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 MotorJointObject 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:
      MotorJointObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setEnabledAxes

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

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

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


      Available enumeration values for string comparison: ALL, NONE.
      Specified by:
      getForceOutput in interface MotorJoint
      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 MotorJointObject 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 MotorJoint
      Specified by:
      setForceOutput in interface X3DRigidJointNode
      Parameters:
      newValue - is new value for the forceOutput field.
      Returns:
      MotorJointObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setForceOutput

      public MotorJointObject setForceOutput​(MFStringObject newValue)
      Assign typed object value to MFString forceOutput field, similar to setForceOutput(String[]).
      Parameters:
      newValue - is new value for the forceOutput field.
      Returns:
      MotorJointObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setForceOutput

      public MotorJointObject setForceOutput​(SFStringObject newValue)
      Assign single SFString object value to MFString forceOutput field, similar to setForceOutput(String[]).
      Parameters:
      newValue - is new value for the forceOutput field.
      Returns:
      MotorJointObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      MFStringObject.cleanupEnumerationValues(String)
    • setForceOutput

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

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

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

      public MotorJointObject 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:
      MotorJointObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      MFStringObject.cleanupEnumerationValues(String)
    • addForceOutput

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

      public ISObject getIS()
      Provide ISObject 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 MotorJointObject setIS​(ISObject newValue)
      Accessor method to assign ISObject 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:
      MotorJointObject - 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 MotorJointObject clearIS()
      Utility method to clear SFNode value of IS field.
      Returns:
      MotorJointObject - 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 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:
      getMetadataProtoInstance(), X3D Scene Authoring Hints: Metadata Nodes
    • setMetadata

      public MotorJointObject setMetadata​(X3DMetadataObject newValue)
      Accessor method to assign 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:
      MotorJointObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setMetadata(ProtoInstanceObject), X3D Scene Authoring Hints: Metadata Nodes
    • clearMetadata

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

      public MotorJointObject setMetadata​(ProtoInstanceObject 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:
      MotorJointObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setMetadata(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.
      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 MotorJointObject 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:
      MotorJointObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setMotor1Axis

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

      public MotorJointObject setDEF​(SFStringObject newValue)
      Assign typed object value to SFString DEF field, similar to setDEF(String).
      Parameters:
      newValue - is new value for the DEF field.
      Returns:
      MotorJointObject - 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 MotorJointObject 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:
      MotorJointObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setUSE

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

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

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

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

      Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
      • Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
      • Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
      Specified by:
      setCssClass in class X3DConcreteNode
      Parameters:
      newValue - is new value for the class field.
      Returns:
      MotorJointObject - 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 MotorJointObject setCssClass​(SFStringObject newValue)
      Assign typed object value to SFString cssClass field, similar to setCssClass(String).
      Parameters:
      newValue - is new value for the class field.
      Returns:
      MotorJointObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setUSE

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

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

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

      public MotorJointObject addComments​(CommentsBlock newCommentsBlock)
      Add CommentsBlock to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newCommentsBlock - block of comments to add
      Returns:
      MotorJointObject - 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:
      X3DObject.FILE_EXTENSION_X3D, X3DObject.FILE_EXTENSION_XML, X3DObject.toStringXML(), X3DObject.toFileXML(String), X3DObject.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:
      X3DObject.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:
      X3DObject.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 findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.

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

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

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

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

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

      Warning: more than one element may be found that has the same 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.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
    • 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)