BlendedVolumeStyle (X3DJSAIL, X3D Java Scene Access Interface Library)

All Superinterfaces:

X3DComposableVolumeRenderStyleNode, X3DNode, X3DVolumeRenderStyleNode

All Known Implementing Classes:

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

X3D node tooltip: (X3D version 3.3 or later) [X3DComposableVolumeRenderStyleNode] BlendedVolumeStyle combines rendering of two voxel data sets into one by blending voxel values.
- Hint: BlendedVolumeStyle can contain just one each of following: VolumeStyle node with containerField='renderStyle', Texture3D node with containerField='voxels', Texture2D node with containerField='weightTransferFunction1' and Texture2D node with containerField='weightTransferFunction2'.
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: BlendedVolumeStyle, X3D Tooltips: BlendedVolumeStyle, 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.
`X3DComposableVolumeRenderStyleNode`	`getRenderStyle()` Provide X3DComposableVolumeRenderStyleNode instance (using a properly typed node) from inputOutput SFNode field renderStyle.
`X3DTexture3DNode`	`getVoxels()` Provide X3DTexture3DNode instance (using a properly typed node) from inputOutput SFNode field voxels.
`float`	`getWeightConstant1()` Provide float value within allowed range of [0,1] from inputOutput SFFloat field named weightConstant1.
`float`	`getWeightConstant2()` Provide float value within allowed range of [0,1] from inputOutput SFFloat field named weightConstant2.
`java.lang.String`	`getWeightFunction1()` Provide String enumeration value ['CONSTANT'\|'ALPHA1'\|'ALPHA2'\|'ONE_MINUS_ALPHA1'\|'ONE_MINUS_ALPHA2'\|'TABLE'] from inputOutput SFString field named weightFunction1.
`java.lang.String`	`getWeightFunction2()` Provide String enumeration value ['CONSTANT'\|'ALPHA1'\|'ALPHA2'\|'ONE_MINUS_ALPHA1'\|'ONE_MINUS_ALPHA2'\|'TABLE'] from inputOutput SFString field named weightFunction2.
`X3DTexture2DNode`	`getWeightTransferFunction1()` Provide X3DTexture2DNode instance (using a properly typed node) from inputOutput SFNode field weightTransferFunction1.
`X3DTexture2DNode`	`getWeightTransferFunction2()` Provide X3DTexture2DNode instance (using a properly typed node) from inputOutput SFNode field weightTransferFunction2.
`BlendedVolumeStyle`	`setCssClass(java.lang.String newValue)` Assign String value to inputOutput SFString field named class.
`BlendedVolumeStyle`	`setDEF(java.lang.String newValue)` Assign String value to inputOutput SFString field named DEF.
`BlendedVolumeStyle`	`setEnabled(boolean newValue)` Assign boolean value to inputOutput SFBool field named enabled.
`BlendedVolumeStyle`	`setMetadata(X3DMetadataObject newValue)` Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`BlendedVolumeStyle`	`setRenderStyle(X3DComposableVolumeRenderStyleNode newValue)` Assign X3DComposableVolumeRenderStyleNode instance (using a properly typed node) to inputOutput SFNode field renderStyle.
`BlendedVolumeStyle`	`setUSE(java.lang.String newValue)` Assign String value to inputOutput SFString field named USE.
`BlendedVolumeStyle`	`setVoxels(X3DTexture3DNode newValue)` Assign X3DTexture3DNode instance (using a properly typed node) to inputOutput SFNode field voxels.
`BlendedVolumeStyle`	`setWeightConstant1(float newValue)` Assign float value within allowed range of [0,1] to inputOutput SFFloat field named weightConstant1.
`BlendedVolumeStyle`	`setWeightConstant2(float newValue)` Assign float value within allowed range of [0,1] to inputOutput SFFloat field named weightConstant2.
`BlendedVolumeStyle`	`setWeightFunction1(java.lang.String newValue)` Assign String enumeration value ("CONSTANT"\|"ALPHA1"\|"ALPHA2"\|"ONE_MINUS_ALPHA1"\|"ONE_MINUS_ALPHA2"\|"TABLE") ['CONSTANT'\|'ALPHA1'\|'ALPHA2'\|'ONE_MINUS_ALPHA1'\|'ONE_MINUS_ALPHA2'\|'TABLE'] to inputOutput SFString field named weightFunction1.
`BlendedVolumeStyle`	`setWeightFunction2(java.lang.String newValue)` Assign String enumeration value ("CONSTANT"\|"ALPHA1"\|"ALPHA2"\|"ONE_MINUS_ALPHA1"\|"ONE_MINUS_ALPHA2"\|"TABLE") ['CONSTANT'\|'ALPHA1'\|'ALPHA2'\|'ONE_MINUS_ALPHA1'\|'ONE_MINUS_ALPHA2'\|'TABLE'] to inputOutput SFString field named weightFunction2.
`BlendedVolumeStyle`	`setWeightTransferFunction1(X3DTexture2DNode newValue)` Assign X3DTexture2DNode instance (using a properly typed node) to inputOutput SFNode field weightTransferFunction1.
`BlendedVolumeStyle`	`setWeightTransferFunction2(X3DTexture2DNode newValue)` Assign X3DTexture2DNode instance (using a properly typed node) to inputOutput SFNode field weightTransferFunction2.

