ProgramShaderObject (X3DJSAIL, X3D Java Scene Access Interface Library)

java.lang.Object
- org.web3d.x3d.jsail.X3DConcreteElement
- - org.web3d.x3d.jsail.X3DConcreteNode
  - - org.web3d.x3d.jsail.Shaders.ProgramShaderObject

All Implemented Interfaces:

X3DNode, ProgramShader, X3DShaderNode, X3DAppearanceChildNode
```
public class ProgramShaderObject
extends X3DConcreteNode
implements ProgramShader
```
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 org.web3d.x3d.jsail concrete class is used for implementing a standalone X3D object as a Plain Old Java Object (POJO). If you are writing Java code for use inside an X3D Script node, compile separate code using only the org.web3d.x3d.sai package instead.
See Also:

X3D Abstract Specification: ProgramShader, X3D Tooltips: ProgramShader, X3D Scene Authoring Hints

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`COMPONENT` String constant COMPONENT defines X3D component for the ProgramShader element: Shaders
`static java.lang.String`	`containerField_DEFAULT_VALUE` containerField describes typical field relationship of a node to its parent.
`static java.lang.String`	`fromField_ISSELECTED` fromField ROUTE name for SFBool field named isSelected.
`static java.lang.String`	`fromField_ISVALID` fromField ROUTE name for SFBool field named isValid.
`static java.lang.String`	`fromField_METADATA` fromField ROUTE name for SFNode field named metadata.
`static java.lang.String`	`fromField_PROGRAMS` fromField ROUTE name for MFNode field named programs.
`static java.lang.String`	`LANGUAGE_CG` SFString field named language can equal this enumeration value "Cg" (Java syntax) or Cg (XML syntax).
`static java.lang.String`	`LANGUAGE_DEFAULT_VALUE` SFString field named language has default value equal to an empty string.
`static java.lang.String`	`LANGUAGE_GLSL` SFString field named language can equal this enumeration value "GLSL" (Java syntax) or GLSL (XML syntax).
`static java.lang.String`	`LANGUAGE_HLSL` SFString field named language can equal this enumeration value "HLSL" (Java syntax) or HLSL (XML syntax).
`static int`	`LEVEL` Integer constant LEVEL provides default X3D Shaders component level for this element: 1
`static java.lang.String`	`NAME` String constant NAME provides name of this element: ProgramShader.
`static java.lang.String`	`toField_ACTIVATE` toField ROUTE name for SFBool field named activate.
`static java.lang.String`	`toField_METADATA` toField ROUTE name for SFNode field named metadata.
`static java.lang.String`	`toField_PROGRAMS` toField ROUTE name for MFNode field named programs.

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteNode
CLASS_DEFAULT_VALUE, containerField_ALTERNATE_VALUES, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteElement
validationResult

Constructor Summary

