Package org.web3d.x3d.sai.VolumeRendering

Interface BlendedVolumeStyle

All Superinterfaces:

X3DComposableVolumeRenderStyleNode, X3DNode, X3DVolumeRenderStyleNode

All Known Implementing Classes:

BlendedVolumeStyle

public interface BlendedVolumeStyle
extends X3DComposableVolumeRenderStyleNode

BlendedVolumeStyle combines rendering of two voxel data sets into one by blending voxel values.

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. BlendedVolumeStyle 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'.
• Warning: requires X3D profile='Full' or else include <component name='VolumeRendering' level='3'/>

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

See Also:

• SAI Java Specification
• X3D Abstract Specification: BlendedVolumeStyle
• X3D Tooltips: BlendedVolumeStyle
• X3D Scene Authoring Hints: Volume

Method Summary

Modifier and Type	Method	Description
boolean	getEnabled()	Provide boolean value from inputOutput SFBool field named enabled.
X3DMetadataObject	getMetadata()	Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
X3DComposableVolumeRenderStyleNode	getRenderStyle()	Provide org.web3d.x3d.sai.VolumeRendering.X3DComposableVolumeRenderStyleNode instance (using a properly typed node) from inputOutput SFNode field renderStyle.
X3DTexture3DNode	getVoxels()	Provide org.web3d.x3d.sai.Texturing3D.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.
String	getWeightFunction1()	Provide String enumeration value (baseType xs:NMTOKEN) ["CONSTANT" | "ALPHA1" | "ALPHA2" | "ONE_MINUS_ALPHA1" | "ONE_MINUS_ALPHA2" | "TABLE"] from inputOutput SFString field named weightFunction1.
String	getWeightFunction2()	Provide String enumeration value (baseType xs:NMTOKEN) ["CONSTANT" | "ALPHA1" | "ALPHA2" | "ONE_MINUS_ALPHA1" | "ONE_MINUS_ALPHA2" | "TABLE"] from inputOutput SFString field named weightFunction2.
X3DTexture2DNode	getWeightTransferFunction1()	Provide org.web3d.x3d.sai.Texturing.X3DTexture2DNode instance (using a properly typed node) from inputOutput SFNode field weightTransferFunction1.
X3DTexture2DNode	getWeightTransferFunction2()	Provide org.web3d.x3d.sai.Texturing.X3DTexture2DNode instance (using a properly typed node) from inputOutput SFNode field weightTransferFunction2.
BlendedVolumeStyle	setEnabled(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named enabled.
BlendedVolumeStyle	setMetadata(X3DMetadataObject newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
BlendedVolumeStyle	setRenderStyle(X3DComposableVolumeRenderStyleNode newValue)	Accessor method to assign org.web3d.x3d.sai.VolumeRendering.X3DComposableVolumeRenderStyleNode instance (using a properly typed node) to inputOutput SFNode field renderStyle.
BlendedVolumeStyle	setVoxels(X3DTexture3DNode newValue)	Accessor method to assign org.web3d.x3d.sai.Texturing3D.X3DTexture3DNode instance (using a properly typed node) to inputOutput SFNode field voxels.
BlendedVolumeStyle	setWeightConstant1(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named weightConstant1.
BlendedVolumeStyle	setWeightConstant2(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named weightConstant2.
BlendedVolumeStyle	setWeightFunction1(String newValue)	Accessor method to assign String enumeration value ("CONSTANT" | "ALPHA1" | "ALPHA2" | "ONE_MINUS_ALPHA1" | "ONE_MINUS_ALPHA2" | "TABLE") to inputOutput SFString field named weightFunction1.
BlendedVolumeStyle	setWeightFunction2(String newValue)	Accessor method to assign String enumeration value ("CONSTANT" | "ALPHA1" | "ALPHA2" | "ONE_MINUS_ALPHA1" | "ONE_MINUS_ALPHA2" | "TABLE") to inputOutput SFString field named weightFunction2.
BlendedVolumeStyle	setWeightTransferFunction1(X3DTexture2DNode newValue)	Accessor method to assign org.web3d.x3d.sai.Texturing.X3DTexture2DNode instance (using a properly typed node) to inputOutput SFNode field weightTransferFunction1.
BlendedVolumeStyle	setWeightTransferFunction2(X3DTexture2DNode newValue)	Accessor method to assign org.web3d.x3d.sai.Texturing.X3DTexture2DNode instance (using a properly typed node) to inputOutput SFNode field weightTransferFunction2.

Method Details

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)

Accessor method to 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 org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.

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 https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/core.html#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)

Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.

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 https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/core.html#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 org.web3d.x3d.sai.VolumeRendering.X3DComposableVolumeRenderStyleNode instance (using a properly typed node) from inputOutput SFNode field renderStyle.

Tooltip: [X3DComposableVolumeRenderStyleNode] Single contained X3DComposableVolumeRenderStyleNode node that defines specific rendering technique for data in the voxels field, and the result is blended with parent VolumeData or SegmentedVoliumeData node. *

Returns:

value of renderStyle field

setRenderStyle

BlendedVolumeStyle setRenderStyle(X3DComposableVolumeRenderStyleNode newValue)

Accessor method to assign org.web3d.x3d.sai.VolumeRendering.X3DComposableVolumeRenderStyleNode instance (using a properly typed node) to inputOutput SFNode field renderStyle.

Tooltip: [X3DComposableVolumeRenderStyleNode] Single contained X3DComposableVolumeRenderStyleNode node that defines specific rendering technique for data in the voxels field, and the result is blended with parent VolumeData or SegmentedVoliumeData node. *

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 org.web3d.x3d.sai.Texturing3D.X3DTexture3DNode instance (using a properly typed node) from inputOutput SFNode field voxels.

Tooltip: [X3DTexture3DNode] Single contained X3DTexture3DNode (ComposedTexture3D, ImageTexture3D, PixelTexture3D) that provides second set of raw voxel information utilized by corresponding rendering styles. Any number of color components (1-4) may be defined. *

Returns:

value of voxels field

setVoxels

BlendedVolumeStyle setVoxels(X3DTexture3DNode newValue)

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

Tooltip: [X3DTexture3DNode] Single contained X3DTexture3DNode (ComposedTexture3D, ImageTexture3D, PixelTexture3D) that provides second set of raw voxel information utilized by corresponding rendering styles. Any number of color components (1-4) may be defined. *

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)

Accessor method to assign float value 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)

Accessor method to assign float value 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

String getWeightFunction1()

Provide String enumeration value (baseType xs:NMTOKEN) ["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 https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/volume.html#t-WeightFunctionTypes
• Hint: X3D Architecture Table 41.4, Transfer function to weight mapping https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/volume.html#t-transferFunctionToWeightMapping

Returns:

value of weightFunction1 field

setWeightFunction1

BlendedVolumeStyle setWeightFunction1(String newValue)

Accessor method to assign String enumeration value ("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 https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/volume.html#t-WeightFunctionTypes
• Hint: X3D Architecture Table 41.4, Transfer function to weight mapping https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /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

String getWeightFunction2()

Provide String enumeration value (baseType xs:NMTOKEN) ["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 https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/volume.html#t-WeightFunctionTypes
• Hint: X3D Architecture Table 41.4, Transfer function to weight mapping https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/volume.html#t-transferFunctionToWeightMapping

Returns:

value of weightFunction2 field

setWeightFunction2

BlendedVolumeStyle setWeightFunction2(String newValue)

Accessor method to assign String enumeration value ("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 https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/volume.html#t-WeightFunctionTypes
• Hint: X3D Architecture Table 41.4, Transfer function to weight mapping https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /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 org.web3d.x3d.sai.Texturing.X3DTexture2DNode instance (using a properly typed node) from inputOutput SFNode field weightTransferFunction1.

Tooltip: [X3DTexture2DNode] The weightTransferFunction1 and weightTransferFunction2 fields specify two-dimensional textures that are used to determine the weight values when the weight function is set to "TABLE". The output weight value depends on the number of components in the textures as specified in Table 41.4.

• Hint: https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/volume.html#t-transferFunctionToWeightMapping

Returns:

value of weightTransferFunction1 field

setWeightTransferFunction1

BlendedVolumeStyle setWeightTransferFunction1(X3DTexture2DNode newValue)

Accessor method to assign org.web3d.x3d.sai.Texturing.X3DTexture2DNode instance (using a properly typed node) to inputOutput SFNode field weightTransferFunction1.

Tooltip: [X3DTexture2DNode] The weightTransferFunction1 and weightTransferFunction2 fields specify two-dimensional textures that are used to determine the weight values when the weight function is set to "TABLE". The output weight value depends on the number of components in the textures as specified in Table 41.4.

• Hint: https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/volume.html#t-transferFunctionToWeightMapping

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 org.web3d.x3d.sai.Texturing.X3DTexture2DNode instance (using a properly typed node) from inputOutput SFNode field weightTransferFunction2.

Tooltip: [X3DTexture2DNode] The weightTransferFunction1 and weightTransferFunction2 fields specify two-dimensional textures that are used to determine the weight values when the weight function is set to "TABLE". The output weight value depends on the number of components in the textures as specified in Table 41.4.

• Hint: https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/volume.html#t-transferFunctionToWeightMapping

Returns:

value of weightTransferFunction2 field

setWeightTransferFunction2

BlendedVolumeStyle setWeightTransferFunction2(X3DTexture2DNode newValue)

Accessor method to assign org.web3d.x3d.sai.Texturing.X3DTexture2DNode instance (using a properly typed node) to inputOutput SFNode field weightTransferFunction2.

Tooltip: [X3DTexture2DNode] The weightTransferFunction1 and weightTransferFunction2 fields specify two-dimensional textures that are used to determine the weight values when the weight function is set to "TABLE". The output weight value depends on the number of components in the textures as specified in Table 41.4.

• Hint: https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/volume.html#t-transferFunctionToWeightMapping

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