- 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
```
BlendedVolumeStyle 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:
    
    BlendedVolumeStyle - 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
```
BlendedVolumeStyle 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:
    
    BlendedVolumeStyle - 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
  - getRenderStyle
```
X3DComposableVolumeRenderStyleNode getRenderStyle()
```
    Provide X3DComposableVolumeRenderStyleNode instance (using a properly typed node) from inputOutput SFNode field renderStyle.
    
    Returns:
    
    value of renderStyle field
  - setRenderStyle
```
BlendedVolumeStyle setRenderStyle(X3DComposableVolumeRenderStyleNode newValue)
```
    Assign X3DComposableVolumeRenderStyleNode instance (using a properly typed node) to inputOutput SFNode field renderStyle.
    
    Parameters:
    
    newValue - is new value for the renderStyle field.
    
    Returns:
    
    BlendedVolumeStyle - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getVoxels
```
X3DTexture3DNode getVoxels()
```
    Provide X3DTexture3DNode instance (using a properly typed node) from inputOutput SFNode field voxels.
    
    Returns:
    
    value of voxels field
  - setVoxels
```
BlendedVolumeStyle setVoxels(X3DTexture3DNode newValue)
```
    Assign X3DTexture3DNode instance (using a properly typed node) to inputOutput SFNode field voxels.
    
    Parameters:
    
    newValue - is new value for the voxels field.
    
    Returns:
    
    BlendedVolumeStyle - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getWeightConstant1
```
float getWeightConstant1()
```
    Provide float value within allowed range of [0,1] from inputOutput SFFloat field named weightConstant1.
    
    Tooltip: [0,1] weightConstant1 is used when weightFunction1=CONSTANT. *
    
    Returns:
    
    value of weightConstant1 field
  - setWeightConstant1
```
BlendedVolumeStyle setWeightConstant1(float newValue)
```
    Assign float value within allowed range of [0,1] to inputOutput SFFloat field named weightConstant1.
    
    Tooltip: [0,1] weightConstant1 is used when weightFunction1=CONSTANT.
    
    Parameters:
    
    newValue - is new value for the weightConstant1 field.
    
    Returns:
    
    BlendedVolumeStyle - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getWeightConstant2
```
float getWeightConstant2()
```
    Provide float value within allowed range of [0,1] from inputOutput SFFloat field named weightConstant2.
    
    Tooltip: [0,1] weightConstant2 is used when weightFunction2=CONSTANT. *
    
    Returns:
    
    value of weightConstant2 field
  - setWeightConstant2
```
BlendedVolumeStyle setWeightConstant2(float newValue)
```
    Assign float value within allowed range of [0,1] to inputOutput SFFloat field named weightConstant2.
    
    Tooltip: [0,1] weightConstant2 is used when weightFunction2=CONSTANT.
    
    Parameters:
    
    newValue - is new value for the weightConstant2 field.
    
    Returns:
    
    BlendedVolumeStyle - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getWeightFunction1
```
java.lang.String getWeightFunction1()
```
    Provide String enumeration value ['CONSTANT'|'ALPHA1'|'ALPHA2'|'ONE_MINUS_ALPHA1'|'ONE_MINUS_ALPHA2'|'TABLE'] from inputOutput SFString field named weightFunction1.
    
    Tooltip: specifies 2D textures used to determine weight values when weight function is set to TABLE.
    - Warning: do not wrap extra quotation marks around these SFString enumeration values, since "quotation" "marks" are only used for MFString values.
    - Hint: X3D Architecture Table 41.3, Weight function types
      http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/volume.html#t-WeightFunctionTypes
    - Hint: X3D Architecture Table 41.4, Transfer function to weight mapping
      http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/volume.html#t-transferFunctionToWeightMapping
    Returns:
    
    value of weightFunction1 field
  - setWeightFunction1
