Package org.web3d.x3d.jsail.VolumeRendering

Class BlendedVolumeStyle

java.lang.Object

org.web3d.x3d.jsail.X3DConcreteElement

org.web3d.x3d.jsail.X3DConcreteNode

org.web3d.x3d.jsail.VolumeRendering.BlendedVolumeStyle

All Implemented Interfaces:

X3DNode, BlendedVolumeStyle, X3DComposableVolumeRenderStyleNode, X3DVolumeRenderStyleNode

public class BlendedVolumeStyle
extends X3DConcreteNode
implements BlendedVolumeStyle

BlendedVolumeStyle combines rendering of two voxel data sets into one by blending voxel values.

Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the org.web3d.x3d.jsail classes. BlendedVolumeStyle node tooltip: (X3D version 3.3 or later) [X3DComposableVolumeRenderStyleNode] BlendedVolumeStyle combines rendering of two voxel data sets into one by blending voxel values.

• Hint: BlendedVolumeStyle can contain just one each of following: VolumeStyle node with containerField='renderStyle', Texture3D node with containerField='voxels', Texture2D node with containerField='weightTransferFunction1' and Texture2D node with containerField='weightTransferFunction2'.
• Warning: requires X3D profile='Full' or else include <component name='VolumeRendering' level='3'/>

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COMPONENT	String constant COMPONENT defines X3D component for the BlendedVolumeStyle element: VolumeRendering
static final String	containerField_DEFAULT_VALUE	containerField describes typical field relationship of a node to its parent.
static final boolean	ENABLED_DEFAULT_VALUE	SFBool field named enabled has default value true (Java syntax) or true (XML syntax).
static final String	fromField_ENABLED	fromField ROUTE name for SFBool field named enabled.
static final String	fromField_IS	fromField ROUTE name for SFNode field named IS.
static final String	fromField_METADATA	fromField ROUTE name for SFNode field named metadata.
static final String	fromField_RENDERSTYLE	fromField ROUTE name for SFNode field named renderStyle.
static final String	fromField_VOXELS	fromField ROUTE name for SFNode field named voxels.
static final String	fromField_WEIGHTCONSTANT1	fromField ROUTE name for SFFloat field named weightConstant1.
static final String	fromField_WEIGHTCONSTANT2	fromField ROUTE name for SFFloat field named weightConstant2.
static final String	fromField_WEIGHTFUNCTION1	fromField ROUTE name for SFString field named weightFunction1.
static final String	fromField_WEIGHTFUNCTION2	fromField ROUTE name for SFString field named weightFunction2.
static final String	fromField_WEIGHTTRANSFERFUNCTION1	fromField ROUTE name for SFNode field named weightTransferFunction1.
static final String	fromField_WEIGHTTRANSFERFUNCTION2	fromField ROUTE name for SFNode field named weightTransferFunction2.
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: 3
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: BlendedVolumeStyle.
static final X3DComposableVolumeRenderStyleNode	RENDERSTYLE_DEFAULT_VALUE	SFNode field named renderStyle has default value null (Java syntax) or NULL (XML syntax).
static final String	toField_ENABLED	toField ROUTE name for SFBool field named enabled.
static final String	toField_METADATA	toField ROUTE name for SFNode field named metadata.
static final String	toField_RENDERSTYLE	toField ROUTE name for SFNode field named renderStyle.
static final String	toField_VOXELS	toField ROUTE name for SFNode field named voxels.
static final String	toField_WEIGHTCONSTANT1	toField ROUTE name for SFFloat field named weightConstant1.
static final String	toField_WEIGHTCONSTANT2	toField ROUTE name for SFFloat field named weightConstant2.
static final String	toField_WEIGHTFUNCTION1	toField ROUTE name for SFString field named weightFunction1.
static final String	toField_WEIGHTFUNCTION2	toField ROUTE name for SFString field named weightFunction2.
static final String	toField_WEIGHTTRANSFERFUNCTION1	toField ROUTE name for SFNode field named weightTransferFunction1.
static final String	toField_WEIGHTTRANSFERFUNCTION2	toField ROUTE name for SFNode field named weightTransferFunction2.
static final X3DTexture3DNode	VOXELS_DEFAULT_VALUE	SFNode field named voxels has default value null (Java syntax) or NULL (XML syntax).
static final float	WEIGHTCONSTANT1_DEFAULT_VALUE	SFFloat field named weightConstant1 has default value 0.5f (Java syntax) or 0.5 (XML syntax).
static final float	WEIGHTCONSTANT2_DEFAULT_VALUE	SFFloat field named weightConstant2 has default value 0.5f (Java syntax) or 0.5 (XML syntax).
static final String	WEIGHTFUNCTION1_ALPHA1	Tooltip: Use O_v.
static final String	WEIGHTFUNCTION1_ALPHA2	Tooltip: Use O_blend.
static final String	WEIGHTFUNCTION1_CONSTANT	Tooltip: Use weightConstant1.
static final String	WEIGHTFUNCTION1_DEFAULT_VALUE	SFString field named weightFunction1 has default value "CONSTANT" (Java syntax) or CONSTANT (XML syntax).
static final String	WEIGHTFUNCTION1_ONE_MINUS_ALPHA1	Tooltip: Use 1 - O_v.
static final String	WEIGHTFUNCTION1_ONE_MINUS_ALPHA2	Tooltip: Use 1 - O_blend.
static final String	WEIGHTFUNCTION1_TABLE	Tooltip: Use table lookup value.
static final String	WEIGHTFUNCTION2_ALPHA1	Tooltip: Use O_v.
static final String	WEIGHTFUNCTION2_ALPHA2	Tooltip: Use O_blend.
static final String	WEIGHTFUNCTION2_CONSTANT	Tooltip: Use weightConstant1.
static final String	WEIGHTFUNCTION2_DEFAULT_VALUE	SFString field named weightFunction2 has default value "CONSTANT" (Java syntax) or CONSTANT (XML syntax).
static final String	WEIGHTFUNCTION2_ONE_MINUS_ALPHA1	Tooltip: Use 1 - O_v.
static final String	WEIGHTFUNCTION2_ONE_MINUS_ALPHA2	Tooltip: Use 1 - O_blend.
static final String	WEIGHTFUNCTION2_TABLE	Tooltip: Use table lookup value.
static final X3DTexture2DNode	WEIGHTTRANSFERFUNCTION1_DEFAULT_VALUE	SFNode field named weightTransferFunction1 has default value null (Java syntax) or NULL (XML syntax).
static final X3DTexture2DNode	WEIGHTTRANSFERFUNCTION2_DEFAULT_VALUE	SFNode field named weightTransferFunction2 has default value null (Java syntax) or NULL (XML syntax).

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

