All Superinterfaces:: X3DComposableVolumeRenderStyleNode, X3DNode, X3DVolumeRenderStyleNode

All Known Implementing Classes:: EdgeEnhancementVolumeStyle

public interface EdgeEnhancementVolumeStyle extends X3DComposableVolumeRenderStyleNode

EdgeEnhancementVolumeStyle specifies edge enhancement for the volume rendering style.

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. EdgeEnhancementVolumeStyle node tooltip: (X3D version 3.3 or later) [X3DComposableVolumeRenderStyleNode] EdgeEnhancementVolumeStyle specifies edge enhancement for the volume rendering style.

Hint: surfaceNormals can be provided in a single ComposedTexture3D, ImageTexture3D or PixelTexture3D node.
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[]

getEdgeColor()

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

boolean

getEnabled()

Provide boolean value from inputOutput SFBool field named enabled.

float

getGradientThreshold()

Provide float value within allowed range of [0,3.1416] from inputOutput SFFloat field named gradientThreshold.

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.

EdgeEnhancementVolumeStyle

setEdgeColor(float[] newValue)

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

EdgeEnhancementVolumeStyle

setEnabled(boolean newValue)

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

EdgeEnhancementVolumeStyle

setGradientThreshold(float newValue)

Accessor method to assign float value to inputOutput SFFloat field named gradientThreshold.

EdgeEnhancementVolumeStyle

setMetadata(X3DMetadataObject newValue)

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

EdgeEnhancementVolumeStyle

setSurfaceNormals(X3DTexture3DNode newValue)

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

Method Details
- getEdgeColor
  float[] getEdgeColor()
  
  Provide array of 4-tuple float results using RGBA values [0..1] using RGBA values [0..1] from inputOutput SFColorRGBA field named edgeColor.
  
  Tooltip: [0,1] color used to highlight edges.
  
  Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color
  
  Returns:
  
  value of edgeColor field
- setEdgeColor
  EdgeEnhancementVolumeStyle setEdgeColor(float[] newValue)
  
  Accessor method to assign 4-tuple float array using RGBA values [0..1] to inputOutput SFColorRGBA field named edgeColor.
  
  Tooltip: [0,1] color used to highlight edges.
  
  Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color
  
  Parameters:
  
  newValue - is new value for the edgeColor field.
  
  Returns:
  
  EdgeEnhancementVolumeStyle - 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
  
  EdgeEnhancementVolumeStyle 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:
  
  EdgeEnhancementVolumeStyle - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getGradientThreshold
  
  float getGradientThreshold()
  
  Provide float value within allowed range of [0,3.1416] from inputOutput SFFloat field named gradientThreshold.
  
  Tooltip: [0,1] minimum angle (in radians) away from view-direction vector for surface normal before applying enhancement. *
  
  Returns:
  
  value of gradientThreshold field
- setGradientThreshold
  
  EdgeEnhancementVolumeStyle setGradientThreshold(float newValue)
  
  Accessor method to assign float value to inputOutput SFFloat field named gradientThreshold.
  
  Tooltip: [0,1] minimum angle (in radians) away from view-direction vector for surface normal before applying enhancement. *
  
  Parameters:
  
  newValue - is new value for the gradientThreshold field.
  
  Returns:
  
  EdgeEnhancementVolumeStyle - 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
  EdgeEnhancementVolumeStyle 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:
  
  EdgeEnhancementVolumeStyle - 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
  
  EdgeEnhancementVolumeStyle 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:
  
  EdgeEnhancementVolumeStyle - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

Interface EdgeEnhancementVolumeStyle

Method Summary

Method Details

getEdgeColor

setEdgeColor

getEnabled

setEnabled

getGradientThreshold

setGradientThreshold

getMetadata

setMetadata

getSurfaceNormals

setSurfaceNormals