org.web3d.x3d.jsail.VolumeRendering

Class ToneMappedVolumeStyleObject

java.lang.Object

org.web3d.x3d.jsail.X3DConcreteElement

org.web3d.x3d.jsail.X3DConcreteNode

org.web3d.x3d.jsail.VolumeRendering.ToneMappedVolumeStyleObject

All Implemented Interfaces:

X3DNode, ToneMappedVolumeStyle, X3DComposableVolumeRenderStyleNode, X3DVolumeRenderStyleNode

public class ToneMappedVolumeStyleObject
extends X3DConcreteNode
implements ToneMappedVolumeStyle

X3D node tooltip: (X3D version 3.3 or later) [X3DComposableVolumeRenderStyleNode] ToneMappedVolumeStyle specifies that volumetric data is rendered with Gooch shading model of two-toned warm/cool coloring.

• Hint: ToneMappedVolumeStyle can contain a single Texture3D node with containerField='surfaceNormals'

Note that SFColorObject provides a variety of color constants.

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: ToneMappedVolumeStyle, X3D Tooltips: ToneMappedVolumeStyle, X3D Scene Authoring Hints: Volume

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COMPONENT String constant COMPONENT defines X3D component for the ToneMappedVolumeStyle element: VolumeRendering
static java.lang.String	containerField_DEFAULT_VALUE containerField describes typical field relationship of a node to its parent.
static float[]	COOLCOLOR_DEFAULT_VALUE SFColorRGBA field named coolColor has default value {0f,0f,1f,0f} (Java syntax) or 0 0 1 0 (XML syntax).
static boolean	ENABLED_DEFAULT_VALUE SFBool field named enabled has default value true (Java syntax) or true (XML syntax).
static java.lang.String	fromField_COOLCOLOR fromField ROUTE name for SFColorRGBA field named coolColor.
static java.lang.String	fromField_ENABLED fromField ROUTE name for SFBool field named enabled.
static java.lang.String	fromField_METADATA fromField ROUTE name for SFNode field named metadata.
static java.lang.String	fromField_SURFACENORMALS fromField ROUTE name for SFNode field named surfaceNormals.
static java.lang.String	fromField_WARMCOLOR fromField ROUTE name for SFColorRGBA field named warmColor.
static int	LEVEL Integer constant LEVEL provides default X3D VolumeRendering component level for this element: 2
static java.lang.String	NAME String constant NAME provides name of this element: ToneMappedVolumeStyle.
static java.lang.String	toField_COOLCOLOR toField ROUTE name for SFColorRGBA field named coolColor.
static java.lang.String	toField_ENABLED toField ROUTE name for SFBool field named enabled.
static java.lang.String	toField_METADATA toField ROUTE name for SFNode field named metadata.
static java.lang.String	toField_SURFACENORMALS toField ROUTE name for SFNode field named surfaceNormals.
static java.lang.String	toField_WARMCOLOR toField ROUTE name for SFColorRGBA field named warmColor.
static float[]	WARMCOLOR_DEFAULT_VALUE SFColorRGBA field named warmColor has default value {1f,1f,0f,0f} (Java syntax) or 1 1 0 0 (XML syntax).

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

CLASS_DEFAULT_VALUE, containerField_ALTERNATE_VALUES, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE

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

