All Superinterfaces:: X3DComposableVolumeRenderStyleNode, X3DNode, X3DVolumeRenderStyleNode

All Known Implementing Classes:: ShadedVolumeStyle

public interface ShadedVolumeStyle extends X3DComposableVolumeRenderStyleNode

All fields fully supported except shadows supported with at least Phong shading at level 3. All fields fully supported with at least Phong shading and Henyey-Greenstein phase function, shadows fully supported at level 4.

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. ShadedVolumeStyle node tooltip: (X3D version 3.3 or later) [X3DComposableVolumeRenderStyleNode] ShadedVolumeStyle applies Blinn-Phong illumination model to volume rendering.

Hint: ShadedVolumeStyle can contain a single Texture3D node with containerField='surfaceNormals' and a single Material node.
Warning: requires X3D profile='Full' or else include <component name='VolumeRendering' level='3'/> or level='4' to include shadows.

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

boolean

getEnabled()

Provide boolean value from inputOutput SFBool field named enabled.

boolean

getLighting()

Provide boolean value from inputOutput SFBool field named lighting.

X3DMaterialNode

getMaterial()

Provide org.web3d.x3d.sai.Shape.X3DMaterialNode instance (using a properly typed node) from inputOutput SFNode field material.

X3DMetadataObject

getMetadata()

Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.

String

getPhaseFunction()

Provide String enumeration value (baseType SFString) ["Henyey-Greenstein" | "NONE" | 'etc.'] from initializeOnly SFString field named phaseFunction.

boolean

getShadows()

Provide boolean value from inputOutput SFBool field named shadows.

X3DTexture3DNode

getSurfaceNormals()

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

ShadedVolumeStyle

setEnabled(boolean newValue)

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

ShadedVolumeStyle

setLighting(boolean newValue)

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

ShadedVolumeStyle

setMaterial(X3DMaterialNode newValue)

Accessor method to assign org.web3d.x3d.sai.Shape.X3DMaterialNode instance (using a properly typed node) to inputOutput SFNode field material.

ShadedVolumeStyle

setMetadata(X3DMetadataObject newValue)

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

ShadedVolumeStyle

setPhaseFunction(String newValue)

Accessor method to assign String enumeration value ("Henyey-Greenstein" | "NONE") to initializeOnly SFString field named phaseFunction.

ShadedVolumeStyle

setShadows(boolean newValue)

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

ShadedVolumeStyle

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
  
  ShadedVolumeStyle 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:
  
  ShadedVolumeStyle - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getLighting
  
  boolean getLighting()
  
  Provide boolean value from inputOutput SFBool field named lighting.
  
  Tooltip: Whether rendering calculates and applies shading effects to visual output. *
  
  Returns:
  
  value of lighting field
- setLighting
  
  ShadedVolumeStyle setLighting(boolean newValue)
  
  Accessor method to assign boolean value to inputOutput SFBool field named lighting.
  
  Tooltip: Whether rendering calculates and applies shading effects to visual output. *
  
  Parameters:
  
  newValue - is new value for the lighting field.
  
  Returns:
  
  ShadedVolumeStyle - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getMaterial
  
  X3DMaterialNode getMaterial()
  
  Provide org.web3d.x3d.sai.Shape.X3DMaterialNode instance (using a properly typed node) from inputOutput SFNode field material.
  
  Tooltip: [X3DMaterialNode] Colour and opacity is determined based on whether a value has been specified for the material field. *
  
  Returns:
  
  value of material field
- setMaterial
  
  ShadedVolumeStyle setMaterial(X3DMaterialNode newValue)
  
  Accessor method to assign org.web3d.x3d.sai.Shape.X3DMaterialNode instance (using a properly typed node) to inputOutput SFNode field material.
  
  Tooltip: [X3DMaterialNode] Colour and opacity is determined based on whether a value has been specified for the material field. *
  
  Parameters:
  
  newValue - is new value for the material field.
  
  Returns:
  
  ShadedVolumeStyle - 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
  ShadedVolumeStyle 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:
  
  ShadedVolumeStyle - 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
- getPhaseFunction
  String getPhaseFunction()
  
  Provide String enumeration value (baseType SFString) ["Henyey-Greenstein" | "NONE" | 'etc.'] from initializeOnly SFString field named phaseFunction.
  
  Tooltip: define scattering model for implementations using global illumination (NONE or Henyey-Greenstein phase function).#10;
  
  Warning: do not wrap extra quotation marks around these SFString enumeration values, since "quotation" "marks" are only used for MFString values.
  
  Returns:
  
  value of phaseFunction field
- setPhaseFunction
  ShadedVolumeStyle setPhaseFunction(String newValue)
  
  Accessor method to assign String enumeration value ("Henyey-Greenstein" | "NONE") to initializeOnly SFString field named phaseFunction.
  
  Tooltip: define scattering model for implementations using global illumination (NONE or Henyey-Greenstein phase function).#10;
  
  Warning: do not wrap extra quotation marks around these SFString enumeration values, since "quotation" "marks" are only used for MFString values.
  
  Parameters:
  
  newValue - is new value for the phaseFunction field.
  
  Returns:
  
  ShadedVolumeStyle - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getShadows
  
  boolean getShadows()
  
  Provide boolean value from inputOutput SFBool field named shadows.
  
  Tooltip: Whether rendering calculates and applies shadows to visual output (using global illumination model). *
  
  Returns:
  
  value of shadows field
- setShadows
  
  ShadedVolumeStyle setShadows(boolean newValue)
  
  Accessor method to assign boolean value to inputOutput SFBool field named shadows.
  
  Tooltip: Whether rendering calculates and applies shadows to visual output (using global illumination model). *
  
  Parameters:
  
  newValue - is new value for the shadows field.
  
  Returns:
  
  ShadedVolumeStyle - 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
  
  ShadedVolumeStyle 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:
  
  ShadedVolumeStyle - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

Interface ShadedVolumeStyle

Method Summary

Method Details

getEnabled

setEnabled

getLighting

setLighting

getMaterial

setMaterial

getMetadata

setMetadata

getPhaseFunction

setPhaseFunction

getShadows

setShadows

getSurfaceNormals

setSurfaceNormals