Constructors
Constructor and Description
`ProgramShaderObject()` Constructor for ProgramShaderObject to initialize member variables with default values.
`ProgramShaderObject(java.lang.String DEFlabel)` Utility constructor that assigns DEF label after initializing member variables with default values.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ProgramShaderObject`	`addComments(CommentsBlock newCommentsBlock)` Add CommentsBlock to contained commentsList.
`ProgramShaderObject`	`addComments(java.lang.String newComment)` Add comment as String to contained commentsList.
`ProgramShaderObject`	`addComments(java.lang.String[] newComments)` Add comments as String[] array to contained commentsList.
`ProgramShaderObject`	`addPrograms(ShaderProgramObject newValue)` Add single child node to existing array of programs nodes (if any).
`void`	`addPrograms(X3DNode[] newValue)` Add array of child programs nodes to array of existing nodes (if any).
`ProgramShaderObject`	`clearMetadata()` Utility method to clear SFNode value of metadata field.
`ProgramShaderObject`	`clearPrograms()` Utility method to clear MFNode value of programs field.
`X3DConcreteElement`	`findElementByNameValue(java.lang.String nameValue)` Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.
`X3DConcreteElement`	`findElementByNameValue(java.lang.String nameValue, java.lang.String elementName)` Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.
`X3DConcreteNode`	`findNodeByDEF(java.lang.String DEFvalue)` Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
`java.lang.String`	`getAccessType(java.lang.String fieldName)` Indicate accessType corresponding to given fieldName.
`java.lang.String`	`getComponent()` Defines X3D component for the ProgramShader element: Shaders
`int`	`getComponentLevel()` Provides default X3D component level for this element: 1
`java.lang.String`	`getContainerFieldDefault()` containerField describes typical field relationship of a node to its parent.
`java.lang.String`	`getElementName()` Provides name of this element: ProgramShader
`java.lang.String`	`getFieldType(java.lang.String fieldName)` Indicate type corresponding to given fieldName.
`ISObject`	`getIS()` Provide field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes.
`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 ShaderProgram results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field programs.
`java.util.ArrayList<X3DNode>`	`getProgramsList()` Utility method to get ArrayList value of MFNode programs field, similar to `getPrograms()`.
`boolean`	`hasElementByNameValue(java.lang.String nameValue, java.lang.String elementName)` Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
`boolean`	`hasMetadata()` Indicate whether an object is available for inputOutput SFNode field metadata.
`boolean`	`hasNodeByDEF(java.lang.String DEFvalue)` Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
`boolean`	`hasPrograms()` Indicate whether an object is available for inputOutput MFNode field programs.
`void`	`initialize()` Initialize all member variables to default values.
`ProgramShaderObject`	`setActivate(boolean newValue)` Assign boolean value to inputOnly SFBool field named activate.
`ProgramShaderObject`	`setActivate(SFBoolObject newValue)` Assign typed object value to SFBool activate field, similar to `setActivate(boolean)`.
`ProgramShaderObject`	`setCssClass(SFStringObject newValue)` Assign typed object value to SFString cssClass field, similar to `setCssClass(String)`.
`ProgramShaderObject`	`setCssClass(java.lang.String newValue)` Assign String value to inputOutput SFString field named class.
`ProgramShaderObject`	`setDEF(SFStringObject newValue)` Assign typed object value to SFString DEF field, similar to `setDEF(String)`.
`ProgramShaderObject`	`setDEF(java.lang.String newValue)` Assign String value to inputOutput SFString field named DEF.
`ProgramShaderObject`	`setIS(ISObject newValue)` Assign field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes.
`ProgramShaderObject`	`setLanguage(SFStringObject newValue)` Assign typed object value to SFString language field, similar to `setLanguage(String)`.
`ProgramShaderObject`	`setLanguage(java.lang.String newValue)` Assign String enumeration value ("Cg"\|"GLSL"\|"HLSL") ['Cg'\|'GLSL'\|'HLSL'\|'etc.'] to initializeOnly SFString field named language.
`ProgramShaderObject`	`setMetadata(ProtoInstanceObject newValue)` Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
`ProgramShaderObject`	`setMetadata(X3DMetadataObject newValue)` Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`ProgramShaderObject`	`setPrograms(java.util.ArrayList<ShaderProgram> newValue)` Assign ArrayList value of MFNode programs field, similar to `setPrograms(X3DNode[])`.
`ProgramShaderObject`	`setPrograms(X3DConcreteNode newValue)` Utility method to set single SFNode as ProgramShaderObject programs.
`void`	`setPrograms(X3DNode newValue)` Set single child programs node, replacing prior array of existing nodes (if any).
`ProgramShaderObject`	`setPrograms(X3DNode[] newValue)` Assign ShaderProgram array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field programs.
`ProgramShaderObject`	`setUSE(ProgramShaderObject DEFnode)` Assign a USE reference to another DEF node of same node type, similar to `setUSE(String)`.
`ProgramShaderObject`	`setUSE(SFStringObject newValue)` Assign typed object value to SFString USE field, similar to `setUSE(String)`.
`ProgramShaderObject`	`setUSE(java.lang.String newValue)` Assign String value to inputOutput SFString field named USE.
`java.lang.String`	`toStringClassicVRML(int indentLevel)` Recursive method to provide ClassicVRML string serialization.
`java.lang.String`	`toStringVRML97(int indentLevel)` Recursive method to provide VRML97 string serialization.
`java.lang.String`	`toStringX3D(int indentLevel)` Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
`java.lang.String`	`validate()` Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteNode
getContainerFieldAlternateValues, getContainerFieldOverride, getCssClass, getDEF, getUSE, isNode, isStatement, isUSE, resetContainerFieldOverride, setConcreteCssClass, setConcreteDEF, setConcreteUSE, setContainerFieldOverride

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement
clearParentObject, findAncestorElementByName, findAncestorProtoBody, findAncestorSceneObject, findAncestorX3DObject, getPackageName, getParentObject, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorSceneObject, hasAncestorX3DObject, setParentObject, toStringClassicVRML, toStringVRML97, toStringX3D

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - LANGUAGE_CG
```
public static final java.lang.String LANGUAGE_CG
```
    SFString field named language can equal this enumeration value "Cg" (Java syntax) or Cg (XML syntax).
    
    See Also:
    
    Constant Field Values
  - LANGUAGE_GLSL
