ShadedVolumeStyle (X3DJSAIL, X3D Java Scene Access Interface Library)

All Superinterfaces:

X3DComposableVolumeRenderStyleNode, X3DNode, X3DVolumeRenderStyleNode

All Known Implementing Classes:

ShadedVolumeStyleObject
```
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.

X3D 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.
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: ShadedVolumeStyle, X3D Tooltips: ShadedVolumeStyle, X3D Scene Authoring Hints: Volume

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and 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 X3DMaterialNode instance (using a properly typed node) from inputOutput SFNode field material.
`X3DMetadataObject`	`getMetadata()` Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
`java.lang.String`	`getPhaseFunction()` Provide String enumeration value ['Henyey-Greenstein'\|'NONE'\|'etc.'] from initializeOnly SFString field named phaseFunction.
`boolean`	`getShadows()` Provide boolean value from inputOutput SFBool field named shadows.
`X3DTexture3DNode`	`getSurfaceNormals()` Provide X3DTexture3DNode instance (using a properly typed node) from inputOutput SFNode field surfaceNormals.
`ShadedVolumeStyle`	`setCssClass(java.lang.String newValue)` Assign String value to inputOutput SFString field named class.
`ShadedVolumeStyle`	`setDEF(java.lang.String newValue)` Assign String value to inputOutput SFString field named DEF.
`ShadedVolumeStyle`	`setEnabled(boolean newValue)` Assign boolean value to inputOutput SFBool field named enabled.
`ShadedVolumeStyle`	`setLighting(boolean newValue)` Assign boolean value to inputOutput SFBool field named lighting.
`ShadedVolumeStyle`	`setMaterial(X3DMaterialNode newValue)` Assign X3DMaterialNode instance (using a properly typed node) to inputOutput SFNode field material.
`ShadedVolumeStyle`	`setMetadata(X3DMetadataObject newValue)` Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`ShadedVolumeStyle`	`setPhaseFunction(java.lang.String newValue)` Assign String enumeration value ("Henyey-Greenstein"\|"NONE") ['Henyey-Greenstein'\|'NONE'\|'etc.'] to initializeOnly SFString field named phaseFunction.
`ShadedVolumeStyle`	`setShadows(boolean newValue)` Assign boolean value to inputOutput SFBool field named shadows.
`ShadedVolumeStyle`	`setSurfaceNormals(X3DTexture3DNode newValue)` Assign X3DTexture3DNode instance (using a properly typed node) to inputOutput SFNode field surfaceNormals.
`ShadedVolumeStyle`	`setUSE(java.lang.String newValue)` Assign String value to inputOutput SFString field named USE.

- Method Detail
  - 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)
```
    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)
```
    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 X3DMaterialNode instance (using a properly typed node) from inputOutput SFNode field material.
    
    Returns:
    
    value of material field
  - setMaterial
```
ShadedVolumeStyle setMaterial(X3DMaterialNode newValue)
```
    Assign X3DMaterialNode instance (using a properly typed node) to inputOutput SFNode field material.
    
    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 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
```
ShadedVolumeStyle 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:
    
    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
```
java.lang.String getPhaseFunction()
```
    Provide String enumeration value ['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(java.lang.String newValue)
```
    Assign String enumeration value ("Henyey-Greenstein"|"NONE") ['Henyey-Greenstein'|'NONE'|'etc.'] 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)
```
    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 X3DTexture3DNode instance (using a properly typed node) from inputOutput SFNode field surfaceNormals.
    
    Returns:
    
    value of surfaceNormals field
  - setSurfaceNormals
```
ShadedVolumeStyle setSurfaceNormals(X3DTexture3DNode newValue)
```
    Assign X3DTexture3DNode instance (using a properly typed node) to inputOutput SFNode field surfaceNormals.
    
    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).
  - setDEF
```
ShadedVolumeStyle 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:
    
    ShadedVolumeStyle - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUSE
```
ShadedVolumeStyle 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:
    
    ShadedVolumeStyle - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setCssClass
```
ShadedVolumeStyle 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:
    
    ShadedVolumeStyle - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

Interface ShadedVolumeStyle

Method Summary

Method Detail

getEnabled

setEnabled

getLighting

setLighting

getMaterial

setMaterial

getMetadata

setMetadata

getPhaseFunction

setPhaseFunction

getShadows

setShadows

getSurfaceNormals

setSurfaceNormals

setDEF

setUSE

setCssClass