All Superinterfaces:: X3DComposableVolumeRenderStyleNode, X3DNode, X3DVolumeRenderStyleNode

All Known Implementing Classes:: ToneMappedVolumeStyle

public interface ToneMappedVolumeStyle extends X3DComposableVolumeRenderStyleNode

ToneMappedVolumeStyle specifies that volumetric data is rendered with Gooch shading model of two-toned warm/cool coloring.

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. ToneMappedVolumeStyle node tooltip: (X3D version 3.3 or later) [X3DComposableVolumeRenderStyleNode] ToneMappedVolumeStyle specifies that volumetric data is rendered with Gooch shading model of two-toned warm/cool coloring.

Hint: ToneMappedVolumeStyle can contain a single Texture3D node with containerField='surfaceNormals'
Hint: Gooch shading https://en.wikipedia.org/wiki/Gooch_shading
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).

See Also:

Method Summary

Modifier and Type

Method

Description

float[]

getCoolColor()

Provide array of 4-tuple float results using RGBA values [0..1] using RGBA values [0..1] from inputOutput SFColorRGBA field named coolColor.

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.

X3DTexture3DNode

getSurfaceNormals()

Provide org.web3d.x3d.sai.Texturing3D.X3DTexture3DNode instance (using a properly typed node) from inputOutput SFNode field surfaceNormals.

float[]

getWarmColor()

Provide array of 4-tuple float results using RGBA values [0..1] using RGBA values [0..1] from inputOutput SFColorRGBA field named warmColor.

ToneMappedVolumeStyle

setCoolColor(float[] newValue)

Accessor method to assign 4-tuple float array using RGBA values [0..1] to inputOutput SFColorRGBA field named coolColor.

ToneMappedVolumeStyle

setEnabled(boolean newValue)

Accessor method to assign boolean value to inputOutput SFBool field named enabled.

ToneMappedVolumeStyle

setMetadata(X3DMetadataObject newValue)

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

ToneMappedVolumeStyle

setSurfaceNormals(X3DTexture3DNode newValue)

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

ToneMappedVolumeStyle

setWarmColor(float[] newValue)

Accessor method to assign 4-tuple float array using RGBA values [0..1] to inputOutput SFColorRGBA field named warmColor.

Method Details
- getCoolColor
  float[] getCoolColor()
  
  Provide array of 4-tuple float results using RGBA values [0..1] using RGBA values [0..1] from inputOutput SFColorRGBA field named coolColor.
  
  Tooltip: [0,1] coolColor is used for surfaces facing away from the light direction.
  
  Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color
  
  Returns:
  
  value of coolColor field
- setCoolColor
  ToneMappedVolumeStyle setCoolColor(float[] newValue)
  
  Accessor method to assign 4-tuple float array using RGBA values [0..1] to inputOutput SFColorRGBA field named coolColor.
  
  Tooltip: [0,1] coolColor is used for surfaces facing away from the light direction.
  
  Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color
  
  Parameters:
  
  newValue - is new value for the coolColor field.
  
  Returns:
  
  ToneMappedVolumeStyle - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- 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
  
  ToneMappedVolumeStyle 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:
  
  ToneMappedVolumeStyle - 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
  ToneMappedVolumeStyle 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:
  
  ToneMappedVolumeStyle - 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
- getSurfaceNormals
  
  X3DTexture3DNode getSurfaceNormals()
  
  Provide org.web3d.x3d.sai.Texturing3D.X3DTexture3DNode instance (using a properly typed node) from inputOutput SFNode field surfaceNormals.
  
  Tooltip: [X3DTexture3DNode] The surfaceNormals field contains a 3D texture with at least three component values. Each voxel in the texture represents the surface normal direction for the corresponding voxel in the base data source. *
  
  Returns:
  
  value of surfaceNormals field
- setSurfaceNormals
  
  ToneMappedVolumeStyle setSurfaceNormals(X3DTexture3DNode newValue)
  
  Accessor method to assign org.web3d.x3d.sai.Texturing3D.X3DTexture3DNode instance (using a properly typed node) to inputOutput SFNode field surfaceNormals.
  
  Tooltip: [X3DTexture3DNode] The surfaceNormals field contains a 3D texture with at least three component values. Each voxel in the texture represents the surface normal direction for the corresponding voxel in the base data source. *
  
  Parameters:
  
  newValue - is new value for the surfaceNormals field.
  
  Returns:
  
  ToneMappedVolumeStyle - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getWarmColor
  float[] getWarmColor()
  
  Provide array of 4-tuple float results using RGBA values [0..1] using RGBA values [0..1] from inputOutput SFColorRGBA field named warmColor.
  
  Tooltip: [0,1] warmColor is used for surfaces facing towards the light.
  
  Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color
  
  Returns:
  
  value of warmColor field
- setWarmColor
  ToneMappedVolumeStyle setWarmColor(float[] newValue)
  
  Accessor method to assign 4-tuple float array using RGBA values [0..1] to inputOutput SFColorRGBA field named warmColor.
  
  Tooltip: [0,1] warmColor is used for surfaces facing towards the light.
  
  Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color
  
  Parameters:
  
  newValue - is new value for the warmColor field.
  
  Returns:
  
  ToneMappedVolumeStyle - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

Interface ToneMappedVolumeStyle

Method Summary

Method Details

getCoolColor

setCoolColor

getEnabled

setEnabled

getMetadata

setMetadata

getSurfaceNormals

setSurfaceNormals

getWarmColor

setWarmColor