```
public static final java.lang.String LANGUAGE_GLSL
```
    SFString field named language can equal this enumeration value "GLSL" (Java syntax) or GLSL (XML syntax).
    
    See Also:
    
    Constant Field Values
  - LANGUAGE_HLSL
```
public static final java.lang.String LANGUAGE_HLSL
```
    SFString field named language can equal this enumeration value "HLSL" (Java syntax) or HLSL (XML syntax).
    
    See Also:
    
    Constant Field Values
  - NAME
```
public static final java.lang.String NAME
```
    String constant NAME provides name of this element: ProgramShader.
    
    See Also:
    
    Constant Field Values
  - COMPONENT
```
public static final java.lang.String COMPONENT
```
    String constant COMPONENT defines X3D component for the ProgramShader element: Shaders
    
    See Also:
    
    Constant Field Values
  - LEVEL
```
public static final int LEVEL
```
    Integer constant LEVEL provides default X3D Shaders component level for this element: 1
    
    See Also:
    
    Constant Field Values
  - LANGUAGE_DEFAULT_VALUE
```
public static final java.lang.String LANGUAGE_DEFAULT_VALUE
```
    SFString field named language has default value equal to an empty string.
    
    See Also:
    
    Constant Field Values
  - containerField_DEFAULT_VALUE
```
public static final java.lang.String containerField_DEFAULT_VALUE
```
    containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.
    
    See Also:
    
    X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM), Constant Field Values
  - toField_ACTIVATE
```
public static final java.lang.String toField_ACTIVATE
```
    toField ROUTE name for SFBool field named activate.
    
    See Also:
    
    Constant Field Values
  - fromField_ISSELECTED
```
public static final java.lang.String fromField_ISSELECTED
```
    fromField ROUTE name for SFBool field named isSelected.
    
    See Also:
    
    Constant Field Values
  - fromField_ISVALID
```
public static final java.lang.String fromField_ISVALID
```
    fromField ROUTE name for SFBool field named isValid.
    
    See Also:
    
    Constant Field Values
  - fromField_METADATA
```
public static final java.lang.String fromField_METADATA
```
    fromField ROUTE name for SFNode field named metadata.
    
    See Also:
    
    Constant Field Values
  - toField_METADATA
```
public static final java.lang.String toField_METADATA
```
    toField ROUTE name for SFNode field named metadata.
    
    See Also:
    
    Constant Field Values
  - fromField_PROGRAMS
```
public static final java.lang.String fromField_PROGRAMS
```
    fromField ROUTE name for MFNode field named programs.
    
    See Also:
    
    Constant Field Values
  - toField_PROGRAMS
```
public static final java.lang.String toField_PROGRAMS
```
    toField ROUTE name for MFNode field named programs.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ProgramShaderObject
```
public ProgramShaderObject()
```
    Constructor for ProgramShaderObject to initialize member variables with default values.
  - ProgramShaderObject
```
public ProgramShaderObject(java.lang.String DEFlabel)
```
    Utility constructor that assigns DEF label after initializing member variables with default values.
    
    Parameters:
    
    DEFlabel - unique DEF name for this X3D node
- Method Detail
  - getElementName
```
public final java.lang.String getElementName()
```
    Provides name of this element: ProgramShader
    
    Specified by:
    
    getElementName in class X3DConcreteElement
    
    Returns:
    
    name of this element
  - getComponent
```
public final java.lang.String getComponent()
```
    Defines X3D component for the ProgramShader element: Shaders
    
    Specified by:
    
    getComponent in class X3DConcreteElement
    
    Returns:
    
    X3D component for this element
  - getComponentLevel
```
public final int getComponentLevel()
```
    Provides default X3D component level for this element: 1
    
    Specified by:
    
    getComponentLevel in class X3DConcreteElement
    
    Returns:
    
    default X3D component level for this element
  - getFieldType