validationResult

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ToneMappedVolumeStyleObject	addComments(CommentsBlock newCommentsBlock) Add CommentsBlock to contained commentsList.
ToneMappedVolumeStyleObject	addComments(java.lang.String newComment) Add comment as String to contained commentsList.
ToneMappedVolumeStyleObject	addComments(java.lang.String[] newComments) Add comments as String[] array to contained commentsList.
ToneMappedVolumeStyleObject	clearMetadata() Utility method to clear SFNode value of metadata field.
ToneMappedVolumeStyleObject	clearSurfaceNormals() Utility method to clear SFNode value of surfaceNormals field.
X3DConcreteElement	findElementByNameValue(java.lang.String nameValue) Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.
X3DConcreteElement	findElementByNameValue(java.lang.String nameValue, java.lang.String elementName) Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.
X3DConcreteNode	findNodeByDEF(java.lang.String DEFvalue) Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
java.lang.String	getAccessType(java.lang.String fieldName) Indicate accessType corresponding to given fieldName.
java.lang.String	getComponent() Defines X3D component for the ToneMappedVolumeStyle element: VolumeRendering
int	getComponentLevel() Provides default X3D component level for this element: 2
java.lang.String	getContainerFieldDefault() containerField describes typical field relationship of a node to its parent.
float[]	getCoolColor() Provide array of 4-tuple float results using RGBA values [0..1] using RGBA values [0..1] from inputOutput SFColorRGBA field named coolColor.
java.lang.String	getElementName() Provides name of this element: ToneMappedVolumeStyle
boolean	getEnabled() Provide boolean value from inputOutput SFBool field named enabled.
java.lang.String	getFieldType(java.lang.String fieldName) Indicate type corresponding to given fieldName.
ISObject	getIS() Provide field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes.
X3DMetadataObject	getMetadata() Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
X3DTexture3DNode	getSurfaceNormals() Provide X3DTexture3DNode instance (using a properly typed node) from inputOutput SFNode field surfaceNormals.
float[]	getWarmColor() Provide array of 4-tuple float results using RGBA values [0..1] using RGBA values [0..1] from inputOutput SFColorRGBA field named warmColor.
boolean	hasElementByNameValue(java.lang.String nameValue, java.lang.String elementName) Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
boolean	hasMetadata() Indicate whether an object is available for inputOutput SFNode field metadata.
boolean	hasNodeByDEF(java.lang.String DEFvalue) Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
boolean	hasSurfaceNormals() Indicate whether an object is available for inputOutput SFNode field surfaceNormals.
void	initialize() Initialize all member variables to default values.
ToneMappedVolumeStyleObject	setCoolColor(float[] newValue) Assign 4-tuple float array using RGBA values [0..1] using RGBA values [0..1] to inputOutput SFColorRGBA field named coolColor.
ToneMappedVolumeStyleObject	setCoolColor(float red, float green, float blue, float alpha) Assign values to SFColorRGBA coolColor field, similar to setCoolColor(float[]).
ToneMappedVolumeStyleObject	setCoolColor(SFColorRGBAObject newValue) Assign typed object value to SFColorRGBA coolColor field, similar to setCoolColor(float[]).
ToneMappedVolumeStyleObject	setCssClass(SFStringObject newValue) Assign typed object value to SFString cssClass field, similar to setCssClass(String).
ToneMappedVolumeStyleObject	setCssClass(java.lang.String newValue) Assign String value to inputOutput SFString field named class.
ToneMappedVolumeStyleObject	setDEF(SFStringObject newValue) Assign typed object value to SFString DEF field, similar to setDEF(String).
ToneMappedVolumeStyleObject	setDEF(java.lang.String newValue) Assign String value to inputOutput SFString field named DEF.
ToneMappedVolumeStyleObject	setEnabled(boolean newValue) Assign boolean value to inputOutput SFBool field named enabled.
ToneMappedVolumeStyleObject	setEnabled(SFBoolObject newValue) Assign typed object value to SFBool enabled field, similar to setEnabled(boolean).
ToneMappedVolumeStyleObject	setIS(ISObject newValue) Assign field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes.
ToneMappedVolumeStyleObject	setMetadata(ProtoInstanceObject newValue) Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
ToneMappedVolumeStyleObject	setMetadata(X3DMetadataObject newValue) Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
ToneMappedVolumeStyleObject	setSurfaceNormals(ProtoInstanceObject newValue) Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field surfaceNormals.
ToneMappedVolumeStyleObject	setSurfaceNormals(X3DTexture3DNode newValue) Assign X3DTexture3DNode instance (using a properly typed node) to inputOutput SFNode field surfaceNormals.
ToneMappedVolumeStyleObject	setUSE(SFStringObject newValue) Assign typed object value to SFString USE field, similar to setUSE(String).
ToneMappedVolumeStyleObject	setUSE(java.lang.String newValue) Assign String value to inputOutput SFString field named USE.
ToneMappedVolumeStyleObject	setUSE(ToneMappedVolumeStyleObject DEFnode) Assign a USE reference to another DEF node of same node type, similar to setUSE(String).
ToneMappedVolumeStyleObject	setWarmColor(float[] newValue) Assign 4-tuple float array using RGBA values [0..1] using RGBA values [0..1] to inputOutput SFColorRGBA field named warmColor.
ToneMappedVolumeStyleObject	setWarmColor(float red, float green, float blue, float alpha) Assign values to SFColorRGBA warmColor field, similar to setWarmColor(float[]).
ToneMappedVolumeStyleObject	setWarmColor(SFColorRGBAObject newValue) Assign typed object value to SFColorRGBA warmColor field, similar to setWarmColor(float[]).
java.lang.String	toStringClassicVRML(int indentLevel) Recursive method to provide ClassicVRML string serialization.
java.lang.String	toStringVRML97(int indentLevel) Recursive method to provide VRML97 string serialization.
java.lang.String	toStringX3D(int indentLevel) Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
java.lang.String	validate() Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.

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

