Interface CartoonVolumeStyle

All Superinterfaces:
X3DComposableVolumeRenderStyleNode, X3DNode, X3DVolumeRenderStyleNode
All Known Implementing Classes:
CartoonVolumeStyle

public interface CartoonVolumeStyle extends X3DComposableVolumeRenderStyleNode
CartoonVolumeStyle generates cartoon-style non-photorealistic rendering of associated volumetric data.

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'
  • Warning: requires X3D profile='Full' or else include <component name='VolumeRendering' level='3'/>

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: CartoonVolumeStyle, X3D Tooltips: CartoonVolumeStyle, X3D Scene Authoring Hints: Volume
  • Method Summary

    Modifier and Type
    Method
    Description
    int
    Provide int value using RGB values [0..1] from inputOutput SFInt32 field named colorSteps.
    boolean
    Provide boolean value from inputOutput SFBool field named enabled.
    Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    float[]
    Provide array of 4-tuple float results using RGBA values [0..1] using RGBA values [0..1] from inputOutput SFColorRGBA field named orthogonalColor.
    float[]
    Provide array of 4-tuple float results using RGBA values [0..1] using RGBA values [0..1] from inputOutput SFColorRGBA field named parallelColor.
    Provide org.web3d.x3d.sai.Texturing3D.X3DTexture3DNode instance (using a properly typed node) from inputOutput SFNode field surfaceNormals.
    setColorSteps​(int newValue)
    Accessor method to assign int value to inputOutput SFInt32 field named colorSteps.
    setEnabled​(boolean newValue)
    Accessor method to assign boolean value to inputOutput SFBool field named enabled.
    Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    setOrthogonalColor​(float[] newValue)
    Accessor method to assign 4-tuple float array using RGBA values [0..1] to inputOutput SFColorRGBA field named orthogonalColor.
    setParallelColor​(float[] newValue)
    Accessor method to assign 4-tuple float array using RGBA values [0..1] to inputOutput SFColorRGBA field named parallelColor.
    Accessor method to assign org.web3d.x3d.sai.Texturing3D.X3DTexture3DNode instance (using a properly typed node) to inputOutput SFNode field surfaceNormals.
  • Method Details

    • 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)
      Accessor method to assign int value 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)
      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:
      CartoonVolumeStyle - 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.
      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)
      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.
      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.
      Returns:
      value of orthogonalColor field
    • setOrthogonalColor

      CartoonVolumeStyle setOrthogonalColor(float[] newValue)
      Accessor method to assign 4-tuple float array 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.
      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.
      Returns:
      value of parallelColor field
    • setParallelColor

      CartoonVolumeStyle setParallelColor(float[] newValue)
      Accessor method to assign 4-tuple float array 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.
      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 org.web3d.x3d.sai.Texturing3D.X3DTexture3DNode instance (using a properly typed node) from inputOutput SFNode field surfaceNormals.
      Returns:
      value of surfaceNormals field
    • setSurfaceNormals

      CartoonVolumeStyle setSurfaceNormals(X3DTexture3DNode newValue)
      Accessor method to assign org.web3d.x3d.sai.Texturing3D.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).