```
public java.lang.String getFieldType(java.lang.String fieldName)
```
    Indicate type corresponding to given fieldName.
    
    Specified by:
    
    getFieldType in class X3DConcreteElement
    
    Parameters:
    
    fieldName - name of field in this X3D node
    
    Returns:
    
    X3D type (SFvec3f etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE if not recognized
    
    See Also:
    
    ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE
  - getAccessType
```
public java.lang.String getAccessType(java.lang.String fieldName)
```
    Indicate accessType corresponding to given fieldName.
    
    Specified by:
    
    getAccessType in class X3DConcreteElement
    
    Parameters:
    
    fieldName - name of field in this X3D node
    
    Returns:
    
    X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized
    
    See Also:
    
    ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE
  - getContainerFieldDefault
```
public final java.lang.String getContainerFieldDefault()
```
    containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.
    
    Specified by:
    
    getContainerFieldDefault in class X3DConcreteNode
    
    Returns:
    
    default containerField value
    
    See Also:
    
    X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM)
  - initialize
```
public final void initialize()
```
    Initialize all member variables to default values.
    
    Overrides:
    
    initialize in class X3DConcreteNode
  - setActivate
```
public ProgramShaderObject 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 ProgramShader
    
    Specified by:
    
    setActivate in interface X3DShaderNode
    
    Parameters:
    
    newValue - is new value for the activate field.
    
    Returns:
    
    ProgramShaderObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setActivate
```
public ProgramShaderObject setActivate(SFBoolObject newValue)
```
    Assign typed object value to SFBool activate field, similar to setActivate(boolean).
    
    Parameters:
    
    newValue - is new value for the activate field.
    
    Returns:
    
    ProgramShaderObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getIsSelected
```
public 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 ProgramShader
    
    Specified by:
    
    getIsSelected in interface X3DShaderNode
    
    Returns:
    
    value of isSelected field
  - getIsValid
```
public 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 ProgramShader
    
    Specified by:
    
    getIsValid in interface X3DShaderNode
    
    Returns:
    
    value of isValid field
  - getLanguage
```
public 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
    Available enumeration values for string comparison: CG, GLSL, HLSL.
    Specified by:
    
    getLanguage in interface ProgramShader
    
    Specified by:
    
    getLanguage in interface X3DShaderNode
    
    Returns:
    
    value of language field
  - setLanguage
```
public ProgramShaderObject setLanguage(java.lang.String newValue)
```
    Assign String enumeration value ("Cg"|"GLSL"|"HLSL") ['Cg'|'GLSL'|'HLSL'|'etc.'] to initializeOnly SFString field named language.
    
    Hint: authors have option to choose from an extendible list of predefined enumeration values (CG, GLSL, HLSL).
    
    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 ProgramShader
    
    Specified by:
    
    setLanguage in interface X3DShaderNode
    
    Parameters:
    
    newValue - is new value for the language field.
    
    Returns:
    
    ProgramShaderObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setLanguage
```
public ProgramShaderObject setLanguage(SFStringObject newValue)
```
    Assign typed object value to SFString language field, similar to setLanguage(String).
    
    Parameters:
    
    newValue - is new value for the language field.
    
    Returns:
    
    ProgramShaderObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getMetadata
```
public X3DMetadataObject getMetadata()
```
    Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    
    Specified by:
    
    getMetadata in interface X3DNode
    
    Specified by:
    
    getMetadata in interface ProgramShader
    
    Specified by:
    
    getMetadata in interface X3DShaderNode
    
    Specified by:
    
    getMetadata in interface X3DAppearanceChildNode
    
    Returns:
    
    value of metadata field
    
    See Also:
    
    getMetadataProtoInstance(), X3D Scene Authoring Hints: Metadata Nodes
  - setMetadata
```
public ProgramShaderObject setMetadata(X3DMetadataObject newValue)
```
    Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    
    Specified by:
    
    setMetadata in interface X3DNode
    
    Specified by:
    
    setMetadata in interface ProgramShader
    
    Specified by:
    
    setMetadata in interface X3DShaderNode
    
    Specified by:
    
    setMetadata in interface X3DAppearanceChildNode
    
    Specified by:
    
    setMetadata in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the metadata field.
    
    Returns:
    
    ProgramShaderObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    
    See Also:
    
    setMetadata(ProtoInstanceObject), X3D Scene Authoring Hints: Metadata Nodes
  - clearMetadata
