Class RigidBody

java.lang.Object

org.web3d.x3d.jsail.X3DConcreteElement

org.web3d.x3d.jsail.X3DConcreteNode

org.web3d.x3d.jsail.RigidBodyPhysics.RigidBody

All Implemented Interfaces:

X3DChildNode, X3DNode, X3DBoundedObject, RigidBody

public class RigidBody
extends X3DConcreteNode
implements RigidBody

RigidBody describes a collection of shapes with a mass distribution that is affected by the physics model.

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. RigidBody node tooltip: (X3D version 3.2 or later) [X3DChildNode] RigidBody describes a collection of shapes with a mass distribution that is affected by the physics model. Contains a Sphere, Box, or Cone (containerField='massDensityModel') and multiple CollidableOffset or CollidableShape nodes (containerField='geometry') for animating collidable geometry. *


Package hint: This org.web3d.x3d.jsail concrete class is used for implementing a standalone X3D object as a Plain Old Java Object (POJO). If you are writing Java code for use inside an X3D Script node, compile separate code using only the org.web3d.x3d.sai package instead.

See Also:

• X3D Abstract Specification: RigidBody
• X3D Tooltips: RigidBody
• X3D Scene Authoring Hints

Field Summary

Fields

Modifier and Type	Field	Description
static final float	ANGULARDAMPINGFACTOR_DEFAULT_VALUE	SFFloat field named angularDampingFactor has default value 0.001f (Java syntax) or 0.001 (XML syntax).
static final float[]	ANGULARVELOCITY_DEFAULT_VALUE	SFVec3f field named angularVelocity has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).
static final boolean	AUTODAMP_DEFAULT_VALUE	SFBool field named autoDamp has default value false (Java syntax) or false (XML syntax).
static final boolean	AUTODISABLE_DEFAULT_VALUE	SFBool field named autoDisable has default value false (Java syntax) or false (XML syntax).
static final float[]	BBOXCENTER_DEFAULT_VALUE	SFVec3f field named bboxCenter has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).
static final boolean	BBOXDISPLAY_DEFAULT_VALUE	SFBool field named bboxDisplay has default value false (Java syntax) or false (XML syntax).
static final float[]	BBOXSIZE_DEFAULT_VALUE	SFVec3f field named bboxSize has default value {-1f,-1f,-1f} (Java syntax) or -1 -1 -1 (XML syntax).
static final float[]	CENTEROFMASS_DEFAULT_VALUE	SFVec3f field named centerOfMass has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).
static final String	COMPONENT	String constant COMPONENT defines X3D component for the RigidBody element: RigidBodyPhysics
static final String	containerField_DEFAULT_VALUE	containerField describes typical field relationship of a node to its parent.
static final float	DISABLEANGULARSPEED_DEFAULT_VALUE	SFFloat field named disableAngularSpeed has default value 0f (Java syntax) or 0 (XML syntax).
static final float	DISABLELINEARSPEED_DEFAULT_VALUE	SFFloat field named disableLinearSpeed has default value 0f (Java syntax) or 0 (XML syntax).
static final double	DISABLETIME_DEFAULT_VALUE	SFTime field named disableTime has default value 0 (Java syntax) or 0 (XML syntax).
static final boolean	ENABLED_DEFAULT_VALUE	SFBool field named enabled has default value true (Java syntax) or true (XML syntax).
static final float[]	FINITEROTATIONAXIS_DEFAULT_VALUE	SFVec3f field named finiteRotationAxis has default value {0f,1f,0f} (Java syntax) or 0 1 0 (XML syntax).
static final boolean	FIXED_DEFAULT_VALUE	SFBool field named fixed has default value false (Java syntax) or false (XML syntax).
static final float[]	FORCES_DEFAULT_VALUE	MFVec3f field named forces has default value equal to an empty list.
static final String	fromField_ANGULARDAMPINGFACTOR	fromField ROUTE name for SFFloat field named angularDampingFactor.
static final String	fromField_ANGULARVELOCITY	fromField ROUTE name for SFVec3f field named angularVelocity.
static final String	fromField_AUTODAMP	fromField ROUTE name for SFBool field named autoDamp.
static final String	fromField_AUTODISABLE	fromField ROUTE name for SFBool field named autoDisable.
static final String	fromField_BBOXDISPLAY	fromField ROUTE name for SFBool field named bboxDisplay.
static final String	fromField_CENTEROFMASS	fromField ROUTE name for SFVec3f field named centerOfMass.
static final String	fromField_DISABLEANGULARSPEED	fromField ROUTE name for SFFloat field named disableAngularSpeed.
static final String	fromField_DISABLELINEARSPEED	fromField ROUTE name for SFFloat field named disableLinearSpeed.
static final String	fromField_DISABLETIME	fromField ROUTE name for SFTime field named disableTime.
static final String	fromField_ENABLED	fromField ROUTE name for SFBool field named enabled.
static final String	fromField_FINITEROTATIONAXIS	fromField ROUTE name for SFVec3f field named finiteRotationAxis.
static final String	fromField_FIXED	fromField ROUTE name for SFBool field named fixed.
static final String	fromField_FORCES	fromField ROUTE name for MFVec3f field named forces.
static final String	fromField_GEOMETRY	fromField ROUTE name for MFNode field named geometry.
static final String	fromField_INERTIA	fromField ROUTE name for SFMatrix3f field named inertia.
static final String	fromField_IS	fromField ROUTE name for SFNode field named IS.
static final String	fromField_LINEARDAMPINGFACTOR	fromField ROUTE name for SFFloat field named linearDampingFactor.
static final String	fromField_LINEARVELOCITY	fromField ROUTE name for SFVec3f field named linearVelocity.
static final String	fromField_MASS	fromField ROUTE name for SFFloat field named mass.
static final String	fromField_MASSDENSITYMODEL	fromField ROUTE name for SFNode field named massDensityModel.
static final String	fromField_METADATA	fromField ROUTE name for SFNode field named metadata.
static final String	fromField_ORIENTATION	fromField ROUTE name for SFRotation field named orientation.
static final String	fromField_POSITION	fromField ROUTE name for SFVec3f field named position.
static final String	fromField_TORQUES	fromField ROUTE name for MFVec3f field named torques.
static final String	fromField_USEFINITEROTATION	fromField ROUTE name for SFBool field named useFiniteRotation.
static final String	fromField_USEGLOBALGRAVITY	fromField ROUTE name for SFBool field named useGlobalGravity.
static final String	fromField_VISIBLE	fromField ROUTE name for SFBool field named visible.
static final float[]	INERTIA_DEFAULT_VALUE	SFMatrix3f field named inertia has default value {1f,0f,0f,0f,1f,0f,0f,0f,1f} (Java syntax) or 1 0 0 0 1 0 0 0 1 (XML syntax).
static final IS	IS_DEFAULT_VALUE	SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).
static final int	LEVEL	Integer constant LEVEL provides default X3D RigidBodyPhysics component level for this element: 2
static final float	LINEARDAMPINGFACTOR_DEFAULT_VALUE	SFFloat field named linearDampingFactor has default value 0.001f (Java syntax) or 0.001 (XML syntax).
static final float[]	LINEARVELOCITY_DEFAULT_VALUE	SFVec3f field named linearVelocity has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).
static final float	MASS_DEFAULT_VALUE	SFFloat field named mass has default value 1f (Java syntax) or 1 (XML syntax).
static final X3DNode	MASSDENSITYMODEL_DEFAULT_VALUE	SFNode field named massDensityModel has default value null (Java syntax) or NULL (XML syntax).
static final X3DMetadataObject	METADATA_DEFAULT_VALUE	SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).
static final String	NAME	String constant NAME provides name of this element: RigidBody.
static final float[]	ORIENTATION_DEFAULT_VALUE	SFRotation field named orientation has default value {0f,0f,1f,0f} (Java syntax) or 0 0 1 0 (XML syntax).
static final float[]	POSITION_DEFAULT_VALUE	SFVec3f field named position has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).
static final String	toField_ANGULARDAMPINGFACTOR	toField ROUTE name for SFFloat field named angularDampingFactor.
static final String	toField_ANGULARVELOCITY	toField ROUTE name for SFVec3f field named angularVelocity.
static final String	toField_AUTODAMP	toField ROUTE name for SFBool field named autoDamp.
static final String	toField_AUTODISABLE	toField ROUTE name for SFBool field named autoDisable.
static final String	toField_BBOXDISPLAY	toField ROUTE name for SFBool field named bboxDisplay.
static final String	toField_CENTEROFMASS	toField ROUTE name for SFVec3f field named centerOfMass.
static final String	toField_DISABLEANGULARSPEED	toField ROUTE name for SFFloat field named disableAngularSpeed.
static final String	toField_DISABLELINEARSPEED	toField ROUTE name for SFFloat field named disableLinearSpeed.
static final String	toField_DISABLETIME	toField ROUTE name for SFTime field named disableTime.
static final String	toField_ENABLED	toField ROUTE name for SFBool field named enabled.
static final String	toField_FINITEROTATIONAXIS	toField ROUTE name for SFVec3f field named finiteRotationAxis.
static final String	toField_FIXED	toField ROUTE name for SFBool field named fixed.
static final String	toField_FORCES	toField ROUTE name for MFVec3f field named forces.
static final String	toField_GEOMETRY	toField ROUTE name for MFNode field named geometry.
static final String	toField_INERTIA	toField ROUTE name for SFMatrix3f field named inertia.
static final String	toField_LINEARDAMPINGFACTOR	toField ROUTE name for SFFloat field named linearDampingFactor.
static final String	toField_LINEARVELOCITY	toField ROUTE name for SFVec3f field named linearVelocity.
static final String	toField_MASS	toField ROUTE name for SFFloat field named mass.
static final String	toField_MASSDENSITYMODEL	toField ROUTE name for SFNode field named massDensityModel.
static final String	toField_METADATA	toField ROUTE name for SFNode field named metadata.
static final String	toField_ORIENTATION	toField ROUTE name for SFRotation field named orientation.
static final String	toField_POSITION	toField ROUTE name for SFVec3f field named position.
static final String	toField_TORQUES	toField ROUTE name for MFVec3f field named torques.
static final String	toField_USEFINITEROTATION	toField ROUTE name for SFBool field named useFiniteRotation.
static final String	toField_USEGLOBALGRAVITY	toField ROUTE name for SFBool field named useGlobalGravity.
static final String	toField_VISIBLE	toField ROUTE name for SFBool field named visible.
static final float[]	TORQUES_DEFAULT_VALUE	MFVec3f field named torques has default value equal to an empty list.
static final boolean	USEFINITEROTATION_DEFAULT_VALUE	SFBool field named useFiniteRotation has default value false (Java syntax) or false (XML syntax).
static final boolean	USEGLOBALGRAVITY_DEFAULT_VALUE	SFBool field named useGlobalGravity has default value true (Java syntax) or true (XML syntax).
static final boolean	VISIBLE_DEFAULT_VALUE	SFBool field named visible has default value true (Java syntax) or true (XML syntax).

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteNode

containerField_ALLOWED_VALUES, containerFieldOverride, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteElement

CLASS_DEFAULT_VALUE, ID_DEFAULT_VALUE, STYLE_DEFAULT_VALUE, validationResult

Constructor Summary

Constructors

Constructor	Description
RigidBody()	Constructor for RigidBody to initialize member variables with default values.
RigidBody(String DEFlabel)	Utility constructor that assigns DEF label after initializing member variables with default values.

Method Summary

