Interface ComposedShader

All Superinterfaces:
X3DAppearanceChildNode, X3DNode, X3DProgrammableShaderObject, X3DShaderNode
All Known Implementing Classes:
ComposedShaderObject

public interface ComposedShader
extends X3DShaderNode, X3DProgrammableShaderObject
ComposedShader can contain field declarations, but no CDATA section of plain-text source code, since programs are composed from child ShaderPart nodes.

X3D node tooltip: (X3D version 3.1 or later) [X3DShaderNode,X3DProgrammableShaderObject] ComposedShader defines a shader where the individual source files are assembled from contained ShaderPart program sections. All access to shading capabilities is defined through a single interface that applies to all parts.
  • Hint: ComposedShader contains field declarations and then corresponding IS/connect statements (if any), followed by <ShaderPart containerField='parts'/> nodes.
  • Warning: ComposedShader does not contain CDATA section of plain-text source code. All source programs are contained in child ShaderPart nodes.
  • Hint: apply default containerField='shaders' when parent node is Appearance.

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

    Modifier and Type Method Description
    void addParts​(X3DNode[] newValue)
    Add array of child parts nodes to array of existing nodes (if any).
    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 shaderLanguageValues) ["Cg" | "GLSL" | "HLSL" | 'etc.'] from initializeOnly SFString field named language.
    X3DMetadataObject getMetadata()
    Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    X3DNode[] getParts()
    Provide array of X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field parts.
    ComposedShader setActivate​(boolean newValue)
    Accessor method to assign boolean value to inputOnly SFBool field named activate.
    ComposedShader setLanguage​(java.lang.String newValue)
    Accessor method to assign String enumeration value ("Cg" | "GLSL" | "HLSL") to initializeOnly SFString field named language.
    ComposedShader setMetadata​(X3DMetadataObject newValue)
    Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    void setParts​(X3DNode newValue)
    Set single child parts node, replacing prior array of existing nodes (if any).
    ComposedShader setParts​(X3DNode[] newValue)
    Accessor method to assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field parts.
  • Method Details

    • setActivate

      ComposedShader 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:
      ComposedShader - 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 shaderLanguageValues) ["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

      ComposedShader 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:
      ComposedShader - 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 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

      ComposedShader setMetadata​(X3DMetadataObject newValue)
      Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
      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:
      ComposedShader - 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
    • getParts

      X3DNode[] getParts()
      Provide array of X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field parts.

      Tooltip: [ShaderPart] Multiple ShaderPart nodes contained in the ComposedShader node. *


      Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to ShaderPart.
      Returns:
      value of parts field
      See Also:
      ShaderPartObject
    • setParts

      ComposedShader setParts​(X3DNode[] newValue)
      Accessor method to assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field parts.

      Tooltip: [ShaderPart] Multiple ShaderPart nodes contained in the ComposedShader node. *


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

      void addParts​(X3DNode[] newValue)
      Add array of child parts nodes to array of existing nodes (if any).

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

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