```
public ProgramShaderObject clearMetadata()
```
    Utility method to clear SFNode value of metadata field.
    
    Returns:
    
    ProgramShaderObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - setMetadata
```
public ProgramShaderObject setMetadata(ProtoInstanceObject newValue)
```
    Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
    
    Specified by:
    
    setMetadata in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the metadata field.
    
    Returns:
    
    ProgramShaderObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    
    See Also:
    
    setMetadata(X3DMetadataObject)
  - hasMetadata
```
public boolean hasMetadata()
```
    Indicate whether an object is available for inputOutput SFNode field metadata.
    
    Returns:
    
    whether a properly typed node or ProtoInstance or CommentsBlock is available.
    
    See Also:
    
    getMetadata(), getMetadataProtoInstance(), X3D Scene Authoring Hints: Metadata Nodes
  - getPrograms
```
public X3DNode[] getPrograms()
```
    Provide array of ShaderProgram 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.
    
    Specified by:
    
    getPrograms in interface ProgramShader
    
    Returns:
    
    value of programs field
    
    See Also:
    
    ShaderProgramObject
  - getProgramsList
```
public java.util.ArrayList<X3DNode> getProgramsList()
```
    Utility method to get ArrayList value of MFNode programs field, similar to getPrograms().
    
    Returns:
    
    value of programs field
  - setPrograms
```
public ProgramShaderObject setPrograms(X3DNode[] newValue)
```
    Assign ShaderProgram 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.
    
    Specified by:
    
    setPrograms in interface ProgramShader
    
    Parameters:
    
    newValue - is new value for the programs field.
    
    Returns:
    
    ProgramShaderObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setPrograms
```
public ProgramShaderObject setPrograms(java.util.ArrayList<ShaderProgram> newValue)
```
    Assign ArrayList value of MFNode programs field, similar to setPrograms(X3DNode[]).
    
    Parameters:
    
    newValue - is new value for the programs field.
    
    Returns:
    
    ProgramShaderObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - addPrograms
```
public ProgramShaderObject addPrograms(ShaderProgramObject newValue)
```
    Add single child node to existing array of programs nodes (if any).
    
    Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to ShaderProgram and ProtoInstance.
    
    Parameters:
    
    newValue - is new value to be appended the programs field.
    
    Returns:
    
    ProgramShaderObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - addPrograms
```
public 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.
    
    Specified by:
    
    addPrograms in interface ProgramShader
    
    Parameters:
    
    newValue - is new value array to be appended the programs field.
  - setPrograms
```
public void setPrograms(X3DNode newValue)
```
    Set single child programs node, replacing prior array of existing nodes (if any).
    
    Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are restricted to ShaderProgram.
    
    Specified by:
    
    setPrograms in interface ProgramShader
    
    Parameters:
    
    newValue - is new node for the programs field (restricted to ShaderProgram)
  - setPrograms
```
public ProgramShaderObject setPrograms(X3DConcreteNode newValue)
```
    Utility method to set single SFNode as ProgramShaderObject programs.
    
    Parameters:
    
    newValue - ProgramShaderObject node to set
    
    Returns:
    
    ProgramShaderObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - clearPrograms
```
public ProgramShaderObject clearPrograms()
```
    Utility method to clear MFNode value of programs field.
    
    Returns:
    
    ProgramShaderObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - hasPrograms
```
public boolean hasPrograms()
```
    Indicate whether an object is available for inputOutput MFNode field programs.
    
    Returns:
    
    whether a properly typed node or ProtoInstance array or CommentsBlock is available.
    
    See Also:
    
    getPrograms()
  - setDEF
```
public final ProgramShaderObject 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 X3DNode
    
    Specified by:
    
    setDEF in interface ProgramShader
    
    Specified by:
    
    setDEF in interface X3DShaderNode
    
    Specified by:
    
    setDEF in interface X3DAppearanceChildNode
    
    Specified by:
    
    setDEF in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    ProgramShaderObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setDEF
