Interface BallJoint

All Superinterfaces:
X3DNode, X3DRigidJointNode
All Known Implementing Classes:
BallJointObject

public interface BallJoint
extends X3DRigidJointNode
BallJoint represents an unconstrained joint between two bodies that pivot about a common anchor point.

X3D node tooltip: (X3D version 3.2 or later) [X3DRigidJointNode] BallJoint represents an unconstrained joint between two bodies that pivot about a common anchor point. 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:
SAI Java Specification: TODO, X3D Abstract Specification: BallJoint, X3D Tooltips: BallJoint, X3D Scene Authoring Hints
  • Method Summary

    Modifier and Type Method Description
    float[] getAnchorPoint()
    Provide array of 3-tuple float results from inputOutput SFVec3f field named anchorPoint.
    RigidBody getBody1()
    Provide RigidBody instance (using a properly typed node) from inputOutput SFNode field body1.
    float[] getBody1AnchorPoint()
    Provide array of 3-tuple float results from outputOnly SFVec3f field named body1AnchorPoint.
    RigidBody getBody2()
    Provide RigidBody instance (using a properly typed node) from inputOutput SFNode field body2.
    float[] getBody2AnchorPoint()
    Provide array of 3-tuple float results from outputOnly SFVec3f field named body2AnchorPoint.
    java.lang.String[] getForceOutput()
    Provide array of String enumeration results ( baseType forceOutputValues) [""ALL"" | ""NONE"" | '"etc."'] from inputOutput MFString field named forceOutput.
    X3DMetadataObject getMetadata()
    Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    BallJoint setAnchorPoint​(float[] newValue)
    Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named anchorPoint.
    BallJoint setBody1​(RigidBody newValue)
    Accessor method to assign RigidBody instance (using a properly typed node) to inputOutput SFNode field body1.
    BallJoint setBody2​(RigidBody newValue)
    Accessor method to assign RigidBody instance (using a properly typed node) to inputOutput SFNode field body2.
    BallJoint setForceOutput​(java.lang.String[] newValue)
    Accessor method to assign String enumeration array (""ALL"" | ""NONE"") to inputOutput MFString field named forceOutput.
    BallJoint setMetadata​(X3DMetadataObject newValue)
    Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
  • Method Details

    • getAnchorPoint

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

      Tooltip: anchorPoint is joint center, specified in world coordinates. *
      Returns:
      value of anchorPoint field
    • setAnchorPoint

      BallJoint setAnchorPoint​(float[] newValue)
      Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named anchorPoint.

      Tooltip: anchorPoint is joint center, specified in world coordinates. *
      Parameters:
      newValue - is new value for the anchorPoint field.
      Returns:
      BallJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getBody1

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

      BallJoint setBody1​(RigidBody newValue)
      Accessor method to assign RigidBody instance (using a properly typed node) to inputOutput SFNode field body1.
      Specified by:
      setBody1 in interface X3DRigidJointNode
      Parameters:
      newValue - is new value for the body1 field.
      Returns:
      BallJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getBody1AnchorPoint

      float[] getBody1AnchorPoint()
      Provide array of 3-tuple float results from outputOnly SFVec3f field named body1AnchorPoint.

      Tooltip: body1AnchorPoint describes anchorPoint position relative to local coordinate reference frame.
      • Hint: can detect separation if body1AnchorPoint!=body2AnchorPoint.
      • 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 body1AnchorPoint field
    • getBody2

      RigidBody getBody2()
      Provide RigidBody instance (using a properly typed node) from inputOutput SFNode field body2.
      Specified by:
      getBody2 in interface X3DRigidJointNode
      Returns:
      value of body2 field
    • setBody2

      BallJoint setBody2​(RigidBody newValue)
      Accessor method to assign RigidBody instance (using a properly typed node) to inputOutput SFNode field body2.
      Specified by:
      setBody2 in interface X3DRigidJointNode
      Parameters:
      newValue - is new value for the body2 field.
      Returns:
      BallJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getBody2AnchorPoint

      float[] getBody2AnchorPoint()
      Provide array of 3-tuple float results from outputOnly SFVec3f field named body2AnchorPoint.

      Tooltip: body2AnchorPoint describes anchorPoint position relative to local coordinate reference frame.
      • Hint: can detect separation if body1AnchorPoint!=body2AnchorPoint.
      • 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 body2AnchorPoint field
    • getForceOutput

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

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

      X3DMetadataObject getMetadata()
      Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
      Specified by:
      getMetadata in interface X3DNode
      Specified by:
      getMetadata in interface X3DRigidJointNode
      Returns:
      value of metadata field
      See Also:
      X3D Scene Authoring Hints: Metadata Nodes
    • setMetadata

      BallJoint setMetadata​(X3DMetadataObject newValue)
      Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
      Specified by:
      setMetadata in interface X3DNode
      Specified by:
      setMetadata in interface X3DRigidJointNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      BallJoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      X3D Scene Authoring Hints: Metadata Nodes