CartoonVolumeStyle (X3DJSAIL, X3D Java Scene Access Interface Library)

All Superinterfaces:

X3DComposableVolumeRenderStyleNode, X3DNode, X3DVolumeRenderStyleNode

All Known Implementing Classes:

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

X3D node tooltip: (X3D version 3.3 or later) [X3DComposableVolumeRenderStyleNode] CartoonVolumeStyle generates cartoon-style non-photorealistic rendering of associated volumetric data.
- Hint: contains single Texture3D node with containerField='surfaceNormals'
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: CartoonVolumeStyle, X3D Tooltips: CartoonVolumeStyle, X3D Scene Authoring Hints: Volume

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`int`	`getColorSteps()` Provide int value using RGB values [0..1] from inputOutput SFInt32 field named colorSteps.
`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[]`	`getOrthogonalColor()` Provide array of 4-tuple float results using RGBA values [0..1] using RGBA values [0..1] from inputOutput SFColorRGBA field named orthogonalColor.
`float[]`	`getParallelColor()` Provide array of 4-tuple float results using RGBA values [0..1] using RGBA values [0..1] from inputOutput SFColorRGBA field named parallelColor.
`X3DTexture3DNode`	`getSurfaceNormals()` Provide X3DTexture3DNode instance (using a properly typed node) from inputOutput SFNode field surfaceNormals.
`CartoonVolumeStyle`	`setColorSteps(int newValue)` Assign int value using RGB values [0..1] to inputOutput SFInt32 field named colorSteps.
`CartoonVolumeStyle`	`setCssClass(java.lang.String newValue)` Assign String value to inputOutput SFString field named class.
`CartoonVolumeStyle`	`setDEF(java.lang.String newValue)` Assign String value to inputOutput SFString field named DEF.
`CartoonVolumeStyle`	`setEnabled(boolean newValue)` Assign boolean value to inputOutput SFBool field named enabled.
`CartoonVolumeStyle`	`setMetadata(X3DMetadataObject newValue)` Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`CartoonVolumeStyle`	`setOrthogonalColor(float[] newValue)` Assign 4-tuple float array using RGBA values [0..1] using RGBA values [0..1] to inputOutput SFColorRGBA field named orthogonalColor.
`CartoonVolumeStyle`	`setParallelColor(float[] newValue)` Assign 4-tuple float array using RGBA values [0..1] using RGBA values [0..1] to inputOutput SFColorRGBA field named parallelColor.
`CartoonVolumeStyle`	`setSurfaceNormals(X3DTexture3DNode newValue)` Assign X3DTexture3DNode instance (using a properly typed node) to inputOutput SFNode field surfaceNormals.
`CartoonVolumeStyle`	`setUSE(java.lang.String newValue)` Assign String value to inputOutput SFString field named USE.

- Method Detail
  - getColorSteps
```
int getColorSteps()
```
    Provide int value using RGB values [0..1] from inputOutput SFInt32 field named colorSteps.
    
    Tooltip: [1,64] Number of distinct colors taken from interpolated colors and used to render the object.
    - Hint: colorSteps=1 means no color interpolation takes place, only use orthogonalColor.
    - Hint: parallelColor and orthogonalColor interpolation is in HSV color space for RGB components, linearly for alpha component.
    Returns:
    
    value of colorSteps field
  - setColorSteps
```
CartoonVolumeStyle setColorSteps(int newValue)
```
    Assign int value using RGB values [0..1] to inputOutput SFInt32 field named colorSteps.
    
    Tooltip: [1,64] Number of distinct colors taken from interpolated colors and used to render the object. Hint: colorSteps=1 means no color interpolation takes place, only use orthogonalColor. Hint: parallelColor and orthogonalColor interpolation is in HSV color space for RGB components, linearly for alpha component.
    
    Parameters:
    
    newValue - is new value for the colorSteps field.
    
    Returns:
    
    CartoonVolumeStyle - 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
```
CartoonVolumeStyle 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:
    
    CartoonVolumeStyle - 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
```
CartoonVolumeStyle 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:
    
    CartoonVolumeStyle - 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
  - getOrthogonalColor
```
float[] getOrthogonalColor()
```
    Provide array of 4-tuple float results using RGBA values [0..1] using RGBA values [0..1] from inputOutput SFColorRGBA field named orthogonalColor.
    
    Tooltip: [0,1] orthogonalColor is used for surface normals that are orthogonal (perpendicular) to viewer's current location.
    - Hint: plane of surface itself is orthogonal to user's view direction.
    - Hint: X3D Scene Authoring Hints, Color
      http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color
    Returns:
    
    value of orthogonalColor field
  - setOrthogonalColor
```
CartoonVolumeStyle setOrthogonalColor(float[] newValue)
```
    Assign 4-tuple float array using RGBA values [0..1] using RGBA values [0..1] to inputOutput SFColorRGBA field named orthogonalColor.
    
    Tooltip: [0,1] orthogonalColor is used for surface normals that are orthogonal (perpendicular) to viewer's current location. Hint: plane of surface itself is orthogonal to user's view direction. Hint: X3D Scene Authoring Hints, Color http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color
    
    Parameters:
    
    newValue - is new value for the orthogonalColor field.
    
    Returns:
    
    CartoonVolumeStyle - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getParallelColor
```
float[] getParallelColor()
```
    Provide array of 4-tuple float results using RGBA values [0..1] using RGBA values [0..1] from inputOutput SFColorRGBA field named parallelColor.
    
    Tooltip: [0,1] parallelColor is used for surface normals that are orthogonal to viewer's current location.
    - Hint: plane of surface itself is parallel to user's view direction.
    - Hint: X3D Scene Authoring Hints, Color
      http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color
    Returns:
    
    value of parallelColor field
  - setParallelColor
```
CartoonVolumeStyle setParallelColor(float[] newValue)
```
    Assign 4-tuple float array using RGBA values [0..1] using RGBA values [0..1] to inputOutput SFColorRGBA field named parallelColor.
    
    Tooltip: [0,1] parallelColor is used for surface normals that are orthogonal to viewer's current location. Hint: plane of surface itself is parallel to user's view direction. Hint: X3D Scene Authoring Hints, Color http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color
    
    Parameters:
    
    newValue - is new value for the parallelColor field.
    
    Returns:
    
    CartoonVolumeStyle - 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
```
CartoonVolumeStyle 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:
    
    CartoonVolumeStyle - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setDEF
```
CartoonVolumeStyle 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:
    
    CartoonVolumeStyle - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUSE
```
CartoonVolumeStyle 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:
    
    CartoonVolumeStyle - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setCssClass
```
CartoonVolumeStyle 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:
    
    CartoonVolumeStyle - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

Interface CartoonVolumeStyle

Method Summary

Method Detail

getColorSteps

setColorSteps

getEnabled

setEnabled

getMetadata

setMetadata

getOrthogonalColor

setOrthogonalColor

getParallelColor

setParallelColor

getSurfaceNormals

setSurfaceNormals

setDEF

setUSE

setCssClass