All Superinterfaces:: X3DNode, X3DRigidJointNode

All Known Implementing Classes:: BallJoint

public interface BallJoint extends X3DRigidJointNode

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

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. BallJoint 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:

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 org.web3d.x3d.sai.RigidBodyPhysics.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 org.web3d.x3d.sai.RigidBodyPhysics.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.

String[]

getForceOutput()

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

X3DMetadataObject

getMetadata()

Provide org.web3d.x3d.sai.Core.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 org.web3d.x3d.sai.RigidBodyPhysics.RigidBody instance (using a properly typed node) to inputOutput SFNode field body1.

BallJoint

setBody2(RigidBody newValue)

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

BallJoint

setForceOutput(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 org.web3d.x3d.sai.Core.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 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
  
  BallJoint 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:
  
  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 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
  
  BallJoint 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:
  
  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
  
  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
  
  BallJoint 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:
  
  BallJoint - 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.
  
  Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/core.html#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 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.
  
  Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/core.html#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

Interface BallJoint

Method Summary

Method Details

getAnchorPoint

setAnchorPoint

getBody1

setBody1

getBody1AnchorPoint

getBody2

setBody2

getBody2AnchorPoint

getForceOutput

setForceOutput

getMetadata

setMetadata