Class CollidableShape

java.lang.Object

org.web3d.x3d.jsail.X3DConcreteElement

org.web3d.x3d.jsail.X3DConcreteNode

org.web3d.x3d.jsail.RigidBodyPhysics.CollidableShape

All Implemented Interfaces:

X3DChildNode, X3DNode, X3DBoundedObject, CollidableShape, X3DNBodyCollidableNode

public class CollidableShape
extends X3DConcreteNode
implements CollidableShape

CollidableShape connects the collision detection system, the rigid body model, and the renderable scene graph.

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. CollidableShape node tooltip: (X3D version 3.2 or later) [X3DNBodyCollidableNode] CollidableShape connects the collision detection system, the rigid body model, and the renderable scene graph. Contains a single Shape node (containerField='shape') for animating collidable geometry.

• Warning: avoid changing Shape geometry at run time to prevent performance problems.
• Warning: apply containerField='shape' to single Shape child node, not containerField='children' default.
• Hint: content must be visible to be collidable and to be pickable.

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: CollidableShape
• X3D Tooltips: CollidableShape
• X3D Scene Authoring Hints

Field Summary

Fields

Modifier and Type	Field	Description
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 String	COMPONENT	String constant COMPONENT defines X3D component for the CollidableShape element: RigidBodyPhysics
static final String	containerField_DEFAULT_VALUE	containerField describes typical field relationship of a node to its parent.
static final boolean	ENABLED_DEFAULT_VALUE	SFBool field named enabled has default value true (Java syntax) or true (XML syntax).
static final String	fromField_BBOXDISPLAY	fromField ROUTE name for SFBool field named bboxDisplay.
static final String	fromField_ENABLED	fromField ROUTE name for SFBool field named enabled.
static final String	fromField_IS	fromField ROUTE name for SFNode field named IS.
static final String	fromField_METADATA	fromField ROUTE name for SFNode field named metadata.
static final String	fromField_ROTATION	fromField ROUTE name for SFRotation field named rotation.
static final String	fromField_TRANSLATION	fromField ROUTE name for SFVec3f field named translation.
static final String	fromField_VISIBLE	fromField ROUTE name for SFBool field named visible.
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: 1
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: CollidableShape.
static final float[]	ROTATION_DEFAULT_VALUE	SFRotation field named rotation has default value {0f,0f,1f,0f} (Java syntax) or 0 0 1 0 (XML syntax).
static final Shape	SHAPE_DEFAULT_VALUE	SFNode field named shape has default value null (Java syntax) or NULL (XML syntax).
static final String	toField_BBOXDISPLAY	toField ROUTE name for SFBool field named bboxDisplay.
static final String	toField_ENABLED	toField ROUTE name for SFBool field named enabled.
static final String	toField_METADATA	toField ROUTE name for SFNode field named metadata.
static final String	toField_ROTATION	toField ROUTE name for SFRotation field named rotation.
static final String	toField_TRANSLATION	toField ROUTE name for SFVec3f field named translation.
static final String	toField_VISIBLE	toField ROUTE name for SFBool field named visible.
static final float[]	TRANSLATION_DEFAULT_VALUE	SFVec3f field named translation has default value {0f,0f,0f} (Java syntax) or 0 0 0 (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
CollidableShape()	Constructor for CollidableShape to initialize member variables with default values.
CollidableShape(String DEFlabel)	Utility constructor that assigns DEF label after initializing member variables with default values.

Method Summary

Modifier and Type	Method	Description
CollidableShape	addComments(String newComment)	Add comment as String to contained commentsList.
CollidableShape	addComments(String[] newComments)	Add comments as String[] array to contained commentsList.
CollidableShape	addComments(CommentsBlock newCommentsBlock)	Add CommentsBlock to contained commentsList.
CollidableShape	clearIS()	Utility method to clear SFNode value of IS field.
CollidableShape	clearMetadata()	Utility method to clear SFNode value of metadata field.
CollidableShape	clearShape()	Utility method to clear SFNode value of shape 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[]	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.
final String	getComponent()	Defines X3D component for the CollidableShape element: RigidBodyPhysics
final int	getComponentLevel()	Provides default X3D component level for this element: 1
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.
final String	getElementName()	Provides name of this element: CollidableShape
boolean	getEnabled()	Provide boolean value from inputOutput SFBool field named enabled.
String	getFieldType(String fieldName)	Indicate type corresponding to given fieldName.
String	getHtmlID()	Provide String value from inputOutput SFString field named id.
IS	getIS()	Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.
X3DMetadataObject	getMetadata()	Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
float[]	getRotation()	Provide array of 4-tuple float results unit axis, angle (in radians) from inputOutput SFRotation field named rotation.
Shape	getShape()	Provide org.web3d.x3d.sai.Shape.Shape instance (using a properly typed node) from initializeOnly SFNode field shape.
float[]	getTranslation()	Provide array of 3-tuple float results from inputOutput SFVec3f field named translation.
String	getUSE()	Provide String value from inputOutput SFString field named USE.
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	hasIS()	Indicate whether an object is available for inputOutput SFNode field IS.
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.
boolean	hasShape()	Indicate whether an object is available for initializeOnly SFNode field shape.
final void	initialize()	Initialize all member variables to default values.
CollidableShape	setBboxCenter(double[] newArray)	Utility method: double-precision set-array accessor for X3D floating-point type, similar to setBboxCenter(float[]).
CollidableShape	setBboxCenter(double x, double y, double z)	Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setBboxCenter(float[]).
CollidableShape	setBboxCenter(float[] newValue)	Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxCenter.
CollidableShape	setBboxCenter(float x, float y, float z)	Assign values to SFVec3f bboxCenter field, similar to setBboxCenter(float[]).
CollidableShape	setBboxCenter(SFVec3f newValue)	Assign typed object value to SFVec3f bboxCenter field, similar to setBboxCenter(float[]).
CollidableShape	setBboxDisplay(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named bboxDisplay.
CollidableShape	setBboxDisplay(SFBool newValue)	Assign typed object value to SFBool bboxDisplay field, similar to setBboxDisplay(boolean).
CollidableShape	setBboxSize(double[] newArray)	Utility method: double-precision set-array accessor for X3D floating-point type, similar to setBboxSize(float[]).
CollidableShape	setBboxSize(double x, double y, double z)	Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setBboxSize(float[]).
CollidableShape	setBboxSize(float[] newValue)	Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxSize.
CollidableShape	setBboxSize(float x, float y, float z)	Assign values to SFVec3f bboxSize field, similar to setBboxSize(float[]).
CollidableShape	setBboxSize(SFVec3f newValue)	Assign typed object value to SFVec3f bboxSize field, similar to setBboxSize(float[]).
final CollidableShape	setCssClass(String newValue)	Accessor method to assign String value to inputOutput SFString field named class.
CollidableShape	setCssClass(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssClass(String).
final CollidableShape	setCssStyle(String newValue)	Accessor method to assign String value to inputOutput SFString field named style.
CollidableShape	setCssStyle(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssStyle(String).
final CollidableShape	setDEF(String newValue)	Accessor method to assign String value to inputOutput SFString field named DEF.
CollidableShape	setDEF(SFString newValue)	Assign typed object value to SFString DEF field, similar to setDEF(String).
CollidableShape	setEnabled(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named enabled.
CollidableShape	setEnabled(SFBool newValue)	Assign typed object value to SFBool enabled field, similar to setEnabled(boolean).
final CollidableShape	setHtmlID(String newValue)	Accessor method to assign String value to inputOutput SFString field named id.
CollidableShape	setHtmlID(SFString newValue)	Assign typed object value to SFString HtmlID field, similar to setHtmlID(String).
CollidableShape	setIS(IS newValue)	Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
CollidableShape	setMetadata(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
CollidableShape	setMetadata(X3DMetadataObject newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
CollidableShape	setRotation(double[] newArray)	Utility method: double-precision set-array accessor for X3D floating-point type, similar to setRotation(float[]).
CollidableShape	setRotation(double x, double y, double z, double angleRadians)	Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setRotation(float[]).
CollidableShape	setRotation(float[] newValue)	Accessor method to assign 4-tuple float array unit axis, angle (in radians) to inputOutput SFRotation field named rotation.
CollidableShape	setRotation(float x, float y, float z, float angleRadians)	Assign values to SFRotation rotation field, similar to setRotation(float[]).
CollidableShape	setRotation(SFRotation newValue)	Assign typed object value to SFRotation rotation field, similar to setRotation(float[]).
CollidableShape	setShape(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to initializeOnly SFNode field shape.
CollidableShape	setShape(Shape newValue)	Accessor method to assign org.web3d.x3d.sai.Shape.Shape instance (using a properly typed node) to initializeOnly SFNode field shape.
CollidableShape	setTranslation(double[] newArray)	Utility method: double-precision set-array accessor for X3D floating-point type, similar to setTranslation(float[]).
CollidableShape	setTranslation(double x, double y, double z)	Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setTranslation(float[]).
CollidableShape	setTranslation(float[] newValue)	Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named translation.
CollidableShape	setTranslation(float x, float y, float z)	Assign values to SFVec3f translation field, similar to setTranslation(float[]).
CollidableShape	setTranslation(SFVec3f newValue)	Assign typed object value to SFVec3f translation field, similar to setTranslation(float[]).
final CollidableShape	setUSE(String newValue)	Accessor method to assign String value to inputOutput SFString field named USE.
CollidableShape	setUSE(SFString newValue)	Assign typed object value to SFString USE field, similar to setUSE(String).
CollidableShape	setUSE(CollidableShape DEFnode)	Assign a USE reference to another DEF node of same node type, similar to setUSE(String).
CollidableShape	setVisible(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named visible.
CollidableShape	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: CollidableShape.

See Also:

• Constant Field Values

COMPONENT

public static final String COMPONENT

String constant COMPONENT defines X3D component for the CollidableShape 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: 1

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).

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

IS_DEFAULT_VALUE

public static final IS IS_DEFAULT_VALUE

SFNode field named IS 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).

ROTATION_DEFAULT_VALUE

public static final float[] ROTATION_DEFAULT_VALUE

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

SHAPE_DEFAULT_VALUE

public static final Shape SHAPE_DEFAULT_VALUE

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

TRANSLATION_DEFAULT_VALUE

public static final float[] TRANSLATION_DEFAULT_VALUE

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

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 = "children";
containerField_ALLOWED_VALUES = {"children" }; 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_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_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_IS

public static final String fromField_IS

fromField ROUTE name for SFNode field named IS.

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_ROTATION

public static final String fromField_ROTATION

fromField ROUTE name for SFRotation field named rotation.

See Also:

• Constant Field Values

toField_ROTATION

public static final String toField_ROTATION

toField ROUTE name for SFRotation field named rotation.

See Also:

• Constant Field Values

fromField_TRANSLATION

public static final String fromField_TRANSLATION

fromField ROUTE name for SFVec3f field named translation.

See Also:

• Constant Field Values

toField_TRANSLATION

public static final String toField_TRANSLATION

toField ROUTE name for SFVec3f field named translation.

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

CollidableShape

public CollidableShape()

Constructor for CollidableShape to initialize member variables with default values.

CollidableShape

public CollidableShape(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: CollidableShape

Specified by:

getElementName in class X3DConcreteElement

Returns:

name of this element

getComponent

public final String getComponent()

Defines X3D component for the CollidableShape 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: 1

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

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 CollidableShape

Specified by:

getBboxCenter in interface X3DBoundedObject

Specified by:

getBboxCenter in interface X3DNBodyCollidableNode

Returns:

value of bboxCenter field

setBboxCenter

public CollidableShape 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 CollidableShape

Specified by:

setBboxCenter in interface X3DBoundedObject

Specified by:

setBboxCenter in interface X3DNBodyCollidableNode

Parameters:

newValue - is new value for the bboxCenter field.

Returns:

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

setBboxCenter

public CollidableShape 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:

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

setBboxCenter

public CollidableShape 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:

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

setBboxCenter

public CollidableShape 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:

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

setBboxCenter

public CollidableShape 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:

CollidableShape - 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 CollidableShape

Specified by:

getBboxDisplay in interface X3DBoundedObject

Specified by:

getBboxDisplay in interface X3DNBodyCollidableNode

Returns:

value of bboxDisplay field

setBboxDisplay

public CollidableShape 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 CollidableShape

Specified by:

setBboxDisplay in interface X3DBoundedObject

Specified by:

setBboxDisplay in interface X3DNBodyCollidableNode

Parameters:

newValue - is new value for the bboxDisplay field.

Returns:

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

setBboxDisplay

public CollidableShape 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:

CollidableShape - 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 CollidableShape

Specified by:

getBboxSize in interface X3DBoundedObject

Specified by:

getBboxSize in interface X3DNBodyCollidableNode

Returns:

value of bboxSize field

setBboxSize

public CollidableShape 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 CollidableShape

Specified by:

setBboxSize in interface X3DBoundedObject

Specified by:

setBboxSize in interface X3DNBodyCollidableNode

Parameters:

newValue - is new value for the bboxSize field.

Returns:

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

setBboxSize

public CollidableShape 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:

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

setBboxSize

public CollidableShape 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:

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

setBboxSize

public CollidableShape 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:

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

setBboxSize

public CollidableShape 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:

CollidableShape - 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 CollidableShape

Specified by:

getEnabled in interface X3DNBodyCollidableNode

Returns:

value of enabled field

setEnabled

public CollidableShape 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 CollidableShape

Specified by:

setEnabled in interface X3DNBodyCollidableNode

Parameters:

newValue - is new value for the enabled field.

Returns:

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

setEnabled

public CollidableShape 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:

CollidableShape - 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 CollidableShape 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:

CollidableShape - 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 CollidableShape clearIS()

Utility method to clear SFNode value of IS field.

Returns:

CollidableShape - 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()

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 CollidableShape

Specified by:

getMetadata in interface X3DChildNode

Specified by:

getMetadata in interface X3DNBodyCollidableNode

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 CollidableShape 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 CollidableShape

Specified by:

setMetadata in interface X3DChildNode

Specified by:

setMetadata in interface X3DNBodyCollidableNode

Specified by:

setMetadata in interface X3DNode

Specified by:

setMetadata in class X3DConcreteNode

Parameters:

newValue - is new value for the metadata field.

Returns:

CollidableShape - 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 CollidableShape clearMetadata()

Utility method to clear SFNode value of metadata field.

Returns:

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

setMetadata

public CollidableShape 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:

CollidableShape - 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

getRotation

public float[] getRotation()

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

Tooltip: Orientation (axis, angle in radians) of children relative to local coordinate system.

• Hint: The order of operation is first apply the center offset, then scaleOrientation and scale, then rotation, then restore the center offset, then translation.

Specified by:

getRotation in interface CollidableShape

Specified by:

getRotation in interface X3DNBodyCollidableNode

Returns:

value of rotation field

setRotation

public CollidableShape setRotation(float[] newValue)

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

Tooltip: Orientation (axis, angle in radians) of children relative to local coordinate system.

• Hint: The order of operation is first apply the center offset, then scaleOrientation and scale, then rotation, then restore the center offset, then translation.

Specified by:

setRotation in interface CollidableShape

Specified by:

setRotation in interface X3DNBodyCollidableNode

Parameters:

newValue - is new value for the rotation field.

Returns:

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

setRotation

public CollidableShape setRotation(SFRotation newValue)

Assign typed object value to SFRotation rotation field, similar to setRotation(float[]).

Parameters:

newValue - is new value for the rotation field.

Returns:

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

setRotation

public CollidableShape setRotation(float x,
 float y,
 float z,
 float angleRadians)

Assign values to SFRotation rotation field, similar to setRotation(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:

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

setRotation

public CollidableShape setRotation(double x,
 double y,
 double z,
 double angleRadians)

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

Parameters:

x - first component

y - second component

z - third component

angleRadians - fourth component

Returns:

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

setRotation

public CollidableShape setRotation(double[] newArray)

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

Parameters:

newArray - is new value for field

Returns:

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

getShape

public Shape getShape()

Provide org.web3d.x3d.sai.Shape.Shape instance (using a properly typed node) from initializeOnly SFNode field shape.

Specified by:

getShape in interface CollidableShape

Returns:

value of shape field

See Also:

• 
  
  Tooltip: [Shape] The shape field provides a geometry proxy for specifying which geometry best represents the collidable object. *
  

setShape

public CollidableShape setShape(Shape newValue)

Accessor method to assign org.web3d.x3d.sai.Shape.Shape instance (using a properly typed node) to initializeOnly SFNode field shape.

Specified by:

setShape in interface CollidableShape

Parameters:

newValue - is new value for the shape field.

Returns:

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

See Also:

• 
  
  Tooltip: [Shape] The shape field provides a geometry proxy for specifying which geometry best represents the collidable object. *
  

clearShape

public CollidableShape clearShape()

Utility method to clear SFNode value of shape field.

Returns:

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

setShape

public CollidableShape setShape(ProtoInstance newValue)

Assign ProtoInstance (using a properly typed node) to initializeOnly SFNode field shape.

Parameters:

newValue - is new value for the shape field.

Returns:

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

See Also:

• setShape(org.web3d.x3d.sai.Shape.Shape)

hasShape

public boolean hasShape()

Indicate whether an object is available for initializeOnly SFNode field shape.

Returns:

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

See Also:

• getShape()
• getShapeProtoInstance()

getTranslation

public float[] getTranslation()

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

Tooltip: Position (x, y, z in meters) of children relative to local coordinate system.

• Hint: The order of operation is first apply the center offset, then scaleOrientation and scale, then rotation, then restore the center offset, then translation.

Specified by:

getTranslation in interface CollidableShape

Specified by:

getTranslation in interface X3DNBodyCollidableNode

Returns:

value of translation field

setTranslation

public CollidableShape setTranslation(float[] newValue)

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

Tooltip: Position (x, y, z in meters) of children relative to local coordinate system.

• Hint: The order of operation is first apply the center offset, then scaleOrientation and scale, then rotation, then restore the center offset, then translation.

Specified by:

setTranslation in interface CollidableShape

Specified by:

setTranslation in interface X3DNBodyCollidableNode

Parameters:

newValue - is new value for the translation field.

Returns:

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

setTranslation

public CollidableShape setTranslation(SFVec3f newValue)

Assign typed object value to SFVec3f translation field, similar to setTranslation(float[]).

Parameters:

newValue - is new value for the translation field.

Returns:

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

setTranslation

public CollidableShape setTranslation(float x,
 float y,
 float z)

Assign values to SFVec3f translation field, similar to setTranslation(float[]).

Parameters:

x - first component

y - second component

z - third component

Returns:

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

setTranslation

public CollidableShape setTranslation(double x,
 double y,
 double z)

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

Parameters:

x - first component

y - second component

z - third component

Returns:

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

setTranslation

public CollidableShape setTranslation(double[] newArray)

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

Parameters:

newArray - is new value for field

Returns:

CollidableShape - 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 CollidableShape

Specified by:

getVisible in interface X3DBoundedObject

Specified by:

getVisible in interface X3DNBodyCollidableNode

Returns:

value of visible field

setVisible

public CollidableShape 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 CollidableShape

Specified by:

setVisible in interface X3DBoundedObject

Specified by:

setVisible in interface X3DNBodyCollidableNode

Parameters:

newValue - is new value for the visible field.

Returns:

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

setVisible

public CollidableShape 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:

CollidableShape - 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 CollidableShape 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:

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

setDEF

public CollidableShape 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:

CollidableShape - 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 CollidableShape 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:

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

setUSE

public CollidableShape 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:

CollidableShape - 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 CollidableShape 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:

CollidableShape - 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 CollidableShape 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:

CollidableShape - 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 CollidableShape 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:

CollidableShape - 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 CollidableShape 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:

CollidableShape - 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 CollidableShape 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:

CollidableShape - 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 CollidableShape 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:

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

setUSE

public CollidableShape setUSE(CollidableShape 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:

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

addComments

public CollidableShape addComments(String newComment)

Add comment as String to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComment - initial value

Returns:

CollidableShape - 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 CollidableShape addComments(String[] newComments)

Add comments as String[] array to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComments - array of comments

Returns:

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

addComments

public CollidableShape addComments(CommentsBlock newCommentsBlock)

Add CommentsBlock to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newCommentsBlock - block of comments to add

Returns:

CollidableShape - 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)