BoundaryEnhancementVolumeStyle (X3DJSAIL, X3D Java Scene Access Interface Library)

All Superinterfaces:

X3DComposableVolumeRenderStyleNode, X3DNode, X3DVolumeRenderStyleNode

All Known Implementing Classes:

BoundaryEnhancementVolumeStyleObject
```
public interface BoundaryEnhancementVolumeStyle
extends X3DComposableVolumeRenderStyleNode
```
Abstract node interface, defined by X3D specification to support X3D Java interoperability.

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

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

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and 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)` Assign float value within allowed range of [0,1] to inputOutput SFFloat field named boundaryOpacity.
`BoundaryEnhancementVolumeStyle`	`setCssClass(java.lang.String newValue)` Assign String value to inputOutput SFString field named class.
`BoundaryEnhancementVolumeStyle`	`setDEF(java.lang.String newValue)` Assign String value to inputOutput SFString field named DEF.
`BoundaryEnhancementVolumeStyle`	`setEnabled(boolean newValue)` Assign boolean value to inputOutput SFBool field named enabled.
`BoundaryEnhancementVolumeStyle`	`setMetadata(X3DMetadataObject newValue)` Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`BoundaryEnhancementVolumeStyle`	`setOpacityFactor(float newValue)` Assign float value within allowed range of [0,infinity) to inputOutput SFFloat field named opacityFactor.
`BoundaryEnhancementVolumeStyle`	`setRetainedOpacity(float newValue)` Assign float value within allowed range of [0,1] to inputOutput SFFloat field named retainedOpacity.
`BoundaryEnhancementVolumeStyle`	`setUSE(java.lang.String newValue)` Assign String value to inputOutput SFString field named USE.

- Method Detail
  - 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)
```
    Assign float value within allowed range of [0,1] 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)
```
    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.
    
    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)
```
    Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field 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)
```
    Assign float value within allowed range of [0,infinity) 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)
```
    Assign float value within allowed range of [0,1] 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).
  - setDEF
```
BoundaryEnhancementVolumeStyle setDEF(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named DEF.
    
    Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes. Hint: descriptive DEF names improve clarity and help document a model. Hint: well-defined names can simplify design and debugging through improved author understanding. Hint: X3D Scene Authoring Hints, Naming Conventions http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
    
    Note that setting the DEF value clears the USE value.
    
    Specified by:
    
    setDEF in interface X3DComposableVolumeRenderStyleNode
    
    Specified by:
    
    setDEF in interface X3DNode
    
    Specified by:
    
    setDEF in interface X3DVolumeRenderStyleNode
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    BoundaryEnhancementVolumeStyle - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUSE
```
BoundaryEnhancementVolumeStyle setUSE(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named USE.
    
    Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value). Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance. Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute. Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
    
    Note: each USE node is still an independent object, with the USE value matching the DEF value in the preceding object.
    
    Warning: invoking the setUSE() method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.
    
    Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.
    
    Specified by:
    
    setUSE in interface X3DComposableVolumeRenderStyleNode
    
    Specified by:
    
    setUSE in interface X3DNode
    
    Specified by:
    
    setUSE in interface X3DVolumeRenderStyleNode
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    BoundaryEnhancementVolumeStyle - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setCssClass
```
BoundaryEnhancementVolumeStyle setCssClass(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named class.
    
    Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets. Warning: currently the class attribute is only supported in XML encoding of X3D scenes. Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
    
    Specified by:
    
    setCssClass in interface X3DComposableVolumeRenderStyleNode
    
    Specified by:
    
    setCssClass in interface X3DNode
    
    Specified by:
    
    setCssClass in interface X3DVolumeRenderStyleNode
    
    Parameters:
    
    newValue - is new value for the class 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 Detail

getBoundaryOpacity

setBoundaryOpacity

getEnabled

setEnabled

getMetadata

setMetadata

getOpacityFactor

setOpacityFactor

getRetainedOpacity

setRetainedOpacity

setDEF

setUSE

setCssClass