Package org.web3d.x3d.sai.VolumeRendering

Interface ComposedVolumeStyle

All Superinterfaces:
X3DComposableVolumeRenderStyleNode, X3DNode, X3DVolumeRenderStyleNode
All Known Implementing Classes:
ComposedVolumeStyle
public interface ComposedVolumeStyle extends X3DComposableVolumeRenderStyleNode
ComposedVolumeStyle allows compositing multiple rendering styles into single rendering pass.

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] ComposedVolumeStyle allows compositing multiple rendering styles into single rendering pass. Hint: contains multiple RenderStyle nodes. 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
    void
    addRenderStyle(X3DNode[] newValue)
    Add array of child renderStyle nodes to array of existing nodes (if any).
    boolean
    getEnabled()
    Provide boolean value from inputOutput SFBool field named enabled.
    X3DMetadataObject
    getMetadata()
    Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    X3DNode[]
    getRenderStyle()
    Provide array of org.web3d.x3d.sai.Core.X3DNode results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field renderStyle.
    ComposedVolumeStyle
    setEnabled(boolean newValue)
    Accessor method to assign boolean value to inputOutput SFBool field named enabled.
    ComposedVolumeStyle
    setMetadata(X3DMetadataObject newValue)
    Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    void
    setRenderStyle(X3DNode newValue)
    Set single child renderStyle node, replacing prior array of existing nodes (if any).
    ComposedVolumeStyle
    setRenderStyle(X3DNode[] newValue)
    Accessor method to assign org.web3d.x3d.sai.Core.X3DNode array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field renderStyle.

  • 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

      ComposedVolumeStyle 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:
      ComposedVolumeStyle - 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 X3DComposableVolumeRenderStyleNode
      Specified by:
      getMetadata in interface X3DNode
      Specified by:
      getMetadata in interface X3DVolumeRenderStyleNode
      Returns:
      value of metadata field
      See Also:

    • setMetadata

      ComposedVolumeStyle 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 X3DComposableVolumeRenderStyleNode
      Specified by:
      setMetadata in interface X3DNode
      Specified by:
      setMetadata in interface X3DVolumeRenderStyleNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      ComposedVolumeStyle - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • getRenderStyle

      X3DNode[] getRenderStyle()
      Provide array of org.web3d.x3d.sai.Core.X3DNode results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field renderStyle.

      Tooltip: [X3DComposableVolumeRenderStyleNode] List of contributing rendering style nodes or node references that can be applied to the object. Each rendering style is applied strictly in the order declared, starting with the first rendering style in the renderStyle field. *


      Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DComposableVolumeRenderStyleNode.
      Returns:
      value of renderStyle field
      See Also:

    • setRenderStyle

      ComposedVolumeStyle setRenderStyle(X3DNode[] newValue)
      Accessor method to assign org.web3d.x3d.sai.Core.X3DNode array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field renderStyle.

      Tooltip: [X3DComposableVolumeRenderStyleNode] List of contributing rendering style nodes or node references that can be applied to the object. Each rendering style is applied strictly in the order declared, starting with the first rendering style in the renderStyle field. *


      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DComposableVolumeRenderStyleNode.
      Parameters:
      newValue - is new value for the renderStyle field.
      Returns:
      ComposedVolumeStyle - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • addRenderStyle

      void addRenderStyle(X3DNode[] newValue)
      Add array of child renderStyle nodes to array of existing nodes (if any).

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DComposableVolumeRenderStyleNode.
      Parameters:
      newValue - is new value array to be appended the renderStyle field.

    • setRenderStyle

      void setRenderStyle(X3DNode newValue)
      Set single child renderStyle node, replacing prior array of existing nodes (if any).
      Parameters:
      newValue - is new node for the renderStyle field