All Superinterfaces:: X3DComposableVolumeRenderStyleNode, X3DNode, X3DVolumeRenderStyleNode

All Known Implementing Classes:: BoundaryEnhancementVolumeStyleObject

public interface BoundaryEnhancementVolumeStyle
extends X3DComposableVolumeRenderStyleNode

BoundaryEnhancementVolumeStyle provides boundary enhancement for the volume rendering style.

X3D node tooltip: (X3D version 3.3 or later) [X3DComposableVolumeRenderStyleNode] BoundaryEnhancementVolumeStyle provides boundary enhancement for the volume rendering style.

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:: SAI Java Specification: TODO, X3D Abstract Specification: BoundaryEnhancementVolumeStyle, X3D Tooltips: BoundaryEnhancementVolumeStyle, X3D Scene Authoring Hints: Volume

Method Summary

Modifier and Type	Method	Description
`float`	`getBoundaryOpacity()`	Provide float value within allowed range of [0,1] from inputOutput SFFloat field named boundaryOpacity.
`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.
`float`	`getOpacityFactor()`	Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named opacityFactor.
`float`	`getRetainedOpacity()`	Provide float value within allowed range of [0,1] from inputOutput SFFloat field named retainedOpacity.
`BoundaryEnhancementVolumeStyle`	`setBoundaryOpacity(float newValue)`	Accessor method to assign float value to inputOutput SFFloat field named boundaryOpacity.
`BoundaryEnhancementVolumeStyle`	`setEnabled(boolean newValue)`	Accessor method to assign boolean value to inputOutput SFBool field named enabled.
`BoundaryEnhancementVolumeStyle`	`setMetadata(X3DMetadataObject newValue)`	Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`BoundaryEnhancementVolumeStyle`	`setOpacityFactor(float newValue)`	Accessor method to assign float value to inputOutput SFFloat field named opacityFactor.
`BoundaryEnhancementVolumeStyle`	`setRetainedOpacity(float newValue)`	Accessor method to assign float value to inputOutput SFFloat field named retainedOpacity.

Method Details
- getBoundaryOpacity
  
  float getBoundaryOpacity()
  
  Provide float value within allowed range of [0,1] from inputOutput SFFloat field named boundaryOpacity.
  
  Tooltip: [0,+infinity) boundaryOpacity k_gs is the factored amount of the gradient enhancement to use. *
  
  Returns:
  
  value of boundaryOpacity field
- setBoundaryOpacity
  
  BoundaryEnhancementVolumeStyle setBoundaryOpacity(float newValue)
  
  Accessor method to assign float value to inputOutput SFFloat field named boundaryOpacity.
  
  Tooltip: [0,+infinity) boundaryOpacity k_gs is the factored amount of the gradient enhancement to use. *
  
  Parameters:
  
  newValue - is new value for the boundaryOpacity field.
  
  Returns:
  
  BoundaryEnhancementVolumeStyle - 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
  
  BoundaryEnhancementVolumeStyle 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:
  
  BoundaryEnhancementVolumeStyle - 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:
  
  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
  
  BoundaryEnhancementVolumeStyle setMetadata(X3DMetadataObject newValue)
  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:
  
  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:
  
  BoundaryEnhancementVolumeStyle - 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
- getOpacityFactor
  
  float getOpacityFactor()
  
  Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named opacityFactor.
  
  Tooltip: [0,+infinity) opacityFactor k_ge is the power function to control the slope of the opacity curve to highlight the set of data. *
  
  Returns:
  
  value of opacityFactor field
- setOpacityFactor
  
  BoundaryEnhancementVolumeStyle setOpacityFactor(float newValue)
  
  Accessor method to assign float value to inputOutput SFFloat field named opacityFactor.
  
  Tooltip: [0,+infinity) opacityFactor k_ge is the power function to control the slope of the opacity curve to highlight the set of data. *
  
  Parameters:
  
  newValue - is new value for the opacityFactor field.
  
  Returns:
  
  BoundaryEnhancementVolumeStyle - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getRetainedOpacity
  
  float getRetainedOpacity()
  
  Provide float value within allowed range of [0,1] from inputOutput SFFloat field named retainedOpacity.
  
  Tooltip: [0,1] retainedOpacity k_gc is the amount of initial opacity to mix into the output. *
  
  Returns:
  
  value of retainedOpacity field
- setRetainedOpacity
  
  BoundaryEnhancementVolumeStyle setRetainedOpacity(float newValue)
  
  Accessor method to assign float value to inputOutput SFFloat field named retainedOpacity.
  
  Tooltip: [0,1] retainedOpacity k_gc is the amount of initial opacity to mix into the output. *
  
  Parameters:
  
  newValue - is new value for the retainedOpacity field.
  
  Returns:
  
  BoundaryEnhancementVolumeStyle - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

Interface BoundaryEnhancementVolumeStyle

Method Summary

Method Details