getContainerFieldAlternateValues, getContainerFieldOverride, getCssClass, getDEF, getUSE, isNode, isStatement, isUSE, resetContainerFieldOverride, setConcreteCssClass, setConcreteDEF, setConcreteUSE, setContainerFieldOverride

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

clearParentObject, findAncestorElementByName, findAncestorProtoBody, findAncestorSceneObject, findAncestorX3DObject, getPackageName, getParentObject, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorSceneObject, hasAncestorX3DObject, setParentObject, toStringClassicVRML, toStringVRML97, toStringX3D

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final java.lang.String NAME

String constant NAME provides name of this element: ToneMappedVolumeStyle.

See Also:

Constant Field Values

COMPONENT

public static final java.lang.String COMPONENT

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

See Also:

Constant Field Values

LEVEL

public static final int LEVEL

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

See Also:

Constant Field Values

COOLCOLOR_DEFAULT_VALUE

public static final float[] COOLCOLOR_DEFAULT_VALUE

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

ENABLED_DEFAULT_VALUE

public static final boolean ENABLED_DEFAULT_VALUE

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

See Also:

Constant Field Values

WARMCOLOR_DEFAULT_VALUE

public static final float[] WARMCOLOR_DEFAULT_VALUE

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

containerField_DEFAULT_VALUE

public static final java.lang.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_COOLCOLOR

public static final java.lang.String fromField_COOLCOLOR

fromField ROUTE name for SFColorRGBA field named coolColor.

See Also:

Constant Field Values

toField_COOLCOLOR

public static final java.lang.String toField_COOLCOLOR

toField ROUTE name for SFColorRGBA field named coolColor.

See Also:

Constant Field Values

fromField_ENABLED

public static final java.lang.String fromField_ENABLED

fromField ROUTE name for SFBool field named enabled.

See Also:

Constant Field Values

toField_ENABLED

public static final java.lang.String toField_ENABLED

toField ROUTE name for SFBool field named enabled.

See Also:

Constant Field Values

fromField_METADATA

public static final java.lang.String fromField_METADATA

fromField ROUTE name for SFNode field named metadata.

See Also:

Constant Field Values

toField_METADATA

public static final java.lang.String toField_METADATA

toField ROUTE name for SFNode field named metadata.

See Also:

Constant Field Values

fromField_SURFACENORMALS

public static final java.lang.String fromField_SURFACENORMALS

fromField ROUTE name for SFNode field named surfaceNormals.

See Also:

Constant Field Values

toField_SURFACENORMALS

public static final java.lang.String toField_SURFACENORMALS

toField ROUTE name for SFNode field named surfaceNormals.

See Also:

Constant Field Values

fromField_WARMCOLOR

public static final java.lang.String fromField_WARMCOLOR

fromField ROUTE name for SFColorRGBA field named warmColor.

See Also:

Constant Field Values

toField_WARMCOLOR

public static final java.lang.String toField_WARMCOLOR

toField ROUTE name for SFColorRGBA field named warmColor.

See Also:

Constant Field Values

Constructor Detail

ToneMappedVolumeStyleObject

public ToneMappedVolumeStyleObject()

Constructor for ToneMappedVolumeStyleObject to initialize member variables with default values.

ToneMappedVolumeStyleObject

public ToneMappedVolumeStyleObject(java.lang.String DEFlabel)

Utility constructor that assigns DEF label after initializing member variables with default values.

Parameters:

DEFlabel - unique DEF name for this X3D node

Method Detail

getElementName

public final java.lang.String getElementName()

Provides name of this element: ToneMappedVolumeStyle

Specified by:

getElementName in class X3DConcreteElement

Returns:

name of this element

getComponent

public final java.lang.String getComponent()

Defines X3D component for the ToneMappedVolumeStyle element: VolumeRendering

