org.web3d.x3d.sai.VolumeRendering

Interface X3DComposableVolumeRenderStyleNode

All Superinterfaces:

X3DNode, X3DVolumeRenderStyleNode

All Known Subinterfaces:

BlendedVolumeStyle, BoundaryEnhancementVolumeStyle, CartoonVolumeStyle, ComposedVolumeStyle, EdgeEnhancementVolumeStyle, OpacityMapVolumeStyle, ShadedVolumeStyle, SilhouetteEnhancementVolumeStyle, ToneMappedVolumeStyle

All Known Implementing Classes:

BlendedVolumeStyleObject, BoundaryEnhancementVolumeStyleObject, CartoonVolumeStyleObject, ComposedVolumeStyleObject, EdgeEnhancementVolumeStyleObject, OpacityMapVolumeStyleObject, ShadedVolumeStyleObject, SilhouetteEnhancementVolumeStyleObject, ToneMappedVolumeStyleObject

public interface X3DComposableVolumeRenderStyleNode
extends X3DVolumeRenderStyleNode

Abstract node interface, defined by X3D specification to support X3D Java interoperability.


Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).

See Also:

SAI Java Specification: TODO, X3D Abstract Specification: TODO, X3D Tooltips, X3D Scene Authoring Hints: Volume

Method Summary

Modifier and Type	Method and Description
boolean	getEnabled() Provide boolean value from inputOutput SFBool field named enabled.
X3DMetadataObject	getMetadata() Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
X3DComposableVolumeRenderStyleNode	setCssClass(java.lang.String newValue) Assign String value to inputOutput SFString field named class.
X3DComposableVolumeRenderStyleNode	setDEF(java.lang.String newValue) Assign String value to inputOutput SFString field named DEF.
X3DComposableVolumeRenderStyleNode	setEnabled(boolean newValue) Assign boolean value to inputOutput SFBool field named enabled.
X3DComposableVolumeRenderStyleNode	setMetadata(X3DMetadataObject newValue) Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
X3DComposableVolumeRenderStyleNode	setUSE(java.lang.String newValue) Assign String value to inputOutput SFString field named USE.

Method Detail

getEnabled

boolean getEnabled()

Provide boolean value from inputOutput SFBool field named enabled.

Specified by:

getEnabled in interface X3DVolumeRenderStyleNode

Returns:

value of enabled field

setEnabled

X3DComposableVolumeRenderStyleNode setEnabled(boolean newValue)

Assign boolean value to inputOutput SFBool field named enabled.

Specified by:

setEnabled in interface X3DVolumeRenderStyleNode

Parameters:

newValue - is new value for the enabled field.

Returns:

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

getMetadata

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 X3DVolumeRenderStyleNode

Returns:

value of metadata field

See Also:

X3D Scene Authoring Hints: Metadata Nodes

setMetadata

X3DComposableVolumeRenderStyleNode 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 X3DVolumeRenderStyleNode

Parameters:

newValue - is new value for the metadata field.

Returns:

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

See Also:

X3D Scene Authoring Hints: Metadata Nodes

setDEF

X3DComposableVolumeRenderStyleNode setDEF(java.lang.String newValue)

Assign String value to inputOutput SFString field named DEF.

Note that setting the DEF value clears the USE value.

Specified by:

setDEF in interface X3DNode

Specified by:

setDEF in interface X3DVolumeRenderStyleNode

Parameters:

newValue - is new value for the DEF field.

Returns:

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

setUSE

X3DComposableVolumeRenderStyleNode setUSE(java.lang.String newValue)

Assign String value to inputOutput SFString field named USE.

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 X3DVolumeRenderStyleNode

Parameters:

newValue - is new value for the USE field.

Returns:

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

setCssClass

X3DComposableVolumeRenderStyleNode setCssClass(java.lang.String newValue)

Assign String value to inputOutput SFString field named class.

Specified by:

setCssClass in interface X3DNode

Specified by:

setCssClass in interface X3DVolumeRenderStyleNode

Parameters:

newValue - is new value for the class field.

Returns:

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