```
BlendedVolumeStyle setWeightFunction1(java.lang.String newValue)
```
    Assign String enumeration value ("CONSTANT"|"ALPHA1"|"ALPHA2"|"ONE_MINUS_ALPHA1"|"ONE_MINUS_ALPHA2"|"TABLE") ['CONSTANT'|'ALPHA1'|'ALPHA2'|'ONE_MINUS_ALPHA1'|'ONE_MINUS_ALPHA2'|'TABLE'] to inputOutput SFString field named weightFunction1.
    
    Tooltip: specifies 2D textures used to determine weight values when weight function is set to TABLE. Warning: do not wrap extra quotation marks around these SFString enumeration values, since "quotation" "marks" are only used for MFString values. Hint: X3D Architecture Table 41.3, Weight function types http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/volume.html#t-WeightFunctionTypes Hint: X3D Architecture Table 41.4, Transfer function to weight mapping http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/volume.html#t-transferFunctionToWeightMapping
    
    Parameters:
    
    newValue - is new value for the weightFunction1 field.
    
    Returns:
    
    BlendedVolumeStyle - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getWeightFunction2
```
java.lang.String getWeightFunction2()
```
    Provide String enumeration value ['CONSTANT'|'ALPHA1'|'ALPHA2'|'ONE_MINUS_ALPHA1'|'ONE_MINUS_ALPHA2'|'TABLE'] from inputOutput SFString field named weightFunction2.
    
    Tooltip: specifies 2D textures used to determine weight values when weight function is set to TABLE.
    - Warning: do not wrap extra quotation marks around these SFString enumeration values, since "quotation" "marks" are only used for MFString values.
    - Hint: X3D Architecture Table 41.3, Weight function types
      http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/volume.html#t-WeightFunctionTypes
    - Hint: X3D Architecture Table 41.4, Transfer function to weight mapping
      http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/volume.html#t-transferFunctionToWeightMapping
    Returns:
    
    value of weightFunction2 field
  - setWeightFunction2
```
BlendedVolumeStyle setWeightFunction2(java.lang.String newValue)
```
    Assign String enumeration value ("CONSTANT"|"ALPHA1"|"ALPHA2"|"ONE_MINUS_ALPHA1"|"ONE_MINUS_ALPHA2"|"TABLE") ['CONSTANT'|'ALPHA1'|'ALPHA2'|'ONE_MINUS_ALPHA1'|'ONE_MINUS_ALPHA2'|'TABLE'] to inputOutput SFString field named weightFunction2.
    
    Tooltip: specifies 2D textures used to determine weight values when weight function is set to TABLE. Warning: do not wrap extra quotation marks around these SFString enumeration values, since "quotation" "marks" are only used for MFString values. Hint: X3D Architecture Table 41.3, Weight function types http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/volume.html#t-WeightFunctionTypes Hint: X3D Architecture Table 41.4, Transfer function to weight mapping http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/volume.html#t-transferFunctionToWeightMapping
    
    Parameters:
    
    newValue - is new value for the weightFunction2 field.
    
    Returns:
    
    BlendedVolumeStyle - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getWeightTransferFunction1
```
X3DTexture2DNode getWeightTransferFunction1()
```
    Provide X3DTexture2DNode instance (using a properly typed node) from inputOutput SFNode field weightTransferFunction1.
    
    Returns:
    
    value of weightTransferFunction1 field
  - setWeightTransferFunction1
```
BlendedVolumeStyle setWeightTransferFunction1(X3DTexture2DNode newValue)
```
    Assign X3DTexture2DNode instance (using a properly typed node) to inputOutput SFNode field weightTransferFunction1.
    
    Parameters:
    
    newValue - is new value for the weightTransferFunction1 field.
    
    Returns:
    
    BlendedVolumeStyle - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getWeightTransferFunction2
```
X3DTexture2DNode getWeightTransferFunction2()
```
    Provide X3DTexture2DNode instance (using a properly typed node) from inputOutput SFNode field weightTransferFunction2.
    
    Returns:
    
    value of weightTransferFunction2 field
  - setWeightTransferFunction2
```
BlendedVolumeStyle setWeightTransferFunction2(X3DTexture2DNode newValue)
```
    Assign X3DTexture2DNode instance (using a properly typed node) to inputOutput SFNode field weightTransferFunction2.
    
    Parameters:
    
    newValue - is new value for the weightTransferFunction2 field.
    
    Returns:
    
    BlendedVolumeStyle - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setDEF
```
BlendedVolumeStyle 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:
    
    BlendedVolumeStyle - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUSE
```
BlendedVolumeStyle 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:
    
    BlendedVolumeStyle - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setCssClass
```
BlendedVolumeStyle 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:
    
    BlendedVolumeStyle - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

Interface BlendedVolumeStyle

Method Summary

Method Detail

getEnabled

setEnabled

getMetadata

setMetadata

getRenderStyle

setRenderStyle

getVoxels

setVoxels

getWeightConstant1

setWeightConstant1

getWeightConstant2

setWeightConstant2

getWeightFunction1

setWeightFunction1

getWeightFunction2

setWeightFunction2

getWeightTransferFunction1

setWeightTransferFunction1

getWeightTransferFunction2

setWeightTransferFunction2

setDEF

setUSE

setCssClass