```
public ProgramShaderObject setDEF(SFStringObject newValue)
```
    Assign typed object value to SFString DEF field, similar to setDEF(String).
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    ProgramShaderObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUSE
```
public final ProgramShaderObject 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 X3DNode
    
    Specified by:
    
    setUSE in interface ProgramShader
    
    Specified by:
    
    setUSE in interface X3DShaderNode
    
    Specified by:
    
    setUSE in interface X3DAppearanceChildNode
    
    Specified by:
    
    setUSE in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    ProgramShaderObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUSE
```
public ProgramShaderObject setUSE(SFStringObject newValue)
```
    Assign typed object value to SFString USE field, similar to setUSE(String).
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    ProgramShaderObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setCssClass
```
public final ProgramShaderObject 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 X3DNode
    
    Specified by:
    
    setCssClass in interface ProgramShader
    
    Specified by:
    
    setCssClass in interface X3DShaderNode
    
    Specified by:
    
    setCssClass in interface X3DAppearanceChildNode
    
    Specified by:
    
    setCssClass in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    ProgramShaderObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    
    See Also:
    
    W3C Cascading Style Sheets
  - setCssClass
```
public ProgramShaderObject setCssClass(SFStringObject newValue)
```
    Assign typed object value to SFString cssClass field, similar to setCssClass(String).
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    ProgramShaderObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setIS
```
public ProgramShaderObject setIS(ISObject newValue)
```
    Assign field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes. The IS statement connects node fields defined inside a ProtoBody declaration back to corresponding ProtoInterface fields.
    
    Specified by:
    
    setIS in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the description field.
    
    Returns:
    
    ProgramShaderObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    
    See Also:
    
    X3D Tooltips: IS, X3D Tooltips: connect
  - getIS
```
public ISObject getIS()
```
    Provide field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes. The IS statement connects node fields defined inside a ProtoBody declaration back to corresponding ProtoInterface fields.
    
    Specified by:
    
    getIS in class X3DConcreteNode
    
    Returns:
    
    current ISObject, if any.
    
    See Also:
    
    X3D Tooltips: IS, X3D Tooltips: connect
  - setUSE
```
public ProgramShaderObject setUSE(ProgramShaderObject DEFnode)
```
    Assign a USE reference to another DEF node of same node type, similar to setUSE(String).
    
    Warning: note that 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.
    
    Parameters:
    
    DEFnode - must have a DEF value defined
    
    Returns:
    
    ProgramShaderObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - addComments
```
public ProgramShaderObject addComments(java.lang.String newComment)
```
    Add comment as String to contained commentsList.
    
    Specified by:
    
    addComments in class X3DConcreteElement
    
    Parameters:
    
    newComment - initial value
    
    Returns:
    
    ProgramShaderObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - addComments
```
public ProgramShaderObject addComments(java.lang.String[] newComments)
```
    Add comments as String[] array to contained commentsList.
    
    Specified by:
    
    addComments in class X3DConcreteElement
    
    Parameters:
    
    newComments - array of comments
    
    Returns:
    
    ProgramShaderObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - addComments
```
public ProgramShaderObject addComments(CommentsBlock newCommentsBlock)
```
    Add CommentsBlock to contained commentsList.
    
    Specified by:
    
    addComments in class X3DConcreteElement
    
    Parameters:
    
    newCommentsBlock - block of comments to add
    
    Returns:
    
    ProgramShaderObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - toStringX3D
```
public java.lang.String toStringX3D(int indentLevel)
```
    Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
    
    Specified by:
    
    toStringX3D in class X3DConcreteElement
    
    Parameters:
    
    indentLevel - number of levels of indentation for this element
    
    Returns:
    
    X3D string
    
    See Also:
    
    X3DObject.FILE_EXTENSION_X3D, X3DObject.FILE_EXTENSION_XML, X3DObject.toStringXML(), X3DObject.toFileXML(String), X3DObject.toFileX3D(String), X3D XML Encoding, X3D Compressed Binary Encoding: X3D Canonical Form
  - toStringClassicVRML
```
public java.lang.String toStringClassicVRML(int indentLevel)
```
    Recursive method to provide ClassicVRML string serialization.
    
    Specified by:
    
    toStringClassicVRML in class X3DConcreteElement
    
    Parameters:
    
    indentLevel - number of levels of indentation for this element
    
    Returns:
    
    ClassicVRML string
    
    See Also:
    
    X3DObject.FILE_EXTENSION_CLASSICVRML, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Annex A: Grammar
  - toStringVRML97
