Class SegmentedVolumeDataObject
java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.VolumeRendering.SegmentedVolumeDataObject
- All Implemented Interfaces:
X3DChildNode
,X3DNode
,X3DBoundedObject
,SegmentedVolumeData
,X3DVolumeDataNode
public class SegmentedVolumeDataObject extends X3DConcreteNode implements SegmentedVolumeData
SegmentedVolumeData displays a segmented voxel dataset with different RenderStyle nodes.
X3D node tooltip: (X3D version 3.3 or later) [X3DVolumeDataNode] SegmentedVolumeData displays a segmented voxel dataset with different RenderStyle nodes.
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.
X3D node tooltip: (X3D version 3.3 or later) [X3DVolumeDataNode] SegmentedVolumeData displays a segmented voxel dataset with different RenderStyle nodes.
- Hint: SegmentedVolumeData can contain a single ComposedTexture3D, ImageTexture3D or PixelTexture3D node with containerField='segmentIdentifiers' and another with containerField='voxels'.
- Hint: SegmentedVolumeData can contain multiple RenderStyle nodes.
- 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.
-
Field Summary
Fields Modifier and Type Field Description static float[]
BBOXCENTER_DEFAULT_VALUE
SFVec3f field named bboxCenter has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).static boolean
BBOXDISPLAY_DEFAULT_VALUE
SFBool field named bboxDisplay has default value false (Java syntax) or false (XML syntax).static float[]
BBOXSIZE_DEFAULT_VALUE
SFVec3f field named bboxSize has default value {-1f,-1f,-1f} (Java syntax) or -1 -1 -1 (XML syntax).static java.lang.String
COMPONENT
String constant COMPONENT defines X3D component for the SegmentedVolumeData element: VolumeRenderingstatic java.lang.String
containerField_DEFAULT_VALUE
containerField describes typical field relationship of a node to its parent.static float[]
DIMENSIONS_DEFAULT_VALUE
SFVec3f field named dimensions has default value {1f,1f,1f} (Java syntax) or 1 1 1 (XML syntax).static java.lang.String
fromField_BBOXDISPLAY
fromField ROUTE name for SFBool field named bboxDisplay.static java.lang.String
fromField_DIMENSIONS
fromField ROUTE name for SFVec3f field named dimensions.static java.lang.String
fromField_IS
fromField ROUTE name for SFNode field named IS.static java.lang.String
fromField_METADATA
fromField ROUTE name for SFNode field named metadata.static java.lang.String
fromField_RENDERSTYLE
fromField ROUTE name for MFNode field named renderStyle.static java.lang.String
fromField_SEGMENTENABLED
fromField ROUTE name for MFBool field named segmentEnabled.static java.lang.String
fromField_SEGMENTIDENTIFIERS
fromField ROUTE name for SFNode field named segmentIdentifiers.static java.lang.String
fromField_VISIBLE
fromField ROUTE name for SFBool field named visible.static java.lang.String
fromField_VOXELS
fromField ROUTE name for SFNode field named voxels.static ISObject
IS_DEFAULT_VALUE
SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).static int
LEVEL
Integer constant LEVEL provides default X3D VolumeRendering component level for this element: 2static X3DMetadataObject
METADATA_DEFAULT_VALUE
SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).static java.lang.String
NAME
String constant NAME provides name of this element: SegmentedVolumeData.static java.util.ArrayList<java.lang.Boolean>
SEGMENTENABLED_DEFAULT_VALUE
MFBool field named segmentEnabled has default value equal to an empty list.static X3DTexture3DNode
SEGMENTIDENTIFIERS_DEFAULT_VALUE
SFNode field named segmentIdentifiers has default value null (Java syntax) or NULL (XML syntax).static java.lang.String
toField_BBOXDISPLAY
toField ROUTE name for SFBool field named bboxDisplay.static java.lang.String
toField_DIMENSIONS
toField ROUTE name for SFVec3f field named dimensions.static java.lang.String
toField_METADATA
toField ROUTE name for SFNode field named metadata.static java.lang.String
toField_RENDERSTYLE
toField ROUTE name for MFNode field named renderStyle.static java.lang.String
toField_SEGMENTENABLED
toField ROUTE name for MFBool field named segmentEnabled.static java.lang.String
toField_SEGMENTIDENTIFIERS
toField ROUTE name for SFNode field named segmentIdentifiers.static java.lang.String
toField_VISIBLE
toField ROUTE name for SFBool field named visible.static java.lang.String
toField_VOXELS
toField ROUTE name for SFNode field named voxels.static boolean
VISIBLE_DEFAULT_VALUE
SFBool field named visible has default value true (Java syntax) or true (XML syntax).static 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
CLASS_DEFAULT_VALUE, containerField_ALTERNATE_VALUES, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE
-
Constructor Summary
Constructors Constructor Description SegmentedVolumeDataObject()
Constructor for SegmentedVolumeDataObject to initialize member variables with default values.SegmentedVolumeDataObject(java.lang.String DEFlabel)
Utility constructor that assigns DEF label after initializing member variables with default values. -
Method Summary
Modifier and Type Method Description SegmentedVolumeDataObject
addComments(java.lang.String newComment)
Add comment as String to contained commentsList.SegmentedVolumeDataObject
addComments(java.lang.String[] newComments)
Add comments as String[] array to contained commentsList.SegmentedVolumeDataObject
addComments(CommentsBlock newCommentsBlock)
Add CommentsBlock to contained commentsList.SegmentedVolumeDataObject
addRenderStyle(ProtoInstanceObject newValue)
Add single ProtoInstanceObject (with appropriate node type and containerField value) to MFNode array for renderStyle field.SegmentedVolumeDataObject
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).SegmentedVolumeDataObject
addSegmentEnabled(boolean newValue)
Add singleton boolean value to MFBool segmentEnabled field.SegmentedVolumeDataObject
addSegmentEnabled(SFBoolObject newValue)
Add singleton SFBoolObject value to MFBool segmentEnabled field.SegmentedVolumeDataObject
clearIS()
Utility method to clear SFNode value of IS field.SegmentedVolumeDataObject
clearMetadata()
Utility method to clear SFNode value of metadata field.SegmentedVolumeDataObject
clearRenderStyle()
Utility method to clear MFNode value of renderStyle field.SegmentedVolumeDataObject
clearSegmentEnabled()
Utility method to clear MFBool value of segmentEnabled field.SegmentedVolumeDataObject
clearSegmentIdentifiers()
Utility method to clear SFNode value of segmentIdentifiers field.SegmentedVolumeDataObject
clearVoxels()
Utility method to clear SFNode value of voxels field.X3DConcreteElement
findElementByNameValue(java.lang.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(java.lang.String nameValue, java.lang.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(java.lang.String DEFvalue)
Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.java.lang.String
getAccessType(java.lang.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.java.lang.String
getComponent()
Defines X3D component for the SegmentedVolumeData element: VolumeRenderingint
getComponentLevel()
Provides default X3D component level for this element: 2java.lang.String
getContainerFieldDefault()
containerField describes typical field relationship of a node to its parent.java.lang.String
getCssClass()
Provide String value from inputOutput SFString field named class.java.lang.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.java.lang.String
getElementName()
Provides name of this element: SegmentedVolumeDatajava.lang.String
getFieldType(java.lang.String fieldName)
Indicate type corresponding to given fieldName.ISObject
getIS()
Provide ISObject instance (using a properly typed node) from inputOutput SFNode field IS.X3DMetadataObject
getMetadata()
Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.X3DNode[]
getRenderStyle()
Provide array of X3DVolumeRenderStyleNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field renderStyle.java.util.ArrayList<X3DNode>
getRenderStyleList()
Utility method to get ArrayList value of MFNode renderStyle field, similar togetRenderStyle()
.boolean[]
getSegmentEnabled()
Provide array of Boolean results from inputOutput MFBool field named segmentEnabled.java.util.ArrayList<java.lang.Boolean>
getSegmentEnabledList()
Utility method to get ArrayList value of MFBool segmentEnabled field, similar togetSegmentEnabled()
.java.lang.String
getSegmentEnabledString()
Utility method to get String value of MFBool segmentEnabled field, similar togetSegmentEnabled()
.X3DTexture3DNode
getSegmentIdentifiers()
Provide X3DTexture3DNode instance (using a properly typed node) from inputOutput SFNode field segmentIdentifiers.java.lang.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 X3DTexture3DNode instance (using a properly typed node) from inputOutput SFNode field voxels.boolean
hasElementByNameValue(java.lang.String nameValue, java.lang.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(java.lang.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
hasSegmentIdentifiers()
Indicate whether an object is available for inputOutput SFNode field segmentIdentifiers.boolean
hasVoxels()
Indicate whether an object is available for inputOutput SFNode field voxels.void
initialize()
Initialize all member variables to default values.SegmentedVolumeDataObject
setBboxCenter(double[] newArray)
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetBboxCenter(float[])
.SegmentedVolumeDataObject
setBboxCenter(double x, double y, double z)
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetBboxCenter(float[])
.SegmentedVolumeDataObject
setBboxCenter(float[] newValue)
Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxCenter.SegmentedVolumeDataObject
setBboxCenter(float x, float y, float z)
Assign values to SFVec3f bboxCenter field, similar tosetBboxCenter(float[])
.SegmentedVolumeDataObject
setBboxCenter(SFVec3fObject newValue)
Assign typed object value to SFVec3f bboxCenter field, similar tosetBboxCenter(float[])
.SegmentedVolumeDataObject
setBboxDisplay(boolean newValue)
Accessor method to assign boolean value to inputOutput SFBool field named bboxDisplay.SegmentedVolumeDataObject
setBboxDisplay(SFBoolObject newValue)
Assign typed object value to SFBool bboxDisplay field, similar tosetBboxDisplay(boolean)
.SegmentedVolumeDataObject
setBboxSize(double[] newArray)
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetBboxSize(float[])
.SegmentedVolumeDataObject
setBboxSize(double x, double y, double z)
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetBboxSize(float[])
.SegmentedVolumeDataObject
setBboxSize(float[] newValue)
Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxSize.SegmentedVolumeDataObject
setBboxSize(float x, float y, float z)
Assign values to SFVec3f bboxSize field, similar tosetBboxSize(float[])
.SegmentedVolumeDataObject
setBboxSize(SFVec3fObject newValue)
Assign typed object value to SFVec3f bboxSize field, similar tosetBboxSize(float[])
.SegmentedVolumeDataObject
setCssClass(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named class.SegmentedVolumeDataObject
setCssClass(SFStringObject newValue)
Assign typed object value to SFString cssClass field, similar tosetCssClass(String)
.SegmentedVolumeDataObject
setDEF(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named DEF.SegmentedVolumeDataObject
setDEF(SFStringObject newValue)
Assign typed object value to SFString DEF field, similar tosetDEF(String)
.SegmentedVolumeDataObject
setDimensions(double[] newArray)
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetDimensions(float[])
.SegmentedVolumeDataObject
setDimensions(double x, double y, double z)
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetDimensions(float[])
.SegmentedVolumeDataObject
setDimensions(float[] newValue)
Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named dimensions.SegmentedVolumeDataObject
setDimensions(float x, float y, float z)
Assign values to SFVec3f dimensions field, similar tosetDimensions(float[])
.SegmentedVolumeDataObject
setDimensions(SFVec3fObject newValue)
Assign typed object value to SFVec3f dimensions field, similar tosetDimensions(float[])
.SegmentedVolumeDataObject
setIS(ISObject newValue)
Accessor method to assign ISObject instance (using a properly typed node) to inputOutput SFNode field IS.SegmentedVolumeDataObject
setMetadata(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.SegmentedVolumeDataObject
setMetadata(X3DMetadataObject newValue)
Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.SegmentedVolumeDataObject
setRenderStyle(java.util.ArrayList<X3DVolumeRenderStyleNode> newValue)
Assign ArrayList value of MFNode renderStyle field, similar tosetRenderStyle(X3DNode[])
.void
setRenderStyle(X3DNode newValue)
Set single child renderStyle node, replacing prior array of existing nodes (if any).SegmentedVolumeDataObject
setRenderStyle(X3DNode[] newValue)
Accessor method to assign X3DVolumeRenderStyleNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field renderStyle.SegmentedVolumeDataObject
setSegmentEnabled(boolean[] newValue)
Accessor method to assign Boolean array to inputOutput MFBool field named segmentEnabled.SegmentedVolumeDataObject
setSegmentEnabled(java.util.ArrayList<java.lang.Boolean> newValue)
Assign ArrayList value of MFBool segmentEnabled field, similar tosetSegmentEnabled(boolean[])
.SegmentedVolumeDataObject
setSegmentEnabled(MFBoolObject newValue)
Assign typed object value to MFBool segmentEnabled field, similar tosetSegmentEnabled(boolean[])
.SegmentedVolumeDataObject
setSegmentIdentifiers(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field segmentIdentifiers.SegmentedVolumeDataObject
setSegmentIdentifiers(X3DTexture3DNode newValue)
Accessor method to assign X3DTexture3DNode instance (using a properly typed node) to inputOutput SFNode field segmentIdentifiers.SegmentedVolumeDataObject
setUSE(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named USE.SegmentedVolumeDataObject
setUSE(SFStringObject newValue)
Assign typed object value to SFString USE field, similar tosetUSE(String)
.SegmentedVolumeDataObject
setUSE(SegmentedVolumeDataObject DEFnode)
Assign a USE reference to another DEF node of same node type, similar tosetUSE(String)
.SegmentedVolumeDataObject
setVisible(boolean newValue)
Accessor method to assign boolean value to inputOutput SFBool field named visible.SegmentedVolumeDataObject
setVisible(SFBoolObject newValue)
Assign typed object value to SFBool visible field, similar tosetVisible(boolean)
.SegmentedVolumeDataObject
setVoxels(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field voxels.SegmentedVolumeDataObject
setVoxels(X3DTexture3DNode newValue)
Accessor method to assign X3DTexture3DNode instance (using a properly typed node) to inputOutput SFNode field voxels.java.lang.String
toStringClassicVRML(int indentLevel)
Recursive method to provide ClassicVRML string serialization.java.lang.String
toStringVRML97(int indentLevel)
Recursive method to provide VRML97 string serialization.java.lang.String
toStringX3D(int indentLevel)
Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.java.lang.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, isNode, isStatement, isUSE, resetContainerFieldOverride, setConcreteCssClass, setConcreteDEF, setConcreteUSE, setContainerFieldOverride
Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement
clearParentObject, findAncestorElementByName, findAncestorProtoBody, findAncestorSceneObject, findAncestorX3DObject, getPackageName, getParentObject, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorSceneObject, hasAncestorX3DObject, hasParentObject, isValid, setParentObject, toStringClassicVRML, toStringVRML97, toStringX3D
-
Field Details
-
NAME
public static final java.lang.String NAMEString constant NAME provides name of this element: SegmentedVolumeData.- See Also:
- Constant Field Values
-
COMPONENT
public static final java.lang.String COMPONENTString constant COMPONENT defines X3D component for the SegmentedVolumeData element: VolumeRendering- See Also:
- Constant Field Values
-
LEVEL
public static final int LEVELInteger 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_VALUESFVec3f 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_VALUESFBool 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_VALUESFVec3f field named bboxSize has default value {-1f,-1f,-1f} (Java syntax) or -1 -1 -1 (XML syntax). -
DIMENSIONS_DEFAULT_VALUE
public static final float[] DIMENSIONS_DEFAULT_VALUESFVec3f field named dimensions has default value {1f,1f,1f} (Java syntax) or 1 1 1 (XML syntax). -
IS_DEFAULT_VALUE
SFNode field named IS has default value null (Java syntax) or NULL (XML syntax). -
METADATA_DEFAULT_VALUE
SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax). -
SEGMENTENABLED_DEFAULT_VALUE
public static final java.util.ArrayList<java.lang.Boolean> SEGMENTENABLED_DEFAULT_VALUEMFBool field named segmentEnabled has default value equal to an empty list. -
SEGMENTIDENTIFIERS_DEFAULT_VALUE
SFNode field named segmentIdentifiers has default value null (Java syntax) or NULL (XML syntax). -
VISIBLE_DEFAULT_VALUE
public static final boolean VISIBLE_DEFAULT_VALUESFBool field named visible has default value true (Java syntax) or true (XML syntax).- See Also:
- Constant Field Values
-
VOXELS_DEFAULT_VALUE
SFNode field named voxels has default value null (Java syntax) or NULL (XML syntax). -
containerField_DEFAULT_VALUE
public static final java.lang.String containerField_DEFAULT_VALUEcontainerField 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. -
fromField_BBOXDISPLAY
public static final java.lang.String fromField_BBOXDISPLAYfromField ROUTE name for SFBool field named bboxDisplay.- See Also:
- Constant Field Values
-
toField_BBOXDISPLAY
public static final java.lang.String toField_BBOXDISPLAYtoField ROUTE name for SFBool field named bboxDisplay.- See Also:
- Constant Field Values
-
fromField_DIMENSIONS
public static final java.lang.String fromField_DIMENSIONSfromField ROUTE name for SFVec3f field named dimensions.- See Also:
- Constant Field Values
-
toField_DIMENSIONS
public static final java.lang.String toField_DIMENSIONStoField ROUTE name for SFVec3f field named dimensions.- See Also:
- Constant Field Values
-
fromField_IS
public static final java.lang.String fromField_ISfromField ROUTE name for SFNode field named IS.- See Also:
- Constant Field Values
-
fromField_METADATA
public static final java.lang.String fromField_METADATAfromField ROUTE name for SFNode field named metadata.- See Also:
- Constant Field Values
-
toField_METADATA
public static final java.lang.String toField_METADATAtoField ROUTE name for SFNode field named metadata.- See Also:
- Constant Field Values
-
fromField_RENDERSTYLE
public static final java.lang.String fromField_RENDERSTYLEfromField ROUTE name for MFNode field named renderStyle.- See Also:
- Constant Field Values
-
toField_RENDERSTYLE
public static final java.lang.String toField_RENDERSTYLEtoField ROUTE name for MFNode field named renderStyle.- See Also:
- Constant Field Values
-
fromField_SEGMENTENABLED
public static final java.lang.String fromField_SEGMENTENABLEDfromField ROUTE name for MFBool field named segmentEnabled.- See Also:
- Constant Field Values
-
toField_SEGMENTENABLED
public static final java.lang.String toField_SEGMENTENABLEDtoField ROUTE name for MFBool field named segmentEnabled.- See Also:
- Constant Field Values
-
fromField_SEGMENTIDENTIFIERS
public static final java.lang.String fromField_SEGMENTIDENTIFIERSfromField ROUTE name for SFNode field named segmentIdentifiers.- See Also:
- Constant Field Values
-
toField_SEGMENTIDENTIFIERS
public static final java.lang.String toField_SEGMENTIDENTIFIERStoField ROUTE name for SFNode field named segmentIdentifiers.- See Also:
- Constant Field Values
-
fromField_VISIBLE
public static final java.lang.String fromField_VISIBLEfromField ROUTE name for SFBool field named visible.- See Also:
- Constant Field Values
-
toField_VISIBLE
public static final java.lang.String toField_VISIBLEtoField ROUTE name for SFBool field named visible.- See Also:
- Constant Field Values
-
fromField_VOXELS
public static final java.lang.String fromField_VOXELSfromField ROUTE name for SFNode field named voxels.- See Also:
- Constant Field Values
-
toField_VOXELS
public static final java.lang.String toField_VOXELStoField ROUTE name for SFNode field named voxels.- See Also:
- Constant Field Values
-
-
Constructor Details
-
SegmentedVolumeDataObject
public SegmentedVolumeDataObject()Constructor for SegmentedVolumeDataObject to initialize member variables with default values. -
SegmentedVolumeDataObject
public SegmentedVolumeDataObject(java.lang.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 java.lang.String getElementName()Provides name of this element: SegmentedVolumeData- Specified by:
getElementName
in classX3DConcreteElement
- Returns:
- name of this element
-
getComponent
public final java.lang.String getComponent()Defines X3D component for the SegmentedVolumeData element: VolumeRendering- Specified by:
getComponent
in classX3DConcreteElement
- Returns:
- X3D component for this element
-
getComponentLevel
public final int getComponentLevel()Provides default X3D component level for this element: 2- Specified by:
getComponentLevel
in classX3DConcreteElement
- Returns:
- default X3D component level for this element
-
getFieldType
public java.lang.String getFieldType(java.lang.String fieldName)Indicate type corresponding to given fieldName.- Specified by:
getFieldType
in classX3DConcreteElement
- 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 java.lang.String getAccessType(java.lang.String fieldName)Indicate accessType corresponding to given fieldName.- Specified by:
getAccessType
in classX3DConcreteElement
- 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 java.lang.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 classX3DConcreteNode
- 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 classX3DConcreteNode
-
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/documents/specifications/19775-1/V3.3/Part01/components/group.html#BoundingBoxes
- Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#X3DBoundedObject
- Specified by:
getBboxCenter
in interfaceSegmentedVolumeData
- Specified by:
getBboxCenter
in interfaceX3DBoundedObject
- Specified by:
getBboxCenter
in interfaceX3DVolumeDataNode
- Returns:
- value of bboxCenter field
-
setBboxCenter
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/documents/specifications/19775-1/V3.3/Part01/components/group.html#BoundingBoxes
- Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#X3DBoundedObject
- Specified by:
setBboxCenter
in interfaceSegmentedVolumeData
- Specified by:
setBboxCenter
in interfaceX3DBoundedObject
- Specified by:
setBboxCenter
in interfaceX3DVolumeDataNode
- Parameters:
newValue
- is new value for the bboxCenter field.- Returns:
SegmentedVolumeDataObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBboxCenter
Assign typed object value to SFVec3f bboxCenter field, similar tosetBboxCenter(float[])
.- Parameters:
newValue
- is new value for the bboxCenter field.- Returns:
SegmentedVolumeDataObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBboxCenter
Assign values to SFVec3f bboxCenter field, similar tosetBboxCenter(float[])
.- Parameters:
x
- first componenty
- second componentz
- third component- Returns:
SegmentedVolumeDataObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBboxCenter
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetBboxCenter(float[])
.- Parameters:
x
- first componenty
- second componentz
- third component- Returns:
SegmentedVolumeDataObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBboxCenter
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetBboxCenter(float[])
.- Parameters:
newArray
- is new value for field- Returns:
SegmentedVolumeDataObject
- 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 interfaceSegmentedVolumeData
- Specified by:
getBboxDisplay
in interfaceX3DBoundedObject
- Specified by:
getBboxDisplay
in interfaceX3DVolumeDataNode
- Returns:
- value of bboxDisplay field
-
setBboxDisplay
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 interfaceSegmentedVolumeData
- Specified by:
setBboxDisplay
in interfaceX3DBoundedObject
- Specified by:
setBboxDisplay
in interfaceX3DVolumeDataNode
- Parameters:
newValue
- is new value for the bboxDisplay field.- Returns:
SegmentedVolumeDataObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBboxDisplay
Assign typed object value to SFBool bboxDisplay field, similar tosetBboxDisplay(boolean)
.- Parameters:
newValue
- is new value for the bboxDisplay field.- Returns:
SegmentedVolumeDataObject
- 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: 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/documents/specifications/19775-1/V3.3/Part01/components/group.html#BoundingBoxes
- Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#X3DBoundedObject
- Specified by:
getBboxSize
in interfaceSegmentedVolumeData
- Specified by:
getBboxSize
in interfaceX3DBoundedObject
- Specified by:
getBboxSize
in interfaceX3DVolumeDataNode
- Returns:
- value of bboxSize field
-
setBboxSize
Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxSize.
Tooltip: 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/documents/specifications/19775-1/V3.3/Part01/components/group.html#BoundingBoxes
- Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#X3DBoundedObject
- Specified by:
setBboxSize
in interfaceSegmentedVolumeData
- Specified by:
setBboxSize
in interfaceX3DBoundedObject
- Specified by:
setBboxSize
in interfaceX3DVolumeDataNode
- Parameters:
newValue
- is new value for the bboxSize field.- Returns:
SegmentedVolumeDataObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBboxSize
Assign typed object value to SFVec3f bboxSize field, similar tosetBboxSize(float[])
.- Parameters:
newValue
- is new value for the bboxSize field.- Returns:
SegmentedVolumeDataObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBboxSize
Assign values to SFVec3f bboxSize field, similar tosetBboxSize(float[])
.- Parameters:
x
- first componenty
- second componentz
- third component- Returns:
SegmentedVolumeDataObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBboxSize
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetBboxSize(float[])
.- Parameters:
x
- first componenty
- second componentz
- third component- Returns:
SegmentedVolumeDataObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBboxSize
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetBboxSize(float[])
.- Parameters:
newArray
- is new value for field- Returns:
SegmentedVolumeDataObject
- 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 interfaceSegmentedVolumeData
- Specified by:
getDimensions
in interfaceX3DVolumeDataNode
- Returns:
- value of dimensions field
-
setDimensions
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 interfaceSegmentedVolumeData
- Specified by:
setDimensions
in interfaceX3DVolumeDataNode
- Parameters:
newValue
- is new value for the dimensions field.- Returns:
SegmentedVolumeDataObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setDimensions
Assign typed object value to SFVec3f dimensions field, similar tosetDimensions(float[])
.- Parameters:
newValue
- is new value for the dimensions field.- Returns:
SegmentedVolumeDataObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setDimensions
Assign values to SFVec3f dimensions field, similar tosetDimensions(float[])
.- Parameters:
x
- first componenty
- second componentz
- third component- Returns:
SegmentedVolumeDataObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setDimensions
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetDimensions(float[])
.- Parameters:
x
- first componenty
- second componentz
- third component- Returns:
SegmentedVolumeDataObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setDimensions
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetDimensions(float[])
.- Parameters:
newArray
- is new value for field- Returns:
SegmentedVolumeDataObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getIS
Provide ISObject instance (using a properly typed node) from inputOutput SFNode field IS.- Specified by:
getIS
in classX3DConcreteNode
- Returns:
- value of IS field
- See Also:
- X3D Tooltips: IS, X3D Tooltips: connect
-
setIS
Accessor method to assign ISObject instance (using a properly typed node) to inputOutput SFNode field IS.- Specified by:
setIS
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the IS field.- Returns:
SegmentedVolumeDataObject
- 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
Utility method to clear SFNode value of IS field.- Returns:
SegmentedVolumeDataObject
- 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
Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.- Specified by:
getMetadata
in interfaceSegmentedVolumeData
- Specified by:
getMetadata
in interfaceX3DChildNode
- Specified by:
getMetadata
in interfaceX3DNode
- Specified by:
getMetadata
in interfaceX3DVolumeDataNode
- 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/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
, X3D Scene Authoring Hints: Metadata Nodes
-
setMetadata
Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.- Specified by:
setMetadata
in interfaceSegmentedVolumeData
- Specified by:
setMetadata
in interfaceX3DChildNode
- Specified by:
setMetadata
in interfaceX3DNode
- Specified by:
setMetadata
in interfaceX3DVolumeDataNode
- Specified by:
setMetadata
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the metadata field.- Returns:
SegmentedVolumeDataObject
- 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/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
, X3D Scene Authoring Hints: Metadata Nodes
-
clearMetadata
Utility method to clear SFNode value of metadata field.- Returns:
SegmentedVolumeDataObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setMetadata
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.- Specified by:
setMetadata
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the metadata field.- Returns:
SegmentedVolumeDataObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
setMetadata(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
Provide array of X3DVolumeRenderStyleNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) 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 interfaceSegmentedVolumeData
- Returns:
- value of renderStyle field
- See Also:
X3DVolumeRenderStyleNode
-
getRenderStyleList
Utility method to get ArrayList value of MFNode renderStyle field, similar togetRenderStyle()
.- Returns:
- value of renderStyle field
-
setRenderStyle
Accessor method to assign X3DVolumeRenderStyleNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) 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 interfaceSegmentedVolumeData
- Parameters:
newValue
- is new value for the renderStyle field.- Returns:
SegmentedVolumeDataObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setRenderStyle
public SegmentedVolumeDataObject setRenderStyle(java.util.ArrayList<X3DVolumeRenderStyleNode> newValue)Assign ArrayList value of MFNode renderStyle field, similar tosetRenderStyle(X3DNode[])
.- Parameters:
newValue
- is new value for the renderStyle field.- Returns:
SegmentedVolumeDataObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addRenderStyle
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:
SegmentedVolumeDataObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addRenderStyle
Add single ProtoInstanceObject (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:
SegmentedVolumeDataObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addRenderStyle
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 interfaceSegmentedVolumeData
- Parameters:
newValue
- is new value array to be appended the renderStyle field.
-
setRenderStyle
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 interfaceSegmentedVolumeData
- Parameters:
newValue
- is new node for the renderStyle field (restricted to X3DVolumeRenderStyleNode)
-
clearRenderStyle
Utility method to clear MFNode value of renderStyle field.- Returns:
SegmentedVolumeDataObject
- 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()
-
getSegmentEnabled
public boolean[] getSegmentEnabled()Provide array of Boolean results from inputOutput MFBool field named segmentEnabled.- Specified by:
getSegmentEnabled
in interfaceSegmentedVolumeData
- Returns:
- value of segmentEnabled field
-
getSegmentEnabledList
public java.util.ArrayList<java.lang.Boolean> getSegmentEnabledList()Utility method to get ArrayList value of MFBool segmentEnabled field, similar togetSegmentEnabled()
.- Returns:
- value of segmentEnabled field
-
getSegmentEnabledString
public java.lang.String getSegmentEnabledString()Utility method to get String value of MFBool segmentEnabled field, similar togetSegmentEnabled()
.- Returns:
- value of segmentEnabled field
-
setSegmentEnabled
Accessor method to assign Boolean array to inputOutput MFBool field named segmentEnabled.- Specified by:
setSegmentEnabled
in interfaceSegmentedVolumeData
- Parameters:
newValue
- is new value for the segmentEnabled field.- Returns:
SegmentedVolumeDataObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setSegmentEnabled
Assign typed object value to MFBool segmentEnabled field, similar tosetSegmentEnabled(boolean[])
.- Parameters:
newValue
- is new value for the segmentEnabled field.- Returns:
SegmentedVolumeDataObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setSegmentEnabled
public SegmentedVolumeDataObject setSegmentEnabled(java.util.ArrayList<java.lang.Boolean> newValue)Assign ArrayList value of MFBool segmentEnabled field, similar tosetSegmentEnabled(boolean[])
.- Parameters:
newValue
- is new value for the segmentEnabled field.- Returns:
SegmentedVolumeDataObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
clearSegmentEnabled
Utility method to clear MFBool value of segmentEnabled field.- Returns:
SegmentedVolumeDataObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
addSegmentEnabled
Add singleton boolean value to MFBool segmentEnabled field.- Parameters:
newValue
- is new value to add to the segmentEnabled field.- Returns:
SegmentedVolumeDataObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addSegmentEnabled
Add singleton SFBoolObject value to MFBool segmentEnabled field.- Parameters:
newValue
- is new value to add to the segmentEnabled field.- Returns:
SegmentedVolumeDataObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getSegmentIdentifiers
Provide X3DTexture3DNode instance (using a properly typed node) from inputOutput SFNode field segmentIdentifiers.- Specified by:
getSegmentIdentifiers
in interfaceSegmentedVolumeData
- Returns:
- value of segmentIdentifiers field
- See Also:
Tooltip: [X3DTexture3DNode] Single contained X3DTexture3DNode (ComposedTexture3D, ImageTexture3D, PixelTexture3D) holds component texture that provides corresponding segment identifier. Hint: if more than one color component is contained, only initial color component defines the segment identifier. Warning: if segmentIdentifiers texture is not identical in size to the main voxels, it shall be ignored.
-
setSegmentIdentifiers
Accessor method to assign X3DTexture3DNode instance (using a properly typed node) to inputOutput SFNode field segmentIdentifiers.- Specified by:
setSegmentIdentifiers
in interfaceSegmentedVolumeData
- Parameters:
newValue
- is new value for the segmentIdentifiers field.- Returns:
SegmentedVolumeDataObject
- 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) holds component texture that provides corresponding segment identifier. Hint: if more than one color component is contained, only initial color component defines the segment identifier. Warning: if segmentIdentifiers texture is not identical in size to the main voxels, it shall be ignored.
-
clearSegmentIdentifiers
Utility method to clear SFNode value of segmentIdentifiers field.- Returns:
SegmentedVolumeDataObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setSegmentIdentifiers
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field segmentIdentifiers.- Parameters:
newValue
- is new value for the segmentIdentifiers field.- Returns:
SegmentedVolumeDataObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
setSegmentIdentifiers(X3DTexture3DNode)
-
hasSegmentIdentifiers
public boolean hasSegmentIdentifiers()Indicate whether an object is available for inputOutput SFNode field segmentIdentifiers.- Returns:
- whether a properly typed node or ProtoInstance or CommentsBlock is available.
- See Also:
getSegmentIdentifiers()
,getSegmentIdentifiersProtoInstance()
-
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 interfaceSegmentedVolumeData
- Specified by:
getVisible
in interfaceX3DBoundedObject
- Specified by:
getVisible
in interfaceX3DVolumeDataNode
- Returns:
- value of visible field
-
setVisible
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 interfaceSegmentedVolumeData
- Specified by:
setVisible
in interfaceX3DBoundedObject
- Specified by:
setVisible
in interfaceX3DVolumeDataNode
- Parameters:
newValue
- is new value for the visible field.- Returns:
SegmentedVolumeDataObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setVisible
Assign typed object value to SFBool visible field, similar tosetVisible(boolean)
.- Parameters:
newValue
- is new value for the visible field.- Returns:
SegmentedVolumeDataObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getVoxels
Provide X3DTexture3DNode instance (using a properly typed node) from inputOutput SFNode field voxels.- Specified by:
getVoxels
in interfaceSegmentedVolumeData
- 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
Accessor method to assign X3DTexture3DNode instance (using a properly typed node) to inputOutput SFNode field voxels.- Specified by:
setVoxels
in interfaceSegmentedVolumeData
- Parameters:
newValue
- is new value for the voxels field.- Returns:
SegmentedVolumeDataObject
- 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
Utility method to clear SFNode value of voxels field.- Returns:
SegmentedVolumeDataObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setVoxels
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field voxels.- Parameters:
newValue
- is new value for the voxels field.- Returns:
SegmentedVolumeDataObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
setVoxels(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 java.lang.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 classX3DConcreteNode
- Returns:
- value of DEF field
- See Also:
- X3D Scene Authoring Hints: Naming Conventions
-
setDEF
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 classX3DConcreteNode
- Parameters:
newValue
- is new value for the DEF field.- Returns:
SegmentedVolumeDataObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setDEF
Assign typed object value to SFString DEF field, similar tosetDEF(String)
.- Parameters:
newValue
- is new value for the DEF field.- Returns:
SegmentedVolumeDataObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getUSE
public java.lang.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 classX3DConcreteNode
- Returns:
- value of USE field
- See Also:
- X3D Scene Authoring Hints: Naming Conventions
-
setUSE
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: eachUSE
node is still an independent object, with theUSE
value matching theDEF
value in the preceding object.
Warning: invoking thesetUSE()
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 classX3DConcreteNode
- Parameters:
newValue
- is new value for the USE field.- Returns:
SegmentedVolumeDataObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setUSE
Assign typed object value to SFString USE field, similar tosetUSE(String)
.- Parameters:
newValue
- is new value for the USE field.- Returns:
SegmentedVolumeDataObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getCssClass
public java.lang.String getCssClass()Provide String value from inputOutput SFString field named class.
Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.- Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
- Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
- Overrides:
getCssClass
in classX3DConcreteNode
- Returns:
- value of class field
- See Also:
- W3C Cascading Style Sheets
-
setCssClass
Accessor method to assign String value to inputOutput SFString field named class.
Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.- Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
- Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
- Specified by:
setCssClass
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the class field.- Returns:
SegmentedVolumeDataObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
- W3C Cascading Style Sheets
-
setCssClass
Assign typed object value to SFString cssClass field, similar tosetCssClass(String)
.- Parameters:
newValue
- is new value for the class field.- Returns:
SegmentedVolumeDataObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setUSE
Assign a USE reference to another DEF node of same node type, similar tosetUSE(String)
.
Warning: note that thesetUSE()
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:
SegmentedVolumeDataObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addComments
Add comment as String to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newComment
- initial value- Returns:
SegmentedVolumeDataObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
addComments
Add comments as String[] array to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newComments
- array of comments- Returns:
SegmentedVolumeDataObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
addComments
Add CommentsBlock to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newCommentsBlock
- block of comments to add- Returns:
SegmentedVolumeDataObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
toStringX3D
public java.lang.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 classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- X3D string
- See Also:
X3DObject.FILE_EXTENSION_X3D
,X3DObject.FILE_EXTENSION_XML
,X3DObject.toStringXML()
,X3DObject.toFileXML(String)
,X3DObject.toFileX3D(String)
, X3D XML Encoding, X3D Compressed Binary Encoding: X3D Canonical Form, X3D Canonicalization (C14N) Tool
-
toStringClassicVRML
public java.lang.String toStringClassicVRML(int indentLevel)Recursive method to provide ClassicVRML string serialization.- Specified by:
toStringClassicVRML
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- ClassicVRML string
- See Also:
X3DObject.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 java.lang.String toStringVRML97(int indentLevel)Recursive method to provide VRML97 string serialization.- Specified by:
toStringVRML97
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- VRML97 string
- See Also:
X3DObject.FILE_EXTENSION_VRML97
, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Virtual Reality Modeling Language (VRML) 97 specification, VRML 97 v2.1 Amendment
-
findElementByNameValue
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 findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() 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 classX3DConcreteElement
- 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.hasAncestorSceneObject()
,X3DConcreteElement.findAncestorX3DObject()
-
findElementByNameValue
public X3DConcreteElement findElementByNameValue(java.lang.String nameValue, java.lang.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 findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() 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 classX3DConcreteElement
- 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.hasAncestorSceneObject()
,X3DConcreteElement.findAncestorX3DObject()
-
hasElementByNameValue
public boolean hasElementByNameValue(java.lang.String nameValue, java.lang.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
Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() 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 classX3DConcreteElement
- 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.hasAncestorSceneObject()
,X3DConcreteElement.findAncestorX3DObject()
-
hasNodeByDEF
public boolean hasNodeByDEF(java.lang.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 java.lang.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 classX3DConcreteElement
- Returns:
- validation results (if any)
-