Modifier and Type	Method	Description
RigidBody	addComments(String newComment)	Add comment as String to contained commentsList.
RigidBody	addComments(String[] newComments)	Add comments as String[] array to contained commentsList.
RigidBody	addComments(CommentsBlock newCommentsBlock)	Add CommentsBlock to contained commentsList.
RigidBody	addForces(SFVec3f newValue)	Add singleton SFVec3f value to MFVec3f forces field.
RigidBody	addGeometry(ProtoInstance newValue)	Add single ProtoInstance (with appropriate node type and containerField value) to MFNode array for geometry field.
RigidBody	addGeometry(X3DNode newValue)	Add single child node to existing array of geometry nodes (if any).
void	addGeometry(X3DNode[] newValue)	Add array of child geometry nodes to array of existing nodes (if any).
RigidBody	addTorques(SFVec3f newValue)	Add singleton SFVec3f value to MFVec3f torques field.
RigidBody	clearGeometry()	Utility method to clear MFNode value of geometry field.
RigidBody	clearIS()	Utility method to clear SFNode value of IS field.
RigidBody	clearMassDensityModel()	Utility method to clear SFNode value of massDensityModel field.
RigidBody	clearMetadata()	Utility method to clear SFNode value of metadata field.
X3DConcreteElement	findElementByNameValue(String nameValue)	Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.
X3DConcreteElement	findElementByNameValue(String nameValue, String elementName)	Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.
X3DConcreteNode	findNodeByDEF(String DEFvalue)	Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
String	getAccessType(String fieldName)	Indicate accessType corresponding to given fieldName.
float	getAngularDampingFactor()	Provide float value from inputOutput SFFloat field named angularDampingFactor.
float[]	getAngularVelocity()	Provide array of 3-tuple float results from inputOutput SFVec3f field named angularVelocity.
boolean	getAutoDamp()	Provide boolean value from inputOutput SFBool field named autoDamp.
boolean	getAutoDisable()	Provide boolean value from inputOutput SFBool field named autoDisable.
float[]	getBboxCenter()	Provide array of 3-tuple float results from initializeOnly SFVec3f field named bboxCenter.
boolean	getBboxDisplay()	Provide boolean value from inputOutput SFBool field named bboxDisplay.
float[]	getBboxSize()	Provide array of 3-tuple float results within allowed range of [0,infinity), or default value [-1 -1 -1], from initializeOnly SFVec3f field named bboxSize.
float[]	getCenterOfMass()	Provide array of 3-tuple float results from inputOutput SFVec3f field named centerOfMass.
final String	getComponent()	Defines X3D component for the RigidBody element: RigidBodyPhysics
final int	getComponentLevel()	Provides default X3D component level for this element: 2
final String	getContainerFieldDefault()	containerField describes typical field relationship of a node to its parent.
String	getCssClass()	Provide String value from inputOutput SFString field named class.
String	getCssStyle()	Provide String value from inputOutput SFString field named style.
String	getDEF()	Provide String value from inputOutput SFString field named DEF.
float	getDisableAngularSpeed()	Provide float value from inputOutput SFFloat field named disableAngularSpeed.
float	getDisableLinearSpeed()	Provide float value from inputOutput SFFloat field named disableLinearSpeed.
double	getDisableTime()	Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named disableTime.
final String	getElementName()	Provides name of this element: RigidBody
boolean	getEnabled()	Provide boolean value from inputOutput SFBool field named enabled.
String	getFieldType(String fieldName)	Indicate type corresponding to given fieldName.
float[]	getFiniteRotationAxis()	Provide array of 3-tuple float results unit axis, angle (in radians) from inputOutput SFVec3f field named finiteRotationAxis.
boolean	getFixed()	Provide boolean value from inputOutput SFBool field named fixed.
float[]	getForces()	Provide array of 3-tuple float results from inputOutput MFVec3f field named forces.
X3DNode[]	getGeometry()	Provide array of org.web3d.x3d.sai.RigidBodyPhysics.X3DNBodyCollidableNode results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field geometry.
ArrayList<X3DNode>	getGeometryList()	Utility method to get ArrayList value of MFNode geometry field, similar to getGeometry().
String	getHtmlID()	Provide String value from inputOutput SFString field named id.
float[]	getInertia()	Provide array of float results from inputOutput SFMatrix3f field named inertia.
IS	getIS()	Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.
float	getLinearDampingFactor()	Provide float value from inputOutput SFFloat field named linearDampingFactor.
float[]	getLinearVelocity()	Provide array of 3-tuple float results from inputOutput SFVec3f field named linearVelocity.
float	getMass()	Provide float value from inputOutput SFFloat field named mass.
X3DNode	getMassDensityModel()	Provide org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) with acceptable node types limited to Sphere|Box|Cone, from inputOutput SFNode field massDensityModel.
X3DMetadataObject	getMetadata()	Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
float[]	getOrientation()	Provide array of 4-tuple float results unit axis, angle (in radians) from inputOutput SFRotation field named orientation.
float[]	getPosition()	Provide array of 3-tuple float results from inputOutput SFVec3f field named position.
float[]	getTorques()	Provide array of 3-tuple float results from inputOutput MFVec3f field named torques.
String	getUSE()	Provide String value from inputOutput SFString field named USE.
boolean	getUseFiniteRotation()	Provide boolean value unit axis, angle (in radians) from inputOutput SFBool field named useFiniteRotation.
boolean	getUseGlobalGravity()	Provide boolean value from inputOutput SFBool field named useGlobalGravity.
boolean	getVisible()	Provide boolean value from inputOutput SFBool field named visible.
boolean	hasElementByNameValue(String nameValue, String elementName)	Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
boolean	hasGeometry()	Indicate whether an object is available for inputOutput MFNode field geometry.
boolean	hasIS()	Indicate whether an object is available for inputOutput SFNode field IS.
boolean	hasMassDensityModel()	Indicate whether an object is available for inputOutput SFNode field massDensityModel.
boolean	hasMetadata()	Indicate whether an object is available for inputOutput SFNode field metadata.
boolean	hasNodeByDEF(String DEFvalue)	Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
final void	initialize()	Initialize all member variables to default values.
RigidBody	setAngularDampingFactor(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setAngularDampingFactor(float).
RigidBody	setAngularDampingFactor(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named angularDampingFactor.
RigidBody	setAngularDampingFactor(SFFloat newValue)	Assign typed object value to SFFloat angularDampingFactor field, similar to setAngularDampingFactor(float).
RigidBody	setAngularVelocity(double[] newArray)	Utility method: double-precision set-array accessor for X3D floating-point type, similar to setAngularVelocity(float[]).
RigidBody	setAngularVelocity(double x, double y, double z)	Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setAngularVelocity(float[]).
RigidBody	setAngularVelocity(float[] newValue)	Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named angularVelocity.
RigidBody	setAngularVelocity(float x, float y, float z)	Assign values to SFVec3f angularVelocity field, similar to setAngularVelocity(float[]).
RigidBody	setAngularVelocity(SFVec3f newValue)	Assign typed object value to SFVec3f angularVelocity field, similar to setAngularVelocity(float[]).
RigidBody	setAutoDamp(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named autoDamp.
RigidBody	setAutoDamp(SFBool newValue)	Assign typed object value to SFBool autoDamp field, similar to setAutoDamp(boolean).
RigidBody	setAutoDisable(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named autoDisable.
RigidBody	setAutoDisable(SFBool newValue)	Assign typed object value to SFBool autoDisable field, similar to setAutoDisable(boolean).
RigidBody	setBboxCenter(double[] newArray)	Utility method: double-precision set-array accessor for X3D floating-point type, similar to setBboxCenter(float[]).
RigidBody	setBboxCenter(double x, double y, double z)	Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setBboxCenter(float[]).
RigidBody	setBboxCenter(float[] newValue)	Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxCenter.
RigidBody	setBboxCenter(float x, float y, float z)	Assign values to SFVec3f bboxCenter field, similar to setBboxCenter(float[]).
RigidBody	setBboxCenter(SFVec3f newValue)	Assign typed object value to SFVec3f bboxCenter field, similar to setBboxCenter(float[]).
RigidBody	setBboxDisplay(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named bboxDisplay.
RigidBody	setBboxDisplay(SFBool newValue)	Assign typed object value to SFBool bboxDisplay field, similar to setBboxDisplay(boolean).
RigidBody	setBboxSize(double[] newArray)	Utility method: double-precision set-array accessor for X3D floating-point type, similar to setBboxSize(float[]).
RigidBody	setBboxSize(double x, double y, double z)	Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setBboxSize(float[]).
RigidBody	setBboxSize(float[] newValue)	Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxSize.
RigidBody	setBboxSize(float x, float y, float z)	Assign values to SFVec3f bboxSize field, similar to setBboxSize(float[]).
RigidBody	setBboxSize(SFVec3f newValue)	Assign typed object value to SFVec3f bboxSize field, similar to setBboxSize(float[]).
RigidBody	setCenterOfMass(double[] newArray)	Utility method: double-precision set-array accessor for X3D floating-point type, similar to setCenterOfMass(float[]).
RigidBody	setCenterOfMass(double x, double y, double z)	Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setCenterOfMass(float[]).
RigidBody	setCenterOfMass(float[] newValue)	Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named centerOfMass.
RigidBody	setCenterOfMass(float x, float y, float z)	Assign values to SFVec3f centerOfMass field, similar to setCenterOfMass(float[]).
RigidBody	setCenterOfMass(SFVec3f newValue)	Assign typed object value to SFVec3f centerOfMass field, similar to setCenterOfMass(float[]).
final RigidBody	setCssClass(String newValue)	Accessor method to assign String value to inputOutput SFString field named class.
RigidBody	setCssClass(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssClass(String).
final RigidBody	setCssStyle(String newValue)	Accessor method to assign String value to inputOutput SFString field named style.
RigidBody	setCssStyle(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssStyle(String).
final RigidBody	setDEF(String newValue)	Accessor method to assign String value to inputOutput SFString field named DEF.
RigidBody	setDEF(SFString newValue)	Assign typed object value to SFString DEF field, similar to setDEF(String).
RigidBody	setDisableAngularSpeed(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setDisableAngularSpeed(float).
RigidBody	setDisableAngularSpeed(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named disableAngularSpeed.
RigidBody	setDisableAngularSpeed(SFFloat newValue)	Assign typed object value to SFFloat disableAngularSpeed field, similar to setDisableAngularSpeed(float).
RigidBody	setDisableLinearSpeed(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setDisableLinearSpeed(float).
RigidBody	setDisableLinearSpeed(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named disableLinearSpeed.
RigidBody	setDisableLinearSpeed(SFFloat newValue)	Assign typed object value to SFFloat disableLinearSpeed field, similar to setDisableLinearSpeed(float).
RigidBody	setDisableTime(double newValue)	Accessor method to assign double value in seconds to inputOutput SFTime field named disableTime.
RigidBody	setDisableTime(SFTime newValue)	Assign typed object value to SFTime disableTime field, similar to setDisableTime(double).
RigidBody	setEnabled(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named enabled.
RigidBody	setEnabled(SFBool newValue)	Assign typed object value to SFBool enabled field, similar to setEnabled(boolean).
RigidBody	setFiniteRotationAxis(double[] newArray)	Utility method: double-precision set-array accessor for X3D floating-point type, similar to setFiniteRotationAxis(float[]).
RigidBody	setFiniteRotationAxis(double x, double y, double z)	Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setFiniteRotationAxis(float[]).
RigidBody	setFiniteRotationAxis(float[] newValue)	Accessor method to assign 3-tuple float array unit axis, angle (in radians) to inputOutput SFVec3f field named finiteRotationAxis.
RigidBody	setFiniteRotationAxis(float x, float y, float z)	Assign values to SFVec3f finiteRotationAxis field, similar to setFiniteRotationAxis(float[]).
RigidBody	setFiniteRotationAxis(SFVec3f newValue)	Assign typed object value to SFVec3f finiteRotationAxis field, similar to setFiniteRotationAxis(float[]).
RigidBody	setFixed(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named fixed.
RigidBody	setFixed(SFBool newValue)	Assign typed object value to SFBool fixed field, similar to setFixed(boolean).
RigidBody	setForces(double[] newArray)	Utility method: double-precision set-array accessor for X3D floating-point type, similar to setForces(float[]).
RigidBody	setForces(float[] newValue)	Accessor method to assign 3-tuple float array to inputOutput MFVec3f field named forces.
RigidBody	setForces(MFVec3f newValue)	Assign typed object value to MFVec3f forces field, similar to setForces(float[]).
RigidBody	setGeometry(ArrayList<X3DNBodyCollidableNode> newValue)	Assign ArrayList value of MFNode geometry field, similar to setGeometry(org.web3d.x3d.sai.Core.X3DNode[]).
void	setGeometry(X3DNode newValue)	Set single child geometry node, replacing prior array of existing nodes (if any).
RigidBody	setGeometry(X3DNode[] newValue)	Accessor method to assign org.web3d.x3d.sai.RigidBodyPhysics.X3DNBodyCollidableNode array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field geometry.
final RigidBody	setHtmlID(String newValue)	Accessor method to assign String value to inputOutput SFString field named id.
RigidBody	setHtmlID(SFString newValue)	Assign typed object value to SFString HtmlID field, similar to setHtmlID(String).
RigidBody	setInertia(float[] newValue)	Accessor method to assign float array to inputOutput SFMatrix3f field named inertia.
RigidBody	setInertia(SFMatrix3f newValue)	Assign typed object value to SFMatrix3f inertia field, similar to setInertia(float[]).
RigidBody	setIS(IS newValue)	Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
RigidBody	setLinearDampingFactor(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setLinearDampingFactor(float).
RigidBody	setLinearDampingFactor(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named linearDampingFactor.
RigidBody	setLinearDampingFactor(SFFloat newValue)	Assign typed object value to SFFloat linearDampingFactor field, similar to setLinearDampingFactor(float).
RigidBody	setLinearVelocity(double[] newArray)	Utility method: double-precision set-array accessor for X3D floating-point type, similar to setLinearVelocity(float[]).
RigidBody	setLinearVelocity(double x, double y, double z)	Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setLinearVelocity(float[]).
RigidBody	setLinearVelocity(float[] newValue)	Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named linearVelocity.
RigidBody	setLinearVelocity(float x, float y, float z)	Assign values to SFVec3f linearVelocity field, similar to setLinearVelocity(float[]).
RigidBody	setLinearVelocity(SFVec3f newValue)	Assign typed object value to SFVec3f linearVelocity field, similar to setLinearVelocity(float[]).
RigidBody	setMass(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setMass(float).
RigidBody	setMass(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named mass.
RigidBody	setMass(SFFloat newValue)	Assign typed object value to SFFloat mass field, similar to setMass(float).
RigidBody	setMassDensityModel(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field massDensityModel.
RigidBody	setMassDensityModel(X3DNode newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) to inputOutput SFNode field massDensityModel.
RigidBody	setMetadata(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
RigidBody	setMetadata(X3DMetadataObject newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
RigidBody	setOrientation(double[] newArray)	Utility method: double-precision set-array accessor for X3D floating-point type, similar to setOrientation(float[]).
RigidBody	setOrientation(double x, double y, double z, double angleRadians)	Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setOrientation(float[]).
RigidBody	setOrientation(float[] newValue)	Accessor method to assign 4-tuple float array unit axis, angle (in radians) to inputOutput SFRotation field named orientation.
RigidBody	setOrientation(float x, float y, float z, float angleRadians)	Assign values to SFRotation orientation field, similar to setOrientation(float[]).
RigidBody	setOrientation(SFRotation newValue)	Assign typed object value to SFRotation orientation field, similar to setOrientation(float[]).
RigidBody	setPosition(double[] newArray)	Utility method: double-precision set-array accessor for X3D floating-point type, similar to setPosition(float[]).
RigidBody	setPosition(double x, double y, double z)	Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setPosition(float[]).
RigidBody	setPosition(float[] newValue)	Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named position.
RigidBody	setPosition(float x, float y, float z)	Assign values to SFVec3f position field, similar to setPosition(float[]).
RigidBody	setPosition(SFVec3f newValue)	Assign typed object value to SFVec3f position field, similar to setPosition(float[]).
RigidBody	setTorques(double[] newArray)	Utility method: double-precision set-array accessor for X3D floating-point type, similar to setTorques(float[]).
RigidBody	setTorques(float[] newValue)	Accessor method to assign 3-tuple float array to inputOutput MFVec3f field named torques.
RigidBody	setTorques(MFVec3f newValue)	Assign typed object value to MFVec3f torques field, similar to setTorques(float[]).
final RigidBody	setUSE(String newValue)	Accessor method to assign String value to inputOutput SFString field named USE.
RigidBody	setUSE(SFString newValue)	Assign typed object value to SFString USE field, similar to setUSE(String).
RigidBody	setUSE(RigidBody DEFnode)	Assign a USE reference to another DEF node of same node type, similar to setUSE(String).
RigidBody	setUseFiniteRotation(boolean newValue)	Accessor method to assign boolean value unit axis, angle (in radians) to inputOutput SFBool field named useFiniteRotation.
RigidBody	setUseFiniteRotation(SFBool newValue)	Assign typed object value to SFBool useFiniteRotation field, similar to setUseFiniteRotation(boolean).
RigidBody	setUseGlobalGravity(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named useGlobalGravity.
RigidBody	setUseGlobalGravity(SFBool newValue)	Assign typed object value to SFBool useGlobalGravity field, similar to setUseGlobalGravity(boolean).
RigidBody	setVisible(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named visible.
RigidBody	setVisible(SFBool newValue)	Assign typed object value to SFBool visible field, similar to setVisible(boolean).
String	toStringClassicVRML(int indentLevel)	Recursive method to provide ClassicVRML string serialization.
String	toStringVRML97(int indentLevel)	Recursive method to provide VRML97 string serialization.
String	toStringX3D(int indentLevel)	Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
String	validate()	Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteNode

getContainerFieldAllowedValues, getContainerFieldOverride, getName, hasDEF, hasNameField, hasUSE, includesNameField, isNode, isStatement, resetContainerFieldOverride, setConcreteDEF, setConcreteUSE, setContainerFieldOverride

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement

addComments, clearParent, findAncestorElementByName, findAncestorProtoBody, findAncestorScene, findAncestorX3D, getPackageName, getParent, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorScene, hasAncestorX3D, hasParent, isValid, setConcreteCssClass, setConcreteCssStyle, setConcreteHtmlID, setParent, toStringClassicVRML, toStringVRML97, toStringX3D

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

NAME

public static final String NAME

String constant NAME provides name of this element: RigidBody.

See Also:

• Constant Field Values

COMPONENT

public static final String COMPONENT

String constant COMPONENT defines X3D component for the RigidBody element: RigidBodyPhysics

See Also:

• Constant Field Values

LEVEL

public static final int LEVEL

Integer constant LEVEL provides default X3D RigidBodyPhysics component level for this element: 2

See Also:

• Constant Field Values

ANGULARDAMPINGFACTOR_DEFAULT_VALUE

public static final float ANGULARDAMPINGFACTOR_DEFAULT_VALUE

SFFloat field named angularDampingFactor has default value 0.001f (Java syntax) or 0.001 (XML syntax).

See Also:

• Constant Field Values

ANGULARVELOCITY_DEFAULT_VALUE

public static final float[] ANGULARVELOCITY_DEFAULT_VALUE

SFVec3f field named angularVelocity has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).

AUTODAMP_DEFAULT_VALUE

public static final boolean AUTODAMP_DEFAULT_VALUE

SFBool field named autoDamp has default value false (Java syntax) or false (XML syntax).

See Also:

• Constant Field Values

AUTODISABLE_DEFAULT_VALUE

public static final boolean AUTODISABLE_DEFAULT_VALUE

SFBool field named autoDisable has default value false (Java syntax) or false (XML syntax).

See Also:

• Constant Field Values

BBOXCENTER_DEFAULT_VALUE

public static final float[] BBOXCENTER_DEFAULT_VALUE

SFVec3f field named bboxCenter has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).

BBOXDISPLAY_DEFAULT_VALUE

public static final boolean BBOXDISPLAY_DEFAULT_VALUE

SFBool field named bboxDisplay has default value false (Java syntax) or false (XML syntax).

See Also:

• Constant Field Values

BBOXSIZE_DEFAULT_VALUE

public static final float[] BBOXSIZE_DEFAULT_VALUE

SFVec3f field named bboxSize has default value {-1f,-1f,-1f} (Java syntax) or -1 -1 -1 (XML syntax).

CENTEROFMASS_DEFAULT_VALUE

public static final float[] CENTEROFMASS_DEFAULT_VALUE

SFVec3f field named centerOfMass has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).

DISABLEANGULARSPEED_DEFAULT_VALUE

public static final float DISABLEANGULARSPEED_DEFAULT_VALUE

SFFloat field named disableAngularSpeed has default value 0f (Java syntax) or 0 (XML syntax).

See Also:

• Constant Field Values

DISABLELINEARSPEED_DEFAULT_VALUE

public static final float DISABLELINEARSPEED_DEFAULT_VALUE

SFFloat field named disableLinearSpeed has default value 0f (Java syntax) or 0 (XML syntax).

See Also:

• Constant Field Values

DISABLETIME_DEFAULT_VALUE

public static final double DISABLETIME_DEFAULT_VALUE

SFTime field named disableTime has default value 0 (Java syntax) or 0 (XML syntax).

See Also:

• Constant Field Values

ENABLED_DEFAULT_VALUE

public static final boolean ENABLED_DEFAULT_VALUE

SFBool field named enabled has default value true (Java syntax) or true (XML syntax).

See Also:

• Constant Field Values

FINITEROTATIONAXIS_DEFAULT_VALUE

public static final float[] FINITEROTATIONAXIS_DEFAULT_VALUE

SFVec3f field named finiteRotationAxis has default value {0f,1f,0f} (Java syntax) or 0 1 0 (XML syntax).

FIXED_DEFAULT_VALUE

public static final boolean FIXED_DEFAULT_VALUE

SFBool field named fixed has default value false (Java syntax) or false (XML syntax).

See Also:

• Constant Field Values

FORCES_DEFAULT_VALUE

public static final float[] FORCES_DEFAULT_VALUE

MFVec3f field named forces has default value equal to an empty list.

INERTIA_DEFAULT_VALUE

public static final float[] INERTIA_DEFAULT_VALUE

SFMatrix3f field named inertia has default value {1f,0f,0f,0f,1f,0f,0f,0f,1f} (Java syntax) or 1 0 0 0 1 0 0 0 1 (XML syntax).

IS_DEFAULT_VALUE

public static final IS IS_DEFAULT_VALUE

SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).

LINEARDAMPINGFACTOR_DEFAULT_VALUE

public static final float LINEARDAMPINGFACTOR_DEFAULT_VALUE

SFFloat field named linearDampingFactor has default value 0.001f (Java syntax) or 0.001 (XML syntax).

See Also:

• Constant Field Values

LINEARVELOCITY_DEFAULT_VALUE

public static final float[] LINEARVELOCITY_DEFAULT_VALUE

SFVec3f field named linearVelocity has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).

MASS_DEFAULT_VALUE

public static final float MASS_DEFAULT_VALUE

SFFloat field named mass has default value 1f (Java syntax) or 1 (XML syntax).

See Also:

• Constant Field Values

MASSDENSITYMODEL_DEFAULT_VALUE

public static final X3DNode MASSDENSITYMODEL_DEFAULT_VALUE

SFNode field named massDensityModel has default value null (Java syntax) or NULL (XML syntax).

METADATA_DEFAULT_VALUE

public static final X3DMetadataObject METADATA_DEFAULT_VALUE

SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).

ORIENTATION_DEFAULT_VALUE

public static final float[] ORIENTATION_DEFAULT_VALUE

SFRotation field named orientation has default value {0f,0f,1f,0f} (Java syntax) or 0 0 1 0 (XML syntax).

POSITION_DEFAULT_VALUE

public static final float[] POSITION_DEFAULT_VALUE

SFVec3f field named position has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).

TORQUES_DEFAULT_VALUE

public static final float[] TORQUES_DEFAULT_VALUE

MFVec3f field named torques has default value equal to an empty list.

USEFINITEROTATION_DEFAULT_VALUE

public static final boolean USEFINITEROTATION_DEFAULT_VALUE

SFBool field named useFiniteRotation has default value false (Java syntax) or false (XML syntax).

See Also:

• Constant Field Values

USEGLOBALGRAVITY_DEFAULT_VALUE

public static final boolean USEGLOBALGRAVITY_DEFAULT_VALUE

SFBool field named useGlobalGravity has default value true (Java syntax) or true (XML syntax).

See Also:

• Constant Field Values

VISIBLE_DEFAULT_VALUE

public static final boolean VISIBLE_DEFAULT_VALUE

SFBool field named visible has default value true (Java syntax) or true (XML syntax).

See Also:

• Constant Field Values

containerField_DEFAULT_VALUE

public static final String containerField_DEFAULT_VALUE

containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, this default value is provided for informational purposes only.
containerField_DEFAULT_VALUE = "bodies";
containerField_ALLOWED_VALUES = {"bodies" }; type xs:NMTOKEN

See Also:

• X3D Scene Authoring Hints: containerField
• X3D Scene Authoring Hints: validation choices for containerField
• X3D Unified Object Model (X3DUOM)
• Constant Field Values

fromField_ANGULARDAMPINGFACTOR

public static final String fromField_ANGULARDAMPINGFACTOR

fromField ROUTE name for SFFloat field named angularDampingFactor.

See Also:

• Constant Field Values

toField_ANGULARDAMPINGFACTOR

public static final String toField_ANGULARDAMPINGFACTOR

toField ROUTE name for SFFloat field named angularDampingFactor.

See Also:

• Constant Field Values

fromField_ANGULARVELOCITY

public static final String fromField_ANGULARVELOCITY

fromField ROUTE name for SFVec3f field named angularVelocity.

See Also:

• Constant Field Values

toField_ANGULARVELOCITY

public static final String toField_ANGULARVELOCITY

toField ROUTE name for SFVec3f field named angularVelocity.

See Also:

• Constant Field Values

fromField_AUTODAMP

public static final String fromField_AUTODAMP

fromField ROUTE name for SFBool field named autoDamp.

See Also:

• Constant Field Values

toField_AUTODAMP

public static final String toField_AUTODAMP

toField ROUTE name for SFBool field named autoDamp.

See Also:

• Constant Field Values

fromField_AUTODISABLE

public static final String fromField_AUTODISABLE

fromField ROUTE name for SFBool field named autoDisable.

See Also:

• Constant Field Values

toField_AUTODISABLE

public static final String toField_AUTODISABLE

toField ROUTE name for SFBool field named autoDisable.

See Also:

• Constant Field Values

fromField_BBOXDISPLAY

public static final String fromField_BBOXDISPLAY

fromField ROUTE name for SFBool field named bboxDisplay.

See Also:

• Constant Field Values

toField_BBOXDISPLAY

public static final String toField_BBOXDISPLAY

toField ROUTE name for SFBool field named bboxDisplay.

See Also:

• Constant Field Values

fromField_CENTEROFMASS

public static final String fromField_CENTEROFMASS

fromField ROUTE name for SFVec3f field named centerOfMass.

See Also:

• Constant Field Values

toField_CENTEROFMASS

public static final String toField_CENTEROFMASS

toField ROUTE name for SFVec3f field named centerOfMass.

See Also:

• Constant Field Values

fromField_DISABLEANGULARSPEED

public static final String fromField_DISABLEANGULARSPEED

fromField ROUTE name for SFFloat field named disableAngularSpeed.

See Also:

• Constant Field Values

toField_DISABLEANGULARSPEED

public static final String toField_DISABLEANGULARSPEED

toField ROUTE name for SFFloat field named disableAngularSpeed.

See Also:

• Constant Field Values

fromField_DISABLELINEARSPEED

public static final String fromField_DISABLELINEARSPEED

fromField ROUTE name for SFFloat field named disableLinearSpeed.

See Also:

• Constant Field Values

toField_DISABLELINEARSPEED

public static final String toField_DISABLELINEARSPEED

toField ROUTE name for SFFloat field named disableLinearSpeed.

See Also:

• Constant Field Values

fromField_DISABLETIME

public static final String fromField_DISABLETIME

fromField ROUTE name for SFTime field named disableTime.

See Also:

• Constant Field Values

toField_DISABLETIME

public static final String toField_DISABLETIME

toField ROUTE name for SFTime field named disableTime.

See Also:

• Constant Field Values

fromField_ENABLED

public static final String fromField_ENABLED

fromField ROUTE name for SFBool field named enabled.

See Also:

• Constant Field Values

toField_ENABLED

public static final String toField_ENABLED

toField ROUTE name for SFBool field named enabled.

See Also:

• Constant Field Values

fromField_FINITEROTATIONAXIS

public static final String fromField_FINITEROTATIONAXIS

fromField ROUTE name for SFVec3f field named finiteRotationAxis.

See Also:

• Constant Field Values

toField_FINITEROTATIONAXIS

public static final String toField_FINITEROTATIONAXIS

toField ROUTE name for SFVec3f field named finiteRotationAxis.

See Also:

• Constant Field Values

fromField_FIXED

public static final String fromField_FIXED

fromField ROUTE name for SFBool field named fixed.

See Also:

• Constant Field Values

toField_FIXED

public static final String toField_FIXED

toField ROUTE name for SFBool field named fixed.

See Also:

• Constant Field Values

fromField_FORCES

public static final String fromField_FORCES

fromField ROUTE name for MFVec3f field named forces.

See Also:

• Constant Field Values

toField_FORCES

public static final String toField_FORCES

toField ROUTE name for MFVec3f field named forces.

See Also:

• Constant Field Values

fromField_GEOMETRY

public static final String fromField_GEOMETRY

fromField ROUTE name for MFNode field named geometry.

See Also:

• Constant Field Values

toField_GEOMETRY

public static final String toField_GEOMETRY

toField ROUTE name for MFNode field named geometry.

See Also:

• Constant Field Values

fromField_INERTIA

public static final String fromField_INERTIA

fromField ROUTE name for SFMatrix3f field named inertia.

See Also:

• Constant Field Values

toField_INERTIA

public static final String toField_INERTIA

toField ROUTE name for SFMatrix3f field named inertia.

See Also:

• Constant Field Values

fromField_IS

public static final String fromField_IS

fromField ROUTE name for SFNode field named IS.

See Also:

• Constant Field Values

fromField_LINEARDAMPINGFACTOR

public static final String fromField_LINEARDAMPINGFACTOR

fromField ROUTE name for SFFloat field named linearDampingFactor.

See Also:

• Constant Field Values

toField_LINEARDAMPINGFACTOR

public static final String toField_LINEARDAMPINGFACTOR

toField ROUTE name for SFFloat field named linearDampingFactor.

See Also:

• Constant Field Values

fromField_LINEARVELOCITY

public static final String fromField_LINEARVELOCITY

fromField ROUTE name for SFVec3f field named linearVelocity.

See Also:

• Constant Field Values

toField_LINEARVELOCITY

public static final String toField_LINEARVELOCITY

toField ROUTE name for SFVec3f field named linearVelocity.

See Also:

• Constant Field Values

fromField_MASS

public static final String fromField_MASS

fromField ROUTE name for SFFloat field named mass.

See Also:

• Constant Field Values

toField_MASS

public static final String toField_MASS

toField ROUTE name for SFFloat field named mass.

See Also:

• Constant Field Values

fromField_MASSDENSITYMODEL

public static final String fromField_MASSDENSITYMODEL

fromField ROUTE name for SFNode field named massDensityModel.

See Also:

• Constant Field Values

toField_MASSDENSITYMODEL

public static final String toField_MASSDENSITYMODEL

toField ROUTE name for SFNode field named massDensityModel.

See Also:

• Constant Field Values

fromField_METADATA

public static final String fromField_METADATA

fromField ROUTE name for SFNode field named metadata.

See Also:

• Constant Field Values

toField_METADATA

public static final String toField_METADATA

toField ROUTE name for SFNode field named metadata.

See Also:

• Constant Field Values

fromField_ORIENTATION

public static final String fromField_ORIENTATION

fromField ROUTE name for SFRotation field named orientation.

See Also:

• Constant Field Values

toField_ORIENTATION

public static final String toField_ORIENTATION

toField ROUTE name for SFRotation field named orientation.

See Also:

• Constant Field Values

fromField_POSITION

public static final String fromField_POSITION

fromField ROUTE name for SFVec3f field named position.

See Also:

• Constant Field Values

toField_POSITION

public static final String toField_POSITION

toField ROUTE name for SFVec3f field named position.

See Also:

• Constant Field Values

fromField_TORQUES

public static final String fromField_TORQUES

fromField ROUTE name for MFVec3f field named torques.

See Also:

• Constant Field Values

toField_TORQUES

public static final String toField_TORQUES

toField ROUTE name for MFVec3f field named torques.

See Also:

• Constant Field Values

fromField_USEFINITEROTATION

public static final String fromField_USEFINITEROTATION

fromField ROUTE name for SFBool field named useFiniteRotation.

See Also:

• Constant Field Values

toField_USEFINITEROTATION

public static final String toField_USEFINITEROTATION

toField ROUTE name for SFBool field named useFiniteRotation.

See Also:

• Constant Field Values

fromField_USEGLOBALGRAVITY

public static final String fromField_USEGLOBALGRAVITY

fromField ROUTE name for SFBool field named useGlobalGravity.

See Also:

• Constant Field Values

toField_USEGLOBALGRAVITY

public static final String toField_USEGLOBALGRAVITY

toField ROUTE name for SFBool field named useGlobalGravity.

See Also:

• Constant Field Values

fromField_VISIBLE

public static final String fromField_VISIBLE

fromField ROUTE name for SFBool field named visible.

See Also:

• Constant Field Values

toField_VISIBLE

public static final String toField_VISIBLE

toField ROUTE name for SFBool field named visible.

See Also:

• Constant Field Values

Constructor Details

RigidBody

public RigidBody()

Constructor for RigidBody to initialize member variables with default values.

RigidBody

public RigidBody(String DEFlabel)

Utility constructor that assigns DEF label after initializing member variables with default values.

Parameters:

DEFlabel - unique DEF name for this X3D node

Method Details

getElementName

public final String getElementName()

Provides name of this element: RigidBody

Specified by:

getElementName in class X3DConcreteElement

Returns:

name of this element

getComponent

public final String getComponent()

Defines X3D component for the RigidBody element: RigidBodyPhysics

Specified by:

getComponent in class X3DConcreteElement

Returns:

X3D component for this element

getComponentLevel

public final int getComponentLevel()

Provides default X3D component level for this element: 2

Specified by:

getComponentLevel in class X3DConcreteElement

Returns:

default X3D component level for this element

getFieldType

public String getFieldType(String fieldName)

Indicate type corresponding to given fieldName.

Specified by:

getFieldType in class X3DConcreteElement

Parameters:

fieldName - name of field in this X3D node

Returns:

X3D type (SFvec3f etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE if not recognized

See Also:

• ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE

getAccessType

public String getAccessType(String fieldName)

Indicate accessType corresponding to given fieldName.

Specified by:

getAccessType in class X3DConcreteElement

Parameters:

fieldName - name of field in this X3D node

Returns:

X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized

See Also:

• ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE

getContainerFieldDefault

public final String getContainerFieldDefault()

containerField describes typical field relationship of a node to its parent. Programmer usage is not ordinarily needed when using this API, since this default value is provided for informational purposes only.

Specified by:

getContainerFieldDefault in class X3DConcreteNode

Returns:

default containerField value

See Also:

• containerField_DEFAULT_VALUE
• X3DConcreteNode.containerField_ALLOWED_VALUES
• X3D Scene Authoring Hints: containerField
• X3D Scene Authoring Hints: validation choices for containerField
• X3D Unified Object Model (X3DUOM)

initialize

public final void initialize()

Initialize all member variables to default values.

Overrides:

initialize in class X3DConcreteNode

getAngularDampingFactor

public float getAngularDampingFactor()

Provide float value from inputOutput SFFloat field named angularDampingFactor.

Tooltip: [0,1] angularDampingFactor automatically damps a portion of body motion over time. *

Specified by:

getAngularDampingFactor in interface RigidBody

Returns:

value of angularDampingFactor field

setAngularDampingFactor

public RigidBody setAngularDampingFactor(float newValue)

Accessor method to assign float value to inputOutput SFFloat field named angularDampingFactor.

Tooltip: [0,1] angularDampingFactor automatically damps a portion of body motion over time. *

Specified by:

setAngularDampingFactor in interface RigidBody

Parameters:

newValue - is new value for the angularDampingFactor field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setAngularDampingFactor

public RigidBody setAngularDampingFactor(SFFloat newValue)

Assign typed object value to SFFloat angularDampingFactor field, similar to setAngularDampingFactor(float).

Parameters:

newValue - is new value for the angularDampingFactor field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setAngularDampingFactor

public RigidBody setAngularDampingFactor(double newValue)

Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setAngularDampingFactor(float).

Parameters:

newValue - is new value for field

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getAngularVelocity

public float[] getAngularVelocity()

Provide array of 3-tuple float results from inputOutput SFVec3f field named angularVelocity.

Tooltip: angularVelocity sets constant velocity value to object every frame, and reports updates by physics model.

• Hint: initial value only applied during first frame if forces applied.
• Warning: instantaneous velocity changes may lead to numerical instability.

Specified by:

getAngularVelocity in interface RigidBody

Returns:

value of angularVelocity field

setAngularVelocity

public RigidBody setAngularVelocity(float[] newValue)

Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named angularVelocity.

Tooltip: angularVelocity sets constant velocity value to object every frame, and reports updates by physics model.

• Hint: initial value only applied during first frame if forces applied.
• Warning: instantaneous velocity changes may lead to numerical instability.

Specified by:

setAngularVelocity in interface RigidBody

Parameters:

newValue - is new value for the angularVelocity field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setAngularVelocity

public RigidBody setAngularVelocity(SFVec3f newValue)

Assign typed object value to SFVec3f angularVelocity field, similar to setAngularVelocity(float[]).

Parameters:

newValue - is new value for the angularVelocity field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setAngularVelocity

public RigidBody setAngularVelocity(float x,
 float y,
 float z)

Assign values to SFVec3f angularVelocity field, similar to setAngularVelocity(float[]).

Parameters:

x - first component

y - second component

z - third component

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setAngularVelocity

public RigidBody setAngularVelocity(double x,
 double y,
 double z)

Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setAngularVelocity(float[]).

Parameters:

x - first component

y - second component

z - third component

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setAngularVelocity

public RigidBody setAngularVelocity(double[] newArray)

Utility method: double-precision set-array accessor for X3D floating-point type, similar to setAngularVelocity(float[]).

Parameters:

newArray - is new value for field

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getAutoDamp

public boolean getAutoDamp()

Provide boolean value from inputOutput SFBool field named autoDamp.

Tooltip: autoDamp enables/disables angularDampingFactor and linearDampingFactor. *

Specified by:

getAutoDamp in interface RigidBody

Returns:

value of autoDamp field

setAutoDamp

public RigidBody setAutoDamp(boolean newValue)

Accessor method to assign boolean value to inputOutput SFBool field named autoDamp.

Tooltip: autoDamp enables/disables angularDampingFactor and linearDampingFactor. *

Specified by:

setAutoDamp in interface RigidBody

Parameters:

newValue - is new value for the autoDamp field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setAutoDamp

public RigidBody setAutoDamp(SFBool newValue)

Assign typed object value to SFBool autoDamp field, similar to setAutoDamp(boolean).

Parameters:

newValue - is new value for the autoDamp field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getAutoDisable

public boolean getAutoDisable()

Provide boolean value from inputOutput SFBool field named autoDisable.

Tooltip: autoDisable toggles operation of disableAngularSpeed, disableLinearSpeed, disableTime. *

Specified by:

getAutoDisable in interface RigidBody

Returns:

value of autoDisable field

setAutoDisable

public RigidBody setAutoDisable(boolean newValue)

Accessor method to assign boolean value to inputOutput SFBool field named autoDisable.

Tooltip: autoDisable toggles operation of disableAngularSpeed, disableLinearSpeed, disableTime. *

Specified by:

setAutoDisable in interface RigidBody

Parameters:

newValue - is new value for the autoDisable field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setAutoDisable

public RigidBody setAutoDisable(SFBool newValue)

Assign typed object value to SFBool autoDisable field, similar to setAutoDisable(boolean).

Parameters:

newValue - is new value for the autoDisable field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getBboxCenter

public float[] getBboxCenter()

Provide array of 3-tuple float results from initializeOnly SFVec3f field named bboxCenter.

Tooltip: Bounding box center accompanies bboxSize and provides an optional hint for bounding box position offset from origin of local coordinate system.

• Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with a corresponding cost of increased file size.
• Hint: X3D Architecture, 10.2.2 Bounding boxes https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#BoundingBoxes
• Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#X3DBoundedObject

Specified by:

getBboxCenter in interface RigidBody

Specified by:

getBboxCenter in interface X3DBoundedObject

Returns:

value of bboxCenter field

setBboxCenter

public RigidBody setBboxCenter(float[] newValue)

Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxCenter.

Tooltip: Bounding box center accompanies bboxSize and provides an optional hint for bounding box position offset from origin of local coordinate system.

• Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with a corresponding cost of increased file size.
• Hint: X3D Architecture, 10.2.2 Bounding boxes https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#BoundingBoxes
• Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#X3DBoundedObject

Specified by:

setBboxCenter in interface RigidBody

Specified by:

setBboxCenter in interface X3DBoundedObject

Parameters:

newValue - is new value for the bboxCenter field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setBboxCenter

public RigidBody setBboxCenter(SFVec3f newValue)

Assign typed object value to SFVec3f bboxCenter field, similar to setBboxCenter(float[]).

Parameters:

newValue - is new value for the bboxCenter field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setBboxCenter

public RigidBody setBboxCenter(float x,
 float y,
 float z)

Assign values to SFVec3f bboxCenter field, similar to setBboxCenter(float[]).

Parameters:

x - first component

y - second component

z - third component

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setBboxCenter

public RigidBody setBboxCenter(double x,
 double y,
 double z)

Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setBboxCenter(float[]).

Parameters:

x - first component

y - second component

z - third component

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setBboxCenter

public RigidBody setBboxCenter(double[] newArray)

Utility method: double-precision set-array accessor for X3D floating-point type, similar to setBboxCenter(float[]).

Parameters:

newArray - is new value for field

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getBboxDisplay

public boolean getBboxDisplay()

Provide boolean value from inputOutput SFBool field named bboxDisplay.

Tooltip: Whether to display bounding box for associated geometry, aligned with world coordinates.

• Hint: the bounding box is displayed regardless of whether contained content is visible.

Specified by:

getBboxDisplay in interface RigidBody

Specified by:

getBboxDisplay in interface X3DBoundedObject

Returns:

value of bboxDisplay field

setBboxDisplay

public RigidBody setBboxDisplay(boolean newValue)

Accessor method to assign boolean value to inputOutput SFBool field named bboxDisplay.

Tooltip: Whether to display bounding box for associated geometry, aligned with world coordinates.

• Hint: the bounding box is displayed regardless of whether contained content is visible.

Specified by:

setBboxDisplay in interface RigidBody

Specified by:

setBboxDisplay in interface X3DBoundedObject

Parameters:

newValue - is new value for the bboxDisplay field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setBboxDisplay

public RigidBody setBboxDisplay(SFBool newValue)

Assign typed object value to SFBool bboxDisplay field, similar to setBboxDisplay(boolean).

Parameters:

newValue - is new value for the bboxDisplay field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getBboxSize

public float[] getBboxSize()

Provide array of 3-tuple float results within allowed range of [0,infinity), or default value [-1 -1 -1], from initializeOnly SFVec3f field named bboxSize.

Tooltip: or [0,+infinity) Bounding box size is usually omitted, and can easily be calculated automatically by an X3D player at scene-loading time with minimal computational cost. Bounding box size can also be defined as an optional authoring hint that suggests an optimization or constraint.

• Hint: can be useful for collision computations or inverse-kinematics (IK) engines.
• Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with a corresponding cost of increased file size.
• Hint: X3D Architecture, 10.2.2 Bounding boxes https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#BoundingBoxes
• Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#X3DBoundedObject

Specified by:

getBboxSize in interface RigidBody

Specified by:

getBboxSize in interface X3DBoundedObject

Returns:

value of bboxSize field

setBboxSize

public RigidBody setBboxSize(float[] newValue)

Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxSize.

Tooltip: or [0,+infinity) Bounding box size is usually omitted, and can easily be calculated automatically by an X3D player at scene-loading time with minimal computational cost. Bounding box size can also be defined as an optional authoring hint that suggests an optimization or constraint.

• Hint: can be useful for collision computations or inverse-kinematics (IK) engines.
• Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with a corresponding cost of increased file size.
• Hint: X3D Architecture, 10.2.2 Bounding boxes https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#BoundingBoxes
• Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#X3DBoundedObject

Specified by:

setBboxSize in interface RigidBody

Specified by:

setBboxSize in interface X3DBoundedObject

Parameters:

newValue - is new value for the bboxSize field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setBboxSize

public RigidBody setBboxSize(SFVec3f newValue)

Assign typed object value to SFVec3f bboxSize field, similar to setBboxSize(float[]).

Parameters:

newValue - is new value for the bboxSize field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setBboxSize

public RigidBody setBboxSize(float x,
 float y,
 float z)

Assign values to SFVec3f bboxSize field, similar to setBboxSize(float[]).

Parameters:

x - first component

y - second component

z - third component

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setBboxSize

public RigidBody setBboxSize(double x,
 double y,
 double z)

Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setBboxSize(float[]).

Parameters:

x - first component

y - second component

z - third component

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setBboxSize

public RigidBody setBboxSize(double[] newArray)

Utility method: double-precision set-array accessor for X3D floating-point type, similar to setBboxSize(float[]).

Parameters:

newArray - is new value for field

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getCenterOfMass

public float[] getCenterOfMass()

Provide array of 3-tuple float results from inputOutput SFVec3f field named centerOfMass.

Tooltip: centerOfMass defines local center of mass for physics calculations. *

Specified by:

getCenterOfMass in interface RigidBody

Returns:

value of centerOfMass field

setCenterOfMass

public RigidBody setCenterOfMass(float[] newValue)

Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named centerOfMass.

Tooltip: centerOfMass defines local center of mass for physics calculations. *

Specified by:

setCenterOfMass in interface RigidBody

Parameters:

newValue - is new value for the centerOfMass field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setCenterOfMass

public RigidBody setCenterOfMass(SFVec3f newValue)

Assign typed object value to SFVec3f centerOfMass field, similar to setCenterOfMass(float[]).

Parameters:

newValue - is new value for the centerOfMass field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setCenterOfMass

public RigidBody setCenterOfMass(float x,
 float y,
 float z)

Assign values to SFVec3f centerOfMass field, similar to setCenterOfMass(float[]).

Parameters:

x - first component

y - second component

z - third component

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setCenterOfMass

public RigidBody setCenterOfMass(double x,
 double y,
 double z)

Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setCenterOfMass(float[]).

Parameters:

x - first component

y - second component

z - third component

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setCenterOfMass

public RigidBody setCenterOfMass(double[] newArray)

Utility method: double-precision set-array accessor for X3D floating-point type, similar to setCenterOfMass(float[]).

Parameters:

newArray - is new value for field

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getDisableAngularSpeed

public float getDisableAngularSpeed()

Provide float value from inputOutput SFFloat field named disableAngularSpeed.

Tooltip: [0,+infinity) disableAngularSpeed defines lower-limit tolerance value when body is considered at rest and not part of rigid body calculations, reducing numeric instabilities.

• Hint: only activated if autoDisable='true'.

Specified by:

getDisableAngularSpeed in interface RigidBody

Returns:

value of disableAngularSpeed field

setDisableAngularSpeed

public RigidBody setDisableAngularSpeed(float newValue)

Accessor method to assign float value to inputOutput SFFloat field named disableAngularSpeed.

Tooltip: [0,+infinity) disableAngularSpeed defines lower-limit tolerance value when body is considered at rest and not part of rigid body calculations, reducing numeric instabilities.

• Hint: only activated if autoDisable='true'.

Specified by:

setDisableAngularSpeed in interface RigidBody

Parameters:

newValue - is new value for the disableAngularSpeed field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setDisableAngularSpeed

public RigidBody setDisableAngularSpeed(SFFloat newValue)

Assign typed object value to SFFloat disableAngularSpeed field, similar to setDisableAngularSpeed(float).

Parameters:

newValue - is new value for the disableAngularSpeed field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setDisableAngularSpeed

public RigidBody setDisableAngularSpeed(double newValue)

Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setDisableAngularSpeed(float).

Parameters:

newValue - is new value for field

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getDisableLinearSpeed

public float getDisableLinearSpeed()

Provide float value from inputOutput SFFloat field named disableLinearSpeed.

Tooltip: [0,+infinity) disableLinearSpeed defines lower-limit tolerance value when body is considered at rest and not part of rigid body calculation, reducing numeric instabilitiess.

• Hint: only activated if autoDisable='true'.

Specified by:

getDisableLinearSpeed in interface RigidBody

Returns:

value of disableLinearSpeed field

setDisableLinearSpeed

public RigidBody setDisableLinearSpeed(float newValue)

Accessor method to assign float value to inputOutput SFFloat field named disableLinearSpeed.

Tooltip: [0,+infinity) disableLinearSpeed defines lower-limit tolerance value when body is considered at rest and not part of rigid body calculation, reducing numeric instabilitiess.

• Hint: only activated if autoDisable='true'.

Specified by:

setDisableLinearSpeed in interface RigidBody

Parameters:

newValue - is new value for the disableLinearSpeed field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setDisableLinearSpeed

public RigidBody setDisableLinearSpeed(SFFloat newValue)

Assign typed object value to SFFloat disableLinearSpeed field, similar to setDisableLinearSpeed(float).

Parameters:

newValue - is new value for the disableLinearSpeed field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setDisableLinearSpeed

public RigidBody setDisableLinearSpeed(double newValue)

Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setDisableLinearSpeed(float).

Parameters:

newValue - is new value for field

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getDisableTime

public double getDisableTime()

Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named disableTime.

Tooltip: [0,+infinity) disableTime defines interval when body becomes at rest and not part of rigid body calculations, reducing numeric instabilities.

• Hint: only activated if autoDisable='true'
• Hint: disableTime is an SFTime duration interval, not an absolute clock time.

Specified by:

getDisableTime in interface RigidBody

Returns:

value of disableTime field

setDisableTime

public RigidBody setDisableTime(double newValue)

Accessor method to assign double value in seconds to inputOutput SFTime field named disableTime.

Tooltip: [0,+infinity) disableTime defines interval when body becomes at rest and not part of rigid body calculations, reducing numeric instabilities.

• Hint: only activated if autoDisable='true'
• Hint: disableTime is an SFTime duration interval, not an absolute clock time.

Specified by:

setDisableTime in interface RigidBody

Parameters:

newValue - is new value for the disableTime field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setDisableTime

public RigidBody setDisableTime(SFTime newValue)

Assign typed object value to SFTime disableTime field, similar to setDisableTime(double).

Parameters:

newValue - is new value for the disableTime field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getEnabled

public boolean getEnabled()

Provide boolean value from inputOutput SFBool field named enabled.

Tooltip: Enables/disables node operation. *

Specified by:

getEnabled in interface RigidBody

Returns:

value of enabled field

setEnabled

public RigidBody setEnabled(boolean newValue)

Accessor method to assign boolean value to inputOutput SFBool field named enabled.

Tooltip: Enables/disables node operation. *

Specified by:

setEnabled in interface RigidBody

Parameters:

newValue - is new value for the enabled field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setEnabled

public RigidBody setEnabled(SFBool newValue)

Assign typed object value to SFBool enabled field, similar to setEnabled(boolean).

Parameters:

newValue - is new value for the enabled field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getFiniteRotationAxis

public float[] getFiniteRotationAxis()

Provide array of 3-tuple float results unit axis, angle (in radians) from inputOutput SFVec3f field named finiteRotationAxis.

Tooltip: finiteRotationAxis specifies vector around which the object rotates. *

Specified by:

getFiniteRotationAxis in interface RigidBody

Returns:

value of finiteRotationAxis field

setFiniteRotationAxis

public RigidBody setFiniteRotationAxis(float[] newValue)

Accessor method to assign 3-tuple float array unit axis, angle (in radians) to inputOutput SFVec3f field named finiteRotationAxis.

Tooltip: finiteRotationAxis specifies vector around which the object rotates. *

Specified by:

setFiniteRotationAxis in interface RigidBody

Parameters:

newValue - is new value for the finiteRotationAxis field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setFiniteRotationAxis

public RigidBody setFiniteRotationAxis(SFVec3f newValue)

Assign typed object value to SFVec3f finiteRotationAxis field, similar to setFiniteRotationAxis(float[]).

Parameters:

newValue - is new value for the finiteRotationAxis field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setFiniteRotationAxis

public RigidBody setFiniteRotationAxis(float x,
 float y,
 float z)

Assign values to SFVec3f finiteRotationAxis field, similar to setFiniteRotationAxis(float[]).

Parameters:

x - first component

y - second component

z - third component

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setFiniteRotationAxis

public RigidBody setFiniteRotationAxis(double x,
 double y,
 double z)

Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setFiniteRotationAxis(float[]).

Parameters:

x - first component

y - second component

z - third component

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setFiniteRotationAxis

public RigidBody setFiniteRotationAxis(double[] newArray)

Utility method: double-precision set-array accessor for X3D floating-point type, similar to setFiniteRotationAxis(float[]).

Parameters:

newArray - is new value for field

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getFixed

public boolean getFixed()

Provide boolean value from inputOutput SFBool field named fixed.

Tooltip: fixed indicates whether body is able to move.

• Hint: fixed is useful for indicating objects that do not move: walls, ground, etc.

Specified by:

getFixed in interface RigidBody

Returns:

value of fixed field

setFixed

public RigidBody setFixed(boolean newValue)

Accessor method to assign boolean value to inputOutput SFBool field named fixed.

Tooltip: fixed indicates whether body is able to move.

• Hint: fixed is useful for indicating objects that do not move: walls, ground, etc.

Specified by:

setFixed in interface RigidBody

Parameters:

newValue - is new value for the fixed field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setFixed

public RigidBody setFixed(SFBool newValue)

Assign typed object value to SFBool fixed field, similar to setFixed(boolean).

Parameters:

newValue - is new value for the fixed field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getForces

public float[] getForces()

Provide array of 3-tuple float results from inputOutput MFVec3f field named forces.

Tooltip: forces defines linear force values applied to the object every frame. *

Specified by:

getForces in interface RigidBody

Returns:

value of forces field

setForces

public RigidBody setForces(float[] newValue)

Accessor method to assign 3-tuple float array to inputOutput MFVec3f field named forces.

Tooltip: forces defines linear force values applied to the object every frame. *

Specified by:

setForces in interface RigidBody

Parameters:

newValue - is new value for the forces field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setForces

public RigidBody setForces(MFVec3f newValue)

Assign typed object value to MFVec3f forces field, similar to setForces(float[]).

Parameters:

newValue - is new value for the forces field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

addForces

public RigidBody addForces(SFVec3f newValue)

Add singleton SFVec3f value to MFVec3f forces field.

Parameters:

newValue - is new value to add to the forces field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setForces

public RigidBody setForces(double[] newArray)

Utility method: double-precision set-array accessor for X3D floating-point type, similar to setForces(float[]).

Parameters:

newArray - is new value for field

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getGeometry

public X3DNode[] getGeometry()

Provide array of org.web3d.x3d.sai.RigidBodyPhysics.X3DNBodyCollidableNode results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field geometry.

Tooltip: [X3DNBodyCollidableNode] The geometry field is used to connect the body modelled by the physics engine implementation to the real geometry of the scene through the use of collidable nodes. This allows the geometry to be connected directly to the physics model as well as collision detection. Collidable nodes have their location set to the same location as the body instance in which they are located. *


Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DNBodyCollidableNode.

Specified by:

getGeometry in interface RigidBody

Returns:

value of geometry field

See Also:

• X3DNBodyCollidableNode

getGeometryList

public ArrayList<X3DNode> getGeometryList()

Utility method to get ArrayList value of MFNode geometry field, similar to getGeometry().

Returns:

value of geometry field

setGeometry

public RigidBody setGeometry(X3DNode[] newValue)

Accessor method to assign org.web3d.x3d.sai.RigidBodyPhysics.X3DNBodyCollidableNode array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field geometry.

Tooltip: [X3DNBodyCollidableNode] The geometry field is used to connect the body modelled by the physics engine implementation to the real geometry of the scene through the use of collidable nodes. This allows the geometry to be connected directly to the physics model as well as collision detection. Collidable nodes have their location set to the same location as the body instance in which they are located. *


Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DNBodyCollidableNode.

Specified by:

setGeometry in interface RigidBody

Parameters:

newValue - is new value for the geometry field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setGeometry

public RigidBody setGeometry(ArrayList<X3DNBodyCollidableNode> newValue)

Assign ArrayList value of MFNode geometry field, similar to setGeometry(org.web3d.x3d.sai.Core.X3DNode[]).

Parameters:

newValue - is new value for the geometry field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

addGeometry

public RigidBody addGeometry(X3DNode newValue)

Add single child node to existing array of geometry nodes (if any).

Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DNBodyCollidableNode and ProtoInstance.

Parameters:

newValue - is new value to be appended the geometry field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

addGeometry

public RigidBody addGeometry(ProtoInstance newValue)

Add single ProtoInstance (with appropriate node type and containerField value) to MFNode array for geometry field.

Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to ShaderPart and ProtoInstance.

Parameters:

newValue - is new value to be appended the parts field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

addGeometry

public void addGeometry(X3DNode[] newValue)

Add array of child geometry nodes to array of existing nodes (if any).

Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DNBodyCollidableNode.

Specified by:

addGeometry in interface RigidBody

Parameters:

newValue - is new value array to be appended the geometry field.

setGeometry

public void setGeometry(X3DNode newValue)

Set single child geometry node, replacing prior array of existing nodes (if any).

Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are restricted to X3DNBodyCollidableNode.

Specified by:

setGeometry in interface RigidBody

Parameters:

newValue - is new node for the geometry field (restricted to X3DNBodyCollidableNode)

clearGeometry

public RigidBody clearGeometry()

Utility method to clear MFNode value of geometry field. This method does not initialize withGEOMETRY_DEFAULT_VALUE.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

hasGeometry

public boolean hasGeometry()

Indicate whether an object is available for inputOutput MFNode field geometry.

Returns:

whether a properly typed node or ProtoInstance array or CommentsBlock is available.

See Also:

• getGeometry()

getInertia

public float[] getInertia()

Provide array of float results from inputOutput SFMatrix3f field named inertia.

Tooltip: inertia matrix defines a 3x2 inertia tensor matrix.

• Warning: only the first 6 values are used.

Specified by:

getInertia in interface RigidBody

Returns:

value of inertia field

setInertia

public RigidBody setInertia(float[] newValue)

Accessor method to assign float array to inputOutput SFMatrix3f field named inertia.

Tooltip: inertia matrix defines a 3x2 inertia tensor matrix.

• Warning: only the first 6 values are used.

Specified by:

setInertia in interface RigidBody

Parameters:

newValue - is new value for the inertia field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setInertia

public RigidBody setInertia(SFMatrix3f newValue)

Assign typed object value to SFMatrix3f inertia field, similar to setInertia(float[]).

Parameters:

newValue - is new value for the inertia field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getIS

public IS getIS()

Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.

Specified by:

getIS in class X3DConcreteNode

Returns:

value of IS field

See Also:

• X3D Tooltips: IS
• X3D Tooltips: connect

setIS

public RigidBody setIS(IS newValue)

Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.

Specified by:

setIS in class X3DConcreteNode

Parameters:

newValue - is new value for the IS field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• X3D Tooltips: IS
• X3D Tooltips: connect

clearIS

public RigidBody clearIS()

Utility method to clear SFNode value of IS field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

hasIS

public boolean hasIS()

Indicate whether an object is available for inputOutput SFNode field IS.

Returns:

whether a concrete statement or CommentsBlock is available.

See Also:

• getIS()

getLinearDampingFactor

public float getLinearDampingFactor()

Provide float value from inputOutput SFFloat field named linearDampingFactor.

Tooltip: [0,1] linearDampingFactor automatically damps a portion of body motion over time. *

Specified by:

getLinearDampingFactor in interface RigidBody

Returns:

value of linearDampingFactor field

setLinearDampingFactor

public RigidBody setLinearDampingFactor(float newValue)

Accessor method to assign float value to inputOutput SFFloat field named linearDampingFactor.

Tooltip: [0,1] linearDampingFactor automatically damps a portion of body motion over time. *

Specified by:

setLinearDampingFactor in interface RigidBody

Parameters:

newValue - is new value for the linearDampingFactor field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setLinearDampingFactor

public RigidBody setLinearDampingFactor(SFFloat newValue)

Assign typed object value to SFFloat linearDampingFactor field, similar to setLinearDampingFactor(float).

Parameters:

newValue - is new value for the linearDampingFactor field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setLinearDampingFactor

public RigidBody setLinearDampingFactor(double newValue)

Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setLinearDampingFactor(float).

Parameters:

newValue - is new value for field

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getLinearVelocity

public float[] getLinearVelocity()

Provide array of 3-tuple float results from inputOutput SFVec3f field named linearVelocity.

Tooltip: linearVelocity sets constant velocity value to object every frame, and reports updates by physics model.

• Hint: initial value only applied during first frame if forces applied.
• Warning: instantaneous velocity changes may lead to numerical instability.

Specified by:

getLinearVelocity in interface RigidBody

Returns:

value of linearVelocity field

setLinearVelocity

public RigidBody setLinearVelocity(float[] newValue)

Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named linearVelocity.

Tooltip: linearVelocity sets constant velocity value to object every frame, and reports updates by physics model.

• Hint: initial value only applied during first frame if forces applied.
• Warning: instantaneous velocity changes may lead to numerical instability.

Specified by:

setLinearVelocity in interface RigidBody

Parameters:

newValue - is new value for the linearVelocity field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setLinearVelocity

public RigidBody setLinearVelocity(SFVec3f newValue)

Assign typed object value to SFVec3f linearVelocity field, similar to setLinearVelocity(float[]).

Parameters:

newValue - is new value for the linearVelocity field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setLinearVelocity

public RigidBody setLinearVelocity(float x,
 float y,
 float z)

Assign values to SFVec3f linearVelocity field, similar to setLinearVelocity(float[]).

Parameters:

x - first component

y - second component

z - third component

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setLinearVelocity

public RigidBody setLinearVelocity(double x,
 double y,
 double z)

Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setLinearVelocity(float[]).

Parameters:

x - first component

y - second component

z - third component

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setLinearVelocity

public RigidBody setLinearVelocity(double[] newArray)

Utility method: double-precision set-array accessor for X3D floating-point type, similar to setLinearVelocity(float[]).

Parameters:

newArray - is new value for field

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getMass

public float getMass()

Provide float value from inputOutput SFFloat field named mass.

Tooltip: (0,1] mass of the body in kilograms.

• Warning: mass must be greater than 0.
• Hint: https://en.wikipedia.org/wiki/Kilogram
• Hint: X3D Architecture 4.3.6 Standard units and coordinate system https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/concepts.html#Standardunitscoordinates

Specified by:

getMass in interface RigidBody

Returns:

value of mass field

setMass

public RigidBody setMass(float newValue)

Accessor method to assign float value to inputOutput SFFloat field named mass.

Tooltip: (0,1] mass of the body in kilograms.

• Warning: mass must be greater than 0.
• Hint: https://en.wikipedia.org/wiki/Kilogram
• Hint: X3D Architecture 4.3.6 Standard units and coordinate system https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/concepts.html#Standardunitscoordinates

Specified by:

setMass in interface RigidBody

Parameters:

newValue - is new value for the mass field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setMass

public RigidBody setMass(SFFloat newValue)

Assign typed object value to SFFloat mass field, similar to setMass(float).

Parameters:

newValue - is new value for the mass field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setMass

public RigidBody setMass(double newValue)

Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setMass(float).

Parameters:

newValue - is new value for field

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getMassDensityModel

public X3DNode getMassDensityModel()

Provide org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) with acceptable node types limited to Sphere|Box|Cone, from inputOutput SFNode field massDensityModel.

Specified by:

getMassDensityModel in interface RigidBody

Returns:

value of massDensityModel field

See Also:

• 
  
  Tooltip: [Sphere,Box,Cone] The massDensityModel field is used to describe the geometry type and dimensions used to calculate the mass density in the physics model. It is not rendered, nor modified by the physics model. *
  

setMassDensityModel

public RigidBody setMassDensityModel(X3DNode newValue)

Accessor method to assign org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) to inputOutput SFNode field massDensityModel.

Specified by:

setMassDensityModel in interface RigidBody

Parameters:

newValue - is new value for the massDensityModel field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• 
  
  Tooltip: [Sphere,Box,Cone] The massDensityModel field is used to describe the geometry type and dimensions used to calculate the mass density in the physics model. It is not rendered, nor modified by the physics model. *
  

clearMassDensityModel

public RigidBody clearMassDensityModel()

Utility method to clear SFNode value of massDensityModel field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

setMassDensityModel

public RigidBody setMassDensityModel(ProtoInstance newValue)

Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field massDensityModel.

Parameters:

newValue - is new value for the massDensityModel field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• setMassDensityModel(org.web3d.x3d.sai.Core.X3DNode)

hasMassDensityModel

public boolean hasMassDensityModel()

Indicate whether an object is available for inputOutput SFNode field massDensityModel.

Returns:

whether a properly typed node or ProtoInstance or CommentsBlock is available.

See Also:

• getMassDensityModel()
• getMassDensityModelProtoInstance()

getMetadata

public X3DMetadataObject getMetadata()

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

Specified by:

getMetadata in interface RigidBody

Specified by:

getMetadata in interface X3DChildNode

Specified by:

getMetadata in interface X3DNode

Returns:

value of metadata field

See Also:

• 
  
  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
• X3D Scene Authoring Hints: Metadata Nodes

setMetadata

public RigidBody setMetadata(X3DMetadataObject newValue)

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

Specified by:

setMetadata in interface RigidBody

Specified by:

setMetadata in interface X3DChildNode

Specified by:

setMetadata in interface X3DNode

Specified by:

setMetadata in class X3DConcreteNode

Parameters:

newValue - is new value for the metadata field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• 
  
  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
• X3D Scene Authoring Hints: Metadata Nodes

clearMetadata

public RigidBody clearMetadata()

Utility method to clear SFNode value of metadata field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

setMetadata

public RigidBody setMetadata(ProtoInstance newValue)

Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.

Specified by:

setMetadata in class X3DConcreteNode

Parameters:

newValue - is new value for the metadata field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• setMetadata(org.web3d.x3d.sai.Core.X3DMetadataObject)

hasMetadata

public boolean hasMetadata()

Indicate whether an object is available for inputOutput SFNode field metadata.

Returns:

whether a properly typed node or ProtoInstance or CommentsBlock is available.

See Also:

• getMetadata()
• getMetadataProtoInstance()
• X3D Scene Authoring Hints: Metadata Nodes

getOrientation

public float[] getOrientation()

Provide array of 4-tuple float results unit axis, angle (in radians) from inputOutput SFRotation field named orientation.

Tooltip: orientation sets body direction in world space, then reports physics updates. *

Specified by:

getOrientation in interface RigidBody

Returns:

value of orientation field

setOrientation

public RigidBody setOrientation(float[] newValue)

Accessor method to assign 4-tuple float array unit axis, angle (in radians) to inputOutput SFRotation field named orientation.

Tooltip: orientation sets body direction in world space, then reports physics updates. *

Specified by:

setOrientation in interface RigidBody

Parameters:

newValue - is new value for the orientation field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setOrientation

public RigidBody setOrientation(SFRotation newValue)

Assign typed object value to SFRotation orientation field, similar to setOrientation(float[]).

Parameters:

newValue - is new value for the orientation field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setOrientation

public RigidBody setOrientation(float x,
 float y,
 float z,
 float angleRadians)

Assign values to SFRotation orientation field, similar to setOrientation(float[]).

Parameters:

x - first component of axis

y - second component of axis

z - third component of axis

angleRadians - fourth component of rotation around axis

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setOrientation

public RigidBody setOrientation(double x,
 double y,
 double z,
 double angleRadians)

Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setOrientation(float[]).

Parameters:

x - first component

y - second component

z - third component

angleRadians - fourth component

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setOrientation

public RigidBody setOrientation(double[] newArray)

Utility method: double-precision set-array accessor for X3D floating-point type, similar to setOrientation(float[]).

Parameters:

newArray - is new value for field

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getPosition

public float[] getPosition()

Provide array of 3-tuple float results from inputOutput SFVec3f field named position.

Tooltip: position sets body location in world space, then reports physics updates. *

Specified by:

getPosition in interface RigidBody

Returns:

value of position field

setPosition

public RigidBody setPosition(float[] newValue)

Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named position.

Tooltip: position sets body location in world space, then reports physics updates. *

Specified by:

setPosition in interface RigidBody

Parameters:

newValue - is new value for the position field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setPosition

public RigidBody setPosition(SFVec3f newValue)

Assign typed object value to SFVec3f position field, similar to setPosition(float[]).

Parameters:

newValue - is new value for the position field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setPosition

public RigidBody setPosition(float x,
 float y,
 float z)

Assign values to SFVec3f position field, similar to setPosition(float[]).

Parameters:

x - first component

y - second component

z - third component

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setPosition

public RigidBody setPosition(double x,
 double y,
 double z)

Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setPosition(float[]).

Parameters:

x - first component

y - second component

z - third component

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setPosition

public RigidBody setPosition(double[] newArray)

Utility method: double-precision set-array accessor for X3D floating-point type, similar to setPosition(float[]).

Parameters:

newArray - is new value for field

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getTorques

public float[] getTorques()

Provide array of 3-tuple float results from inputOutput MFVec3f field named torques.

Tooltip: torques defines rotational force values applied to the object every frame. *

Specified by:

getTorques in interface RigidBody

Returns:

value of torques field

setTorques

public RigidBody setTorques(float[] newValue)

Accessor method to assign 3-tuple float array to inputOutput MFVec3f field named torques.

Tooltip: torques defines rotational force values applied to the object every frame. *

Specified by:

setTorques in interface RigidBody

Parameters:

newValue - is new value for the torques field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setTorques

public RigidBody setTorques(MFVec3f newValue)

Assign typed object value to MFVec3f torques field, similar to setTorques(float[]).

Parameters:

newValue - is new value for the torques field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

addTorques

public RigidBody addTorques(SFVec3f newValue)

Add singleton SFVec3f value to MFVec3f torques field.

Parameters:

newValue - is new value to add to the torques field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setTorques

public RigidBody setTorques(double[] newArray)

Utility method: double-precision set-array accessor for X3D floating-point type, similar to setTorques(float[]).

Parameters:

newArray - is new value for field

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getUseFiniteRotation

public boolean getUseFiniteRotation()

Provide boolean value unit axis, angle (in radians) from inputOutput SFBool field named useFiniteRotation.

Tooltip: useFiniteRotation enables/disables higher-resolution, higher-cost computational method for calculating rotations. *

Specified by:

getUseFiniteRotation in interface RigidBody

Returns:

value of useFiniteRotation field

setUseFiniteRotation

public RigidBody setUseFiniteRotation(boolean newValue)

Accessor method to assign boolean value unit axis, angle (in radians) to inputOutput SFBool field named useFiniteRotation.

Tooltip: useFiniteRotation enables/disables higher-resolution, higher-cost computational method for calculating rotations. *

Specified by:

setUseFiniteRotation in interface RigidBody

Parameters:

newValue - is new value for the useFiniteRotation field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setUseFiniteRotation

public RigidBody setUseFiniteRotation(SFBool newValue)

Assign typed object value to SFBool useFiniteRotation field, similar to setUseFiniteRotation(boolean).

Parameters:

newValue - is new value for the useFiniteRotation field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getUseGlobalGravity

public boolean getUseGlobalGravity()

Provide boolean value from inputOutput SFBool field named useGlobalGravity.

Tooltip: useGlobalGravity indicates whether this particular body is influenced by parent RigidBodyCollection's gravity setting.

• Hint: contained sub-bodies are not affected by this setting.

Specified by:

getUseGlobalGravity in interface RigidBody

Returns:

value of useGlobalGravity field

setUseGlobalGravity

public RigidBody setUseGlobalGravity(boolean newValue)

Accessor method to assign boolean value to inputOutput SFBool field named useGlobalGravity.

Tooltip: useGlobalGravity indicates whether this particular body is influenced by parent RigidBodyCollection's gravity setting.

• Hint: contained sub-bodies are not affected by this setting.

Specified by:

setUseGlobalGravity in interface RigidBody

Parameters:

newValue - is new value for the useGlobalGravity field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setUseGlobalGravity

public RigidBody setUseGlobalGravity(SFBool newValue)

Assign typed object value to SFBool useGlobalGravity field, similar to setUseGlobalGravity(boolean).

Parameters:

newValue - is new value for the useGlobalGravity field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getVisible

public boolean getVisible()

Provide boolean value from inputOutput SFBool field named visible.

Tooltip: Whether or not renderable content within this node is visually displayed.

• Hint: the visible field has no effect on animation behaviors, event passing or other non-visual characteristics.
• Hint: content must be visible to be collidable and to be pickable.

Specified by:

getVisible in interface RigidBody

Specified by:

getVisible in interface X3DBoundedObject

Returns:

value of visible field

setVisible

public RigidBody setVisible(boolean newValue)

Accessor method to assign boolean value to inputOutput SFBool field named visible.

Tooltip: Whether or not renderable content within this node is visually displayed.

• Hint: the visible field has no effect on animation behaviors, event passing or other non-visual characteristics.
• Hint: content must be visible to be collidable and to be pickable.

Specified by:

setVisible in interface RigidBody

Specified by:

setVisible in interface X3DBoundedObject

Parameters:

newValue - is new value for the visible field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setVisible

public RigidBody setVisible(SFBool newValue)

Assign typed object value to SFBool visible field, similar to setVisible(boolean).

Parameters:

newValue - is new value for the visible field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getDEF

public String getDEF()

Provide String value from inputOutput SFString field named DEF.

Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.

• Hint: descriptive DEF names improve clarity and help document a model.
• Hint: well-defined names can simplify design and debugging through improved author understanding.
• Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions

Overrides:

getDEF in class X3DConcreteNode

Returns:

value of DEF field

See Also:

• X3D Scene Authoring Hints: Naming Conventions

setDEF

public final RigidBody setDEF(String newValue)

Accessor method to assign String value to inputOutput SFString field named DEF.

Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.

• Hint: descriptive DEF names improve clarity and help document a model.
• Hint: well-defined names can simplify design and debugging through improved author understanding.
• Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions

Note that setting the DEF value clears the USE value.

Specified by:

setDEF in class X3DConcreteNode

Parameters:

newValue - is new value for the DEF field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setDEF

public RigidBody setDEF(SFString newValue)

Assign typed object value to SFString DEF field, similar to setDEF(String).

Parameters:

newValue - is new value for the DEF field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getUSE

public String getUSE()

Provide String value from inputOutput SFString field named USE.

Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value).

• Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
• Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute.
• Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.

Overrides:

getUSE in class X3DConcreteNode

Returns:

value of USE field

See Also:

• X3D Scene Authoring Hints: Naming Conventions

setUSE

public final RigidBody setUSE(String newValue)

Accessor method to assign String value to inputOutput SFString field named USE.

Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value).

• Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
• Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute.
• Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.

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 class X3DConcreteNode

Parameters:

newValue - is new value for the USE field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setUSE

public RigidBody setUSE(SFString newValue)

Assign typed object value to SFString USE field, similar to setUSE(String).

Parameters:

newValue - is new value for the USE field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getCssClass

public String getCssClass()

Provide String value from inputOutput SFString field named class.

Overrides:

getCssClass in class X3DConcreteElement

Returns:

value of class field

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssClass

public final RigidBody setCssClass(String newValue)

Accessor method to assign String value to inputOutput SFString field named class.

Specified by:

setCssClass in class X3DConcreteNode

Parameters:

newValue - is new value for the class field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssClass

public RigidBody setCssClass(SFString newValue)

Assign typed object value to SFString cssClass field, similar to setCssClass(String).

Parameters:

newValue - is new value for the class field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getHtmlID

public String getHtmlID()

Provide String value from inputOutput SFString field named id.

Overrides:

getHtmlID in class X3DConcreteElement

Returns:

value of id field

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setHtmlID

public final RigidBody setHtmlID(String newValue)

Accessor method to assign String value to inputOutput SFString field named id.

Specified by:

setHtmlID in class X3DConcreteNode

Parameters:

newValue - is new value for the id field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
  Warning: the id attribute is in a distinct separate namespace from DEF identifiers and thus not applicable for USE nodes, ROUTE statements, or Script references.
• X3D Architecture Annex L - HTML authoring guidelines, L.3.1 Content definition and page presentation
• HTML 5.2 W3C Recommendation
• Document Object Model (DOM) Technical Reports
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setHtmlID

public RigidBody setHtmlID(SFString newValue)

Assign typed object value to SFString HtmlID field, similar to setHtmlID(String).

Parameters:

newValue - is new value for the id field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getCssStyle

public String getCssStyle()

Provide String value from inputOutput SFString field named style.

Overrides:

getCssStyle in class X3DConcreteElement

Returns:

value of style field

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssStyle

public final RigidBody setCssStyle(String newValue)

Accessor method to assign String value to inputOutput SFString field named style.

Specified by:

setCssStyle in class X3DConcreteNode

Parameters:

newValue - is new value for the style field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssStyle

public RigidBody setCssStyle(SFString newValue)

Assign typed object value to SFString cssClass field, similar to setCssStyle(String).

Parameters:

newValue - is new value for the style field.

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setUSE

public RigidBody setUSE(RigidBody DEFnode)

Assign a USE reference to another DEF node of same node type, similar to setUSE(String).

Warning: note that 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.

Parameters:

DEFnode - must have a DEF value defined

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

addComments

public RigidBody addComments(String newComment)

Add comment as String to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComment - initial value

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• X3D Architecture, clause 7.2.5.1 Organization

addComments

public RigidBody addComments(String[] newComments)

Add comments as String[] array to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComments - array of comments

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

addComments

public RigidBody addComments(CommentsBlock newCommentsBlock)

Add CommentsBlock to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newCommentsBlock - block of comments to add

Returns:

RigidBody - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

toStringX3D

public String toStringX3D(int indentLevel)

Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.

Specified by:

toStringX3D in class X3DConcreteElement

Parameters:

indentLevel - number of levels of indentation for this element

Returns:

X3D string

See Also:

• X3D.FILE_EXTENSION_X3D
• X3D.FILE_EXTENSION_XML
• X3D.toStringXML()
• X3D.toFileXML(String)
• X3D.toFileX3D(String)
• X3D XML Encoding
• X3D Compressed Binary Encoding: X3D Canonical Form
• X3D Canonicalization (C14N) Tool

toStringClassicVRML

public String toStringClassicVRML(int indentLevel)

Recursive method to provide ClassicVRML string serialization.

Specified by:

toStringClassicVRML in class X3DConcreteElement

Parameters:

indentLevel - number of levels of indentation for this element

Returns:

ClassicVRML string

See Also:

• X3D.FILE_EXTENSION_CLASSICVRML
• X3D Resources: Virtual Reality Modeling Language (VRML) 97
• Extensible 3D (X3D) encodings Part 2: Classic VRML encoding
• Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Annex A: Grammar

toStringVRML97

public String toStringVRML97(int indentLevel)

Recursive method to provide VRML97 string serialization.

Specified by:

toStringVRML97 in class X3DConcreteElement

Parameters:

indentLevel - number of levels of indentation for this element

Returns:

VRML97 string

See Also:

• X3D.FILE_EXTENSION_VRML97
• X3D Resources: Virtual Reality Modeling Language (VRML) 97
• Virtual Reality Modeling Language (VRML) 97 specification
• VRML 97 v2.1 Amendment

findElementByNameValue

public X3DConcreteElement findElementByNameValue(String nameValue)

Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.

Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.

Warning: more than one element may be found that has the same name, this method does not handle that case.

Specified by:

findElementByNameValue in class X3DConcreteElement

Parameters:

nameValue - is value of the name field being searched for in this element and child elements(if any)

Returns:

object reference to found element, null otherwise

See Also:

• findNodeByDEF(String)
• X3DConcreteElement.hasAncestorScene()
• X3DConcreteElement.findAncestorX3D()

findElementByNameValue

public X3DConcreteElement findElementByNameValue(String nameValue,
 String elementName)

Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.

Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.

Warning: more than one element may be found that has the same name, this method does not handle that case.

Specified by:

findElementByNameValue in class X3DConcreteElement

Parameters:

nameValue - is value of the name field being searched for in this element and child elements(if any)

elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)

Returns:

object reference to found element, null otherwise

See Also:

• findNodeByDEF(String)
• X3DConcreteElement.hasAncestorScene()
• X3DConcreteElement.findAncestorX3D()

hasElementByNameValue

public boolean hasElementByNameValue(String nameValue,
 String elementName)

Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.

Parameters:

nameValue - is value of the name field being searched for in this element and child elements(if any)

elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)

Returns:

whether node is found

See Also:

• findElementByNameValue(String, String)

findNodeByDEF

public X3DConcreteNode findNodeByDEF(String DEFvalue)

Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.

Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.

Warning: more than one element may be found that has the same DEF, this method does not handle that case.

Specified by:

findNodeByDEF in class X3DConcreteElement

Parameters:

DEFvalue - is value of the name field being searched for in this element and child elements(if any)

Returns:

object reference to found node, null otherwise

See Also:

• findElementByNameValue(String)
• X3DConcreteElement.hasAncestorScene()
• X3DConcreteElement.findAncestorX3D()

hasNodeByDEF

public boolean hasNodeByDEF(String DEFvalue)

Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.

Parameters:

DEFvalue - is value of the name field being searched for in this element and child elements(if any)

Returns:

whether node is found

See Also:

• findNodeByDEF(String)

validate

public String validate()

Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values. TODO document specific validation methods.

Specified by:

validate in class X3DConcreteElement

Returns:

validation results (if any)