```
public java.lang.String toStringVRML97(int indentLevel)
```
    Recursive method to provide VRML97 string serialization.
    
    Specified by:
    
    toStringVRML97 in class X3DConcreteElement
    
    Parameters:
    
    indentLevel - number of levels of indentation for this element
    
    Returns:
    
    VRML97 string
    
    See Also:
    
    X3DObject.FILE_EXTENSION_VRML97, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Virtual Reality Modeling Language (VRML) 97 specification, VRML 97 v2.1 Amendment
  - findElementByNameValue
```
public X3DConcreteElement findElementByNameValue(java.lang.String nameValue)
```
    Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.
    
    Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.
    
    Warning: more than one element may be found that has the same name, this method does not handle that case.
    
    Specified by:
    
    findElementByNameValue in class X3DConcreteElement
    
    Parameters:
    
    nameValue - is value of the name field being searched for in this element and child elements(if any)
    
    Returns:
    
    object reference to found element, null otherwise
    
    See Also:
    
    findNodeByDEF(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
  - findElementByNameValue
```
public X3DConcreteElement findElementByNameValue(java.lang.String nameValue,
                                                 java.lang.String elementName)
```
    Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.
    
    Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.
    
    Warning: more than one element may be found that has the same name, this method does not handle that case.
    
    Specified by:
    
    findElementByNameValue in class X3DConcreteElement
    
    Parameters:
    
    nameValue - is value of the name field being searched for in this element and child elements(if any)
    
    elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
    
    Returns:
    
    object reference to found element, null otherwise
    
    See Also:
    
    findNodeByDEF(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
  - hasElementByNameValue
```
public boolean hasElementByNameValue(java.lang.String nameValue,
                                     java.lang.String elementName)
```
    Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
    
    Parameters:
    
    nameValue - is value of the name field being searched for in this element and child elements(if any)
    
    elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
    
    Returns:
    
    whether node is found
    
    See Also:
    
    findElementByNameValue(String, String)
  - findNodeByDEF
```
public X3DConcreteNode findNodeByDEF(java.lang.String DEFvalue)
```
    Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
    
    Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.
    
    Warning: more than one element may be found that has the same DEF, this method does not handle that case.
    
    Specified by:
    
    findNodeByDEF in class X3DConcreteElement
    
    Parameters:
    
    DEFvalue - is value of the name field being searched for in this element and child elements(if any)
    
    Returns:
    
    object reference to found node, null otherwise
    
    See Also:
    
    findElementByNameValue(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
  - hasNodeByDEF
```
public boolean hasNodeByDEF(java.lang.String DEFvalue)
```
    Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
    
    Parameters:
    
    DEFvalue - is value of the name field being searched for in this element and child elements(if any)
    
    Returns:
    
    whether node is found
    
    See Also:
    
    findNodeByDEF(String)
  - validate
```
public java.lang.String validate()
```
    Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.
    
    Specified by:
    
    validate in class X3DConcreteElement
    
    Returns:
    
    validation results (if any)

Class ProgramShaderObject

Field Summary

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteNode

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteElement

Constructor Summary

Method Summary

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteNode

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement

Methods inherited from class java.lang.Object

Field Detail

LANGUAGE_CG

LANGUAGE_GLSL

LANGUAGE_HLSL

NAME

COMPONENT

LEVEL

LANGUAGE_DEFAULT_VALUE

containerField_DEFAULT_VALUE

toField_ACTIVATE

fromField_ISSELECTED

fromField_ISVALID

fromField_METADATA

toField_METADATA

fromField_PROGRAMS

toField_PROGRAMS

Constructor Detail

ProgramShaderObject

ProgramShaderObject

Method Detail

getElementName

getComponent

getComponentLevel

getFieldType

getAccessType

getContainerFieldDefault

initialize

setActivate

setActivate

getIsSelected

getIsValid

getLanguage

setLanguage

setLanguage

getMetadata

setMetadata

clearMetadata

setMetadata

hasMetadata

getPrograms

getProgramsList

setPrograms

setPrograms

addPrograms

addPrograms

setPrograms

setPrograms

clearPrograms

hasPrograms

setDEF

setDEF

setUSE

setUSE

setCssClass

setCssClass

setIS

getIS

setUSE

addComments

addComments

addComments

toStringX3D

toStringClassicVRML

toStringVRML97

findElementByNameValue

findElementByNameValue

hasElementByNameValue

findNodeByDEF

hasNodeByDEF

validate