Package org.web3d.x3d.jsail.VolumeRendering

Class ShadedVolumeStyle

java.lang.Object

org.web3d.x3d.jsail.X3DConcreteElement

org.web3d.x3d.jsail.X3DConcreteNode

org.web3d.x3d.jsail.VolumeRendering.ShadedVolumeStyle

All Implemented Interfaces:

X3DNode, ShadedVolumeStyle, X3DComposableVolumeRenderStyleNode, X3DVolumeRenderStyleNode

public class ShadedVolumeStyle
extends X3DConcreteNode
implements ShadedVolumeStyle

All fields fully supported except shadows supported with at least Phong shading at level 3. All fields fully supported with at least Phong shading and Henyey-Greenstein phase function, shadows fully supported at level 4.

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. X3D node tooltip: (X3D version 3.3 or later) [X3DComposableVolumeRenderStyleNode] ShadedVolumeStyle applies Blinn-Phong illumination model to volume rendering. Hint: ShadedVolumeStyle can contain a single Texture3D node with containerField='surfaceNormals' and a single Material node. Warning: requires X3D profile='Full' or else include <component name='VolumeRendering' level='3'/> or level='4' to include shadows. *


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: ShadedVolumeStyle
• X3D Tooltips: ShadedVolumeStyle
• 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 ShadedVolumeStyle 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_LIGHTING	fromField ROUTE name for SFBool field named lighting.
static final String	fromField_MATERIAL	fromField ROUTE name for SFNode field named material.
static final String	fromField_METADATA	fromField ROUTE name for SFNode field named metadata.
static final String	fromField_SHADOWS	fromField ROUTE name for SFBool field named shadows.
static final String	fromField_SURFACENORMALS	fromField ROUTE name for SFNode field named surfaceNormals.
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 boolean	LIGHTING_DEFAULT_VALUE	SFBool field named lighting has default value false (Java syntax) or false (XML syntax).
static final X3DMaterialNode	MATERIAL_DEFAULT_VALUE	SFNode field named material has default value null (Java syntax) or NULL (XML syntax).
static final X3DMetadataObject	METADATA_DEFAULT_VALUE	SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).
static final String	NAME	String constant NAME provides name of this element: ShadedVolumeStyle.
static final String	PHASEFUNCTION_DEFAULT_VALUE	SFString field named phaseFunction has default value "Henyey-Greenstein" (Java syntax) or Henyey-Greenstein (XML syntax).
static final String	PHASEFUNCTION_HENYEY_GREENSTEIN	Tooltip: Henyey-Greenstein phase function for scattering model.
static final String	PHASEFUNCTION_NONE	Tooltip: no scattering.
static final boolean	SHADOWS_DEFAULT_VALUE	SFBool field named shadows has default value false (Java syntax) or false (XML syntax).
static final X3DTexture3DNode	SURFACENORMALS_DEFAULT_VALUE	SFNode field named surfaceNormals 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_LIGHTING	toField ROUTE name for SFBool field named lighting.
static final String	toField_MATERIAL	toField ROUTE name for SFNode field named material.
static final String	toField_METADATA	toField ROUTE name for SFNode field named metadata.
static final String	toField_SHADOWS	toField ROUTE name for SFBool field named shadows.
static final String	toField_SURFACENORMALS	toField ROUTE name for SFNode field named surfaceNormals.

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

containerField_ALTERNATE_VALUES, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE

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

