Package org.web3d.x3d.sai.VolumeRendering

Interface SilhouetteEnhancementVolumeStyle

All Superinterfaces:

X3DComposableVolumeRenderStyleNode, X3DNode, X3DVolumeRenderStyleNode

All Known Implementing Classes:

SilhouetteEnhancementVolumeStyle

public interface SilhouetteEnhancementVolumeStyle
extends X3DComposableVolumeRenderStyleNode

SilhouetteEnhancementVolumeStyle specifies that volumetric data is rendered with silhouette enhancement.

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. SilhouetteEnhancementVolumeStyle node tooltip: (X3D version 3.3 or later) [X3DComposableVolumeRenderStyleNode] SilhouetteEnhancementVolumeStyle specifies that volumetric data is rendered with silhouette enhancement.

• Hint: SilhouetteEnhancementVolumeStyle can contain a single Texture3D node with containerField='surfaceNormals'
• 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
• X3D Abstract Specification: SilhouetteEnhancementVolumeStyle
• X3D Tooltips: SilhouetteEnhancementVolumeStyle
• X3D Scene Authoring Hints: Volume

Method Summary

Modifier and Type	Method	Description
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.
float	getSilhouetteBoundaryOpacity()	Provide float value within allowed range of [0,1] from inputOutput SFFloat field named silhouetteBoundaryOpacity.
float	getSilhouetteRetainedOpacity()	Provide float value within allowed range of [0,1] from inputOutput SFFloat field named silhouetteRetainedOpacity.
float	getSilhouetteSharpness()	Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named silhouetteSharpness.
X3DTexture3DNode	getSurfaceNormals()	Provide org.web3d.x3d.sai.Texturing3D.X3DTexture3DNode instance (using a properly typed node) from inputOutput SFNode field surfaceNormals.
SilhouetteEnhancementVolumeStyle	setEnabled(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named enabled.
SilhouetteEnhancementVolumeStyle	setMetadata(X3DMetadataObject newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
SilhouetteEnhancementVolumeStyle	setSilhouetteBoundaryOpacity(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named silhouetteBoundaryOpacity.
SilhouetteEnhancementVolumeStyle	setSilhouetteRetainedOpacity(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named silhouetteRetainedOpacity.
SilhouetteEnhancementVolumeStyle	setSilhouetteSharpness(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named silhouetteSharpness.
SilhouetteEnhancementVolumeStyle	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

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

SilhouetteEnhancementVolumeStyle 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:

SilhouetteEnhancementVolumeStyle - 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

SilhouetteEnhancementVolumeStyle 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:

SilhouetteEnhancementVolumeStyle - 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

getSilhouetteBoundaryOpacity

float getSilhouetteBoundaryOpacity()

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

Tooltip: [0,1] amount of the silhouette enhancement to use. *

Returns:

value of silhouetteBoundaryOpacity field

setSilhouetteBoundaryOpacity

SilhouetteEnhancementVolumeStyle setSilhouetteBoundaryOpacity(float newValue)

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

Tooltip: [0,1] amount of the silhouette enhancement to use. *

Parameters:

newValue - is new value for the silhouetteBoundaryOpacity field.

Returns:

SilhouetteEnhancementVolumeStyle - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getSilhouetteRetainedOpacity

float getSilhouetteRetainedOpacity()

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

Tooltip: [0,1] scaling of non-silhouette regions. *

Returns:

value of silhouetteRetainedOpacity field

setSilhouetteRetainedOpacity

SilhouetteEnhancementVolumeStyle setSilhouetteRetainedOpacity(float newValue)

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

Tooltip: [0,1] scaling of non-silhouette regions. *

Parameters:

newValue - is new value for the silhouetteRetainedOpacity field.

Returns:

SilhouetteEnhancementVolumeStyle - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getSilhouetteSharpness

float getSilhouetteSharpness()

Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named silhouetteSharpness.

Tooltip: [0,+infinity) power function to control sharpness of the silhouette. *

Returns:

value of silhouetteSharpness field

setSilhouetteSharpness

SilhouetteEnhancementVolumeStyle setSilhouetteSharpness(float newValue)

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

Tooltip: [0,+infinity) power function to control sharpness of the silhouette. *

Parameters:

newValue - is new value for the silhouetteSharpness field.

Returns:

SilhouetteEnhancementVolumeStyle - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

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

SilhouetteEnhancementVolumeStyle 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:

SilhouetteEnhancementVolumeStyle - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).