Class ComposedShader

All Implemented Interfaces:
X3DNode, ComposedShader, X3DProgrammableShaderObject, X3DShaderNode, X3DAppearanceChildNode

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

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

Package hint: This 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: ComposedShader, X3D Tooltips: ComposedShader, X3D Scene Authoring Hints
  • Field Details

    • LANGUAGE_CG

      public static final String LANGUAGE_CG
      Tooltip: nVidia Cg shading language. SFString field named language with X3DUOM simpleType shaderLanguageValues and with X3DUOM baseType xs:NMTOKEN can equal this value "Cg" (Java syntax) or Cg (XML syntax).
      See Also:
      XML Schema: shaderLanguageValues, Constant Field Values
    • LANGUAGE_GLSL

      public static final String LANGUAGE_GLSL
      Tooltip: OpenGL shading language (GLSL). SFString field named language with X3DUOM simpleType shaderLanguageValues and with X3DUOM baseType xs:NMTOKEN can equal this value "GLSL" (Java syntax) or GLSL (XML syntax).
      See Also:
      XML Schema: shaderLanguageValues, Constant Field Values
    • LANGUAGE_HLSL

      public static final String LANGUAGE_HLSL
      Tooltip: Microsoft High Level Shading Language (HLSL). SFString field named language with X3DUOM simpleType shaderLanguageValues and with X3DUOM baseType xs:NMTOKEN can equal this value "HLSL" (Java syntax) or HLSL (XML syntax).
      See Also:
      XML Schema: shaderLanguageValues, Constant Field Values
    • NAME

      public static final String NAME
      String constant NAME provides name of this element: ComposedShader.
      See Also:
      Constant Field Values
    • COMPONENT

      public static final String COMPONENT
      String constant COMPONENT defines X3D component for the ComposedShader 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
    • IS_DEFAULT_VALUE

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

      public static final String LANGUAGE_DEFAULT_VALUE
      SFString field named language has default value equal to an empty string.
      See Also:
      Constant Field Values
    • METADATA_DEFAULT_VALUE

      public static final X3DMetadataObject METADATA_DEFAULT_VALUE
      SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).
    • 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, 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 String toField_ACTIVATE
      toField ROUTE name for SFBool field named activate.
      See Also:
      Constant Field Values
    • fromField_IS

      public static final String fromField_IS
      fromField ROUTE name for SFNode field named IS.
      See Also:
      Constant Field Values
    • fromField_ISSELECTED

      public static final String fromField_ISSELECTED
      fromField ROUTE name for SFBool field named isSelected.
      See Also:
      Constant Field Values
    • fromField_ISVALID

      public static final String fromField_ISVALID
      fromField ROUTE name for SFBool field named isValid.
      See Also:
      Constant Field Values
    • fromField_METADATA

      public static final String fromField_METADATA
      fromField ROUTE name for SFNode field named metadata.
      See Also:
      Constant Field Values
    • toField_METADATA

      public static final String toField_METADATA
      toField ROUTE name for SFNode field named metadata.
      See Also:
      Constant Field Values
    • fromField_PARTS

      public static final String fromField_PARTS
      fromField ROUTE name for MFNode field named parts.
      See Also:
      Constant Field Values
    • toField_PARTS

      public static final String toField_PARTS
      toField ROUTE name for MFNode field named parts.
      See Also:
      Constant Field Values
  • Constructor Details

    • ComposedShader

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

      public ComposedShader(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: ComposedShader
      Specified by:
      getElementName in class X3DConcreteElement
      Returns:
      name of this element
    • getComponent

      public final String getComponent()
      Defines X3D component for the ComposedShader 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:
      ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE
    • 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:
      ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE
    • getContainerFieldDefault

      public final 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 ComposedShader setActivate(boolean newValue)
      Accessor method to assign boolean value to inputOnly SFBool field named activate.

      Tooltip: activate forces the shader to activate the contained objects.
      • Warning: it is an error to define this transient inputOnly field in an X3D file, instead only use it a destination for ROUTE events.
      Specified by:
      setActivate in interface ComposedShader
      Specified by:
      setActivate in interface X3DShaderNode
      Parameters:
      newValue - is new value for the activate field.
      Returns:
      ComposedShader - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setActivate

      public ComposedShader setActivate(SFBool newValue)
      Assign typed object value to SFBool activate field, similar to setActivate(boolean).
      Parameters:
      newValue - is new value for the activate field.
      Returns:
      ComposedShader - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • 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 ComposedShader node. *


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

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

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

      public ComposedShader clearField()
      Utility method to clear MFNode value of fieldList field.
      Returns:
      ComposedShader - 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:
      getFieldList()
    • 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 ComposedShader 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:
      ComposedShader - 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 ComposedShader clearIS()
      Utility method to clear SFNode value of IS field.
      Returns:
      ComposedShader - 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()
    • 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, instead only use it a source for ROUTE events.
      Specified by:
      getIsSelected in interface ComposedShader
      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, instead only use it a source for ROUTE events.
      Specified by:
      getIsValid in interface ComposedShader
      Specified by:
      getIsValid in interface X3DShaderNode
      Returns:
      value of isValid field
    • getLanguage

      public String getLanguage()
      Provide String enumeration value (baseType xs:NMTOKEN) ["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".


      Available enumeration values for string comparison: CG, GLSL, HLSL.
      Specified by:
      getLanguage in interface ComposedShader
      Specified by:
      getLanguage in interface X3DShaderNode
      Returns:
      value of language field
    • setLanguage

      public ComposedShader setLanguage(String newValue)
      Accessor method to assign String enumeration value ("Cg" | "GLSL" | "HLSL") 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".
      Specified by:
      setLanguage in interface ComposedShader
      Specified by:
      setLanguage in interface X3DShaderNode
      Parameters:
      newValue - is new value for the language field.
      Returns:
      ComposedShader - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setLanguage

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

      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 ComposedShader
      Specified by:
      getMetadata in interface X3DAppearanceChildNode
      Specified by:
      getMetadata in interface X3DNode
      Specified by:
      getMetadata in interface X3DShaderNode
      Returns:
      value of metadata field
      See Also:
      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-WD3/Part01/components/core.html#Metadata , X3D Scene Authoring Hints: Metadata Nodes
    • setMetadata

      public ComposedShader 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 ComposedShader
      Specified by:
      setMetadata in interface X3DAppearanceChildNode
      Specified by:
      setMetadata in interface X3DNode
      Specified by:
      setMetadata in interface X3DShaderNode
      Specified by:
      setMetadata in class X3DConcreteNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      ComposedShader - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      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-WD3/Part01/components/core.html#Metadata , X3D Scene Authoring Hints: Metadata Nodes
    • clearMetadata

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

      public ComposedShader 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:
      ComposedShader - 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
    • getParts

      public X3DNode[] getParts()
      Provide array of org.web3d.x3d.sai.Shaders.ShaderPart results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field parts.

      Tooltip: [ShaderPart] ComposedShader can contain multiple ShaderPart nodes in the parts field. *


      Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to ShaderPart.
      Specified by:
      getParts in interface ComposedShader
      Returns:
      value of parts field
      See Also:
      ShaderPart
    • getPartsList

      public ArrayList<X3DNode> getPartsList()
      Utility method to get ArrayList value of MFNode parts field, similar to getParts().
      Returns:
      value of parts field
    • setParts

      public ComposedShader setParts(X3DNode[] newValue)
      Accessor method to assign org.web3d.x3d.sai.Shaders.ShaderPart array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field parts.

      Tooltip: [ShaderPart] ComposedShader can contain multiple ShaderPart nodes in the parts field. *


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

      public ComposedShader setParts(ArrayList<ShaderPart> newValue)
      Assign ArrayList value of MFNode parts field, similar to setParts(org.web3d.x3d.sai.Core.X3DNode[]).
      Parameters:
      newValue - is new value for the parts field.
      Returns:
      ComposedShader - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • addParts

      public ComposedShader addParts(ShaderPart newValue)
      Add single child node to existing array of parts nodes (if any).

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

      public ComposedShader addParts(ProtoInstance newValue)
      Add single ProtoInstance (with appropriate node type and containerField value) to MFNode array for parts field.

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

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

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

      public void setParts(X3DNode newValue)
      Set single child parts node, replacing prior array of existing nodes (if any).

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are restricted to ShaderPart.
      Specified by:
      setParts in interface ComposedShader
      Parameters:
      newValue - is new node for the parts field (restricted to ShaderPart)
    • clearParts

      public ComposedShader clearParts()
      Utility method to clear MFNode value of parts field.
      Returns:
      ComposedShader - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • hasParts

      public boolean hasParts()
      Indicate whether an object is available for inputOutput MFNode field parts.
      Returns:
      whether a properly typed node or ProtoInstance array or CommentsBlock is available.
      See Also:
      getParts()
    • 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:
      X3D Scene Authoring Hints: Naming Conventions
    • setDEF

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

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

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

      public ComposedShader 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:
      ComposedShader - 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 X3DConcreteNode
      Returns:
      value of class field
      See Also:
      X3D Architecture Annex L, HTML authoring guidelines, CSS considerations, W3C Cascading Style Sheets, W3C CSS Snapshot, Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets
    • setCssClass

      public final ComposedShader 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:
      ComposedShader - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      X3D Architecture Annex L, HTML authoring guidelines, CSS considerations, W3C Cascading Style Sheets, W3C CSS Snapshot, Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets
    • setCssClass

      public ComposedShader 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:
      ComposedShader - 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 X3DConcreteNode
      Returns:
      value of style field
      See Also:
      X3D Architecture Annex L, HTML authoring guidelines, CSS considerations, W3C Cascading Style Sheets, W3C CSS Snapshot, Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets
    • setCssStyle

      public final ComposedShader 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:
      ComposedShader - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      X3D Architecture Annex L, HTML authoring guidelines, CSS considerations, W3C Cascading Style Sheets, W3C CSS Snapshot, Wikibooks, XML - Managing Data Exchange/XSLT and Style Sheets
    • setCssStyle

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

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

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

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

      public ComposedShader addComments(CommentsBlock newCommentsBlock)
      Add CommentsBlock to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newCommentsBlock - block of comments to add
      Returns:
      ComposedShader - 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:
      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 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 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(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(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:
      findNodeByDEF(String), X3DConcreteElement.hasAncestorScene(), X3DConcreteElement.findAncestorX3D()
    • 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:
      findElementByNameValue(String, String)
    • 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:
      findElementByNameValue(String), X3DConcreteElement.hasAncestorScene(), X3DConcreteElement.findAncestorX3D()
    • 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:
      findNodeByDEF(String)
    • 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.
      Specified by:
      validate in class X3DConcreteElement
      Returns:
      validation results (if any)
    • addField

      public ComposedShader addField(field newField)
      Add field to fieldList for this ComposedShader
      Parameters:
      newField - is field to add
      Returns:
      ComposedShader - 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(String)
    • 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:
      removeField(field)
    • 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