Interface OpacityMapVolumeStyle
- All Superinterfaces:
X3DComposableVolumeRenderStyleNode,X3DNode,X3DVolumeRenderStyleNode
- All Known Implementing Classes:
OpacityMapVolumeStyleObject
public interface OpacityMapVolumeStyle extends X3DComposableVolumeRenderStyleNode
OpacityMapVolumeStyle specifies that volumetric data is rendered using opacity mapped to a transfer function texture.
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.
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
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.
- Warning: requires X3D profile='Full' or else include <component name='VolumeRendering' level='2'/>
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
-
Method Summary
Modifier and Type Method Description booleangetEnabled()Provide boolean value from inputOutput SFBool field named enabled.X3DMetadataObjectgetMetadata()Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.X3DNodegetTransferFunction()Provide X3DNode instance (using a properly typed node) with acceptable node types limited to X3DTexture2DNode|X3DTexture3DNode, from inputOutput SFNode field transferFunction.OpacityMapVolumeStylesetEnabled(boolean newValue)Accessor method to assign boolean value to inputOutput SFBool field named enabled.OpacityMapVolumeStylesetMetadata(X3DMetadataObject newValue)Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.OpacityMapVolumeStylesetTransferFunction(X3DNode newValue)Accessor method to assign X3DNode instance (using a properly typed node) 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 (!
-
Method Details
-
getEnabled
boolean getEnabled()Provide boolean value from inputOutput SFBool field named enabled.
Tooltip: Enables/disables node operation. *- Specified by:
getEnabledin interfaceX3DComposableVolumeRenderStyleNode- Specified by:
getEnabledin interfaceX3DVolumeRenderStyleNode- Returns:
- value of enabled field
-
setEnabled
Accessor method to assign boolean value to inputOutput SFBool field named enabled.
Tooltip: Enables/disables node operation. *- Specified by:
setEnabledin interfaceX3DComposableVolumeRenderStyleNode- Specified by:
setEnabledin interfaceX3DVolumeRenderStyleNode- 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.
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/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
- Specified by:
getMetadatain interfaceX3DComposableVolumeRenderStyleNode- Specified by:
getMetadatain interfaceX3DNode- Specified by:
getMetadatain interfaceX3DVolumeRenderStyleNode- Returns:
- value of metadata field
- See Also:
- X3D Scene Authoring Hints: Metadata Nodes
-
setMetadata
Accessor method to assign 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/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
- Specified by:
setMetadatain interfaceX3DComposableVolumeRenderStyleNode- Specified by:
setMetadatain interfaceX3DNode- Specified by:
setMetadatain interfaceX3DVolumeRenderStyleNode- 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
Accessor method to assign X3DNode instance (using a properly typed node) 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).
-