containerField_ALLOWED_VALUES, containerFieldOverride, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE

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

CLASS_DEFAULT_VALUE, ID_DEFAULT_VALUE, STYLE_DEFAULT_VALUE, validationResult

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
BlendedVolumeStyle	addComments(String newComment)	Add comment as String to contained commentsList.
BlendedVolumeStyle	addComments(String[] newComments)	Add comments as String[] array to contained commentsList.
BlendedVolumeStyle	addComments(CommentsBlock newCommentsBlock)	Add CommentsBlock to contained commentsList.
BlendedVolumeStyle	clearIS()	Utility method to clear SFNode value of IS field.
BlendedVolumeStyle	clearMetadata()	Utility method to clear SFNode value of metadata field.
BlendedVolumeStyle	clearRenderStyle()	Utility method to clear SFNode value of renderStyle field.
BlendedVolumeStyle	clearVoxels()	Utility method to clear SFNode value of voxels field.
BlendedVolumeStyle	clearWeightTransferFunction1()	Utility method to clear SFNode value of weightTransferFunction1 field.
BlendedVolumeStyle	clearWeightTransferFunction2()	Utility method to clear SFNode value of weightTransferFunction2 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.
final String	getComponent()	Defines X3D component for the BlendedVolumeStyle element: VolumeRendering
final int	getComponentLevel()	Provides default X3D component level for this element: 3
final String	getContainerFieldDefault()	containerField describes typical field relationship of a node to its parent.
String	getCssClass()	Provide String value from inputOutput SFString field named class.
String	getCssStyle()	Provide String value from inputOutput SFString field named style.
String	getDEF()	Provide String value from inputOutput SFString field named DEF.
final String	getElementName()	Provides name of this element: BlendedVolumeStyle
boolean	getEnabled()	Provide boolean value from inputOutput SFBool field named enabled.
String	getFieldType(String fieldName)	Indicate type corresponding to given fieldName.
String	getHtmlID()	Provide String value from inputOutput SFString field named id.
IS	getIS()	Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.
X3DMetadataObject	getMetadata()	Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
X3DComposableVolumeRenderStyleNode	getRenderStyle()	Provide org.web3d.x3d.sai.VolumeRendering.X3DComposableVolumeRenderStyleNode instance (using a properly typed node) from inputOutput SFNode field renderStyle.
String	getUSE()	Provide String value from inputOutput SFString field named USE.
X3DTexture3DNode	getVoxels()	Provide org.web3d.x3d.sai.Texturing3D.X3DTexture3DNode instance (using a properly typed node) from inputOutput SFNode field voxels.
float	getWeightConstant1()	Provide float value within allowed range of [0,1] from inputOutput SFFloat field named weightConstant1.
float	getWeightConstant2()	Provide float value within allowed range of [0,1] from inputOutput SFFloat field named weightConstant2.
String	getWeightFunction1()	Provide String enumeration value (baseType xs:NMTOKEN) ["CONSTANT" | "ALPHA1" | "ALPHA2" | "ONE_MINUS_ALPHA1" | "ONE_MINUS_ALPHA2" | "TABLE"] from inputOutput SFString field named weightFunction1.
String	getWeightFunction2()	Provide String enumeration value (baseType xs:NMTOKEN) ["CONSTANT" | "ALPHA1" | "ALPHA2" | "ONE_MINUS_ALPHA1" | "ONE_MINUS_ALPHA2" | "TABLE"] from inputOutput SFString field named weightFunction2.
X3DTexture2DNode	getWeightTransferFunction1()	Provide org.web3d.x3d.sai.Texturing.X3DTexture2DNode instance (using a properly typed node) from inputOutput SFNode field weightTransferFunction1.
X3DTexture2DNode	getWeightTransferFunction2()	Provide org.web3d.x3d.sai.Texturing.X3DTexture2DNode instance (using a properly typed node) from inputOutput SFNode field weightTransferFunction2.
boolean	hasElementByNameValue(String nameValue, String elementName)	Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
boolean	hasIS()	Indicate whether an object is available for inputOutput SFNode field IS.
boolean	hasMetadata()	Indicate whether an object is available for inputOutput SFNode field metadata.
boolean	hasNodeByDEF(String DEFvalue)	Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
boolean	hasRenderStyle()	Indicate whether an object is available for inputOutput SFNode field renderStyle.
boolean	hasVoxels()	Indicate whether an object is available for inputOutput SFNode field voxels.
boolean	hasWeightTransferFunction1()	Indicate whether an object is available for inputOutput SFNode field weightTransferFunction1.
boolean	hasWeightTransferFunction2()	Indicate whether an object is available for inputOutput SFNode field weightTransferFunction2.
final void	initialize()	Initialize all member variables to default values.
final BlendedVolumeStyle	setCssClass(String newValue)	Accessor method to assign String value to inputOutput SFString field named class.
BlendedVolumeStyle	setCssClass(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssClass(String).
final BlendedVolumeStyle	setCssStyle(String newValue)	Accessor method to assign String value to inputOutput SFString field named style.
BlendedVolumeStyle	setCssStyle(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssStyle(String).
final BlendedVolumeStyle	setDEF(String newValue)	Accessor method to assign String value to inputOutput SFString field named DEF.
BlendedVolumeStyle	setDEF(SFString newValue)	Assign typed object value to SFString DEF field, similar to setDEF(String).
BlendedVolumeStyle	setEnabled(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named enabled.
BlendedVolumeStyle	setEnabled(SFBool newValue)	Assign typed object value to SFBool enabled field, similar to setEnabled(boolean).
final BlendedVolumeStyle	setHtmlID(String newValue)	Accessor method to assign String value to inputOutput SFString field named id.
BlendedVolumeStyle	setHtmlID(SFString newValue)	Assign typed object value to SFString HtmlID field, similar to setHtmlID(String).
BlendedVolumeStyle	setIS(IS newValue)	Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
BlendedVolumeStyle	setMetadata(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
BlendedVolumeStyle	setMetadata(X3DMetadataObject newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
BlendedVolumeStyle	setRenderStyle(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field renderStyle.
BlendedVolumeStyle	setRenderStyle(X3DComposableVolumeRenderStyleNode newValue)	Accessor method to assign org.web3d.x3d.sai.VolumeRendering.X3DComposableVolumeRenderStyleNode instance (using a properly typed node) to inputOutput SFNode field renderStyle.
final BlendedVolumeStyle	setUSE(String newValue)	Accessor method to assign String value to inputOutput SFString field named USE.
BlendedVolumeStyle	setUSE(SFString newValue)	Assign typed object value to SFString USE field, similar to setUSE(String).
BlendedVolumeStyle	setUSE(BlendedVolumeStyle DEFnode)	Assign a USE reference to another DEF node of same node type, similar to setUSE(String).
BlendedVolumeStyle	setVoxels(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field voxels.
BlendedVolumeStyle	setVoxels(X3DTexture3DNode newValue)	Accessor method to assign org.web3d.x3d.sai.Texturing3D.X3DTexture3DNode instance (using a properly typed node) to inputOutput SFNode field voxels.
BlendedVolumeStyle	setWeightConstant1(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setWeightConstant1(float).
BlendedVolumeStyle	setWeightConstant1(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named weightConstant1.
BlendedVolumeStyle	setWeightConstant1(SFFloat newValue)	Assign typed object value to SFFloat weightConstant1 field, similar to setWeightConstant1(float).
BlendedVolumeStyle	setWeightConstant2(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setWeightConstant2(float).
BlendedVolumeStyle	setWeightConstant2(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named weightConstant2.
BlendedVolumeStyle	setWeightConstant2(SFFloat newValue)	Assign typed object value to SFFloat weightConstant2 field, similar to setWeightConstant2(float).
BlendedVolumeStyle	setWeightFunction1(String newValue)	Accessor method to assign String enumeration value ("CONSTANT" | "ALPHA1" | "ALPHA2" | "ONE_MINUS_ALPHA1" | "ONE_MINUS_ALPHA2" | "TABLE") to inputOutput SFString field named weightFunction1.
BlendedVolumeStyle	setWeightFunction1(SFString newValue)	Assign typed object value to SFString weightFunction1 field, similar to setWeightFunction1(String).
BlendedVolumeStyle	setWeightFunction2(String newValue)	Accessor method to assign String enumeration value ("CONSTANT" | "ALPHA1" | "ALPHA2" | "ONE_MINUS_ALPHA1" | "ONE_MINUS_ALPHA2" | "TABLE") to inputOutput SFString field named weightFunction2.
BlendedVolumeStyle	setWeightFunction2(SFString newValue)	Assign typed object value to SFString weightFunction2 field, similar to setWeightFunction2(String).
BlendedVolumeStyle	setWeightTransferFunction1(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field weightTransferFunction1.
BlendedVolumeStyle	setWeightTransferFunction1(X3DTexture2DNode newValue)	Accessor method to assign org.web3d.x3d.sai.Texturing.X3DTexture2DNode instance (using a properly typed node) to inputOutput SFNode field weightTransferFunction1.
BlendedVolumeStyle	setWeightTransferFunction2(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field weightTransferFunction2.
BlendedVolumeStyle	setWeightTransferFunction2(X3DTexture2DNode newValue)	Accessor method to assign org.web3d.x3d.sai.Texturing.X3DTexture2DNode instance (using a properly typed node) to inputOutput SFNode field weightTransferFunction2.
String	toStringClassicVRML(int indentLevel)	Recursive method to provide ClassicVRML string serialization.
String	toStringVRML97(int indentLevel)	Recursive method to provide VRML97 string serialization.
String	toStringX3D(int indentLevel)	Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
String	validate()	Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.

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

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

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

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

Methods inherited from class java.lang.Object

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

Field Details

WEIGHTFUNCTION1_CONSTANT

public static final String WEIGHTFUNCTION1_CONSTANT

Tooltip: Use weightConstant1. SFString field named weightFunction1 with X3DUOM simpleType volumeRenderingWeightFunctionChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "CONSTANT" (Java syntax) or CONSTANT (XML syntax).

See Also:

• XML Schema: volumeRenderingWeightFunctionChoices
• Constant Field Values

WEIGHTFUNCTION1_ALPHA1

public static final String WEIGHTFUNCTION1_ALPHA1

Tooltip: Use O_v. SFString field named weightFunction1 with X3DUOM simpleType volumeRenderingWeightFunctionChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "ALPHA1" (Java syntax) or ALPHA1 (XML syntax).

See Also:

• XML Schema: volumeRenderingWeightFunctionChoices
• Constant Field Values

WEIGHTFUNCTION1_ALPHA2

public static final String WEIGHTFUNCTION1_ALPHA2

Tooltip: Use O_blend. SFString field named weightFunction1 with X3DUOM simpleType volumeRenderingWeightFunctionChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "ALPHA2" (Java syntax) or ALPHA2 (XML syntax).

See Also:

• XML Schema: volumeRenderingWeightFunctionChoices
• Constant Field Values

WEIGHTFUNCTION1_ONE_MINUS_ALPHA1

public static final String WEIGHTFUNCTION1_ONE_MINUS_ALPHA1

Tooltip: Use 1 - O_v. SFString field named weightFunction1 with X3DUOM simpleType volumeRenderingWeightFunctionChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "ONE_MINUS_ALPHA1" (Java syntax) or ONE_MINUS_ALPHA1 (XML syntax).

See Also:

• XML Schema: volumeRenderingWeightFunctionChoices
• Constant Field Values

WEIGHTFUNCTION1_ONE_MINUS_ALPHA2

public static final String WEIGHTFUNCTION1_ONE_MINUS_ALPHA2

Tooltip: Use 1 - O_blend. SFString field named weightFunction1 with X3DUOM simpleType volumeRenderingWeightFunctionChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "ONE_MINUS_ALPHA2" (Java syntax) or ONE_MINUS_ALPHA2 (XML syntax).

See Also:

• XML Schema: volumeRenderingWeightFunctionChoices
• Constant Field Values

WEIGHTFUNCTION1_TABLE

public static final String WEIGHTFUNCTION1_TABLE

Tooltip: Use table lookup value. SFString field named weightFunction1 with X3DUOM simpleType volumeRenderingWeightFunctionChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "TABLE" (Java syntax) or TABLE (XML syntax).

See Also:

• XML Schema: volumeRenderingWeightFunctionChoices
• Constant Field Values

WEIGHTFUNCTION2_CONSTANT

public static final String WEIGHTFUNCTION2_CONSTANT

Tooltip: Use weightConstant1. SFString field named weightFunction2 with X3DUOM simpleType volumeRenderingWeightFunctionChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "CONSTANT" (Java syntax) or CONSTANT (XML syntax).

See Also:

• XML Schema: volumeRenderingWeightFunctionChoices
• Constant Field Values

WEIGHTFUNCTION2_ALPHA1

public static final String WEIGHTFUNCTION2_ALPHA1

Tooltip: Use O_v. SFString field named weightFunction2 with X3DUOM simpleType volumeRenderingWeightFunctionChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "ALPHA1" (Java syntax) or ALPHA1 (XML syntax).

See Also:

• XML Schema: volumeRenderingWeightFunctionChoices
• Constant Field Values

WEIGHTFUNCTION2_ALPHA2

public static final String WEIGHTFUNCTION2_ALPHA2

Tooltip: Use O_blend. SFString field named weightFunction2 with X3DUOM simpleType volumeRenderingWeightFunctionChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "ALPHA2" (Java syntax) or ALPHA2 (XML syntax).

See Also:

• XML Schema: volumeRenderingWeightFunctionChoices
• Constant Field Values

WEIGHTFUNCTION2_ONE_MINUS_ALPHA1

public static final String WEIGHTFUNCTION2_ONE_MINUS_ALPHA1

Tooltip: Use 1 - O_v. SFString field named weightFunction2 with X3DUOM simpleType volumeRenderingWeightFunctionChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "ONE_MINUS_ALPHA1" (Java syntax) or ONE_MINUS_ALPHA1 (XML syntax).

See Also:

• XML Schema: volumeRenderingWeightFunctionChoices
• Constant Field Values

WEIGHTFUNCTION2_ONE_MINUS_ALPHA2

public static final String WEIGHTFUNCTION2_ONE_MINUS_ALPHA2

Tooltip: Use 1 - O_blend. SFString field named weightFunction2 with X3DUOM simpleType volumeRenderingWeightFunctionChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "ONE_MINUS_ALPHA2" (Java syntax) or ONE_MINUS_ALPHA2 (XML syntax).

See Also:

• XML Schema: volumeRenderingWeightFunctionChoices
• Constant Field Values

WEIGHTFUNCTION2_TABLE

public static final String WEIGHTFUNCTION2_TABLE

Tooltip: Use table lookup value. SFString field named weightFunction2 with X3DUOM simpleType volumeRenderingWeightFunctionChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "TABLE" (Java syntax) or TABLE (XML syntax).

See Also:

• XML Schema: volumeRenderingWeightFunctionChoices
• Constant Field Values

NAME

public static final String NAME

String constant NAME provides name of this element: BlendedVolumeStyle.

See Also:

• Constant Field Values

COMPONENT

public static final String COMPONENT

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

See Also:

• Constant Field Values

ENABLED_DEFAULT_VALUE

public static final boolean ENABLED_DEFAULT_VALUE

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

See Also:

• Constant Field Values

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

RENDERSTYLE_DEFAULT_VALUE

public static final X3DComposableVolumeRenderStyleNode RENDERSTYLE_DEFAULT_VALUE

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

VOXELS_DEFAULT_VALUE

public static final X3DTexture3DNode VOXELS_DEFAULT_VALUE

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

WEIGHTCONSTANT1_DEFAULT_VALUE

public static final float WEIGHTCONSTANT1_DEFAULT_VALUE

SFFloat field named weightConstant1 has default value 0.5f (Java syntax) or 0.5 (XML syntax).

See Also:

• Constant Field Values

WEIGHTCONSTANT2_DEFAULT_VALUE

public static final float WEIGHTCONSTANT2_DEFAULT_VALUE

SFFloat field named weightConstant2 has default value 0.5f (Java syntax) or 0.5 (XML syntax).

See Also:

• Constant Field Values

WEIGHTFUNCTION1_DEFAULT_VALUE

public static final String WEIGHTFUNCTION1_DEFAULT_VALUE

SFString field named weightFunction1 has default value "CONSTANT" (Java syntax) or CONSTANT (XML syntax).

See Also:

• Constant Field Values

WEIGHTFUNCTION2_DEFAULT_VALUE

public static final String WEIGHTFUNCTION2_DEFAULT_VALUE

SFString field named weightFunction2 has default value "CONSTANT" (Java syntax) or CONSTANT (XML syntax).

See Also:

• Constant Field Values

WEIGHTTRANSFERFUNCTION1_DEFAULT_VALUE

public static final X3DTexture2DNode WEIGHTTRANSFERFUNCTION1_DEFAULT_VALUE

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

WEIGHTTRANSFERFUNCTION2_DEFAULT_VALUE

public static final X3DTexture2DNode WEIGHTTRANSFERFUNCTION2_DEFAULT_VALUE

SFNode field named weightTransferFunction2 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, this default value is provided for informational purposes only.
containerField_DEFAULT_VALUE = "renderStyle";
containerField_ALLOWED_VALUES = {"renderStyle" }; type xs:NMTOKEN

See Also:

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

fromField_ENABLED

public static final String fromField_ENABLED

fromField ROUTE name for SFBool field named enabled.

See Also:

• Constant Field Values

toField_ENABLED

public static final String toField_ENABLED

toField ROUTE name for SFBool field named enabled.

See Also:

• Constant Field Values

fromField_IS

public static final String fromField_IS

fromField ROUTE name for SFNode field named IS.

See Also:

• Constant Field Values

fromField_METADATA

public static final String fromField_METADATA

fromField ROUTE name for SFNode field named metadata.

See Also:

• Constant Field Values

toField_METADATA

public static final String toField_METADATA

toField ROUTE name for SFNode field named metadata.

See Also:

• Constant Field Values

fromField_RENDERSTYLE

public static final String fromField_RENDERSTYLE

fromField ROUTE name for SFNode field named renderStyle.

See Also:

• Constant Field Values

toField_RENDERSTYLE

public static final String toField_RENDERSTYLE

toField ROUTE name for SFNode field named renderStyle.

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

fromField_WEIGHTCONSTANT1

public static final String fromField_WEIGHTCONSTANT1

fromField ROUTE name for SFFloat field named weightConstant1.

See Also:

• Constant Field Values

toField_WEIGHTCONSTANT1

public static final String toField_WEIGHTCONSTANT1

toField ROUTE name for SFFloat field named weightConstant1.

See Also:

• Constant Field Values

fromField_WEIGHTCONSTANT2

public static final String fromField_WEIGHTCONSTANT2

fromField ROUTE name for SFFloat field named weightConstant2.

See Also:

• Constant Field Values

toField_WEIGHTCONSTANT2

public static final String toField_WEIGHTCONSTANT2

toField ROUTE name for SFFloat field named weightConstant2.

See Also:

• Constant Field Values

fromField_WEIGHTFUNCTION1

public static final String fromField_WEIGHTFUNCTION1

fromField ROUTE name for SFString field named weightFunction1.

See Also:

• Constant Field Values

toField_WEIGHTFUNCTION1

public static final String toField_WEIGHTFUNCTION1

toField ROUTE name for SFString field named weightFunction1.

See Also:

• Constant Field Values

fromField_WEIGHTFUNCTION2

public static final String fromField_WEIGHTFUNCTION2

fromField ROUTE name for SFString field named weightFunction2.

See Also:

• Constant Field Values

toField_WEIGHTFUNCTION2

public static final String toField_WEIGHTFUNCTION2

toField ROUTE name for SFString field named weightFunction2.

See Also:

• Constant Field Values

fromField_WEIGHTTRANSFERFUNCTION1

public static final String fromField_WEIGHTTRANSFERFUNCTION1

fromField ROUTE name for SFNode field named weightTransferFunction1.

See Also:

• Constant Field Values

toField_WEIGHTTRANSFERFUNCTION1

public static final String toField_WEIGHTTRANSFERFUNCTION1

toField ROUTE name for SFNode field named weightTransferFunction1.

See Also:

• Constant Field Values

fromField_WEIGHTTRANSFERFUNCTION2

public static final String fromField_WEIGHTTRANSFERFUNCTION2

fromField ROUTE name for SFNode field named weightTransferFunction2.

See Also:

• Constant Field Values

toField_WEIGHTTRANSFERFUNCTION2

public static final String toField_WEIGHTTRANSFERFUNCTION2

toField ROUTE name for SFNode field named weightTransferFunction2.

See Also:

• Constant Field Values

Constructor Details

BlendedVolumeStyle

public BlendedVolumeStyle()

Constructor for BlendedVolumeStyle to initialize member variables with default values.

BlendedVolumeStyle

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

Specified by:

getElementName in class X3DConcreteElement

Returns:

name of this element

getComponent

public final String getComponent()

Defines X3D component for the BlendedVolumeStyle 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: 3

Specified by:

getComponentLevel in class X3DConcreteElement

Returns:

default X3D component level for this element

getFieldType

public String getFieldType(String fieldName)

Indicate type corresponding to given fieldName.

Specified by:

getFieldType in class X3DConcreteElement

Parameters:

fieldName - name of field in this X3D node

Returns:

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

See Also:

• ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE

getAccessType

public String getAccessType(String fieldName)

Indicate accessType corresponding to given fieldName.

Specified by:

getAccessType in class X3DConcreteElement

Parameters:

fieldName - name of field in this X3D node

Returns:

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

See Also:

• ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE

getContainerFieldDefault

public final String getContainerFieldDefault()

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

Specified by:

getContainerFieldDefault in class X3DConcreteNode

Returns:

default containerField value

See Also:

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

initialize

public final void initialize()

Initialize all member variables to default values.

Overrides:

initialize in class X3DConcreteNode

getEnabled

public boolean getEnabled()

Provide boolean value from inputOutput SFBool field named enabled.

Tooltip: Enables/disables node operation. *

Specified by:

getEnabled in interface BlendedVolumeStyle

Specified by:

getEnabled in interface X3DComposableVolumeRenderStyleNode

Specified by:

getEnabled in interface X3DVolumeRenderStyleNode

Returns:

value of enabled field

setEnabled

public BlendedVolumeStyle setEnabled(boolean newValue)

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

Tooltip: Enables/disables node operation. *

Specified by:

setEnabled in interface BlendedVolumeStyle

Specified by:

setEnabled in interface X3DComposableVolumeRenderStyleNode

Specified by:

setEnabled in interface X3DVolumeRenderStyleNode

Parameters:

newValue - is new value for the enabled field.

Returns:

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

setEnabled

public BlendedVolumeStyle setEnabled(SFBool newValue)

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

Parameters:

newValue - is new value for the enabled field.

Returns:

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

getIS

public IS getIS()

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

Specified by:

getIS in class X3DConcreteNode

Returns:

value of IS field

See Also:

• X3D Tooltips: IS
• X3D Tooltips: connect

setIS

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

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

Utility method to clear SFNode value of IS field.

Returns:

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

Specified by:

getMetadata in interface X3DComposableVolumeRenderStyleNode

Specified by:

getMetadata in interface X3DNode

Specified by:

getMetadata in interface X3DVolumeRenderStyleNode

Returns:

value of metadata field

See Also:

• 
  
  Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
  • Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/core.html#Metadata
• X3D Scene Authoring Hints: Metadata Nodes

setMetadata

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

Specified by:

setMetadata in interface X3DComposableVolumeRenderStyleNode

Specified by:

setMetadata in interface X3DNode

Specified by:

setMetadata in interface X3DVolumeRenderStyleNode

Specified by:

setMetadata in class X3DConcreteNode

Parameters:

newValue - is new value for the metadata field.

Returns:

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

See Also:

• 
  
  Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
  • Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/core.html#Metadata
• X3D Scene Authoring Hints: Metadata Nodes

clearMetadata

public BlendedVolumeStyle clearMetadata()

Utility method to clear SFNode value of metadata field.

Returns:

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

setMetadata

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

BlendedVolumeStyle - 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 X3DComposableVolumeRenderStyleNode getRenderStyle()

Provide org.web3d.x3d.sai.VolumeRendering.X3DComposableVolumeRenderStyleNode instance (using a properly typed node) from inputOutput SFNode field renderStyle.

Specified by:

getRenderStyle in interface BlendedVolumeStyle

Returns:

value of renderStyle field

See Also:

• 
  
  Tooltip: [X3DComposableVolumeRenderStyleNode] Single contained X3DComposableVolumeRenderStyleNode node that defines specific rendering technique for data in the voxels field, and the result is blended with parent VolumeData or SegmentedVoliumeData node. *
  

setRenderStyle

public BlendedVolumeStyle setRenderStyle(X3DComposableVolumeRenderStyleNode newValue)

Accessor method to assign org.web3d.x3d.sai.VolumeRendering.X3DComposableVolumeRenderStyleNode instance (using a properly typed node) to inputOutput SFNode field renderStyle.

Specified by:

setRenderStyle in interface BlendedVolumeStyle

Parameters:

newValue - is new value for the renderStyle field.

Returns:

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

See Also:

• 
  
  Tooltip: [X3DComposableVolumeRenderStyleNode] Single contained X3DComposableVolumeRenderStyleNode node that defines specific rendering technique for data in the voxels field, and the result is blended with parent VolumeData or SegmentedVoliumeData node. *
  

clearRenderStyle

public BlendedVolumeStyle clearRenderStyle()

Utility method to clear SFNode value of renderStyle field.

Returns:

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

setRenderStyle

public BlendedVolumeStyle setRenderStyle(ProtoInstance newValue)

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

Parameters:

newValue - is new value for the renderStyle field.

Returns:

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

See Also:

• setRenderStyle(org.web3d.x3d.sai.VolumeRendering.X3DComposableVolumeRenderStyleNode)

hasRenderStyle

public boolean hasRenderStyle()

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

Returns:

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

See Also:

• getRenderStyle()
• getRenderStyleProtoInstance()

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 BlendedVolumeStyle

Returns:

value of voxels field

See Also:

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

setVoxels

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

Parameters:

newValue - is new value for the voxels field.

Returns:

BlendedVolumeStyle - 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 second set of raw voxel information utilized by corresponding rendering styles. Any number of color components (1-4) may be defined. *
  

clearVoxels

public BlendedVolumeStyle clearVoxels()

Utility method to clear SFNode value of voxels field.

Returns:

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

setVoxels

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

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

getWeightConstant1

public float getWeightConstant1()

Provide float value within allowed range of [0,1] from inputOutput SFFloat field named weightConstant1.

Tooltip: [0,1] weightConstant1 is used when weightFunction1=CONSTANT. *

Specified by:

getWeightConstant1 in interface BlendedVolumeStyle

Returns:

value of weightConstant1 field

setWeightConstant1

public BlendedVolumeStyle setWeightConstant1(float newValue)

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

Tooltip: [0,1] weightConstant1 is used when weightFunction1=CONSTANT. *

Specified by:

setWeightConstant1 in interface BlendedVolumeStyle

Parameters:

newValue - is new value for the weightConstant1 field.

Returns:

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

setWeightConstant1

public BlendedVolumeStyle setWeightConstant1(SFFloat newValue)

Assign typed object value to SFFloat weightConstant1 field, similar to setWeightConstant1(float).

Parameters:

newValue - is new value for the weightConstant1 field.

Returns:

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

setWeightConstant1

public BlendedVolumeStyle setWeightConstant1(double newValue)

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

Parameters:

newValue - is new value for field

Returns:

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

getWeightConstant2

public float getWeightConstant2()

Provide float value within allowed range of [0,1] from inputOutput SFFloat field named weightConstant2.

Tooltip: [0,1] weightConstant2 is used when weightFunction2=CONSTANT. *

Specified by:

getWeightConstant2 in interface BlendedVolumeStyle

Returns:

value of weightConstant2 field

setWeightConstant2

public BlendedVolumeStyle setWeightConstant2(float newValue)

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

Tooltip: [0,1] weightConstant2 is used when weightFunction2=CONSTANT. *

Specified by:

setWeightConstant2 in interface BlendedVolumeStyle

Parameters:

newValue - is new value for the weightConstant2 field.

Returns:

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

setWeightConstant2

public BlendedVolumeStyle setWeightConstant2(SFFloat newValue)

Assign typed object value to SFFloat weightConstant2 field, similar to setWeightConstant2(float).

Parameters:

newValue - is new value for the weightConstant2 field.

Returns:

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

setWeightConstant2

public BlendedVolumeStyle setWeightConstant2(double newValue)

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

Parameters:

newValue - is new value for field

Returns:

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

getWeightFunction1

public String getWeightFunction1()

Provide String enumeration value (baseType xs:NMTOKEN) ["CONSTANT" | "ALPHA1" | "ALPHA2" | "ONE_MINUS_ALPHA1" | "ONE_MINUS_ALPHA2" | "TABLE"] from inputOutput SFString field named weightFunction1.

Tooltip: specifies 2D textures used to determine weight values when weight function is set to TABLE.

• Warning: do not wrap extra quotation marks around these SFString enumeration values, since "quotation" "marks" are only used for MFString values.
• Hint: X3D Architecture Table 41.3, Weight function types https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/volume.html#t-WeightFunctionTypes
• Hint: X3D Architecture Table 41.4, Transfer function to weight mapping https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/volume.html#t-transferFunctionToWeightMapping

Available enumeration values for string comparison: CONSTANT, ALPHA1, ALPHA2, ONE_MINUS_ALPHA1, ONE_MINUS_ALPHA2, TABLE.

Specified by:

getWeightFunction1 in interface BlendedVolumeStyle

Returns:

value of weightFunction1 field

setWeightFunction1

public BlendedVolumeStyle setWeightFunction1(String newValue)

Accessor method to assign String enumeration value ("CONSTANT" | "ALPHA1" | "ALPHA2" | "ONE_MINUS_ALPHA1" | "ONE_MINUS_ALPHA2" | "TABLE") to inputOutput SFString field named weightFunction1.

Warning: authors can only choose from a strict list of enumeration values (CONSTANT, ALPHA1, ALPHA2, ONE_MINUS_ALPHA1, ONE_MINUS_ALPHA2, TABLE).

Tooltip: specifies 2D textures used to determine weight values when weight function is set to TABLE.

• Warning: do not wrap extra quotation marks around these SFString enumeration values, since "quotation" "marks" are only used for MFString values.
• Hint: X3D Architecture Table 41.3, Weight function types https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/volume.html#t-WeightFunctionTypes
• Hint: X3D Architecture Table 41.4, Transfer function to weight mapping https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/volume.html#t-transferFunctionToWeightMapping

Specified by:

setWeightFunction1 in interface BlendedVolumeStyle

Parameters:

newValue - is new value for the weightFunction1 field.

Returns:

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

setWeightFunction1

public BlendedVolumeStyle setWeightFunction1(SFString newValue)

Assign typed object value to SFString weightFunction1 field, similar to setWeightFunction1(String).

Parameters:

newValue - is new value for the weightFunction1 field.

Returns:

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

getWeightFunction2

public String getWeightFunction2()

Provide String enumeration value (baseType xs:NMTOKEN) ["CONSTANT" | "ALPHA1" | "ALPHA2" | "ONE_MINUS_ALPHA1" | "ONE_MINUS_ALPHA2" | "TABLE"] from inputOutput SFString field named weightFunction2.

Tooltip: specifies 2D textures used to determine weight values when weight function is set to TABLE.

• Warning: do not wrap extra quotation marks around these SFString enumeration values, since "quotation" "marks" are only used for MFString values.
• Hint: X3D Architecture Table 41.3, Weight function types https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/volume.html#t-WeightFunctionTypes
• Hint: X3D Architecture Table 41.4, Transfer function to weight mapping https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/volume.html#t-transferFunctionToWeightMapping

Available enumeration values for string comparison: CONSTANT, ALPHA1, ALPHA2, ONE_MINUS_ALPHA1, ONE_MINUS_ALPHA2, TABLE.

Specified by:

getWeightFunction2 in interface BlendedVolumeStyle

Returns:

value of weightFunction2 field

setWeightFunction2

public BlendedVolumeStyle setWeightFunction2(String newValue)

Accessor method to assign String enumeration value ("CONSTANT" | "ALPHA1" | "ALPHA2" | "ONE_MINUS_ALPHA1" | "ONE_MINUS_ALPHA2" | "TABLE") to inputOutput SFString field named weightFunction2.

Warning: authors can only choose from a strict list of enumeration values (CONSTANT, ALPHA1, ALPHA2, ONE_MINUS_ALPHA1, ONE_MINUS_ALPHA2, TABLE).

Tooltip: specifies 2D textures used to determine weight values when weight function is set to TABLE.

• Warning: do not wrap extra quotation marks around these SFString enumeration values, since "quotation" "marks" are only used for MFString values.
• Hint: X3D Architecture Table 41.3, Weight function types https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/volume.html#t-WeightFunctionTypes
• Hint: X3D Architecture Table 41.4, Transfer function to weight mapping https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/volume.html#t-transferFunctionToWeightMapping

Specified by:

setWeightFunction2 in interface BlendedVolumeStyle

Parameters:

newValue - is new value for the weightFunction2 field.

Returns:

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

setWeightFunction2

public BlendedVolumeStyle setWeightFunction2(SFString newValue)

Assign typed object value to SFString weightFunction2 field, similar to setWeightFunction2(String).

Parameters:

newValue - is new value for the weightFunction2 field.

Returns:

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

getWeightTransferFunction1

public X3DTexture2DNode getWeightTransferFunction1()

Provide org.web3d.x3d.sai.Texturing.X3DTexture2DNode instance (using a properly typed node) from inputOutput SFNode field weightTransferFunction1.

Specified by:

getWeightTransferFunction1 in interface BlendedVolumeStyle

Returns:

value of weightTransferFunction1 field

See Also:

• 
  
  Tooltip: [X3DTexture2DNode] The weightTransferFunction1 and weightTransferFunction2 fields specify two-dimensional textures that are used to determine the weight values when the weight function is set to "TABLE". The output weight value depends on the number of components in the textures as specified in Table 41.4.
  • Hint: https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/volume.html#t-transferFunctionToWeightMapping

setWeightTransferFunction1

public BlendedVolumeStyle setWeightTransferFunction1(X3DTexture2DNode newValue)

Accessor method to assign org.web3d.x3d.sai.Texturing.X3DTexture2DNode instance (using a properly typed node) to inputOutput SFNode field weightTransferFunction1.

Specified by:

setWeightTransferFunction1 in interface BlendedVolumeStyle

Parameters:

newValue - is new value for the weightTransferFunction1 field.

Returns:

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

See Also:

• 
  
  Tooltip: [X3DTexture2DNode] The weightTransferFunction1 and weightTransferFunction2 fields specify two-dimensional textures that are used to determine the weight values when the weight function is set to "TABLE". The output weight value depends on the number of components in the textures as specified in Table 41.4.
  • Hint: https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/volume.html#t-transferFunctionToWeightMapping

clearWeightTransferFunction1

public BlendedVolumeStyle clearWeightTransferFunction1()

Utility method to clear SFNode value of weightTransferFunction1 field.

Returns:

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

setWeightTransferFunction1

public BlendedVolumeStyle setWeightTransferFunction1(ProtoInstance newValue)

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

Parameters:

newValue - is new value for the weightTransferFunction1 field.

Returns:

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

See Also:

• setWeightTransferFunction1(org.web3d.x3d.sai.Texturing.X3DTexture2DNode)

hasWeightTransferFunction1

public boolean hasWeightTransferFunction1()

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

Returns:

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

See Also:

• getWeightTransferFunction1()
• getWeightTransferFunction1ProtoInstance()

getWeightTransferFunction2

public X3DTexture2DNode getWeightTransferFunction2()

Provide org.web3d.x3d.sai.Texturing.X3DTexture2DNode instance (using a properly typed node) from inputOutput SFNode field weightTransferFunction2.

Specified by:

getWeightTransferFunction2 in interface BlendedVolumeStyle

Returns:

value of weightTransferFunction2 field

See Also:

• 
  
  Tooltip: [X3DTexture2DNode] The weightTransferFunction1 and weightTransferFunction2 fields specify two-dimensional textures that are used to determine the weight values when the weight function is set to "TABLE". The output weight value depends on the number of components in the textures as specified in Table 41.4.
  • Hint: https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/volume.html#t-transferFunctionToWeightMapping

setWeightTransferFunction2

public BlendedVolumeStyle setWeightTransferFunction2(X3DTexture2DNode newValue)

Accessor method to assign org.web3d.x3d.sai.Texturing.X3DTexture2DNode instance (using a properly typed node) to inputOutput SFNode field weightTransferFunction2.

Specified by:

setWeightTransferFunction2 in interface BlendedVolumeStyle

Parameters:

newValue - is new value for the weightTransferFunction2 field.

Returns:

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

See Also:

• 
  
  Tooltip: [X3DTexture2DNode] The weightTransferFunction1 and weightTransferFunction2 fields specify two-dimensional textures that are used to determine the weight values when the weight function is set to "TABLE". The output weight value depends on the number of components in the textures as specified in Table 41.4.
  • Hint: https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/volume.html#t-transferFunctionToWeightMapping

clearWeightTransferFunction2

public BlendedVolumeStyle clearWeightTransferFunction2()

Utility method to clear SFNode value of weightTransferFunction2 field.

Returns:

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

setWeightTransferFunction2

public BlendedVolumeStyle setWeightTransferFunction2(ProtoInstance newValue)

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

Parameters:

newValue - is new value for the weightTransferFunction2 field.

Returns:

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

See Also:

• setWeightTransferFunction2(org.web3d.x3d.sai.Texturing.X3DTexture2DNode)

hasWeightTransferFunction2

public boolean hasWeightTransferFunction2()

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

Returns:

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

See Also:

• getWeightTransferFunction2()
• getWeightTransferFunction2ProtoInstance()

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

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

setDEF

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

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

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

setUSE

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

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

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

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

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

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

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

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

setUSE

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

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

addComments

public BlendedVolumeStyle addComments(String newComment)

Add comment as String to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComment - initial value

Returns:

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

Add comments as String[] array to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComments - array of comments

Returns:

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

addComments

public BlendedVolumeStyle addComments(CommentsBlock newCommentsBlock)

Add CommentsBlock to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newCommentsBlock - block of comments to add

Returns:

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

toStringX3D

public String toStringX3D(int indentLevel)

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

Specified by:

toStringX3D in class X3DConcreteElement

Parameters:

indentLevel - number of levels of indentation for this element

Returns:

X3D string

See Also:

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

toStringClassicVRML

public String toStringClassicVRML(int indentLevel)

Recursive method to provide ClassicVRML string serialization.

Specified by:

toStringClassicVRML in class X3DConcreteElement

Parameters:

indentLevel - number of levels of indentation for this element

Returns:

ClassicVRML string

See Also:

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

toStringVRML97

public String toStringVRML97(int indentLevel)

Recursive method to provide VRML97 string serialization.

Specified by:

toStringVRML97 in class X3DConcreteElement

Parameters:

indentLevel - number of levels of indentation for this element

Returns:

VRML97 string

See Also:

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

findElementByNameValue

public X3DConcreteElement findElementByNameValue(String nameValue)

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

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

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

Specified by:

findElementByNameValue in class X3DConcreteElement

Parameters:

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

Returns:

object reference to found element, null otherwise

See Also:

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

findElementByNameValue

public X3DConcreteElement findElementByNameValue(String nameValue,
 String elementName)

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

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

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

Specified by:

findElementByNameValue in class X3DConcreteElement

Parameters:

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

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

Returns:

object reference to found element, null otherwise

See Also:

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

hasElementByNameValue

public boolean hasElementByNameValue(String nameValue,
 String elementName)

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

Parameters:

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

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

Returns:

whether node is found

See Also:

• findElementByNameValue(String, String)

findNodeByDEF

public X3DConcreteNode findNodeByDEF(String DEFvalue)

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

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

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

Specified by:

findNodeByDEF in class X3DConcreteElement

Parameters:

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

Returns:

object reference to found node, null otherwise

See Also:

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

hasNodeByDEF

public boolean hasNodeByDEF(String DEFvalue)

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

Parameters:

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

Returns:

whether node is found

See Also:

• findNodeByDEF(String)

validate

public String validate()

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

Specified by:

validate in class X3DConcreteElement

Returns:

validation results (if any)