Interface SliderJoint

All Superinterfaces:
X3DNode, X3DRigidJointNode
All Known Implementing Classes:
SliderJoint
public interface SliderJoint extends X3DRigidJointNode
SliderJoint constrains all movement between body1 and body2 along a single axis. Contains two RigidBody nodes (containerField values body1, body2).

Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the org.web3d.x3d.jsail classes. SliderJoint node tooltip: (X3D version 3.2 or later) [X3DRigidJointNode] SliderJoint constrains all movement between body1 and body2 along a single axis. Contains two RigidBody nodes (containerField values body1, body2).
  • Hint: RigidBodyPhysics component, level 2.

Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    float[]
    getAxis()
    Provide array of 3-tuple float results from inputOutput SFVec3f field named axis.
    RigidBody
    getBody1()
    Provide org.web3d.x3d.sai.RigidBodyPhysics.RigidBody instance (using a properly typed node) from inputOutput SFNode field body1.
    RigidBody
    getBody2()
    Provide org.web3d.x3d.sai.RigidBodyPhysics.RigidBody instance (using a properly typed node) from inputOutput SFNode field body2.
    String[]
    getForceOutput()
    Provide array of String enumeration results (baseType MFString) ['"ALL"' | '"NONE"' | '"etc."'] from inputOutput MFString field named forceOutput.
    float
    getMaxSeparation()
    Provide float value from inputOutput SFFloat field named maxSeparation.
    X3DMetadataObject
    getMetadata()
    Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    float
    getMinSeparation()
    Provide float value from inputOutput SFFloat field named minSeparation.
    float
    getSeparation()
    Provide float value from outputOnly SFFloat field named separation.
    float
    getSeparationRate()
    Provide float value from outputOnly SFFloat field named separationRate.
    float
    getSliderForce()
    Provide float value from inputOutput SFFloat field named sliderForce.
    float
    getStopBounce()
    Provide float value from inputOutput SFFloat field named stopBounce.
    float
    getStopErrorCorrection()
    Provide float value from inputOutput SFFloat field named stopErrorCorrection.
    SliderJoint
    setAxis(float[] newValue)
    Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named axis.
    SliderJoint
    setBody1(RigidBody newValue)
    Accessor method to assign org.web3d.x3d.sai.RigidBodyPhysics.RigidBody instance (using a properly typed node) to inputOutput SFNode field body1.
    SliderJoint
    setBody2(RigidBody newValue)
    Accessor method to assign org.web3d.x3d.sai.RigidBodyPhysics.RigidBody instance (using a properly typed node) to inputOutput SFNode field body2.
    SliderJoint
    setForceOutput(String[] newValue)
    Accessor method to assign String enumeration array (""ALL"" | ""NONE"") to inputOutput MFString field named forceOutput.
    SliderJoint
    setMaxSeparation(float newValue)
    Accessor method to assign float value to inputOutput SFFloat field named maxSeparation.
    SliderJoint
    setMetadata(X3DMetadataObject newValue)
    Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    SliderJoint
    setMinSeparation(float newValue)
    Accessor method to assign float value to inputOutput SFFloat field named minSeparation.
    SliderJoint
    setSliderForce(float newValue)
    Accessor method to assign float value to inputOutput SFFloat field named sliderForce.
    SliderJoint
    setStopBounce(float newValue)
    Accessor method to assign float value to inputOutput SFFloat field named stopBounce.
    SliderJoint
    setStopErrorCorrection(float newValue)
    Accessor method to assign float value to inputOutput SFFloat field named stopErrorCorrection.

  • Method Details

    • getAxis

      float[] getAxis()
      Provide array of 3-tuple float results from inputOutput SFVec3f field named axis.

      Tooltip: [0,1] axis is normalized vector specifying direction of motion. *
      Returns:
      value of axis field

    • setAxis

      SliderJoint setAxis(float[] newValue)
      Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named axis.

      Tooltip: [0,1] axis is normalized vector specifying direction of motion. *
      Parameters:
      newValue - is new value for the axis field.
      Returns:
      SliderJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getBody1

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

      Tooltip: [RigidBody] The body1 and body2 fields indicate the two RigidBody nodes connected by this joint. *
      Specified by:
      getBody1 in interface X3DRigidJointNode
      Returns:
      value of body1 field

    • setBody1

      SliderJoint setBody1(RigidBody newValue)
      Accessor method to assign org.web3d.x3d.sai.RigidBodyPhysics.RigidBody instance (using a properly typed node) to inputOutput SFNode field body1.

      Tooltip: [RigidBody] The body1 and body2 fields indicate the two RigidBody nodes connected by this joint. *
      Specified by:
      setBody1 in interface X3DRigidJointNode
      Parameters:
      newValue - is new value for the body1 field.
      Returns:
      SliderJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getBody2

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

      Tooltip: [RigidBody] The body1 and body2 fields indicate the two RigidBody nodes connected by this joint. *
      Specified by:
      getBody2 in interface X3DRigidJointNode
      Returns:
      value of body2 field

    • setBody2

      SliderJoint setBody2(RigidBody newValue)
      Accessor method to assign org.web3d.x3d.sai.RigidBodyPhysics.RigidBody instance (using a properly typed node) to inputOutput SFNode field body2.

      Tooltip: [RigidBody] The body1 and body2 fields indicate the two RigidBody nodes connected by this joint. *
      Specified by:
      setBody2 in interface X3DRigidJointNode
      Parameters:
      newValue - is new value for the body2 field.
      Returns:
      SliderJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getForceOutput

      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. *
      Specified by:
      getForceOutput in interface X3DRigidJointNode
      Returns:
      value of forceOutput field

    • setForceOutput

      SliderJoint setForceOutput(String[] newValue)
      Accessor method to assign String enumeration array (""ALL"" | ""NONE"") to 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. *
      Specified by:
      setForceOutput in interface X3DRigidJointNode
      Parameters:
      newValue - is new value for the forceOutput field.
      Returns:
      SliderJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getMaxSeparation

      float getMaxSeparation()
      Provide float value from inputOutput SFFloat field named maxSeparation.

      Tooltip: maxSeparation is maximum separation distance between the two bodies.
      • Hint: if (minSeparation is less than maxSeparation) then no stop is effective.
      Returns:
      value of maxSeparation field

    • setMaxSeparation

      SliderJoint setMaxSeparation(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named maxSeparation.

      Tooltip: maxSeparation is maximum separation distance between the two bodies.
      • Hint: if (minSeparation is less than maxSeparation) then no stop is effective.
      Parameters:
      newValue - is new value for the maxSeparation field.
      Returns:
      SliderJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getMetadata

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

      Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
      Specified by:
      getMetadata in interface X3DNode
      Specified by:
      getMetadata in interface X3DRigidJointNode
      Returns:
      value of metadata field
      See Also:

    • setMetadata

      SliderJoint setMetadata(X3DMetadataObject newValue)
      Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.

      Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
      Specified by:
      setMetadata in interface X3DNode
      Specified by:
      setMetadata in interface X3DRigidJointNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      SliderJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • getMinSeparation

      float getMinSeparation()
      Provide float value from inputOutput SFFloat field named minSeparation.

      Tooltip: minSeparation is minimum separation distance between the two bodies.
      • Hint: if (minSeparation is less than maxSeparation) then no stop is effective.
      Returns:
      value of minSeparation field

    • setMinSeparation

      SliderJoint setMinSeparation(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named minSeparation.

      Tooltip: minSeparation is minimum separation distance between the two bodies.
      • Hint: if (minSeparation is less than maxSeparation) then no stop is effective.
      Parameters:
      newValue - is new value for the minSeparation field.
      Returns:
      SliderJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getSeparation

      float getSeparation()
      Provide float value from outputOnly SFFloat field named separation.

      Tooltip: separation indicates final separation distance between the two bodies.
      • Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
      Returns:
      value of separation field

    • getSeparationRate

      float getSeparationRate()
      Provide float value from outputOnly SFFloat field named separationRate.

      Tooltip: separationRate indicates change in separation distance over time between the two bodies.
      • Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
      Returns:
      value of separationRate field

    • getSliderForce

      float getSliderForce()
      Provide float value from inputOutput SFFloat field named sliderForce.

      Tooltip: [-infinity,infinity] sliderForce value is used to apply a force (specified in force base units) along the axis of the slider in equal and opposite directions to the two bodies. A positive value applies a force such that the two bodies accelerate away from each other, while a negative value applies a force such that the two bodies accelerate toward each other. *
      Returns:
      value of sliderForce field

    • setSliderForce

      SliderJoint setSliderForce(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named sliderForce.

      Tooltip: [-infinity,infinity] sliderForce value is used to apply a force (specified in force base units) along the axis of the slider in equal and opposite directions to the two bodies. A positive value applies a force such that the two bodies accelerate away from each other, while a negative value applies a force such that the two bodies accelerate toward each other. *
      Parameters:
      newValue - is new value for the sliderForce field.
      Returns:
      SliderJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getStopBounce

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

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

    • setStopBounce

      SliderJoint setStopBounce(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named stopBounce.

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

    • getStopErrorCorrection

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

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

    • setStopErrorCorrection

      SliderJoint setStopErrorCorrection(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named stopErrorCorrection.

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