Package org.web3d.x3d.sai.Shaders

Interface PackagedShader

All Superinterfaces:
X3DAppearanceChildNode, X3DNode, X3DProgrammableShaderObject, X3DShaderNode, X3DUrlObject
All Known Implementing Classes:
PackagedShader
public interface PackagedShader
extends X3DShaderNode, X3DUrlObject, X3DProgrammableShaderObject
PackagedShader can contain field declarations, but no CDATA section of plain-text source code.

X3D node tooltip: (X3D version 3.1 or later) [X3DShaderNode,X3DUrlObject,X3DProgrammableShaderObject] PackagedShader contains a url for a single file that may contain a number of shaders and combined effects.
  • Hint: PackagedShader contains field declarations and then corresponding IS/connect statements (if any).
  • Warning: PackagedShader does not contain CDATA section of plain-text source code.
  • Hint: apply default containerField='shaders' when parent node is Appearance.
  • Hint: apply containerField='watchList' when parent node is LoadSensor.

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: PackagedShader, X3D Tooltips: PackagedShader, X3D Scene Authoring Hints

  • Method Summary

    Modifier and Type Method Description
    java.lang.String getDescription()
    Provide String value from inputOutput SFString field named description.
    boolean getIsSelected()
    Provide boolean value from outputOnly SFBool field named isSelected.
    boolean getIsValid()
    Provide boolean value from outputOnly SFBool field named isValid.
    java.lang.String getLanguage()
    Provide String enumeration value (baseType xs:NMTOKEN) ["Cg" | "GLSL" | "HLSL" | 'etc.'] from initializeOnly SFString field named language.
    boolean getLoad()
    Provide boolean value from inputOutput SFBool field named load.
    X3DMetadataObject getMetadata()
    Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    double getRefresh()
    Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named refresh.
    java.lang.String[] getUrl()
    Provide array of String results from inputOutput MFString field named url.
    PackagedShader setActivate​(boolean newValue)
    Accessor method to assign boolean value to inputOnly SFBool field named activate.
    PackagedShader setDescription​(java.lang.String newValue)
    Accessor method to assign String value to inputOutput SFString field named description.
    PackagedShader setLanguage​(java.lang.String newValue)
    Accessor method to assign String enumeration value ("Cg" | "GLSL" | "HLSL") to initializeOnly SFString field named language.
    PackagedShader setLoad​(boolean newValue)
    Accessor method to assign boolean value to inputOutput SFBool field named load.
    PackagedShader setMetadata​(X3DMetadataObject newValue)
    Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    PackagedShader setRefresh​(double newValue)
    Accessor method to assign double value in seconds to inputOutput SFTime field named refresh.
    PackagedShader setUrl​(java.lang.String[] newValue)
    Accessor method to assign String array to inputOutput MFString field named url.

  • Method Details

    • setActivate

      PackagedShader setActivate​(boolean newValue)
      Accessor method to assign boolean value to inputOnly SFBool field named activate.

      Tooltip: activate forces the shader to activate the contained objects.
      • Warning: it is an error to define this transient inputOnly field in an X3D file, instead only use it a destination for ROUTE events.
      Specified by:
      setActivate in interface X3DShaderNode
      Parameters:
      newValue - is new value for the activate field.
      Returns:
      PackagedShader - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getDescription

      java.lang.String getDescription()
      Provide String value from inputOutput SFString field named description.

      Tooltip: Author-provided prose that describes intended purpose of the url asset.
      • Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).
      Specified by:
      getDescription in interface X3DUrlObject
      Returns:
      value of description field

    • setDescription

      PackagedShader setDescription​(java.lang.String newValue)
      Accessor method to assign String value to inputOutput SFString field named description.

      Tooltip: Author-provided prose that describes intended purpose of the url asset.
      • Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).
      Specified by:
      setDescription in interface X3DUrlObject
      Parameters:
      newValue - is new value for the description field.
      Returns:
      PackagedShader - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getIsSelected

      boolean getIsSelected()
      Provide boolean value from outputOnly SFBool field named isSelected.

      Tooltip: isSelected indicates this shader instance is selected for use by browser
      • Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
      Specified by:
      getIsSelected in interface X3DShaderNode
      Returns:
      value of isSelected field

    • getIsValid

      boolean getIsValid()
      Provide boolean value from outputOnly SFBool field named isValid.

      Tooltip: isValid indicates whether current shader objects can be run as a shader program.
      • Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
      Specified by:
      getIsValid in interface X3DShaderNode
      Returns:
      value of isValid field

    • getLanguage

      java.lang.String getLanguage()
      Provide String enumeration value (baseType xs:NMTOKEN) ["Cg" | "GLSL" | "HLSL" | 'etc.'] from initializeOnly SFString field named language.

      Tooltip: The language field indicates to the X3D player which shading language is used. The language field may be used to optionally determine the language type if no MIME-type information is available.
      • Hint: recognized values include "Cg" "GLSL" "HLSL".
      Specified by:
      getLanguage in interface X3DShaderNode
      Returns:
      value of language field

    • setLanguage

      PackagedShader setLanguage​(java.lang.String newValue)
      Accessor method to assign String enumeration value ("Cg" | "GLSL" | "HLSL") to initializeOnly SFString field named language.

      Tooltip: The language field indicates to the X3D player which shading language is used. The language field may be used to optionally determine the language type if no MIME-type information is available.
      • Hint: recognized values include "Cg" "GLSL" "HLSL".
      Specified by:
      setLanguage in interface X3DShaderNode
      Parameters:
      newValue - is new value for the language field.
      Returns:
      PackagedShader - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getLoad

      boolean getLoad()
      Provide boolean value from inputOutput SFBool field named load.

      Tooltip: load=true means load immediately, load=false means defer loading or else unload a previously loaded scene.
      • Hint: allows author to design when Inline loading occurs via user interaction, event chains or scripting.
      • Hint: use a separate LoadSensor node to detect when loading is complete.
      Specified by:
      getLoad in interface X3DUrlObject
      Returns:
      value of load field

    • setLoad

      PackagedShader setLoad​(boolean newValue)
      Accessor method to assign boolean value to inputOutput SFBool field named load.

      Tooltip: load=true means load immediately, load=false means defer loading or else unload a previously loaded scene.
      • Hint: allows author to design when Inline loading occurs via user interaction, event chains or scripting.
      • Hint: use a separate LoadSensor node to detect when loading is complete.
      Specified by:
      setLoad in interface X3DUrlObject
      Parameters:
      newValue - is new value for the load field.
      Returns:
      PackagedShader - 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 X3DAppearanceChildNode
      Specified by:
      getMetadata in interface X3DNode
      Specified by:
      getMetadata in interface X3DShaderNode
      Returns:
      value of metadata field
      See Also:
      X3D Scene Authoring Hints: Metadata Nodes

    • setMetadata

      PackagedShader 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 X3DAppearanceChildNode
      Specified by:
      setMetadata in interface X3DNode
      Specified by:
      setMetadata in interface X3DShaderNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      PackagedShader - 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

    • getRefresh

      double getRefresh()
      Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named refresh.

      Tooltip: refresh defines interval in seconds before automatic reload of current url asset is performed.
      • Hint: if preceding file loading fails or load field is false, no refresh is performed.
      • Hint: repeated refresh attempts to reload currently loaded entry of url list. If that fails, the browser retries other entries in the url list.
      • Warning: automatically reloading content has security considerations and needs to be considered carefully.
      Specified by:
      getRefresh in interface X3DUrlObject
      Returns:
      value of refresh field

    • setRefresh

      PackagedShader setRefresh​(double newValue)
      Accessor method to assign double value in seconds to inputOutput SFTime field named refresh.

      Tooltip: refresh defines interval in seconds before automatic reload of current url asset is performed.
      • Hint: if preceding file loading fails or load field is false, no refresh is performed.
      • Hint: repeated refresh attempts to reload currently loaded entry of url list. If that fails, the browser retries other entries in the url list.
      • Warning: automatically reloading content has security considerations and needs to be considered carefully.
      Specified by:
      setRefresh in interface X3DUrlObject
      Parameters:
      newValue - is new value for the refresh field.
      Returns:
      PackagedShader - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getUrl

      java.lang.String[] getUrl()
      Provide array of String results from inputOutput MFString field named url.

      Tooltip: url points to a shader source-code file that may contain a number of shaders and combined effects.
      Specified by:
      getUrl in interface X3DUrlObject
      Returns:
      value of url field

    • setUrl

      PackagedShader setUrl​(java.lang.String[] newValue)
      Accessor method to assign String array to inputOutput MFString field named url.

      Tooltip: url points to a shader source-code file that may contain a number of shaders and combined effects.
      Specified by:
      setUrl in interface X3DUrlObject
      Parameters:
      newValue - is new value for the url field.
      Returns:
      PackagedShader - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).