Package org.web3d.x3d.sai.VolumeRendering

Interface ProjectionVolumeStyle

All Superinterfaces:
X3DNode, X3DVolumeRenderStyleNode
All Known Implementing Classes:
ProjectionVolumeStyle
public interface ProjectionVolumeStyle extends X3DVolumeRenderStyleNode
ProjectionVolumeStyle uses voxel data to directly generate output color.

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. X3D node tooltip: (X3D version 3.3 or later) [X3DComposableVolumeRenderStyleNode] ProjectionVolumeStyle uses voxel data to directly generate output color. 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:

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    getEnabled()
    Provide boolean value from inputOutput SFBool field named enabled.
    float
    getIntensityThreshold()
    Provide float value within allowed range of [0,1] from inputOutput SFFloat field named intensityThreshold.
    X3DMetadataObject
    getMetadata()
    Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    String
    getType()
    Provide String enumeration value (baseType xs:NMTOKEN) ["MAX" | "MIN" | "AVERAGE"] from inputOutput SFString field named type.
    ProjectionVolumeStyle
    setEnabled(boolean newValue)
    Accessor method to assign boolean value to inputOutput SFBool field named enabled.
    ProjectionVolumeStyle
    setIntensityThreshold(float newValue)
    Accessor method to assign float value to inputOutput SFFloat field named intensityThreshold.
    ProjectionVolumeStyle
    setMetadata(X3DMetadataObject newValue)
    Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    ProjectionVolumeStyle
    setType(String newValue)
    Accessor method to assign String enumeration value ("MAX" | "MIN" | "AVERAGE") to inputOutput SFString field named type.

  • Method Details

    • getEnabled

      boolean getEnabled()
      Provide boolean value from inputOutput SFBool field named enabled.

      Tooltip: Enables/disables node operation. *
      Specified by:
      getEnabled in interface X3DVolumeRenderStyleNode
      Returns:
      value of enabled field

    • setEnabled

      ProjectionVolumeStyle 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 X3DVolumeRenderStyleNode
      Parameters:
      newValue - is new value for the enabled field.
      Returns:
      ProjectionVolumeStyle - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getIntensityThreshold

      float getIntensityThreshold()
      Provide float value within allowed range of [0,1] from inputOutput SFFloat field named intensityThreshold.

      Tooltip: [0,1] Threshold value used when type=MIN (LMIP) or type=MAX (MIP). Hint: ignored if type=AVERAGE (no thresholding). *
      Returns:
      value of intensityThreshold field

    • setIntensityThreshold

      ProjectionVolumeStyle setIntensityThreshold(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named intensityThreshold.

      Tooltip: [0,1] Threshold value used when type=MIN (LMIP) or type=MAX (MIP). Hint: ignored if type=AVERAGE (no thresholding). *
      Parameters:
      newValue - is new value for the intensityThreshold field.
      Returns:
      ProjectionVolumeStyle - 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 <a href="https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/core.html#Metadata" target="_blank">https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/core.html#Metadata</a> *
      Specified by:
      getMetadata in interface X3DNode
      Specified by:
      getMetadata in interface X3DVolumeRenderStyleNode
      Returns:
      value of metadata field
      See Also:

    • setMetadata

      ProjectionVolumeStyle 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 <a href="https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/core.html#Metadata" target="_blank">https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/core.html#Metadata</a> *
      Specified by:
      setMetadata in interface X3DNode
      Specified by:
      setMetadata in interface X3DVolumeRenderStyleNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      ProjectionVolumeStyle - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • getType

      String getType()
      Provide String enumeration value (baseType xs:NMTOKEN) ["MAX" | "MIN" | "AVERAGE"] from inputOutput SFString field named type.

      Tooltip: If type=MAX then Maximum Intensity Projection (MIP) or Least MIP (LMIP) algorithm is used to generate output color. If type=MIN then Minimum Intensity Projection algorithm is used. If type=AVERAGE then all voxels along ray are averaged. Hint: type=AVERAGE matches a simple approximation of an X-ray.#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 type field

    • setType

      ProjectionVolumeStyle setType(String newValue)
      Accessor method to assign String enumeration value ("MAX" | "MIN" | "AVERAGE") to inputOutput SFString field named type.

      Tooltip: If type=MAX then Maximum Intensity Projection (MIP) or Least MIP (LMIP) algorithm is used to generate output color. If type=MIN then Minimum Intensity Projection algorithm is used. If type=AVERAGE then all voxels along ray are averaged. Hint: type=AVERAGE matches a simple approximation of an X-ray.#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 type field.
      Returns:
      ProjectionVolumeStyle - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).