OpacityMapVolumeStyle (X3DJSAIL, X3D Java Scene Access Interface Library)

All Superinterfaces:

X3DComposableVolumeRenderStyleNode, X3DNode, X3DVolumeRenderStyleNode

All Known Implementing Classes:

OpacityMapVolumeStyleObject
```
public interface OpacityMapVolumeStyle
extends X3DComposableVolumeRenderStyleNode
```
Abstract node interface, defined by X3D specification to support X3D Java interoperability.

X3D node tooltip: (X3D version 3.3 or later) [X3DComposableVolumeRenderStyleNode] OpacityMapVolumeStyle specifies that volumetric data is rendered using opacity mapped to a transfer function texture.
- Hint: contains a single ImageTexture2D or ImageTexture3D node with containerField='transferFunction'. Voxel values are used as lookup coordinates into the transfer function texture, where the texel value represents the output color.
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: OpacityMapVolumeStyle, X3D Tooltips: OpacityMapVolumeStyle, X3D Scene Authoring Hints: Volume

Method Summary

All Methods Instance Methods Abstract Methods
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.
`X3DNode`	`getTransferFunction()` Provide X3DNode instance (using a properly typed node) with acceptable node types limited to X3DTexture2DNode\|X3DTexture3DNode, from inputOutput SFNode field transferFunction.
`OpacityMapVolumeStyle`	`setCssClass(java.lang.String newValue)` Assign String value to inputOutput SFString field named class.
`OpacityMapVolumeStyle`	`setDEF(java.lang.String newValue)` Assign String value to inputOutput SFString field named DEF.
`OpacityMapVolumeStyle`	`setEnabled(boolean newValue)` Assign boolean value to inputOutput SFBool field named enabled.
`OpacityMapVolumeStyle`	`setMetadata(X3DMetadataObject newValue)` Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`OpacityMapVolumeStyle`	`setTransferFunction(X3DNode newValue)` Assign X3DNode instance (using a properly typed node) with acceptable node types limited to X3DTexture2DNode\|X3DTexture3DNode, to inputOutput SFNode field transferFunction. // newValueInstanceAcceptableNodeTypesTest checks are needed for methods that override/subset X3DNode interfaces #1 boolean isNodeTypeAllowed = (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.sai.Texturing.X3DTexture2DNode) \|\| (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.sai.Texturing3D.X3DTexture3DNode); if (!
`OpacityMapVolumeStyle`	`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.
    
    Tooltip: Enables/disables node operation. *
    
    Specified by:
    
    getEnabled in interface X3DComposableVolumeRenderStyleNode
    
    Specified by:
    
    getEnabled in interface X3DVolumeRenderStyleNode
    
    Returns:
    
    value of enabled field
  - setEnabled
```
OpacityMapVolumeStyle setEnabled(boolean newValue)
```
    Assign boolean value to inputOutput SFBool field named enabled.
    
    Tooltip: Enables/disables node operation.
    
    Specified by:
    
    setEnabled in interface X3DComposableVolumeRenderStyleNode
    
    Specified by:
    
    setEnabled in interface X3DVolumeRenderStyleNode
    
    Parameters:
    
    newValue - is new value for the enabled field.
    
    Returns:
    
    OpacityMapVolumeStyle - 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 X3DComposableVolumeRenderStyleNode
    
    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
```
OpacityMapVolumeStyle setMetadata(X3DMetadataObject newValue)
```
    Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    
    Specified by:
    
    setMetadata in interface X3DComposableVolumeRenderStyleNode
    
    Specified by:
    
    setMetadata in interface X3DNode
    
    Specified by:
    
    setMetadata in interface X3DVolumeRenderStyleNode
    
    Parameters:
    
    newValue - is new value for the metadata field.
    
    Returns:
    
    OpacityMapVolumeStyle - 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
  - getTransferFunction
```
X3DNode getTransferFunction()
```
    Provide X3DNode instance (using a properly typed node) with acceptable node types limited to X3DTexture2DNode|X3DTexture3DNode, from inputOutput SFNode field transferFunction.
    
    Returns:
    
    value of transferFunction field
  - setTransferFunction
```
OpacityMapVolumeStyle setTransferFunction(X3DNode newValue)
```
    Assign X3DNode instance (using a properly typed node) with acceptable node types limited to X3DTexture2DNode|X3DTexture3DNode, to inputOutput SFNode field transferFunction. // newValueInstanceAcceptableNodeTypesTest checks are needed for methods that override/subset X3DNode interfaces #1 boolean isNodeTypeAllowed = (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.sai.Texturing.X3DTexture2DNode) || (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.sai.Texturing3D.X3DTexture3DNode); if (!isNodeTypeAllowed) { throw new org.web3d.x3d.sai.InvalidFieldValueException("X3DNode newValue is not instanceof " + "acceptableNodeTypes X3DTexture2DNode|X3DTexture3DNode; newValue=" + newValue); }
    
    Parameters:
    
    newValue - is new value for the transferFunction field.
    
    Returns:
    
    OpacityMapVolumeStyle - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setDEF
```
OpacityMapVolumeStyle 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 X3DComposableVolumeRenderStyleNode
    
    Specified by:
    
    setDEF in interface X3DNode
    
    Specified by:
    
    setDEF in interface X3DVolumeRenderStyleNode
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    OpacityMapVolumeStyle - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUSE
```
OpacityMapVolumeStyle 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 X3DComposableVolumeRenderStyleNode
    
    Specified by:
    
    setUSE in interface X3DNode
    
    Specified by:
    
    setUSE in interface X3DVolumeRenderStyleNode
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    OpacityMapVolumeStyle - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setCssClass
```
OpacityMapVolumeStyle 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 X3DComposableVolumeRenderStyleNode
    
    Specified by:
    
    setCssClass in interface X3DNode
    
    Specified by:
    
    setCssClass in interface X3DVolumeRenderStyleNode
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    OpacityMapVolumeStyle - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

Interface OpacityMapVolumeStyle

Method Summary

Method Detail

getEnabled

setEnabled

getMetadata

setMetadata

getTransferFunction

setTransferFunction

setDEF

setUSE

setCssClass