CLASS_DEFAULT_VALUE, ID_DEFAULT_VALUE, STYLE_DEFAULT_VALUE, validationResult

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
ShadedVolumeStyle	addComments(String newComment)	Add comment as String to contained commentsList.
ShadedVolumeStyle	addComments(String[] newComments)	Add comments as String[] array to contained commentsList.
ShadedVolumeStyle	addComments(CommentsBlock newCommentsBlock)	Add CommentsBlock to contained commentsList.
ShadedVolumeStyle	clearIS()	Utility method to clear SFNode value of IS field.
ShadedVolumeStyle	clearMaterial()	Utility method to clear SFNode value of material field.
ShadedVolumeStyle	clearMetadata()	Utility method to clear SFNode value of metadata field.
ShadedVolumeStyle	clearSurfaceNormals()	Utility method to clear SFNode value of surfaceNormals 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 ShadedVolumeStyle 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: ShadedVolumeStyle
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.
boolean	getLighting()	Provide boolean value from inputOutput SFBool field named lighting.
X3DMaterialNode	getMaterial()	Provide org.web3d.x3d.sai.Shape.X3DMaterialNode instance (using a properly typed node) from inputOutput SFNode field material.
X3DMetadataObject	getMetadata()	Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
String	getPhaseFunction()	Provide String enumeration value (baseType SFString) ["Henyey-Greenstein" | "NONE" | 'etc.'] from initializeOnly SFString field named phaseFunction.
boolean	getShadows()	Provide boolean value from inputOutput SFBool field named shadows.
X3DTexture3DNode	getSurfaceNormals()	Provide org.web3d.x3d.sai.Texturing3D.X3DTexture3DNode instance (using a properly typed node) from inputOutput SFNode field surfaceNormals.
String	getUSE()	Provide String value from inputOutput SFString field named USE.
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	hasMaterial()	Indicate whether an object is available for inputOutput SFNode field material.
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	hasSurfaceNormals()	Indicate whether an object is available for inputOutput SFNode field surfaceNormals.
final void	initialize()	Initialize all member variables to default values.
final ShadedVolumeStyle	setCssClass(String newValue)	Accessor method to assign String value to inputOutput SFString field named class.
ShadedVolumeStyle	setCssClass(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssClass(String). // #0.e
final ShadedVolumeStyle	setCssStyle(String newValue)	Accessor method to assign String value to inputOutput SFString field named style.
ShadedVolumeStyle	setCssStyle(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssStyle(String). // #0.e
final ShadedVolumeStyle	setDEF(String newValue)	Accessor method to assign String value to inputOutput SFString field named DEF.
ShadedVolumeStyle	setDEF(SFString newValue)	Assign typed object value to SFString DEF field, similar to setDEF(String). // #0.e
ShadedVolumeStyle	setEnabled(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named enabled.
ShadedVolumeStyle	setEnabled(SFBool newValue)	Assign typed object value to SFBool enabled field, similar to setEnabled(boolean). // #0.e
final ShadedVolumeStyle	setHtmlID(String newValue)	Accessor method to assign String value to inputOutput SFString field named id.
ShadedVolumeStyle	setHtmlID(SFString newValue)	Assign typed object value to SFString HtmlID field, similar to setHtmlID(String). // #0.e
ShadedVolumeStyle	setIS(IS newValue)	Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
ShadedVolumeStyle	setLighting(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named lighting.
ShadedVolumeStyle	setLighting(SFBool newValue)	Assign typed object value to SFBool lighting field, similar to setLighting(boolean). // #0.e
ShadedVolumeStyle	setMaterial(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field material.
ShadedVolumeStyle	setMaterial(X3DMaterialNode newValue)	Accessor method to assign org.web3d.x3d.sai.Shape.X3DMaterialNode instance (using a properly typed node) to inputOutput SFNode field material.
ShadedVolumeStyle	setMetadata(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
ShadedVolumeStyle	setMetadata(X3DMetadataObject newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
ShadedVolumeStyle	setPhaseFunction(String newValue)	Accessor method to assign String enumeration value ("Henyey-Greenstein" | "NONE") to initializeOnly SFString field named phaseFunction.
ShadedVolumeStyle	setPhaseFunction(SFString newValue)	Assign typed object value to SFString phaseFunction field, similar to setPhaseFunction(String). // #0.e
ShadedVolumeStyle	setShadows(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named shadows.
ShadedVolumeStyle	setShadows(SFBool newValue)	Assign typed object value to SFBool shadows field, similar to setShadows(boolean). // #0.e
ShadedVolumeStyle	setSurfaceNormals(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field surfaceNormals.
ShadedVolumeStyle	setSurfaceNormals(X3DTexture3DNode newValue)	Accessor method to assign org.web3d.x3d.sai.Texturing3D.X3DTexture3DNode instance (using a properly typed node) to inputOutput SFNode field surfaceNormals.
final ShadedVolumeStyle	setUSE(String newValue)	Accessor method to assign String value to inputOutput SFString field named USE.
ShadedVolumeStyle	setUSE(SFString newValue)	Assign typed object value to SFString USE field, similar to setUSE(String). // #0.e
ShadedVolumeStyle	setUSE(ShadedVolumeStyle DEFnode)	Assign a USE reference to another DEF node of same node type, similar to setUSE(String).
String	toStringClassicVRML(int indentLevel)	Recursive method to provide ClassicVRML string serialization.
String	toStringVRML97(int indentLevel)	Recursive method to provide VRML97 string serialization.
String	toStringX3D(int indentLevel)	Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
String	validate()	Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.

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

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

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

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

Methods inherited from class java.lang.Object

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

Field Details

PHASEFUNCTION_HENYEY_GREENSTEIN

public static final String PHASEFUNCTION_HENYEY_GREENSTEIN

Tooltip: Henyey-Greenstein phase function for scattering model. SFString field named phaseFunction with X3DUOM simpleType phaseFunctionValues and with X3DUOM baseType SFString can equal this value "Henyey-Greenstein" (Java syntax) or Henyey-Greenstein (XML syntax).

See Also:

• XML Schema: phaseFunctionValues
• Constant Field Values

PHASEFUNCTION_NONE

public static final String PHASEFUNCTION_NONE

Tooltip: no scattering. SFString field named phaseFunction with X3DUOM simpleType phaseFunctionValues and with X3DUOM baseType SFString can equal this value "NONE" (Java syntax) or NONE (XML syntax).

See Also:

• XML Schema: phaseFunctionValues
• Constant Field Values

NAME

public static final String NAME

String constant NAME provides name of this element: ShadedVolumeStyle.

See Also:

• Constant Field Values

COMPONENT

public static final String COMPONENT

String constant COMPONENT defines X3D component for the ShadedVolumeStyle 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).

LIGHTING_DEFAULT_VALUE

public static final boolean LIGHTING_DEFAULT_VALUE

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

See Also:

• Constant Field Values

MATERIAL_DEFAULT_VALUE

public static final X3DMaterialNode MATERIAL_DEFAULT_VALUE

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

PHASEFUNCTION_DEFAULT_VALUE

public static final String PHASEFUNCTION_DEFAULT_VALUE

SFString field named phaseFunction has default value "Henyey-Greenstein" (Java syntax) or Henyey-Greenstein (XML syntax).

See Also:

• Constant Field Values

SHADOWS_DEFAULT_VALUE

public static final boolean SHADOWS_DEFAULT_VALUE

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

See Also:

• Constant Field Values

SURFACENORMALS_DEFAULT_VALUE

public static final X3DTexture3DNode SURFACENORMALS_DEFAULT_VALUE

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

containerField_DEFAULT_VALUE

public static final String containerField_DEFAULT_VALUE

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

See Also:

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

fromField_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_LIGHTING

public static final String fromField_LIGHTING

fromField ROUTE name for SFBool field named lighting.

See Also:

• Constant Field Values

toField_LIGHTING

public static final String toField_LIGHTING

toField ROUTE name for SFBool field named lighting.

See Also:

• Constant Field Values

fromField_MATERIAL

public static final String fromField_MATERIAL

fromField ROUTE name for SFNode field named material.

See Also:

• Constant Field Values

toField_MATERIAL

public static final String toField_MATERIAL

toField ROUTE name for SFNode field named material.

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_SHADOWS

public static final String fromField_SHADOWS

fromField ROUTE name for SFBool field named shadows.

See Also:

• Constant Field Values

toField_SHADOWS

public static final String toField_SHADOWS

toField ROUTE name for SFBool field named shadows.

See Also:

• Constant Field Values

fromField_SURFACENORMALS

public static final String fromField_SURFACENORMALS

fromField ROUTE name for SFNode field named surfaceNormals.

See Also:

• Constant Field Values

toField_SURFACENORMALS

public static final String toField_SURFACENORMALS

toField ROUTE name for SFNode field named surfaceNormals.

See Also:

• Constant Field Values

Constructor Details

ShadedVolumeStyle

public ShadedVolumeStyle()

Constructor for ShadedVolumeStyle to initialize member variables with default values.

ShadedVolumeStyle

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

Specified by:

getElementName in class X3DConcreteElement

Returns:

name of this element

getComponent

public final String getComponent()

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

Specified by:

getContainerFieldDefault in class X3DConcreteNode

Returns:

default containerField value

See Also:

• X3D Scene Authoring Hints: containerField
• X3D Unified Object Model (X3DUOM)

initialize

public final void initialize()

Initialize all member variables to default values.

Overrides:

initialize in class X3DConcreteNode

getEnabled

public boolean getEnabled()

Provide boolean value from inputOutput SFBool field named enabled.

Tooltip: Enables/disables node operation. *

Specified by:

getEnabled in interface ShadedVolumeStyle

Specified by:

getEnabled in interface X3DComposableVolumeRenderStyleNode

Specified by:

getEnabled in interface X3DVolumeRenderStyleNode

Returns:

value of enabled field

setEnabled

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

Specified by:

setEnabled in interface X3DComposableVolumeRenderStyleNode

Specified by:

setEnabled in interface X3DVolumeRenderStyleNode

Parameters:

newValue - is new value for the enabled field.

Returns:

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

setEnabled

public ShadedVolumeStyle setEnabled(SFBool newValue)

Assign typed object value to SFBool enabled field, similar to setEnabled(boolean). // #0.e

Parameters:

newValue - is new value for the enabled field.

Returns:

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

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

Utility method to clear SFNode value of IS field.

Returns:

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

getLighting

public boolean getLighting()

Provide boolean value from inputOutput SFBool field named lighting.

Tooltip: Whether rendering calculates and applies shading effects to visual output. *

Specified by:

getLighting in interface ShadedVolumeStyle

Returns:

value of lighting field

setLighting

public ShadedVolumeStyle setLighting(boolean newValue)

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

Tooltip: Whether rendering calculates and applies shading effects to visual output. *

Specified by:

setLighting in interface ShadedVolumeStyle

Parameters:

newValue - is new value for the lighting field.

Returns:

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

setLighting

public ShadedVolumeStyle setLighting(SFBool newValue)

Assign typed object value to SFBool lighting field, similar to setLighting(boolean). // #0.e

Parameters:

newValue - is new value for the lighting field.

Returns:

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

getMaterial

public X3DMaterialNode getMaterial()

Provide org.web3d.x3d.sai.Shape.X3DMaterialNode instance (using a properly typed node) from inputOutput SFNode field material.

Specified by:

getMaterial in interface ShadedVolumeStyle

Returns:

value of material field

See Also:

• 
  
  Tooltip: [X3DMaterialNode] Colour and opacity is determined based on whether a value has been specified for the material field. *
  

setMaterial

public ShadedVolumeStyle setMaterial(X3DMaterialNode newValue)

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

Specified by:

setMaterial in interface ShadedVolumeStyle

Parameters:

newValue - is new value for the material field.

Returns:

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

See Also:

• 
  
  Tooltip: [X3DMaterialNode] Colour and opacity is determined based on whether a value has been specified for the material field. *
  

clearMaterial

public ShadedVolumeStyle clearMaterial()

Utility method to clear SFNode value of material field.

Returns:

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

setMaterial

public ShadedVolumeStyle setMaterial(ProtoInstance newValue)

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

Parameters:

newValue - is new value for the material field.

Returns:

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

See Also:

• setMaterial(org.web3d.x3d.sai.Shape.X3DMaterialNode)

hasMaterial

public boolean hasMaterial()

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

Returns:

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

See Also:

• getMaterial()
• getMaterialProtoInstance()

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 ShadedVolumeStyle

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 <a href="https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS//Part01/components/core.html#Metadata" target="_blank">https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS//Part01/components/core.html#Metadata</a> *
  
• X3D Scene Authoring Hints: Metadata Nodes

setMetadata

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

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:

ShadedVolumeStyle - 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 <a href="https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS//Part01/components/core.html#Metadata" target="_blank">https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS//Part01/components/core.html#Metadata</a> *
  
• X3D Scene Authoring Hints: Metadata Nodes

clearMetadata

public ShadedVolumeStyle clearMetadata()

Utility method to clear SFNode value of metadata field.

Returns:

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

setMetadata

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

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

getPhaseFunction

public String getPhaseFunction()

Provide String enumeration value (baseType SFString) ["Henyey-Greenstein" | "NONE" | 'etc.'] from initializeOnly SFString field named phaseFunction.

Tooltip: define scattering model for implementations using global illumination (NONE or Henyey-Greenstein phase function).#10;Warning: do not wrap extra quotation marks around these SFString enumeration values, since "quotation" "marks" are only used for MFString values. *


Available enumeration values for string comparison: HENYEY_GREENSTEIN, NONE.

Specified by:

getPhaseFunction in interface ShadedVolumeStyle

Returns:

value of phaseFunction field

setPhaseFunction

public ShadedVolumeStyle setPhaseFunction(String newValue)

Accessor method to assign String enumeration value ("Henyey-Greenstein" | "NONE") to initializeOnly SFString field named phaseFunction.

Hint: authors have option to choose from an extendible list of predefined enumeration values (HENYEY_GREENSTEIN, NONE).

Tooltip: define scattering model for implementations using global illumination (NONE or Henyey-Greenstein phase function).#10;Warning: do not wrap extra quotation marks around these SFString enumeration values, since "quotation" "marks" are only used for MFString values. *

Specified by:

setPhaseFunction in interface ShadedVolumeStyle

Parameters:

newValue - is new value for the phaseFunction field.

Returns:

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

setPhaseFunction

public ShadedVolumeStyle setPhaseFunction(SFString newValue)

Assign typed object value to SFString phaseFunction field, similar to setPhaseFunction(String). // #0.e

Parameters:

newValue - is new value for the phaseFunction field.

Returns:

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

getShadows

public boolean getShadows()

Provide boolean value from inputOutput SFBool field named shadows.

Tooltip: Whether rendering calculates and applies shadows to visual output (using global illumination model). *

Specified by:

getShadows in interface ShadedVolumeStyle

Returns:

value of shadows field

setShadows

public ShadedVolumeStyle setShadows(boolean newValue)

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

Tooltip: Whether rendering calculates and applies shadows to visual output (using global illumination model). *

Specified by:

setShadows in interface ShadedVolumeStyle

Parameters:

newValue - is new value for the shadows field.

Returns:

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

setShadows

public ShadedVolumeStyle setShadows(SFBool newValue)

Assign typed object value to SFBool shadows field, similar to setShadows(boolean). // #0.e

Parameters:

newValue - is new value for the shadows field.

Returns:

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

getSurfaceNormals

public X3DTexture3DNode getSurfaceNormals()

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

Specified by:

getSurfaceNormals in interface ShadedVolumeStyle

Returns:

value of surfaceNormals field

See Also:

• 
  
  Tooltip: [X3DTexture3DNode] The surfaceNormals field contains a 3D texture with at least three component values. Each voxel in the texture represents the surface normal direction for the corresponding voxel in the base data source. *
  

setSurfaceNormals

public ShadedVolumeStyle setSurfaceNormals(X3DTexture3DNode newValue)

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

Specified by:

setSurfaceNormals in interface ShadedVolumeStyle

Parameters:

newValue - is new value for the surfaceNormals field.

Returns:

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

See Also:

• 
  
  Tooltip: [X3DTexture3DNode] The surfaceNormals field contains a 3D texture with at least three component values. Each voxel in the texture represents the surface normal direction for the corresponding voxel in the base data source. *
  

clearSurfaceNormals

public ShadedVolumeStyle clearSurfaceNormals()

Utility method to clear SFNode value of surfaceNormals field.

Returns:

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

setSurfaceNormals

public ShadedVolumeStyle setSurfaceNormals(ProtoInstance newValue)

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

Parameters:

newValue - is new value for the surfaceNormals field.

Returns:

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

See Also:

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

hasSurfaceNormals

public boolean hasSurfaceNormals()

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

Returns:

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

See Also:

• getSurfaceNormals()
• getSurfaceNormalsProtoInstance()

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 <a href="https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions" target="_blank">https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions</a> *

Overrides:

getDEF in class X3DConcreteNode

Returns:

value of DEF field

See Also:

• X3D Scene Authoring Hints: Naming Conventions

setDEF

public final ShadedVolumeStyle 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 <a href="https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions" target="_blank">https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions</a> *


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:

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

setDEF

public ShadedVolumeStyle setDEF(SFString newValue)

Assign typed object value to SFString DEF field, similar to setDEF(String). // #0.e

Parameters:

newValue - is new value for the DEF field.

Returns:

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

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

setUSE

public ShadedVolumeStyle setUSE(SFString newValue)

Assign typed object value to SFString USE field, similar to setUSE(String). // #0.e

Parameters:

newValue - is new value for the USE field.

Returns:

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

ShadedVolumeStyle - 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 ShadedVolumeStyle setCssClass(SFString newValue)

Assign typed object value to SFString cssClass field, similar to setCssClass(String). // #0.e

Parameters:

newValue - is new value for the class field.

Returns:

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

ShadedVolumeStyle - 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 ShadedVolumeStyle setHtmlID(SFString newValue)

Assign typed object value to SFString HtmlID field, similar to setHtmlID(String). // #0.e

Parameters:

newValue - is new value for the id field.

Returns:

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

ShadedVolumeStyle - 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 ShadedVolumeStyle setCssStyle(SFString newValue)

Assign typed object value to SFString cssClass field, similar to setCssStyle(String). // #0.e

Parameters:

newValue - is new value for the style field.

Returns:

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

setUSE

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

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

addComments

public ShadedVolumeStyle addComments(String newComment)

Add comment as String to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComment - initial value

Returns:

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

Add comments as String[] array to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComments - array of comments

Returns:

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

addComments

public ShadedVolumeStyle addComments(CommentsBlock newCommentsBlock)

Add CommentsBlock to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newCommentsBlock - block of comments to add

Returns:

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