ProgramShader (X3DJSAIL, X3D Java Scene Access Interface Library)

All Superinterfaces:

X3DAppearanceChildNode, X3DNode, X3DShaderNode

All Known Implementing Classes:

ProgramShaderObject
```
public interface ProgramShader
extends X3DShaderNode
```
ProgramShader contains no field declarations and no plain-text source code.

X3D node tooltip: (X3D version 3.1 or later) [X3DShaderNode] ProgramShader defines a shader that consists of one or more individually programmable, self-contained pieces. ProgramShader contains IS/connect and programs [ShaderProgram] nodes.
- Warning: ProgramShader contains no field declarations and no plain-text CDATA block source code.
- 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: ProgramShader, X3D Tooltips: ProgramShader, X3D Scene Authoring Hints

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addPrograms(X3DNode[] newValue)` Add array of child programs 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 ['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[]`	`getPrograms()` Provide array of X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field programs.
`ProgramShader`	`setActivate(boolean newValue)` Assign boolean value to inputOnly SFBool field named activate.
`ProgramShader`	`setCssClass(java.lang.String newValue)` Assign String value to inputOutput SFString field named class.
`ProgramShader`	`setDEF(java.lang.String newValue)` Assign String value to inputOutput SFString field named DEF.
`ProgramShader`	`setLanguage(java.lang.String newValue)` Assign String enumeration value ("Cg"\|"GLSL"\|"HLSL") ['Cg'\|'GLSL'\|'HLSL'\|'etc.'] to initializeOnly SFString field named language.
`ProgramShader`	`setMetadata(X3DMetadataObject newValue)` Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`void`	`setPrograms(X3DNode newValue)` Set single child programs node, replacing prior array of existing nodes (if any).
`ProgramShader`	`setPrograms(X3DNode[] newValue)` Assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field programs.
`ProgramShader`	`setUSE(java.lang.String newValue)` Assign String value to inputOutput SFString field named USE.

- Method Detail
  - setActivate
```
ProgramShader setActivate(boolean newValue)
```
    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.
    
    Specified by:
    
    setActivate in interface X3DShaderNode
    
    Parameters:
    
    newValue - is new value for the activate field.
    
    Returns:
    
    ProgramShader - 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.
    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.
    Specified by:
    
    getIsValid in interface X3DShaderNode
    
    Returns:
    
    value of isValid field
  - getLanguage
```
java.lang.String getLanguage()
```
    Provide String enumeration value ['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" "FX"
    - Hint: relates to Internationalization (i18n)
      http://www.w3.org/standards/webdesign/i18n
    Specified by:
    
    getLanguage in interface X3DShaderNode
    
    Returns:
    
    value of language field
  - setLanguage
```
ProgramShader setLanguage(java.lang.String newValue)
```
    Assign String enumeration value ("Cg"|"GLSL"|"HLSL") ['Cg'|'GLSL'|'HLSL'|'etc.'] 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" "FX" Hint: relates to Internationalization (i18n) http://www.w3.org/standards/webdesign/i18n
    
    Specified by:
    
    setLanguage in interface X3DShaderNode
    
    Parameters:
    
    newValue - is new value for the language field.
    
    Returns:
    
    ProgramShader - 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
```
ProgramShader setMetadata(X3DMetadataObject newValue)
```
    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:
    
    ProgramShader - 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
  - getPrograms
```
X3DNode[] getPrograms()
```
    Provide array of X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field programs.
    
    Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to ShaderProgram.
    
    Returns:
    
    value of programs field
    
    See Also:
    
    ShaderProgramObject
  - setPrograms
```
ProgramShader setPrograms(X3DNode[] newValue)
```
    Assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field programs.
    
    Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to ShaderProgram.
    
    Parameters:
    
    newValue - is new value for the programs field.
    
    Returns:
    
    ProgramShader - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - addPrograms
```
void addPrograms(X3DNode[] newValue)
```
    Add array of child programs nodes to array of existing nodes (if any).
    
    Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to ShaderProgram.
    
    Parameters:
    
    newValue - is new value array to be appended the programs field.
  - setPrograms
```
void setPrograms(X3DNode newValue)
```
    Set single child programs node, replacing prior array of existing nodes (if any).
    
    Parameters:
    
    newValue - is new node for the programs field
  - setDEF
```
ProgramShader setDEF(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named DEF.
    
    Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes. Hint: descriptive DEF names improve clarity and help document a model. Hint: well-defined names can simplify design and debugging through improved author understanding. Hint: X3D Scene Authoring Hints, Naming Conventions http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
    
    Note that setting the DEF value clears the USE value.
    
    Specified by:
    
    setDEF in interface X3DAppearanceChildNode
    
    Specified by:
    
    setDEF in interface X3DNode
    
    Specified by:
    
    setDEF in interface X3DShaderNode
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    ProgramShader - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUSE
```
ProgramShader setUSE(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named USE.
    
    Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value). Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance. Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute. Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
    
    Note: each USE node is still an independent object, with the USE value matching the DEF value in the preceding object.
    
    Warning: invoking the setUSE() method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.
    
    Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.
    
    Specified by:
    
    setUSE in interface X3DAppearanceChildNode
    
    Specified by:
    
    setUSE in interface X3DNode
    
    Specified by:
    
    setUSE in interface X3DShaderNode
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    ProgramShader - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setCssClass
```
ProgramShader setCssClass(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named class.
    
    Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets. Warning: currently the class attribute is only supported in XML encoding of X3D scenes. Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
    
    Specified by:
    
    setCssClass in interface X3DAppearanceChildNode
    
    Specified by:
    
    setCssClass in interface X3DNode
    
    Specified by:
    
    setCssClass in interface X3DShaderNode
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    ProgramShader - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

Interface ProgramShader

Method Summary

Method Detail

setActivate

getIsSelected

getIsValid

getLanguage

setLanguage

getMetadata

setMetadata

getPrograms

setPrograms

addPrograms

setPrograms

setDEF

setUSE

setCssClass