Class ShaderPart

java.lang.Object
All Implemented Interfaces:
X3DNode, X3DUrlObject, ShaderPart

public class ShaderPart
extends X3DConcreteNode
implements ShaderPart
ShaderPart can contain a CDATA section of plain-text source code.

X3D node tooltip: (X3D version 3.1 or later) [X3DNode,X3DUrlObject] ShaderPart defines the source for a portion of source code used by a ComposedShader node. The source is not required to be a complete shader for all of the vertex/fragment processing.
  • Hint: ShaderPart can contain a CDATA block of plain-text source code.
  • Warning: ShaderPart contains no field declarations.
  • Hint: insert a CDATA block to contain source code embedded within an X3D scene.
  • Hint: a contained 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: ShaderPart subprograms are written in the same language, which is specified in the parent ComposedShader node.
  • Hint: apply containerField='watchList' when parent node is LoadSensor.

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: ShaderPart, X3D Tooltips: ShaderPart, X3D Scene Authoring Hints
  • Field Details

  • Constructor Details

    • ShaderPart

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

      public ShaderPart​(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 Details

    • getElementName

      public final java.lang.String getElementName()
      Provides name of this element: ShaderPart
      Specified by:
      getElementName in class X3DConcreteElement
      Returns:
      name of this element
    • getComponent

      public final java.lang.String getComponent()
      Defines X3D component for the ShaderPart 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
    • getDescription

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

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

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

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

      public ShaderPart 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:
      ShaderPart - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • 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:
      X3D Tooltips: IS, X3D Tooltips: connect
    • setIS

      public ShaderPart 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:
      ShaderPart - 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
    • clearIS

      public ShaderPart clearIS()
      Utility method to clear SFNode value of IS field.
      Returns:
      ShaderPart - 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:
      getIS()
    • 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 ShaderPart
      Specified by:
      getLoad in interface X3DUrlObject
      Returns:
      value of load field
    • setLoad

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

      public ShaderPart 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:
      ShaderPart - 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 ShaderPart
      Specified by:
      getMetadata in interface X3DNode
      Returns:
      value of metadata field
      See Also:
      Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node. Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-WD2/Part01/components/core.html#Metadata , X3D Scene Authoring Hints: Metadata Nodes
    • setMetadata

      public ShaderPart 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 ShaderPart
      Specified by:
      setMetadata in interface X3DNode
      Specified by:
      setMetadata in class X3DConcreteNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      ShaderPart - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node. Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-WD2/Part01/components/core.html#Metadata , X3D Scene Authoring Hints: Metadata Nodes
    • clearMetadata

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

      public ShaderPart 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:
      ShaderPart - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setMetadata( org.web3d.x3d.sai.Core.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
    • getRefresh

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

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

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

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

      public ShaderPart setRefresh​(SFTime newValue)
      Assign typed object value to SFTime refresh field, similar to setRefresh(double).
      Parameters:
      newValue - is new value for the refresh field.
      Returns:
      ShaderPart - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getType

      public java.lang.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 ShaderPart
      Returns:
      value of type field
    • setType

      public ShaderPart setType​(java.lang.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 ShaderPart
      Parameters:
      newValue - is new value for the type field.
      Returns:
      ShaderPart - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setType

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

      public java.lang.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: 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 " (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 ShaderPart
      Specified by:
      getUrl in interface X3DUrlObject
      Returns:
      value of url field
    • getUrlList

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

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

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

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

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

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

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

      public ShaderPart clearUrl()
      Utility method to clear MFString value of url field.
      Returns:
      ShaderPart - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • addUrl

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

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

      public java.lang.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:
      X3D Scene Authoring Hints: Naming Conventions
    • setDEF

      public final ShaderPart setDEF​(java.lang.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:
      ShaderPart - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setDEF

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

      public java.lang.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:
      X3D Scene Authoring Hints: Naming Conventions
    • setUSE

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

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

      public java.lang.String getCssClass()
      Provide String value from inputOutput SFString field named class.

      Tooltip: The class attribute is a space-separated list of classes, reserved for use by Cascading Style Sheets (CSS) and XML stylesheets.
      Overrides:
      getCssClass in class X3DConcreteNode
      Returns:
      value of class field
      See Also:
      W3C Cascading Style Sheets
    • setCssClass

      public final ShaderPart setCssClass​(java.lang.String newValue)
      Accessor method to assign String value to inputOutput SFString field named class.

      Tooltip: The class attribute is a space-separated list of classes, reserved for use by Cascading Style Sheets (CSS) and XML stylesheets.
      Specified by:
      setCssClass in class X3DConcreteNode
      Parameters:
      newValue - is new value for the class field.
      Returns:
      ShaderPart - 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 ShaderPart 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:
      ShaderPart - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setUSE

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

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

      public ShaderPart 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:
      ShaderPart - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • addComments

      public ShaderPart addComments​(CommentsBlock newCommentsBlock)
      Add CommentsBlock to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newCommentsBlock - block of comments to add
      Returns:
      ShaderPart - 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:
      X3D.FILE_EXTENSION_X3D, X3D.FILE_EXTENSION_XML, X3D.toStringXML(), X3D.toFileXML(String), X3D.toFileX3D(String), X3D XML Encoding, X3D Compressed Binary Encoding: X3D Canonical Form, X3D Canonicalization (C14N) Tool
    • 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:
      X3D.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:
      X3D.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 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:
      findNodeByDEF(String), X3DConcreteElement.hasAncestorScene(), X3DConcreteElement.findAncestorX3D()
    • 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 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:
      findNodeByDEF(String), X3DConcreteElement.hasAncestorScene(), X3DConcreteElement.findAncestorX3D()
    • 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 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:
      findElementByNameValue(String), X3DConcreteElement.hasAncestorScene(), X3DConcreteElement.findAncestorX3D()
    • 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)
    • setSourceCode

      public ShaderPart setSourceCode​(java.lang.String[] newSourceText)
      Set new source code (for example, JavaScript). WARNING: be sure to prepend ecmascript: prior to any actual source code.
      Parameters:
      newSourceText - is source code to set
      Returns:
      ShaderPart - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • setSourceCode

      public ShaderPart setSourceCode​(java.lang.String newSourceText)
      Set new source code (for example, JavaScript). WARNING: be sure to prepend ecmascript: prior to any actual source code.
      Parameters:
      newSourceText - is source code to set
      Returns:
      ShaderPart - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      See Also:
      X3D Scene Authoring Hints: CDATA Character Data
    • setSourceCode

      public ShaderPart setSourceCode​(java.lang.StringBuilder newSourceText)
      Set new source code (for example, JavaScript). WARNING: be sure to prepend ecmascript: prior to any actual source code.
      Parameters:
      newSourceText - is source to set
      Returns:
      ShaderPart - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • appendSourceCode

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

      public ShaderPart appendSourceCode​(java.lang.StringBuilder newSourceText)
      Append source code (for example, JavaScript)
      Parameters:
      newSourceText - is source to append
      Returns:
      ShaderPart - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • clearSource

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