Specified by:

getComponent in class X3DConcreteElement

Returns:

X3D component for this element

getComponentLevel

public final int getComponentLevel()

Provides default X3D component level for this element: 2

Specified by:

getComponentLevel in class X3DConcreteElement

Returns:

default X3D component level for this element

getFieldType

public java.lang.String getFieldType(java.lang.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 java.lang.String getAccessType(java.lang.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 java.lang.String getContainerFieldDefault()

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

Specified by:

getContainerFieldDefault in 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

getCoolColor

public float[] getCoolColor()

Provide array of 4-tuple float results using RGBA values [0..1] using RGBA values [0..1] from inputOutput SFColorRGBA field named coolColor.

Tooltip: [0,1] coolColor is used for surfaces facing away from the light direction.

• Hint: X3D Scene Authoring Hints, Color
  http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color

Specified by:

getCoolColor in interface ToneMappedVolumeStyle

Returns:

value of coolColor field

setCoolColor

public ToneMappedVolumeStyleObject setCoolColor(float[] newValue)

Assign 4-tuple float array using RGBA values [0..1] using RGBA values [0..1] to inputOutput SFColorRGBA field named coolColor.

Tooltip: [0,1] coolColor is used for surfaces facing away from the light direction. Hint: X3D Scene Authoring Hints, Color http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color

Specified by:

setCoolColor in interface ToneMappedVolumeStyle

Parameters:

newValue - is new value for the coolColor field.

Returns:

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

setCoolColor

public ToneMappedVolumeStyleObject setCoolColor(SFColorRGBAObject newValue)

Assign typed object value to SFColorRGBA coolColor field, similar to setCoolColor(float[]).

Parameters:

newValue - is new value for the coolColor field.

Returns:

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

setCoolColor

public ToneMappedVolumeStyleObject setCoolColor(float red,
                                                float green,
                                                float blue,
                                                float alpha)

Assign values to SFColorRGBA coolColor field, similar to setCoolColor(float[]).

Parameters:

red - first component

green - second component

blue - third component

alpha - fourth component for opaqueness (1 - transparency)

Returns:

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

getEnabled

public boolean getEnabled()

Provide boolean value from inputOutput SFBool field named enabled.

Tooltip: Enables/disables node operation. *

Specified by:

getEnabled in interface ToneMappedVolumeStyle

Specified by:

getEnabled in interface X3DComposableVolumeRenderStyleNode

Specified by:

getEnabled in interface X3DVolumeRenderStyleNode

Returns:

value of enabled field

setEnabled

public ToneMappedVolumeStyleObject setEnabled(boolean newValue)

Assign boolean value to inputOutput SFBool field named enabled.

Tooltip: Enables/disables node operation.

Specified by:

setEnabled in interface ToneMappedVolumeStyle

Specified by:

setEnabled in interface X3DComposableVolumeRenderStyleNode

Specified by:

setEnabled in interface X3DVolumeRenderStyleNode

Parameters:

newValue - is new value for the enabled field.

Returns:

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

setEnabled

public ToneMappedVolumeStyleObject setEnabled(SFBoolObject newValue)

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

Parameters:

newValue - is new value for the enabled field.

Returns:

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

getMetadata

public X3DMetadataObject getMetadata()

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

Specified by:

getMetadata in interface X3DNode

Specified by:

getMetadata in interface ToneMappedVolumeStyle

Specified by:

getMetadata in interface X3DComposableVolumeRenderStyleNode

Specified by:

getMetadata in interface X3DVolumeRenderStyleNode

Returns:

value of metadata field

See Also:

getMetadataProtoInstance(), X3D Scene Authoring Hints: Metadata Nodes

setMetadata

public ToneMappedVolumeStyleObject setMetadata(X3DMetadataObject newValue)

Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.

Specified by:

setMetadata in interface X3DNode

Specified by:

setMetadata in interface ToneMappedVolumeStyle

Specified by:

setMetadata in interface X3DComposableVolumeRenderStyleNode

Specified by:

setMetadata in interface X3DVolumeRenderStyleNode

Specified by:

setMetadata in class X3DConcreteNode

Parameters:

newValue - is new value for the metadata field.

Returns:

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

See Also:

setMetadata(ProtoInstanceObject), X3D Scene Authoring Hints: Metadata Nodes

clearMetadata

public ToneMappedVolumeStyleObject clearMetadata()

Utility method to clear SFNode value of metadata field.

Returns:

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

setMetadata

public ToneMappedVolumeStyleObject setMetadata(ProtoInstanceObject 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:

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

See Also:

setMetadata(X3DMetadataObject)

hasMetadata

public boolean hasMetadata()

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

Returns:

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

See Also:

getMetadata(), getMetadataProtoInstance(), X3D Scene Authoring Hints: Metadata Nodes

getSurfaceNormals

public X3DTexture3DNode getSurfaceNormals()

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

Specified by:

getSurfaceNormals in interface ToneMappedVolumeStyle

Returns:

value of surfaceNormals field

See Also:

getSurfaceNormalsProtoInstance()

setSurfaceNormals

public ToneMappedVolumeStyleObject setSurfaceNormals(X3DTexture3DNode newValue)

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

Specified by:

setSurfaceNormals in interface ToneMappedVolumeStyle

Parameters:

newValue - is new value for the surfaceNormals field.

Returns:

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

See Also:

setSurfaceNormals(ProtoInstanceObject)

clearSurfaceNormals

public ToneMappedVolumeStyleObject clearSurfaceNormals()

Utility method to clear SFNode value of surfaceNormals field.

Returns:

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

setSurfaceNormals

public ToneMappedVolumeStyleObject setSurfaceNormals(ProtoInstanceObject newValue)

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

Parameters:

newValue - is new value for the surfaceNormals field.

Returns:

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

See Also:

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

getWarmColor

public float[] getWarmColor()

Provide array of 4-tuple float results using RGBA values [0..1] using RGBA values [0..1] from inputOutput SFColorRGBA field named warmColor.

Tooltip: [0,1] warmColor is used for surfaces facing towards the light.

• Hint: X3D Scene Authoring Hints, Color
  http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color

Specified by:

getWarmColor in interface ToneMappedVolumeStyle

Returns:

value of warmColor field

setWarmColor

public ToneMappedVolumeStyleObject setWarmColor(float[] newValue)

Assign 4-tuple float array using RGBA values [0..1] using RGBA values [0..1] to inputOutput SFColorRGBA field named warmColor.

Tooltip: [0,1] warmColor is used for surfaces facing towards the light. Hint: X3D Scene Authoring Hints, Color http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color

Specified by:

setWarmColor in interface ToneMappedVolumeStyle

Parameters:

newValue - is new value for the warmColor field.

Returns:

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

setWarmColor

public ToneMappedVolumeStyleObject setWarmColor(SFColorRGBAObject newValue)

Assign typed object value to SFColorRGBA warmColor field, similar to setWarmColor(float[]).

Parameters:

newValue - is new value for the warmColor field.

Returns:

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

setWarmColor

public ToneMappedVolumeStyleObject setWarmColor(float red,
                                                float green,
                                                float blue,
                                                float alpha)

Assign values to SFColorRGBA warmColor field, similar to setWarmColor(float[]).

Parameters:

red - first component

green - second component

blue - third component

alpha - fourth component for opaqueness (1 - transparency)

Returns:

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

setDEF

public final ToneMappedVolumeStyleObject setDEF(java.lang.String newValue)

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 http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions

Note that setting the DEF value clears the USE value.

Specified by:

setDEF in interface X3DNode

Specified by:

setDEF in interface ToneMappedVolumeStyle

Specified by:

setDEF in interface X3DComposableVolumeRenderStyleNode

Specified by:

setDEF in interface X3DVolumeRenderStyleNode

Specified by:

setDEF in class X3DConcreteNode

Parameters:

newValue - is new value for the DEF field.

Returns:

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

setDEF

public ToneMappedVolumeStyleObject setDEF(SFStringObject newValue)

Assign typed object value to SFString DEF field, similar to setDEF(String).

Parameters:

newValue - is new value for the DEF field.

Returns:

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

setUSE

public final ToneMappedVolumeStyleObject setUSE(java.lang.String newValue)

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 interface X3DNode

Specified by:

setUSE in interface ToneMappedVolumeStyle

Specified by:

setUSE in interface X3DComposableVolumeRenderStyleNode

Specified by:

setUSE in interface X3DVolumeRenderStyleNode

Specified by:

setUSE in class X3DConcreteNode

Parameters:

newValue - is new value for the USE field.

Returns:

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

setUSE

public ToneMappedVolumeStyleObject setUSE(SFStringObject newValue)

Assign typed object value to SFString USE field, similar to setUSE(String).

Parameters:

newValue - is new value for the USE field.

Returns:

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

setCssClass

public final ToneMappedVolumeStyleObject setCssClass(java.lang.String newValue)

Assign String value to inputOutput SFString field named class.

Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets. Warning: currently the class attribute is only supported in XML encoding of X3D scenes. Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS

Specified by:

setCssClass in interface X3DNode

Specified by:

setCssClass in interface ToneMappedVolumeStyle

Specified by:

setCssClass in interface X3DComposableVolumeRenderStyleNode

Specified by:

setCssClass in interface X3DVolumeRenderStyleNode

Specified by:

setCssClass in class X3DConcreteNode

Parameters:

newValue - is new value for the class field.

Returns:

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

See Also:

W3C Cascading Style Sheets

setCssClass

public ToneMappedVolumeStyleObject setCssClass(SFStringObject newValue)

Assign typed object value to SFString cssClass field, similar to setCssClass(String).

Parameters:

newValue - is new value for the class field.

Returns:

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

setIS

public ToneMappedVolumeStyleObject setIS(ISObject newValue)

Assign field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes. The IS statement connects node fields defined inside a ProtoBody declaration back to corresponding ProtoInterface fields.

Specified by:

setIS in class X3DConcreteNode

Parameters:

newValue - is new value for the description field.

Returns:

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

getIS

public ISObject getIS()

Provide field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes. The IS statement connects node fields defined inside a ProtoBody declaration back to corresponding ProtoInterface fields.

Specified by:

getIS in class X3DConcreteNode

Returns:

current ISObject, if any.

See Also:

X3D Tooltips: IS, X3D Tooltips: connect

setUSE

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

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

addComments

public ToneMappedVolumeStyleObject addComments(java.lang.String newComment)

Add comment as String to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComment - initial value

Returns:

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

addComments

public ToneMappedVolumeStyleObject addComments(java.lang.String[] newComments)

Add comments as String[] array to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComments - array of comments

Returns:

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

addComments

public ToneMappedVolumeStyleObject addComments(CommentsBlock newCommentsBlock)

Add CommentsBlock to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newCommentsBlock - block of comments to add

Returns:

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

toStringX3D

public java.lang.String toStringX3D(int indentLevel)

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

Specified by:

toStringX3D in class X3DConcreteElement

Parameters:

indentLevel - number of levels of indentation for this element

Returns:

X3D string

See Also:

X3DObject.FILE_EXTENSION_X3D, X3DObject.FILE_EXTENSION_XML, X3DObject.toStringXML(), X3DObject.toFileXML(String), X3DObject.toFileX3D(String), X3D XML Encoding, X3D Compressed Binary Encoding: X3D Canonical Form

toStringClassicVRML

public java.lang.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:

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

toStringVRML97

public java.lang.String toStringVRML97(int indentLevel)

Recursive method to provide VRML97 string serialization.

Specified by:

toStringVRML97 in class X3DConcreteElement

Parameters:

indentLevel - number of levels of indentation for this element

Returns:

VRML97 string

See Also:

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

findElementByNameValue

public X3DConcreteElement findElementByNameValue(java.lang.String nameValue)

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

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

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

Specified by:

findElementByNameValue in 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.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()

findElementByNameValue

public X3DConcreteElement findElementByNameValue(java.lang.String nameValue,
                                                 java.lang.String elementName)

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

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

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

Specified by:

findElementByNameValue in 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.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()

hasElementByNameValue

public boolean hasElementByNameValue(java.lang.String nameValue,
                                     java.lang.String elementName)

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

Parameters:

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

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

Returns:

whether node is found

See Also:

findElementByNameValue(String, String)

findNodeByDEF

public X3DConcreteNode findNodeByDEF(java.lang.String DEFvalue)

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

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

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

Specified by:

findNodeByDEF in 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.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()

hasNodeByDEF

public boolean hasNodeByDEF(java.lang.String DEFvalue)

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

Parameters:

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

Returns:

whether node is found

See Also:

findNodeByDEF(String)

validate

public java.lang.String validate()

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

Specified by:

validate in class X3DConcreteElement

Returns:

validation results (if any)