Class ShaderProgram

java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.Shaders.ShaderProgram
All Implemented Interfaces:
X3DNode, X3DUrlObject, ShaderProgram, X3DProgrammableShaderObject
public class ShaderProgram extends X3DConcreteNode implements ShaderProgram
ShaderProgram can contain field declarations and a CDATA section of plain-text source code.

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. ShaderProgram node tooltip: (X3D version 3.1 or later) [X3DNode,X3DUrlObject,X3DProgrammableShaderObject] ShaderProgram is contained by ProgramShader and provides the source and interface to a self-contained program that occupies one part of the rendering process: either a vertex or fragment shader.
  • Hint: ShaderProgram contains field declarations and then corresponding IS/connect statements (if any).
  • Hint: insert an XML Character Data (CDATA) block within the Script node to contain source code embedded within an X3D scene, avoiding the need for escape characters.
  • Hint: a contained XML Character Data (CDATA) block for source code protects whitespace, line breaks, and literal characters (such as & for ampersand character, < for less-than-sign character, and > for greater-than-sign character) from unintended escape-character modifications by XML parsers.
  • Warning: strict order is required for contained constructs: first field declarations (if any), then IS/connect statements (if any), and finally CDATA source-code block.
  • Hint: when parent node is LoadSensor, apply containerField='children' (X3Dv4) or containerField='watchList' (X3Dv3). https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#fieldNameChanges
  • Hint: embedded ecmascript: source can also be contained in the sourceCode pseudo-field without escape characters, equivalent to last entry in the url list, when using other API codebases and file encodings.

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:

  • Field Details

    • TYPE_VERTEX

      public static final String TYPE_VERTEX
      Tooltip: vertex shader. SFString field named type with X3DUOM simpleType shaderPartTypeValues and with X3DUOM baseType xs:NMTOKEN can equal this value "VERTEX" (Java syntax) or VERTEX (XML syntax).
      See Also:

    • TYPE_FRAGMENT

      public static final String TYPE_FRAGMENT
      Tooltip: fragment shader. SFString field named type with X3DUOM simpleType shaderPartTypeValues and with X3DUOM baseType xs:NMTOKEN can equal this value "FRAGMENT" (Java syntax) or FRAGMENT (XML syntax).
      See Also:

    • NAME

      public static final String NAME
      String constant NAME provides name of this element: ShaderProgram.
      See Also:

    • COMPONENT

      public static final String COMPONENT
      String constant COMPONENT defines X3D component for the ShaderProgram element: Shaders
      See Also:

    • LEVEL

      public static final int LEVEL
      Integer constant LEVEL provides default X3D Shaders component level for this element: 1
      See Also:

    • AUTOREFRESH_DEFAULT_VALUE

      public static final double AUTOREFRESH_DEFAULT_VALUE
      SFTime field named autoRefresh has default value 0 (Java syntax) or 0 (XML syntax).
      See Also:

    • AUTOREFRESHTIMELIMIT_DEFAULT_VALUE

      public static final double AUTOREFRESHTIMELIMIT_DEFAULT_VALUE
      SFTime field named autoRefreshTimeLimit has default value 3600 (Java syntax) or 3600 (XML syntax).
      See Also:

    • DESCRIPTION_DEFAULT_VALUE

      public static final String DESCRIPTION_DEFAULT_VALUE
      SFString field named description has default value equal to an empty string.
      See Also:

    • IS_DEFAULT_VALUE

      public static final IS IS_DEFAULT_VALUE
      SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).

    • LOAD_DEFAULT_VALUE

      public static final boolean LOAD_DEFAULT_VALUE
      SFBool field named load has default value true (Java syntax) or true (XML syntax).
      See Also:

    • METADATA_DEFAULT_VALUE

      public static final X3DMetadataObject METADATA_DEFAULT_VALUE
      SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).

    • SOURCECODE_DEFAULT_VALUE

      public static final String SOURCECODE_DEFAULT_VALUE
      SFString field named sourceCode has default value equal to an empty string.
      See Also:

    • TYPE_DEFAULT_VALUE

      public static final String TYPE_DEFAULT_VALUE
      SFString field named type has default value "VERTEX" (Java syntax) or VERTEX (XML syntax).
      See Also:

    • URL_DEFAULT_VALUE

      public static final ArrayList<String> URL_DEFAULT_VALUE
      MFString field named url has default value equal to an empty list.

    • containerField_DEFAULT_VALUE

      public static final String containerField_DEFAULT_VALUE
      containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, this default value is provided for informational purposes only.
      containerField_DEFAULT_VALUE = "programs";
      containerField_ALLOWED_VALUES = {"programs", "children" }; type xs:NMTOKEN
      See Also:

    • fromField_AUTOREFRESH

      public static final String fromField_AUTOREFRESH
      fromField ROUTE name for SFTime field named autoRefresh.
      See Also:

    • toField_AUTOREFRESH

      public static final String toField_AUTOREFRESH
      toField ROUTE name for SFTime field named autoRefresh.
      See Also:

    • fromField_AUTOREFRESHTIMELIMIT

      public static final String fromField_AUTOREFRESHTIMELIMIT
      fromField ROUTE name for SFTime field named autoRefreshTimeLimit.
      See Also:

    • toField_AUTOREFRESHTIMELIMIT

      public static final String toField_AUTOREFRESHTIMELIMIT
      toField ROUTE name for SFTime field named autoRefreshTimeLimit.
      See Also:

    • fromField_DESCRIPTION

      public static final String fromField_DESCRIPTION
      fromField ROUTE name for SFString field named description.
      See Also:

    • toField_DESCRIPTION

      public static final String toField_DESCRIPTION
      toField ROUTE name for SFString field named description.
      See Also:

    • fromField_IS

      public static final String fromField_IS
      fromField ROUTE name for SFNode field named IS.
      See Also:

    • fromField_LOAD

      public static final String fromField_LOAD
      fromField ROUTE name for SFBool field named load.
      See Also:

    • toField_LOAD

      public static final String toField_LOAD
      toField ROUTE name for SFBool field named load.
      See Also:

    • fromField_METADATA

      public static final String fromField_METADATA
      fromField ROUTE name for SFNode field named metadata.
      See Also:

    • toField_METADATA

      public static final String toField_METADATA
      toField ROUTE name for SFNode field named metadata.
      See Also:

    • fromField_SOURCECODE

      public static final String fromField_SOURCECODE
      fromField ROUTE name for SFString field named sourceCode.
      See Also:

    • toField_SOURCECODE

      public static final String toField_SOURCECODE
      toField ROUTE name for SFString field named sourceCode.
      See Also:

    • fromField_URL

      public static final String fromField_URL
      fromField ROUTE name for MFString field named url.
      See Also:

    • toField_URL

      public static final String toField_URL
      toField ROUTE name for MFString field named url.
      See Also:

  • Constructor Details

    • ShaderProgram

      public ShaderProgram()
      Constructor for ShaderProgram to initialize member variables with default values.

    • ShaderProgram

      public ShaderProgram(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 Details

    • getElementName

      public final String getElementName()
      Provides name of this element: ShaderProgram
      Specified by:
      getElementName in class X3DConcreteElement
      Returns:
      name of this element

    • getComponent

      public final String getComponent()
      Defines X3D component for the ShaderProgram 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 String getFieldType(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:

    • getAccessType

      public String getAccessType(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:

    • getContainerFieldDefault

      public final String getContainerFieldDefault()
      containerField describes typical field relationship of a node to its parent. Programmer usage is not ordinarily needed when using this API, since this default value is provided for informational purposes only.
      Specified by:
      getContainerFieldDefault in class X3DConcreteNode
      Returns:
      default containerField value
      See Also:

    • initialize

      public final void initialize()
      Initialize all member variables to default values.
      Overrides:
      initialize in class X3DConcreteNode

    • getAutoRefresh

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

      Tooltip: autoRefresh 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:
      getAutoRefresh in interface ShaderProgram
      Specified by:
      getAutoRefresh in interface X3DUrlObject
      Returns:
      value of autoRefresh field

    • setAutoRefresh

      public ShaderProgram setAutoRefresh(double newValue)
      Accessor method to assign double value in seconds to inputOutput SFTime field named autoRefresh.

      Tooltip: autoRefresh 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:
      setAutoRefresh in interface ShaderProgram
      Specified by:
      setAutoRefresh in interface X3DUrlObject
      Parameters:
      newValue - is new value for the autoRefresh field.
      Returns:
      ShaderProgram - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setAutoRefresh

      public ShaderProgram setAutoRefresh(SFTime newValue)
      Assign typed object value to SFTime autoRefresh field, similar to setAutoRefresh(double).
      Parameters:
      newValue - is new value for the autoRefresh field.
      Returns:
      ShaderProgram - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getAutoRefreshTimeLimit

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

      Tooltip: autoRefreshTimeLimit defines maximum duration that automatic refresh activity can occur.
      • Hint: Automatic refresh is different than query and response timeouts performed by a networking library while sequentially attempting to retrieve addressed content from a url list.
      • Warning: automatically reloading content has security considerations and needs to be considered carefully.
      Specified by:
      getAutoRefreshTimeLimit in interface ShaderProgram
      Specified by:
      getAutoRefreshTimeLimit in interface X3DUrlObject
      Returns:
      value of autoRefreshTimeLimit field

    • setAutoRefreshTimeLimit

      public ShaderProgram setAutoRefreshTimeLimit(double newValue)
      Accessor method to assign double value in seconds to inputOutput SFTime field named autoRefreshTimeLimit.

      Tooltip: autoRefreshTimeLimit defines maximum duration that automatic refresh activity can occur.
      • Hint: Automatic refresh is different than query and response timeouts performed by a networking library while sequentially attempting to retrieve addressed content from a url list.
      • Warning: automatically reloading content has security considerations and needs to be considered carefully.
      Specified by:
      setAutoRefreshTimeLimit in interface ShaderProgram
      Specified by:
      setAutoRefreshTimeLimit in interface X3DUrlObject
      Parameters:
      newValue - is new value for the autoRefreshTimeLimit field.
      Returns:
      ShaderProgram - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setAutoRefreshTimeLimit

      public ShaderProgram setAutoRefreshTimeLimit(SFTime newValue)
      Assign typed object value to SFTime autoRefreshTimeLimit field, similar to setAutoRefreshTimeLimit(double).
      Parameters:
      newValue - is new value for the autoRefreshTimeLimit field.
      Returns:
      ShaderProgram - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getDescription

      public 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 &#38; for & ampersand character, or &#34; for " quotation-mark character).
      Specified by:
      getDescription in interface ShaderProgram
      Specified by:
      getDescription in interface X3DUrlObject
      Returns:
      value of description field

    • setDescription

      public ShaderProgram setDescription(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 &#38; for & ampersand character, or &#34; for " quotation-mark character).
      Specified by:
      setDescription in interface ShaderProgram
      Specified by:
      setDescription in interface X3DUrlObject
      Parameters:
      newValue - is new value for the description field.
      Returns:
      ShaderProgram - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setDescription

      public ShaderProgram setDescription(SFString newValue)
      Assign typed object value to SFString description field, similar to setDescription(String).
      Parameters:
      newValue - is new value for the description field.
      Returns:
      ShaderProgram - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getFieldList

      public ArrayList<field> getFieldList()
      Provide array of field results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field field.

      Tooltip: Include a field statement for each field declaration in the ShaderProgram node. *


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

    • setFieldList

      public ShaderProgram setFieldList(ArrayList<field> newValue)
      Accessor method to assign field array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field field.

      Tooltip: Include a field statement for each field declaration in the ShaderProgram node. *


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

    • setField

      public ShaderProgram setField(field newValue)
      Set single child field node, replacing prior array of existing nodes (if any).

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

    • clearField

      public ShaderProgram clearField()
      Utility method to clear MFNode value of fieldList field. This method does not initialize withFIELD_DEFAULT_VALUE.
      Returns:
      ShaderProgram - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • hasField

      public boolean hasField()
      Indicate whether an object is available for inputOutput MFNode field fieldList.
      Returns:
      whether a concrete statement array or CommentsBlock is available.
      See Also:

    • getIS

      public IS getIS()
      Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.
      Specified by:
      getIS in class X3DConcreteNode
      Returns:
      value of IS field
      See Also:

    • setIS

      public ShaderProgram setIS(IS newValue)
      Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
      Specified by:
      setIS in class X3DConcreteNode
      Parameters:
      newValue - is new value for the IS field.
      Returns:
      ShaderProgram - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • clearIS

      public ShaderProgram clearIS()
      Utility method to clear SFNode value of IS field.
      Returns:
      ShaderProgram - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • hasIS

      public boolean hasIS()
      Indicate whether an object is available for inputOutput SFNode field IS.
      Returns:
      whether a concrete statement or CommentsBlock is available.
      See Also:

    • getLoad

      public 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 ShaderProgram
      Specified by:
      getLoad in interface X3DUrlObject
      Returns:
      value of load field

    • setLoad

      public ShaderProgram 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 ShaderProgram
      Specified by:
      setLoad in interface X3DUrlObject
      Parameters:
      newValue - is new value for the load field.
      Returns:
      ShaderProgram - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setLoad

      public ShaderProgram setLoad(SFBool newValue)
      Assign typed object value to SFBool load field, similar to setLoad(boolean).
      Parameters:
      newValue - is new value for the load field.
      Returns:
      ShaderProgram - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getMetadata

      public X3DMetadataObject getMetadata()
      Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
      Specified by:
      getMetadata in interface ShaderProgram
      Specified by:
      getMetadata in interface X3DNode
      Returns:
      value of metadata field
      See Also:

    • setMetadata

      public ShaderProgram setMetadata(X3DMetadataObject newValue)
      Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
      Specified by:
      setMetadata in interface ShaderProgram
      Specified by:
      setMetadata in interface X3DNode
      Specified by:
      setMetadata in class X3DConcreteNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      ShaderProgram - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • clearMetadata

      public ShaderProgram clearMetadata()
      Utility method to clear SFNode value of metadata field.
      Returns:
      ShaderProgram - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • setMetadata

      public ShaderProgram setMetadata(ProtoInstance 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:
      ShaderProgram - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

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

    • getSourceCode

      public String getSourceCode()
      Provide String value from inputOutput SFString field named sourceCode.
      Specified by:
      getSourceCode in interface ShaderProgram
      Returns:
      value of sourceCode field

    • setSourceCode

      public ShaderProgram setSourceCode(String newValue)
      Accessor method to assign String value to inputOutput SFString field named sourceCode.
      Specified by:
      setSourceCode in interface ShaderProgram
      Parameters:
      newValue - is new value for the sourceCode field.
      Returns:
      ShaderProgram - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setSourceCode

      public ShaderProgram setSourceCode(SFString newValue)
      Assign typed object value to SFString sourceCode field, similar to setSourceCode(String).
      Parameters:
      newValue - is new value for the sourceCode field.
      Returns:
      ShaderProgram - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getType

      public String getType()
      Provide String enumeration value (baseType xs:NMTOKEN) ["VERTEX" | "FRAGMENT" | 'etc.'] from initializeOnly SFString field named type.

      Tooltip: type indicates whether this ShaderProgram is a vertex or fragment (pixel) shader.
      • Warning: do not wrap extra quotation marks around these SFString enumeration values, since "quotation" "marks" are only used for MFString values.


      Available enumeration values for string comparison: VERTEX, FRAGMENT.
      Specified by:
      getType in interface ShaderProgram
      Returns:
      value of type field

    • setType

      public ShaderProgram setType(String newValue)
      Accessor method to assign String enumeration value ("VERTEX" | "FRAGMENT") to initializeOnly SFString field named type.

      Hint: authors have option to choose from an extendible list of predefined enumeration values (VERTEX, FRAGMENT).

      Tooltip: type indicates whether this ShaderProgram is a vertex or fragment (pixel) shader.
      • Warning: do not wrap extra quotation marks around these SFString enumeration values, since "quotation" "marks" are only used for MFString values.
      Specified by:
      setType in interface ShaderProgram
      Parameters:
      newValue - is new value for the type field.
      Returns:
      ShaderProgram - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setType

      public ShaderProgram setType(SFString newValue)
      Assign typed object value to SFString type field, similar to setType(String).
      Parameters:
      newValue - is new value for the type field.
      Returns:
      ShaderProgram - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getUrl

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

      Tooltip: Location and filename of shader. Multiple locations are more reliable, and including a Web address lets e-mail attachments work.
      • Hint: embedded ecmascript: source can also be contained in the sourceCode pseudo-field without escape characters, equivalent to last entry in the url list, when using other API codebases and file encodings.
      • Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "https://www.web3d.org" "https://www.web3d.org/about" "etc."
      • Hint: alternative XML encoding for quotation mark " is &quot; (which is an example of a character entity).
      • Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all case sensitive and intolerant of uppercase/lowercase mismatches.
      • Hint: can replace embedded blank(s) in url queries with %20 for each blank character.
      • Hint: X3D Scene Authoring Hints, urls https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#urls
      Specified by:
      getUrl in interface ShaderProgram
      Specified by:
      getUrl in interface X3DUrlObject
      Returns:
      value of url field

    • getUrlList

      public ArrayList<String> getUrlList()
      Utility method to get ArrayList value of MFString url field, similar to getUrl().
      Returns:
      value of url field

    • getUrlString

      public String getUrlString()
      Utility method to get String value of MFString url field, similar to getUrl().
      Returns:
      value of url field

    • setUrl

      public ShaderProgram setUrl(String[] newValue)
      Accessor method to assign String array to inputOutput MFString field named url.

      Tooltip: Location and filename of shader. Multiple locations are more reliable, and including a Web address lets e-mail attachments work.
      • Hint: embedded ecmascript: source can also be contained in the sourceCode pseudo-field without escape characters, equivalent to last entry in the url list, when using other API codebases and file encodings.
      • Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "https://www.web3d.org" "https://www.web3d.org/about" "etc."
      • Hint: alternative XML encoding for quotation mark " is &quot; (which is an example of a character entity).
      • Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all case sensitive and intolerant of uppercase/lowercase mismatches.
      • Hint: can replace embedded blank(s) in url queries with %20 for each blank character.
      • Hint: X3D Scene Authoring Hints, urls https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#urls
      Specified by:
      setUrl in interface ShaderProgram
      Specified by:
      setUrl in interface X3DUrlObject
      Parameters:
      newValue - is new value for the url field.
      Returns:
      ShaderProgram - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setUrl

      public ShaderProgram setUrl(MFString newValue)
      Assign typed object value to MFString url field, similar to setUrl(String[]).
      Parameters:
      newValue - is new value for the url field.
      Returns:
      ShaderProgram - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setUrl

      public ShaderProgram setUrl(SFString newValue)
      Assign single SFString object value to MFString url field, similar to setUrl(String[]).
      Parameters:
      newValue - is new value for the url field.
      Returns:
      ShaderProgram - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setUrl

      public ShaderProgram setUrl(String newValue)
      Assign singleton String value to MFString url field, similar to setUrl(String[]).
      Parameters:
      newValue - is new value for the url field.
      Returns:
      ShaderProgram - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setUrl

      public ShaderProgram setUrl(ArrayList<String> newValue)
      Assign ArrayList value of MFString url field, similar to setUrl(String[]).
      Parameters:
      newValue - is new value for the url field.
      Returns:
      ShaderProgram - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • clearUrl

      public ShaderProgram clearUrl()
      Utility method to clear MFString value of url field. This method does not initialize withURL_DEFAULT_VALUE.
      Returns:
      ShaderProgram - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • addUrl

      public ShaderProgram addUrl(String newValue)
      Add singleton String value to MFString url field.
      Parameters:
      newValue - is new value to add to the url field.
      Returns:
      ShaderProgram - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • addUrl

      public ShaderProgram addUrl(SFString newValue)
      Add singleton SFString value to MFString url field.
      Parameters:
      newValue - is new value to add to the url field.
      Returns:
      ShaderProgram - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • getDEF

      public String getDEF()
      Provide String value from inputOutput SFString field named DEF.

      Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.
      Overrides:
      getDEF in class X3DConcreteNode
      Returns:
      value of DEF field
      See Also:

    • setDEF

      public final ShaderProgram setDEF(String newValue)
      Accessor method to assign String value to inputOutput SFString field named DEF.

      Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.

      Note that setting the DEF value clears the USE value.
      Specified by:
      setDEF in class X3DConcreteNode
      Parameters:
      newValue - is new value for the DEF field.
      Returns:
      ShaderProgram - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setDEF

      public ShaderProgram setDEF(SFString newValue)
      Assign typed object value to SFString DEF field, similar to setDEF(String).
      Parameters:
      newValue - is new value for the DEF field.
      Returns:
      ShaderProgram - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getUSE

      public String getUSE()
      Provide String value from 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.
      Overrides:
      getUSE in class X3DConcreteNode
      Returns:
      value of USE field
      See Also:

    • setUSE

      public final ShaderProgram setUSE(String newValue)
      Accessor method to 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 class X3DConcreteNode
      Parameters:
      newValue - is new value for the USE field.
      Returns:
      ShaderProgram - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setUSE

      public ShaderProgram setUSE(SFString newValue)
      Assign typed object value to SFString USE field, similar to setUSE(String).
      Parameters:
      newValue - is new value for the USE field.
      Returns:
      ShaderProgram - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getCssClass

      public String getCssClass()
      Provide String value from inputOutput SFString field named class.
      Overrides:
      getCssClass in class X3DConcreteElement
      Returns:
      value of class field
      See Also:

    • setCssClass

      public final ShaderProgram setCssClass(String newValue)
      Accessor method to assign String value to inputOutput SFString field named class.
      Specified by:
      setCssClass in class X3DConcreteNode
      Parameters:
      newValue - is new value for the class field.
      Returns:
      ShaderProgram - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • setCssClass

      public ShaderProgram setCssClass(SFString newValue)
      Assign typed object value to SFString cssClass field, similar to setCssClass(String).
      Parameters:
      newValue - is new value for the class field.
      Returns:
      ShaderProgram - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getHtmlID

      public String getHtmlID()
      Provide String value from inputOutput SFString field named id.
      Overrides:
      getHtmlID in class X3DConcreteElement
      Returns:
      value of id field
      See Also:

    • setHtmlID

      public final ShaderProgram setHtmlID(String newValue)
      Accessor method to assign String value to inputOutput SFString field named id.
      Specified by:
      setHtmlID in class X3DConcreteNode
      Parameters:
      newValue - is new value for the id field.
      Returns:
      ShaderProgram - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • setHtmlID

      public ShaderProgram setHtmlID(SFString newValue)
      Assign typed object value to SFString HtmlID field, similar to setHtmlID(String).
      Parameters:
      newValue - is new value for the id field.
      Returns:
      ShaderProgram - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getCssStyle

      public String getCssStyle()
      Provide String value from inputOutput SFString field named style.
      Overrides:
      getCssStyle in class X3DConcreteElement
      Returns:
      value of style field
      See Also:

    • setCssStyle

      public final ShaderProgram setCssStyle(String newValue)
      Accessor method to assign String value to inputOutput SFString field named style.
      Specified by:
      setCssStyle in class X3DConcreteNode
      Parameters:
      newValue - is new value for the style field.
      Returns:
      ShaderProgram - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • setCssStyle

      public ShaderProgram setCssStyle(SFString newValue)
      Assign typed object value to SFString cssClass field, similar to setCssStyle(String).
      Parameters:
      newValue - is new value for the style field.
      Returns:
      ShaderProgram - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setUSE

      public ShaderProgram setUSE(ShaderProgram 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:
      ShaderProgram - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • addComments

      public ShaderProgram addComments(String newComment)
      Add comment as String to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newComment - initial value
      Returns:
      ShaderProgram - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • addComments

      public ShaderProgram addComments(String[] newComments)
      Add comments as String[] array to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newComments - array of comments
      Returns:
      ShaderProgram - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • addComments

      public ShaderProgram addComments(CommentsBlock newCommentsBlock)
      Add CommentsBlock to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newCommentsBlock - block of comments to add
      Returns:
      ShaderProgram - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • toStringX3D

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

    • toStringClassicVRML

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

    • toStringVRML97

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

    • findElementByNameValue

      public X3DConcreteElement findElementByNameValue(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 findAncestorScene() to check entire scene graph, or findAncestorX3D() 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:

    • findElementByNameValue

      public X3DConcreteElement findElementByNameValue(String nameValue, 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 findAncestorScene() to check entire scene graph, or findAncestorX3D() 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:

    • hasElementByNameValue

      public boolean hasElementByNameValue(String nameValue, 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:

    • findNodeByDEF

      public X3DConcreteNode findNodeByDEF(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 findAncestorScene() to check entire scene graph, or findAncestorX3D() 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:

    • hasNodeByDEF

      public boolean hasNodeByDEF(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:

    • validate

      public 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. TODO document specific validation methods.
      Specified by:
      validate in class X3DConcreteElement
      Returns:
      validation results (if any)

    • addField

      public ShaderProgram addField(field newField)
      Add field to fieldList for this ShaderProgram
      Parameters:
      newField - is field to add
      Returns:
      ShaderProgram - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • removeField

      public boolean removeField(field fieldToRemove)
      Remove a field from contained fieldList
      Parameters:
      fieldToRemove - matching field of interest
      Returns:
      whether field was removed
      See Also:

    • removeField

      public boolean removeField(String fieldName)
      Remove a field by name from contained fieldList
      Parameters:
      fieldName - matching field of interest
      Returns:
      whether field was removed
      See Also:

    • clearFields

      public void clearFields()
      Clear all fields

    • findFieldByName

      public field findFieldByName(String fieldName)
      Find contained field statement by name, if present.
      Parameters:
      fieldName - is name attribute for field of interest
      Returns:
      field reference of interest, null otherwise

    • hasField

      public boolean hasField(String fieldName)
      Determine if field statement is present.
      Parameters:
      fieldName - is name attribute for field of interest
      Returns:
      whether field is found

    • setSourceCode

      public ShaderProgram setSourceCode(StringBuilder newSourceCode)
      Set new source code (for example, JavaScript), utility method using StringBuilder. WARNING: be sure to prepend ecmascript: prior to any actual source code.
      Parameters:
      newSourceCode - is source to set
      Returns:
      ShaderProgram - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • appendSourceCode

      public ShaderProgram appendSourceCode(String newSourceCode)
      Append source code (for example, JavaScript)
      Parameters:
      newSourceCode - is source to append
      Returns:
      ShaderProgram - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • appendSourceCode

      public ShaderProgram appendSourceCode(StringBuilder newSourceCode)
      Append source code (for example, JavaScript)
      Parameters:
      newSourceCode - is source to append
      Returns:
      ShaderProgram - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • clearSourceCode

      public ShaderProgram clearSourceCode()
      Clear all contained CDATA source code.
      Returns:
      ShaderProgram - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).