X3DRigidJointNode (X3DJSAIL, X3D Java Scene Access Interface Library)

All Superinterfaces:

X3DNode

All Known Subinterfaces:

BallJoint, DoubleAxisHingeJoint, MotorJoint, SingleAxisHingeJoint, SliderJoint, UniversalJoint

All Known Implementing Classes:

BallJointObject, DoubleAxisHingeJointObject, MotorJointObject, SingleAxisHingeJointObject, SliderJointObject, UniversalJointObject
```
public interface X3DRigidJointNode
extends X3DNode
```
Abstract node interface, defined by X3D specification to support X3D Java interoperability.

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: TODO, X3D Tooltips, X3D Scene Authoring Hints

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`RigidBody`	`getBody1()` Provide RigidBody instance (using a properly typed node) from inputOutput SFNode field body1.
`RigidBody`	`getBody2()` Provide RigidBody instance (using a properly typed node) from inputOutput SFNode field body2.
`java.lang.String[]`	`getForceOutput()` Provide array of String enumeration results ['"ALL"'\|'"NONE"'\|'"etc."'] from inputOutput MFString field named forceOutput.
`X3DMetadataObject`	`getMetadata()` Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
`X3DRigidJointNode`	`setBody1(RigidBody newValue)` Assign RigidBody instance (using a properly typed node) to inputOutput SFNode field body1.
`X3DRigidJointNode`	`setBody2(RigidBody newValue)` Assign RigidBody instance (using a properly typed node) to inputOutput SFNode field body2.
`X3DRigidJointNode`	`setCssClass(java.lang.String newValue)` Assign String value to inputOutput SFString field named class.
`X3DRigidJointNode`	`setDEF(java.lang.String newValue)` Assign String value to inputOutput SFString field named DEF.
`X3DRigidJointNode`	`setForceOutput(java.lang.String[] newValue)` Assign String enumeration array (""ALL""\|""NONE"") ['"ALL"'\|'"NONE"'\|'"etc."'] to inputOutput MFString field named forceOutput.
`X3DRigidJointNode`	`setMetadata(X3DMetadataObject newValue)` Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`X3DRigidJointNode`	`setUSE(java.lang.String newValue)` Assign String value to inputOutput SFString field named USE.

- Method Detail
  - getBody1
```
RigidBody getBody1()
```
    Provide RigidBody instance (using a properly typed node) from inputOutput SFNode field body1.
    
    Returns:
    
    value of body1 field
  - setBody1
```
X3DRigidJointNode setBody1(RigidBody newValue)
```
    Assign RigidBody instance (using a properly typed node) to inputOutput SFNode field body1.
    
    Parameters:
    
    newValue - is new value for the body1 field.
    
    Returns:
    
    X3DRigidJointNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getBody2
```
RigidBody getBody2()
```
    Provide RigidBody instance (using a properly typed node) from inputOutput SFNode field body2.
    
    Returns:
    
    value of body2 field
  - setBody2
```
X3DRigidJointNode setBody2(RigidBody newValue)
```
    Assign RigidBody instance (using a properly typed node) to inputOutput SFNode field body2.
    
    Parameters:
    
    newValue - is new value for the body2 field.
    
    Returns:
    
    X3DRigidJointNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getForceOutput
```
java.lang.String[] getForceOutput()
```
    Provide array of String enumeration results ['"ALL"'|'"NONE"'|'"etc."'] from inputOutput MFString field named forceOutput.
    
    Returns:
    
    value of forceOutput field
  - setForceOutput
```
X3DRigidJointNode setForceOutput(java.lang.String[] newValue)
```
    Assign String enumeration array (""ALL""|""NONE"") ['"ALL"'|'"NONE"'|'"etc."'] to inputOutput MFString field named forceOutput.
    
    Parameters:
    
    newValue - is new value for the forceOutput field.
    
    Returns:
    
    X3DRigidJointNode - 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
    
    Returns:
    
    value of metadata field
    
    See Also:
    
    X3D Scene Authoring Hints: Metadata Nodes
  - setMetadata
```
X3DRigidJointNode setMetadata(X3DMetadataObject newValue)
```
    Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    
    Specified by:
    
    setMetadata in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the metadata field.
    
    Returns:
    
    X3DRigidJointNode - 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
  - setDEF
```
X3DRigidJointNode setDEF(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named DEF.
    
    Note that setting the DEF value clears the USE value.
    
    Specified by:
    
    setDEF in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    X3DRigidJointNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUSE
```
X3DRigidJointNode setUSE(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named USE.
    
    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 interface X3DNode
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    X3DRigidJointNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setCssClass
```
X3DRigidJointNode setCssClass(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named class.
    
    Specified by:
    
    setCssClass in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    X3DRigidJointNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

Interface X3DRigidJointNode

Method Summary

Method Detail

getBody1

setBody1

getBody2

setBody2

getForceOutput

setForceOutput

getMetadata

setMetadata

setDEF

setUSE

setCssClass