Package org.web3d.x3d.jsail.VolumeRendering

Class IsoSurfaceVolumeData

java.lang.Object

org.web3d.x3d.jsail.X3DConcreteElement

org.web3d.x3d.jsail.X3DConcreteNode

org.web3d.x3d.jsail.VolumeRendering.IsoSurfaceVolumeData

All Implemented Interfaces:

X3DChildNode, X3DNode, X3DBoundedObject, IsoSurfaceVolumeData, X3DVolumeDataNode

public class IsoSurfaceVolumeData
extends X3DConcreteNode
implements IsoSurfaceVolumeData

IsoSurfaceVolumeData displays one or more surfaces extracted from a voxel dataset.

X3D node tooltip: (X3D version 3.3 or later) [X3DVolumeDataNode] IsoSurfaceVolumeData displays one or more surfaces extracted from a voxel dataset. A surface is defined as the boundary between regions in the volume where the voxel values are larger than a given value (the iso value) on one side of the boundary and smaller on the other side, and the gradient magnitude is larger than surfaceTolerance.

• Hint: IsoSurfaceVolumeData can contain a single Texture3D node with containerField='gradients' that is used to provide explicit per-voxel gradient direction information for determining surface boundaries, rather than having values implicitly calculated by the implementation.
• Hint: IsoSurfaceVolumeData can contain another Texture3D node with containerField='voxels' containing voxel data.
• Hint: IsoSurfaceVolumeData can contain multiple VolumeStyle nodes.
• Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
• Warning: requires X3D profile='Full' or else include <component name='VolumeRendering' level='2'/>

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

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 IsoSurfaceVolumeData element: VolumeRendering
static final String	containerField_DEFAULT_VALUE	containerField describes typical field relationship of a node to its parent.
static final float	CONTOURSTEPSIZE_DEFAULT_VALUE	SFFloat field named contourStepSize has default value 0f (Java syntax) or 0 (XML syntax).
static final float[]	DIMENSIONS_DEFAULT_VALUE	SFVec3f field named dimensions has default value {1f,1f,1f} (Java syntax) or 1 1 1 (XML syntax).
static final String	fromField_BBOXDISPLAY	fromField ROUTE name for SFBool field named bboxDisplay.
static final String	fromField_CONTOURSTEPSIZE	fromField ROUTE name for SFFloat field named contourStepSize.
static final String	fromField_DIMENSIONS	fromField ROUTE name for SFVec3f field named dimensions.
static final String	fromField_GRADIENTS	fromField ROUTE name for SFNode field named gradients.
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_RENDERSTYLE	fromField ROUTE name for MFNode field named renderStyle.
static final String	fromField_SURFACETOLERANCE	fromField ROUTE name for SFFloat field named surfaceTolerance.
static final String	fromField_SURFACEVALUES	fromField ROUTE name for MFFloat field named surfaceValues.
static final String	fromField_VISIBLE	fromField ROUTE name for SFBool field named visible.
static final String	fromField_VOXELS	fromField ROUTE name for SFNode field named voxels.
static final X3DTexture3DNode	GRADIENTS_DEFAULT_VALUE	SFNode field named gradients has default value null (Java syntax) or NULL (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 VolumeRendering component level for this element: 2
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: IsoSurfaceVolumeData.
static final float	SURFACETOLERANCE_DEFAULT_VALUE	SFFloat field named surfaceTolerance has default value 0f (Java syntax) or 0 (XML syntax).
static final ArrayList<Float>	SURFACEVALUES_DEFAULT_VALUE	MFFloat field named surfaceValues has default value equal to an empty list.
static final String	toField_BBOXDISPLAY	toField ROUTE name for SFBool field named bboxDisplay.
static final String	toField_CONTOURSTEPSIZE	toField ROUTE name for SFFloat field named contourStepSize.
static final String	toField_DIMENSIONS	toField ROUTE name for SFVec3f field named dimensions.
static final String	toField_GRADIENTS	toField ROUTE name for SFNode field named gradients.
static final String	toField_METADATA	toField ROUTE name for SFNode field named metadata.
static final String	toField_RENDERSTYLE	toField ROUTE name for MFNode field named renderStyle.
static final String	toField_SURFACETOLERANCE	toField ROUTE name for SFFloat field named surfaceTolerance.
static final String	toField_SURFACEVALUES	toField ROUTE name for MFFloat field named surfaceValues.
static final String	toField_VISIBLE	toField ROUTE name for SFBool field named visible.
static final String	toField_VOXELS	toField ROUTE name for SFNode field named voxels.
static final boolean	VISIBLE_DEFAULT_VALUE	SFBool field named visible has default value true (Java syntax) or true (XML syntax).
static final X3DTexture3DNode	VOXELS_DEFAULT_VALUE	SFNode field named voxels has default value null (Java syntax) or NULL (XML syntax).

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

containerField_ALTERNATE_VALUES, 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
IsoSurfaceVolumeData()	Constructor for IsoSurfaceVolumeData to initialize member variables with default values.
IsoSurfaceVolumeData(String DEFlabel)	Utility constructor that assigns DEF label after initializing member variables with default values.

Method Summary

Modifier and Type	Method	Description
IsoSurfaceVolumeData	addComments(String newComment)	Add comment as String to contained commentsList.
IsoSurfaceVolumeData	addComments(String[] newComments)	Add comments as String[] array to contained commentsList.
IsoSurfaceVolumeData	addComments(CommentsBlock newCommentsBlock)	Add CommentsBlock to contained commentsList.
IsoSurfaceVolumeData	addRenderStyle(ProtoInstance newValue)	Add single ProtoInstance (with appropriate node type and containerField value) to MFNode array for renderStyle field.
IsoSurfaceVolumeData	addRenderStyle(X3DNode newValue)	Add single child node to existing array of renderStyle nodes (if any).
void	addRenderStyle(X3DNode[] newValue)	Add array of child renderStyle nodes to array of existing nodes (if any).
IsoSurfaceVolumeData	addSurfaceValues(float newValue)	Add singleton float value to MFFloat surfaceValues field.
IsoSurfaceVolumeData	addSurfaceValues(SFFloat newValue)	Add singleton SFFloat value to MFFloat surfaceValues field.
IsoSurfaceVolumeData	clearGradients()	Utility method to clear SFNode value of gradients field.
IsoSurfaceVolumeData	clearIS()	Utility method to clear SFNode value of IS field.
IsoSurfaceVolumeData	clearMetadata()	Utility method to clear SFNode value of metadata field.
IsoSurfaceVolumeData	clearRenderStyle()	Utility method to clear MFNode value of renderStyle field.
IsoSurfaceVolumeData	clearSurfaceValues()	Utility method to clear MFFloat value of surfaceValues field.
IsoSurfaceVolumeData	clearVoxels()	Utility method to clear SFNode value of voxels 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 IsoSurfaceVolumeData element: VolumeRendering
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.
float	getContourStepSize()	Provide float value from inputOutput SFFloat field named contourStepSize.
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[]	getDimensions()	Provide array of 3-tuple float results within allowed range of (0,infinity) from inputOutput SFVec3f field named dimensions.
final String	getElementName()	Provides name of this element: IsoSurfaceVolumeData
String	getFieldType(String fieldName)	Indicate type corresponding to given fieldName.
X3DTexture3DNode	getGradients()	Provide org.web3d.x3d.sai.Texturing3D.X3DTexture3DNode instance (using a properly typed node) from inputOutput SFNode field gradients.
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.
X3DNode[]	getRenderStyle()	Provide array of org.web3d.x3d.sai.VolumeRendering.X3DVolumeRenderStyleNode results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field renderStyle.
ArrayList<X3DNode>	getRenderStyleList()	Utility method to get ArrayList value of MFNode renderStyle field, similar to getRenderStyle().
float	getSurfaceTolerance()	Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named surfaceTolerance.
float[]	getSurfaceValues()	Provide array of Float results from inputOutput MFFloat field named surfaceValues.
ArrayList<Float>	getSurfaceValuesList()	Utility method to get ArrayList value of MFFloat surfaceValues field, similar to getSurfaceValues().
String	getSurfaceValuesString()	Utility method to get String value of MFFloat surfaceValues field, similar to getSurfaceValues().
String	getUSE()	Provide String value from inputOutput SFString field named USE.
boolean	getVisible()	Provide boolean value from inputOutput SFBool field named visible.
X3DTexture3DNode	getVoxels()	Provide org.web3d.x3d.sai.Texturing3D.X3DTexture3DNode instance (using a properly typed node) from inputOutput SFNode field voxels.
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	hasGradients()	Indicate whether an object is available for inputOutput SFNode field gradients.
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	hasRenderStyle()	Indicate whether an object is available for inputOutput MFNode field renderStyle.
boolean	hasVoxels()	Indicate whether an object is available for inputOutput SFNode field voxels.
final void	initialize()	Initialize all member variables to default values.
IsoSurfaceVolumeData	setBboxCenter(double[] newArray)	Utility method: double-precision set-array accessor for X3D floating-point type, similar to setBboxCenter(float[]).
IsoSurfaceVolumeData	setBboxCenter(double x, double y, double z)	Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setBboxCenter(float[]).
IsoSurfaceVolumeData	setBboxCenter(float[] newValue)	Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxCenter.
IsoSurfaceVolumeData	setBboxCenter(float x, float y, float z)	Assign values to SFVec3f bboxCenter field, similar to setBboxCenter(float[]).
IsoSurfaceVolumeData	setBboxCenter(SFVec3f newValue)	Assign typed object value to SFVec3f bboxCenter field, similar to setBboxCenter(float[]).
IsoSurfaceVolumeData	setBboxDisplay(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named bboxDisplay.
IsoSurfaceVolumeData	setBboxDisplay(SFBool newValue)	Assign typed object value to SFBool bboxDisplay field, similar to setBboxDisplay(boolean).
IsoSurfaceVolumeData	setBboxSize(double[] newArray)	Utility method: double-precision set-array accessor for X3D floating-point type, similar to setBboxSize(float[]).
IsoSurfaceVolumeData	setBboxSize(double x, double y, double z)	Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setBboxSize(float[]).
IsoSurfaceVolumeData	setBboxSize(float[] newValue)	Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxSize.
IsoSurfaceVolumeData	setBboxSize(float x, float y, float z)	Assign values to SFVec3f bboxSize field, similar to setBboxSize(float[]).
IsoSurfaceVolumeData	setBboxSize(SFVec3f newValue)	Assign typed object value to SFVec3f bboxSize field, similar to setBboxSize(float[]).
IsoSurfaceVolumeData	setContourStepSize(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setContourStepSize(float).
IsoSurfaceVolumeData	setContourStepSize(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named contourStepSize.
IsoSurfaceVolumeData	setContourStepSize(SFFloat newValue)	Assign typed object value to SFFloat contourStepSize field, similar to setContourStepSize(float).
final IsoSurfaceVolumeData	setCssClass(String newValue)	Accessor method to assign String value to inputOutput SFString field named class.
IsoSurfaceVolumeData	setCssClass(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssClass(String).
final IsoSurfaceVolumeData	setCssStyle(String newValue)	Accessor method to assign String value to inputOutput SFString field named style.
IsoSurfaceVolumeData	setCssStyle(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssStyle(String).
final IsoSurfaceVolumeData	setDEF(String newValue)	Accessor method to assign String value to inputOutput SFString field named DEF.
IsoSurfaceVolumeData	setDEF(SFString newValue)	Assign typed object value to SFString DEF field, similar to setDEF(String).
IsoSurfaceVolumeData	setDimensions(double[] newArray)	Utility method: double-precision set-array accessor for X3D floating-point type, similar to setDimensions(float[]).
IsoSurfaceVolumeData	setDimensions(double x, double y, double z)	Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setDimensions(float[]).
IsoSurfaceVolumeData	setDimensions(float[] newValue)	Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named dimensions.
IsoSurfaceVolumeData	setDimensions(float x, float y, float z)	Assign values to SFVec3f dimensions field, similar to setDimensions(float[]).
IsoSurfaceVolumeData	setDimensions(SFVec3f newValue)	Assign typed object value to SFVec3f dimensions field, similar to setDimensions(float[]).
IsoSurfaceVolumeData	setGradients(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field gradients.
IsoSurfaceVolumeData	setGradients(X3DTexture3DNode newValue)	Accessor method to assign org.web3d.x3d.sai.Texturing3D.X3DTexture3DNode instance (using a properly typed node) to inputOutput SFNode field gradients.
final IsoSurfaceVolumeData	setHtmlID(String newValue)	Accessor method to assign String value to inputOutput SFString field named id.
IsoSurfaceVolumeData	setHtmlID(SFString newValue)	Assign typed object value to SFString HtmlID field, similar to setHtmlID(String).
IsoSurfaceVolumeData	setIS(IS newValue)	Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
IsoSurfaceVolumeData	setMetadata(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
IsoSurfaceVolumeData	setMetadata(X3DMetadataObject newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
IsoSurfaceVolumeData	setRenderStyle(ArrayList<X3DVolumeRenderStyleNode> newValue)	Assign ArrayList value of MFNode renderStyle field, similar to setRenderStyle(org.web3d.x3d.sai.Core.X3DNode[]).
void	setRenderStyle(X3DNode newValue)	Set single child renderStyle node, replacing prior array of existing nodes (if any).
IsoSurfaceVolumeData	setRenderStyle(X3DNode[] newValue)	Accessor method to assign org.web3d.x3d.sai.VolumeRendering.X3DVolumeRenderStyleNode array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field renderStyle.
IsoSurfaceVolumeData	setSurfaceTolerance(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setSurfaceTolerance(float).
IsoSurfaceVolumeData	setSurfaceTolerance(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named surfaceTolerance.
IsoSurfaceVolumeData	setSurfaceTolerance(SFFloat newValue)	Assign typed object value to SFFloat surfaceTolerance field, similar to setSurfaceTolerance(float).
IsoSurfaceVolumeData	setSurfaceValues(double[] newArray)	Utility method: double-precision set-array accessor for X3D floating-point type, similar to setSurfaceValues(float[]).
IsoSurfaceVolumeData	setSurfaceValues(float[] newValue)	Accessor method to assign Float array to inputOutput MFFloat field named surfaceValues.
IsoSurfaceVolumeData	setSurfaceValues(int[] newValue)	Assign floating-point array value of MFFloat surfaceValues field, similar to setSurfaceValues(float[]).
IsoSurfaceVolumeData	setSurfaceValues(ArrayList<Float> newValue)	Assign ArrayList value of MFFloat surfaceValues field, similar to setSurfaceValues(float[]).
IsoSurfaceVolumeData	setSurfaceValues(MFFloat newValue)	Assign typed object value to MFFloat surfaceValues field, similar to setSurfaceValues(float[]).
final IsoSurfaceVolumeData	setUSE(String newValue)	Accessor method to assign String value to inputOutput SFString field named USE.
IsoSurfaceVolumeData	setUSE(SFString newValue)	Assign typed object value to SFString USE field, similar to setUSE(String).
IsoSurfaceVolumeData	setUSE(IsoSurfaceVolumeData DEFnode)	Assign a USE reference to another DEF node of same node type, similar to setUSE(String).
IsoSurfaceVolumeData	setVisible(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named visible.
IsoSurfaceVolumeData	setVisible(SFBool newValue)	Assign typed object value to SFBool visible field, similar to setVisible(boolean).
IsoSurfaceVolumeData	setVoxels(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field voxels.
IsoSurfaceVolumeData	setVoxels(X3DTexture3DNode newValue)	Accessor method to assign org.web3d.x3d.sai.Texturing3D.X3DTexture3DNode instance (using a properly typed node) to inputOutput SFNode field voxels.
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

getContainerFieldAlternateValues, 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: IsoSurfaceVolumeData.

See Also:

• Constant Field Values

COMPONENT

public static final String COMPONENT

String constant COMPONENT defines X3D component for the IsoSurfaceVolumeData element: VolumeRendering

See Also:

• Constant Field Values

LEVEL

public static final int LEVEL

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

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

CONTOURSTEPSIZE_DEFAULT_VALUE

public static final float CONTOURSTEPSIZE_DEFAULT_VALUE

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

See Also:

• Constant Field Values

DIMENSIONS_DEFAULT_VALUE

public static final float[] DIMENSIONS_DEFAULT_VALUE

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

GRADIENTS_DEFAULT_VALUE

public static final X3DTexture3DNode GRADIENTS_DEFAULT_VALUE

SFNode field named gradients has default value null (Java syntax) or NULL (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).

METADATA_DEFAULT_VALUE

public static final X3DMetadataObject METADATA_DEFAULT_VALUE

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

SURFACETOLERANCE_DEFAULT_VALUE

public static final float SURFACETOLERANCE_DEFAULT_VALUE

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

See Also:

• Constant Field Values

SURFACEVALUES_DEFAULT_VALUE

public static final ArrayList<Float> SURFACEVALUES_DEFAULT_VALUE

MFFloat field named surfaceValues has default value equal to an empty list.

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

VOXELS_DEFAULT_VALUE

public static final X3DTexture3DNode VOXELS_DEFAULT_VALUE

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

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, default value is provided for informational purposes.

See Also:

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

public static final String fromField_CONTOURSTEPSIZE

fromField ROUTE name for SFFloat field named contourStepSize.

See Also:

• Constant Field Values

toField_CONTOURSTEPSIZE

public static final String toField_CONTOURSTEPSIZE

toField ROUTE name for SFFloat field named contourStepSize.

See Also:

• Constant Field Values

fromField_DIMENSIONS

public static final String fromField_DIMENSIONS

fromField ROUTE name for SFVec3f field named dimensions.

See Also:

• Constant Field Values

toField_DIMENSIONS

public static final String toField_DIMENSIONS

toField ROUTE name for SFVec3f field named dimensions.

See Also:

• Constant Field Values

fromField_GRADIENTS

public static final String fromField_GRADIENTS

fromField ROUTE name for SFNode field named gradients.

See Also:

• Constant Field Values

toField_GRADIENTS

public static final String toField_GRADIENTS

toField ROUTE name for SFNode field named gradients.

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_RENDERSTYLE

public static final String fromField_RENDERSTYLE

fromField ROUTE name for MFNode field named renderStyle.

See Also:

• Constant Field Values

toField_RENDERSTYLE

public static final String toField_RENDERSTYLE

toField ROUTE name for MFNode field named renderStyle.

See Also:

• Constant Field Values

fromField_SURFACETOLERANCE

public static final String fromField_SURFACETOLERANCE

fromField ROUTE name for SFFloat field named surfaceTolerance.

See Also:

• Constant Field Values

toField_SURFACETOLERANCE

public static final String toField_SURFACETOLERANCE

toField ROUTE name for SFFloat field named surfaceTolerance.

See Also:

• Constant Field Values

fromField_SURFACEVALUES

public static final String fromField_SURFACEVALUES

fromField ROUTE name for MFFloat field named surfaceValues.

See Also:

• Constant Field Values

toField_SURFACEVALUES

public static final String toField_SURFACEVALUES

toField ROUTE name for MFFloat field named surfaceValues.

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

fromField_VOXELS

public static final String fromField_VOXELS

fromField ROUTE name for SFNode field named voxels.

See Also:

• Constant Field Values

toField_VOXELS

public static final String toField_VOXELS

toField ROUTE name for SFNode field named voxels.

See Also:

• Constant Field Values

Constructor Details

IsoSurfaceVolumeData

public IsoSurfaceVolumeData()

Constructor for IsoSurfaceVolumeData to initialize member variables with default values.

IsoSurfaceVolumeData

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

Specified by:

getElementName in class X3DConcreteElement

Returns:

name of this element

getComponent

public final String getComponent()

Defines X3D component for the IsoSurfaceVolumeData element: VolumeRendering

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. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.

Specified by:

getContainerFieldDefault in class X3DConcreteNode

Returns:

default containerField value

See Also:

• X3D Scene Authoring Hints: 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/X3Dv4Draft/ISO-IEC19775-1v4-CD1/Part01/components/grouping.html#BoundingBoxes
• Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-CD1/Part01/components/grouping.html#X3DBoundedObject

Specified by:

getBboxCenter in interface IsoSurfaceVolumeData

Specified by:

getBboxCenter in interface X3DBoundedObject

Specified by:

getBboxCenter in interface X3DVolumeDataNode

Returns:

value of bboxCenter field

setBboxCenter

public IsoSurfaceVolumeData 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/X3Dv4Draft/ISO-IEC19775-1v4-CD1/Part01/components/grouping.html#BoundingBoxes
• Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-CD1/Part01/components/grouping.html#X3DBoundedObject

Specified by:

setBboxCenter in interface IsoSurfaceVolumeData

Specified by:

setBboxCenter in interface X3DBoundedObject

Specified by:

setBboxCenter in interface X3DVolumeDataNode

Parameters:

newValue - is new value for the bboxCenter field.

Returns:

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

setBboxCenter

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

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

setBboxCenter

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

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

setBboxCenter

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

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

setBboxCenter

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

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

Specified by:

getBboxDisplay in interface X3DBoundedObject

Specified by:

getBboxDisplay in interface X3DVolumeDataNode

Returns:

value of bboxDisplay field

setBboxDisplay

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

Specified by:

setBboxDisplay in interface X3DBoundedObject

Specified by:

setBboxDisplay in interface X3DVolumeDataNode

Parameters:

newValue - is new value for the bboxDisplay field.

Returns:

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

setBboxDisplay

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

IsoSurfaceVolumeData - 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/X3Dv4Draft/ISO-IEC19775-1v4-CD1/Part01/components/grouping.html#BoundingBoxes
• Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-CD1/Part01/components/grouping.html#X3DBoundedObject

Specified by:

getBboxSize in interface IsoSurfaceVolumeData

Specified by:

getBboxSize in interface X3DBoundedObject

Specified by:

getBboxSize in interface X3DVolumeDataNode

Returns:

value of bboxSize field

setBboxSize

public IsoSurfaceVolumeData 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/X3Dv4Draft/ISO-IEC19775-1v4-CD1/Part01/components/grouping.html#BoundingBoxes
• Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-CD1/Part01/components/grouping.html#X3DBoundedObject

Specified by:

setBboxSize in interface IsoSurfaceVolumeData

Specified by:

setBboxSize in interface X3DBoundedObject

Specified by:

setBboxSize in interface X3DVolumeDataNode

Parameters:

newValue - is new value for the bboxSize field.

Returns:

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

setBboxSize

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

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

setBboxSize

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

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

setBboxSize

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

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

setBboxSize

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

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

getContourStepSize

public float getContourStepSize()

Provide float value from inputOutput SFFloat field named contourStepSize.

Tooltip: If contourStepSize is non-zero, also render all isosurfaces that are multiples of that step size from initial surface value.

• Hint: contourStepSize can be negative so that steppping can proceed in a negative direction.

Specified by:

getContourStepSize in interface IsoSurfaceVolumeData

Returns:

value of contourStepSize field

setContourStepSize

public IsoSurfaceVolumeData setContourStepSize(float newValue)

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

Tooltip: If contourStepSize is non-zero, also render all isosurfaces that are multiples of that step size from initial surface value.

• Hint: contourStepSize can be negative so that steppping can proceed in a negative direction.

Specified by:

setContourStepSize in interface IsoSurfaceVolumeData

Parameters:

newValue - is new value for the contourStepSize field.

Returns:

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

setContourStepSize

public IsoSurfaceVolumeData setContourStepSize(SFFloat newValue)

Assign typed object value to SFFloat contourStepSize field, similar to setContourStepSize(float).

Parameters:

newValue - is new value for the contourStepSize field.

Returns:

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

setContourStepSize

public IsoSurfaceVolumeData setContourStepSize(double newValue)

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

Parameters:

newValue - is new value for field

Returns:

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

getDimensions

public float[] getDimensions()

Provide array of 3-tuple float results within allowed range of (0,infinity) from inputOutput SFVec3f field named dimensions.

Tooltip: Actual-size X-Y-Z dimensions of volume data in local coordinate system. *

Specified by:

getDimensions in interface IsoSurfaceVolumeData

Specified by:

getDimensions in interface X3DVolumeDataNode

Returns:

value of dimensions field

setDimensions

public IsoSurfaceVolumeData setDimensions(float[] newValue)

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

Tooltip: Actual-size X-Y-Z dimensions of volume data in local coordinate system. *

Specified by:

setDimensions in interface IsoSurfaceVolumeData

Specified by:

setDimensions in interface X3DVolumeDataNode

Parameters:

newValue - is new value for the dimensions field.

Returns:

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

setDimensions

public IsoSurfaceVolumeData setDimensions(SFVec3f newValue)

Assign typed object value to SFVec3f dimensions field, similar to setDimensions(float[]).

Parameters:

newValue - is new value for the dimensions field.

Returns:

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

setDimensions

public IsoSurfaceVolumeData setDimensions(float x,
 float y,
 float z)

Assign values to SFVec3f dimensions field, similar to setDimensions(float[]).

Parameters:

x - first component

y - second component

z - third component

Returns:

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

setDimensions

public IsoSurfaceVolumeData setDimensions(double x,
 double y,
 double z)

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

Parameters:

x - first component

y - second component

z - third component

Returns:

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

setDimensions

public IsoSurfaceVolumeData setDimensions(double[] newArray)

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

Parameters:

newArray - is new value for field

Returns:

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

getGradients

public X3DTexture3DNode getGradients()

Provide org.web3d.x3d.sai.Texturing3D.X3DTexture3DNode instance (using a properly typed node) from inputOutput SFNode field gradients.

Specified by:

getGradients in interface IsoSurfaceVolumeData

Returns:

value of gradients field

See Also:

• 

Tooltip: [X3DTexture3DNode] Single contained X3DTexture3DNode (ComposedTexture3D, ImageTexture3D, PixelTexture3D) that provides explicit per-voxel gradient direction information for determining surface boundaries, rather than having it implicitly calculated by the implementation. *


setGradients

public IsoSurfaceVolumeData setGradients(X3DTexture3DNode newValue)

Accessor method to assign org.web3d.x3d.sai.Texturing3D.X3DTexture3DNode instance (using a properly typed node) to inputOutput SFNode field gradients.

Specified by:

setGradients in interface IsoSurfaceVolumeData

Parameters:

newValue - is new value for the gradients field.

Returns:

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

See Also:

• 

Tooltip: [X3DTexture3DNode] Single contained X3DTexture3DNode (ComposedTexture3D, ImageTexture3D, PixelTexture3D) that provides explicit per-voxel gradient direction information for determining surface boundaries, rather than having it implicitly calculated by the implementation. *


clearGradients

public IsoSurfaceVolumeData clearGradients()

Utility method to clear SFNode value of gradients field.

Returns:

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

setGradients

public IsoSurfaceVolumeData setGradients(ProtoInstance newValue)

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

Parameters:

newValue - is new value for the gradients field.

Returns:

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

See Also:

• setGradients(org.web3d.x3d.sai.Texturing3D.X3DTexture3DNode)

hasGradients

public boolean hasGradients()

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

Returns:

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

See Also:

• getGradients()
• getGradientsProtoInstance()

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

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

Utility method to clear SFNode value of IS field.

Returns:

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

Specified by:

getMetadata in interface X3DChildNode

Specified by:

getMetadata in interface X3DNode

Specified by:

getMetadata in interface X3DVolumeDataNode

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/X3Dv4Draft/ISO-IEC19775-1v4-CD1/Part01/components/core.html#Metadata
• X3D Scene Authoring Hints: Metadata Nodes

setMetadata

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

Specified by:

setMetadata in interface X3DChildNode

Specified by:

setMetadata in interface X3DNode

Specified by:

setMetadata in interface X3DVolumeDataNode

Specified by:

setMetadata in class X3DConcreteNode

Parameters:

newValue - is new value for the metadata field.

Returns:

IsoSurfaceVolumeData - 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/X3Dv4Draft/ISO-IEC19775-1v4-CD1/Part01/components/core.html#Metadata
• X3D Scene Authoring Hints: Metadata Nodes

clearMetadata

public IsoSurfaceVolumeData clearMetadata()

Utility method to clear SFNode value of metadata field.

Returns:

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

setMetadata

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

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

getRenderStyle

public X3DNode[] getRenderStyle()

Provide array of org.web3d.x3d.sai.VolumeRendering.X3DVolumeRenderStyleNode results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field renderStyle.

Tooltip: [X3DVolumeRenderStyleNode] Multiple contained X3DVolumeRenderStyleNode nodes corresponding to each isosurface that define specific rendering technique for this volumetric object.

• Hint: Warning: if not defined, no default renderStryle is defined.

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

Specified by:

getRenderStyle in interface IsoSurfaceVolumeData

Returns:

value of renderStyle field

See Also:

• X3DVolumeRenderStyleNode

getRenderStyleList

public ArrayList<X3DNode> getRenderStyleList()

Utility method to get ArrayList value of MFNode renderStyle field, similar to getRenderStyle().

Returns:

value of renderStyle field

setRenderStyle

public IsoSurfaceVolumeData setRenderStyle(X3DNode[] newValue)

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

Tooltip: [X3DVolumeRenderStyleNode] Multiple contained X3DVolumeRenderStyleNode nodes corresponding to each isosurface that define specific rendering technique for this volumetric object.

• Hint: Warning: if not defined, no default renderStryle is defined.

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

Specified by:

setRenderStyle in interface IsoSurfaceVolumeData

Parameters:

newValue - is new value for the renderStyle field.

Returns:

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

setRenderStyle

public IsoSurfaceVolumeData setRenderStyle(ArrayList<X3DVolumeRenderStyleNode> newValue)

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

Parameters:

newValue - is new value for the renderStyle field.

Returns:

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

addRenderStyle

public IsoSurfaceVolumeData addRenderStyle(X3DNode newValue)

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

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

Parameters:

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

Returns:

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

addRenderStyle

public IsoSurfaceVolumeData addRenderStyle(ProtoInstance newValue)

Add single ProtoInstance (with appropriate node type and containerField value) to MFNode array for renderStyle 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:

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

addRenderStyle

public void addRenderStyle(X3DNode[] newValue)

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

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

Specified by:

addRenderStyle in interface IsoSurfaceVolumeData

Parameters:

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

setRenderStyle

public void setRenderStyle(X3DNode newValue)

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

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

Specified by:

setRenderStyle in interface IsoSurfaceVolumeData

Parameters:

newValue - is new node for the renderStyle field (restricted to X3DVolumeRenderStyleNode)

clearRenderStyle

public IsoSurfaceVolumeData clearRenderStyle()

Utility method to clear MFNode value of renderStyle field.

Returns:

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

hasRenderStyle

public boolean hasRenderStyle()

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

Returns:

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

See Also:

• getRenderStyle()

getSurfaceTolerance

public float getSurfaceTolerance()

Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named surfaceTolerance.

Tooltip: [0,+infinity) Threshold for gradient magnitude for voxel inolusion in isosurface.

• Hint: contained Texture3D node with containerField='gradients' can provide explicit per-voxel gradient direction information for determining surface boundaries.

Specified by:

getSurfaceTolerance in interface IsoSurfaceVolumeData

Returns:

value of surfaceTolerance field

setSurfaceTolerance

public IsoSurfaceVolumeData setSurfaceTolerance(float newValue)

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

Tooltip: [0,+infinity) Threshold for gradient magnitude for voxel inolusion in isosurface.

• Hint: contained Texture3D node with containerField='gradients' can provide explicit per-voxel gradient direction information for determining surface boundaries.

Specified by:

setSurfaceTolerance in interface IsoSurfaceVolumeData

Parameters:

newValue - is new value for the surfaceTolerance field.

Returns:

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

setSurfaceTolerance

public IsoSurfaceVolumeData setSurfaceTolerance(SFFloat newValue)

Assign typed object value to SFFloat surfaceTolerance field, similar to setSurfaceTolerance(float).

Parameters:

newValue - is new value for the surfaceTolerance field.

Returns:

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

setSurfaceTolerance

public IsoSurfaceVolumeData setSurfaceTolerance(double newValue)

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

Parameters:

newValue - is new value for field

Returns:

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

getSurfaceValues

public float[] getSurfaceValues()

Provide array of Float results from inputOutput MFFloat field named surfaceValues.

Tooltip: If surfaceValues has one value defined, render corresponding isosurface plus any isosurfaces based on contourStepSize. If surfaceValues has more than one value defined, ignore contourStepSize and render surfaces corresponding to listed surfaceValues. *

Specified by:

getSurfaceValues in interface IsoSurfaceVolumeData

Returns:

value of surfaceValues field

getSurfaceValuesList

public ArrayList<Float> getSurfaceValuesList()

Utility method to get ArrayList value of MFFloat surfaceValues field, similar to getSurfaceValues().

Returns:

value of surfaceValues field

getSurfaceValuesString

public String getSurfaceValuesString()

Utility method to get String value of MFFloat surfaceValues field, similar to getSurfaceValues().

Returns:

value of surfaceValues field

setSurfaceValues

public IsoSurfaceVolumeData setSurfaceValues(float[] newValue)

Accessor method to assign Float array to inputOutput MFFloat field named surfaceValues.

Tooltip: If surfaceValues has one value defined, render corresponding isosurface plus any isosurfaces based on contourStepSize. If surfaceValues has more than one value defined, ignore contourStepSize and render surfaces corresponding to listed surfaceValues. *

Specified by:

setSurfaceValues in interface IsoSurfaceVolumeData

Parameters:

newValue - is new value for the surfaceValues field.

Returns:

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

setSurfaceValues

public IsoSurfaceVolumeData setSurfaceValues(MFFloat newValue)

Assign typed object value to MFFloat surfaceValues field, similar to setSurfaceValues(float[]).

Parameters:

newValue - is new value for the surfaceValues field.

Returns:

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

setSurfaceValues

public IsoSurfaceVolumeData setSurfaceValues(ArrayList<Float> newValue)

Assign ArrayList value of MFFloat surfaceValues field, similar to setSurfaceValues(float[]).

Parameters:

newValue - is new value for the surfaceValues field.

Returns:

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

clearSurfaceValues

public IsoSurfaceVolumeData clearSurfaceValues()

Utility method to clear MFFloat value of surfaceValues field.

Returns:

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

setSurfaceValues

public IsoSurfaceVolumeData setSurfaceValues(int[] newValue)

Assign floating-point array value of MFFloat surfaceValues field, similar to setSurfaceValues(float[]).

Parameters:

newValue - is new value for the surfaceValues field.

Returns:

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

addSurfaceValues

public IsoSurfaceVolumeData addSurfaceValues(float newValue)

Add singleton float value to MFFloat surfaceValues field.

Parameters:

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

Returns:

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

addSurfaceValues

public IsoSurfaceVolumeData addSurfaceValues(SFFloat newValue)

Add singleton SFFloat value to MFFloat surfaceValues field.

Parameters:

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

Returns:

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

setSurfaceValues

public IsoSurfaceVolumeData setSurfaceValues(double[] newArray)

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

Parameters:

newArray - is new value for field

Returns:

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

Specified by:

getVisible in interface X3DBoundedObject

Specified by:

getVisible in interface X3DVolumeDataNode

Returns:

value of visible field

setVisible

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

Specified by:

setVisible in interface X3DBoundedObject

Specified by:

setVisible in interface X3DVolumeDataNode

Parameters:

newValue - is new value for the visible field.

Returns:

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

setVisible

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

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

getVoxels

public X3DTexture3DNode getVoxels()

Provide org.web3d.x3d.sai.Texturing3D.X3DTexture3DNode instance (using a properly typed node) from inputOutput SFNode field voxels.

Specified by:

getVoxels in interface IsoSurfaceVolumeData

Returns:

value of voxels field

See Also:

• 

Tooltip: [X3DTexture3DNode] Single contained X3DTexture3DNode (ComposedTexture3D, ImageTexture3D, PixelTexture3D) that provides raw voxel information utilized by corresponding rendering styles. Any number of color components (1-4) may be defined. *


setVoxels

public IsoSurfaceVolumeData setVoxels(X3DTexture3DNode newValue)

Accessor method to assign org.web3d.x3d.sai.Texturing3D.X3DTexture3DNode instance (using a properly typed node) to inputOutput SFNode field voxels.

Specified by:

setVoxels in interface IsoSurfaceVolumeData

Parameters:

newValue - is new value for the voxels field.

Returns:

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

See Also:

• 

Tooltip: [X3DTexture3DNode] Single contained X3DTexture3DNode (ComposedTexture3D, ImageTexture3D, PixelTexture3D) that provides raw voxel information utilized by corresponding rendering styles. Any number of color components (1-4) may be defined. *


clearVoxels

public IsoSurfaceVolumeData clearVoxels()

Utility method to clear SFNode value of voxels field.

Returns:

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

setVoxels

public IsoSurfaceVolumeData setVoxels(ProtoInstance newValue)

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

Parameters:

newValue - is new value for the voxels field.

Returns:

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

See Also:

• setVoxels(org.web3d.x3d.sai.Texturing3D.X3DTexture3DNode)

hasVoxels

public boolean hasVoxels()

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

Returns:

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

See Also:

• getVoxels()
• getVoxelsProtoInstance()

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

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

setDEF

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

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

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

setUSE

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

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

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

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

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

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

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

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

setUSE

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

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

addComments

public IsoSurfaceVolumeData addComments(String newComment)

Add comment as String to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComment - initial value

Returns:

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

Add comments as String[] array to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComments - array of comments

Returns:

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

addComments

public IsoSurfaceVolumeData addComments(CommentsBlock newCommentsBlock)

Add CommentsBlock to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newCommentsBlock - block of comments to add

Returns:

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

Specified by:

validate in class X3DConcreteElement

Returns:

validation results (if any)