Interface SingleAxisHingeJoint
- All Superinterfaces:
X3DNode
,X3DRigidJointNode
- All Known Implementing Classes:
SingleAxisHingeJoint
public interface SingleAxisHingeJoint extends X3DRigidJointNode
SingleAxisHingeJoint has single axis about which to rotate, similar to a traditional door hinge. Contains two RigidBody nodes (containerField values body1, body2).
X3D node tooltip: (X3D version 3.2 or later) [X3DRigidJointNode] SingleAxisHingeJoint has single axis about which to rotate, similar to a traditional door hinge. Contains two RigidBody nodes (containerField values body1, body2).
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
X3D node tooltip: (X3D version 3.2 or later) [X3DRigidJointNode] SingleAxisHingeJoint has single axis about which to rotate, similar to a traditional door hinge. 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).
-
Method Summary
Modifier and Type Method Description float[]
getAnchorPoint()
Provide array of 3-tuple float results from inputOutput SFVec3f field named anchorPoint.float
getAngle()
Provide float value unit axis, angle (in radians) from outputOnly SFFloat field named angle.float
getAngleRate()
Provide float value unit axis, angle (in radians) from outputOnly SFFloat field named angleRate.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.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.java.lang.String[]
getForceOutput()
Provide array of String enumeration results (baseType MFString) ['"ALL"' | '"NONE"' | '"etc."'] from inputOutput MFString field named forceOutput.float
getMaxAngle()
Provide float value unit axis, angle (in radians) from inputOutput SFFloat field named maxAngle.X3DMetadataObject
getMetadata()
Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.float
getMinAngle()
Provide float value unit axis, angle (in radians) from inputOutput SFFloat field named minAngle.float
getStopBounce()
Provide float value from inputOutput SFFloat field named stopBounce.float
getStopErrorCorrection()
Provide float value from inputOutput SFFloat field named stopErrorCorrection.SingleAxisHingeJoint
setAnchorPoint(float[] newValue)
Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named anchorPoint.SingleAxisHingeJoint
setAxis(float[] newValue)
Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named axis.SingleAxisHingeJoint
setBody1(RigidBody newValue)
Accessor method to assign org.web3d.x3d.sai.RigidBodyPhysics.RigidBody instance (using a properly typed node) to inputOutput SFNode field body1.SingleAxisHingeJoint
setBody2(RigidBody newValue)
Accessor method to assign org.web3d.x3d.sai.RigidBodyPhysics.RigidBody instance (using a properly typed node) to inputOutput SFNode field body2.SingleAxisHingeJoint
setForceOutput(java.lang.String[] newValue)
Accessor method to assign String enumeration array (""ALL"" | ""NONE"") to inputOutput MFString field named forceOutput.SingleAxisHingeJoint
setMaxAngle(float newValue)
Accessor method to assign float value unit axis, angle (in radians) to inputOutput SFFloat field named maxAngle.SingleAxisHingeJoint
setMetadata(X3DMetadataObject newValue)
Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.SingleAxisHingeJoint
setMinAngle(float newValue)
Accessor method to assign float value unit axis, angle (in radians) to inputOutput SFFloat field named minAngle.SingleAxisHingeJoint
setStopBounce(float newValue)
Accessor method to assign float value to inputOutput SFFloat field named stopBounce.SingleAxisHingeJoint
setStopErrorCorrection(float newValue)
Accessor method to assign float value to inputOutput SFFloat field named stopErrorCorrection.
-
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
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:
SingleAxisHingeJoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getAngle
float getAngle()Provide float value unit axis, angle (in radians) from outputOnly SFFloat field named angle.- Returns:
- value of angle field
-
getAngleRate
float getAngleRate()Provide float value unit axis, angle (in radians) from outputOnly SFFloat field named angleRate.- Returns:
- value of angleRate field
-
getAxis
float[] getAxis()Provide array of 3-tuple float results from inputOutput SFVec3f field named axis.
Tooltip: axis defines vector of joint connection between body1 and body2. *- Returns:
- value of axis field
-
setAxis
Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named axis.
Tooltip: axis defines vector of joint connection between body1 and body2. *- Parameters:
newValue
- is new value for the axis field.- Returns:
SingleAxisHingeJoint
- 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.- Specified by:
getBody1
in interfaceX3DRigidJointNode
- Returns:
- value of body1 field
-
setBody1
Accessor method to assign org.web3d.x3d.sai.RigidBodyPhysics.RigidBody instance (using a properly typed node) to inputOutput SFNode field body1.- Specified by:
setBody1
in interfaceX3DRigidJointNode
- Parameters:
newValue
- is new value for the body1 field.- Returns:
SingleAxisHingeJoint
- 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.- 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.- Specified by:
getBody2
in interfaceX3DRigidJointNode
- Returns:
- value of body2 field
-
setBody2
Accessor method to assign org.web3d.x3d.sai.RigidBodyPhysics.RigidBody instance (using a properly typed node) to inputOutput SFNode field body2.- Specified by:
setBody2
in interfaceX3DRigidJointNode
- Parameters:
newValue
- is new value for the body2 field.- Returns:
SingleAxisHingeJoint
- 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.- Returns:
- value of body2AnchorPoint field
-
getForceOutput
java.lang.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 interfaceX3DRigidJointNode
- Returns:
- value of forceOutput field
-
setForceOutput
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 interfaceX3DRigidJointNode
- Parameters:
newValue
- is new value for the forceOutput field.- Returns:
SingleAxisHingeJoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getMaxAngle
float getMaxAngle()Provide float value unit axis, angle (in radians) from inputOutput SFFloat field named maxAngle.
Tooltip: [-pi,pi] maxAngle is maximum rotation angle for hinge.- Hint: radian units for angular measure https://en.wikipedia.org/wiki/Radian
- Returns:
- value of maxAngle field
-
setMaxAngle
Accessor method to assign float value unit axis, angle (in radians) to inputOutput SFFloat field named maxAngle.
Tooltip: [-pi,pi] maxAngle is maximum rotation angle for hinge.- Hint: radian units for angular measure https://en.wikipedia.org/wiki/Radian
- Parameters:
newValue
- is new value for the maxAngle field.- Returns:
SingleAxisHingeJoint
- 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/X3Dv4Draft/ISO-IEC19775-1v4-WD2/Part01/components/core.html#Metadata
- Specified by:
getMetadata
in interfaceX3DNode
- Specified by:
getMetadata
in interfaceX3DRigidJointNode
- Returns:
- value of metadata field
- See Also:
- X3D Scene Authoring Hints: Metadata Nodes
-
setMetadata
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/X3Dv4Draft/ISO-IEC19775-1v4-WD2/Part01/components/core.html#Metadata
- Specified by:
setMetadata
in interfaceX3DNode
- Specified by:
setMetadata
in interfaceX3DRigidJointNode
- Parameters:
newValue
- is new value for the metadata field.- Returns:
SingleAxisHingeJoint
- 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
-
getMinAngle
float getMinAngle()Provide float value unit axis, angle (in radians) from inputOutput SFFloat field named minAngle.
Tooltip: [-pi,pi] minAngle is minimum rotation angle for hinge.- Hint: radian units for angular measure https://en.wikipedia.org/wiki/Radian
- Returns:
- value of minAngle field
-
setMinAngle
Accessor method to assign float value unit axis, angle (in radians) to inputOutput SFFloat field named minAngle.
Tooltip: [-pi,pi] minAngle is minimum rotation angle for hinge.- Hint: radian units for angular measure https://en.wikipedia.org/wiki/Radian
- Parameters:
newValue
- is new value for the minAngle field.- Returns:
SingleAxisHingeJoint
- 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
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:
SingleAxisHingeJoint
- 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
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:
SingleAxisHingeJoint
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-