Package org.web3d.x3d.jsail.Shaders

Class ProgramShader

java.lang.Object

org.web3d.x3d.jsail.X3DConcreteElement

org.web3d.x3d.jsail.X3DConcreteNode

org.web3d.x3d.jsail.Shaders.ProgramShader

All Implemented Interfaces:

X3DNode, ProgramShader, X3DShaderNode, X3DAppearanceChildNode

public class ProgramShader
extends X3DConcreteNode
implements ProgramShader

ProgramShader contains no field declarations and no 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. X3D node tooltip: (X3D version 3.1 or later) [X3DShaderNode] ProgramShader defines a shader that consists of one or more individually programmable, self-contained pieces. ProgramShader contains IS/connect and programs [ShaderProgram] nodes. Warning: ProgramShader contains no field declarations and no plain-text CDATA block source code. Hint: apply default containerField='shaders' when parent node is Appearance. *


Package hint: This org.web3d.x3d.jsail concrete class is used for implementing a standalone X3D object as a Plain Old Java Object (POJO). If you are writing Java code for use inside an X3D Script node, compile separate code using only the org.web3d.x3d.sai package instead.

See Also:

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COMPONENT	String constant COMPONENT defines X3D component for the ProgramShader element: Shaders
static final String	containerField_DEFAULT_VALUE	containerField describes typical field relationship of a node to its parent.
static final String	fromField_IS	fromField ROUTE name for SFNode field named IS.
static final String	fromField_ISSELECTED	fromField ROUTE name for SFBool field named isSelected.
static final String	fromField_ISVALID	fromField ROUTE name for SFBool field named isValid.
static final String	fromField_METADATA	fromField ROUTE name for SFNode field named metadata.
static final String	fromField_PROGRAMS	fromField ROUTE name for MFNode field named programs.
static final IS	IS_DEFAULT_VALUE	SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).
static final String	LANGUAGE_CG	Tooltip: nVidia Cg shading language.
static final String	LANGUAGE_DEFAULT_VALUE	SFString field named language has default value equal to an empty string.
static final String	LANGUAGE_GLSL	Tooltip: OpenGL shading language (GLSL).
static final String	LANGUAGE_HLSL	Tooltip: Microsoft High Level Shading Language (HLSL).
static final int	LEVEL	Integer constant LEVEL provides default X3D Shaders component level for this element: 1
static final X3DMetadataObject	METADATA_DEFAULT_VALUE	SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).
static final String	NAME	String constant NAME provides name of this element: ProgramShader.
static final String	toField_ACTIVATE	toField ROUTE name for SFBool field named activate.
static final String	toField_METADATA	toField ROUTE name for SFNode field named metadata.
static final String	toField_PROGRAMS	toField ROUTE name for MFNode field named programs.

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

containerField_ALTERNATE_VALUES, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE

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

CLASS_DEFAULT_VALUE, ID_DEFAULT_VALUE, STYLE_DEFAULT_VALUE, validationResult

Constructor Summary

Constructors

Constructor	Description
ProgramShader()	Constructor for ProgramShader to initialize member variables with default values.
ProgramShader(String DEFlabel)	Utility constructor that assigns DEF label after initializing member variables with default values.

Method Summary

Modifier and Type	Method	Description
ProgramShader	addComments(String newComment)	Add comment as String to contained commentsList.
ProgramShader	addComments(String[] newComments)	Add comments as String[] array to contained commentsList.
ProgramShader	addComments(CommentsBlock newCommentsBlock)	Add CommentsBlock to contained commentsList.
ProgramShader	addPrograms(ProtoInstance newValue)	Add single ProtoInstance (with appropriate node type and containerField value) to MFNode array for programs field.
ProgramShader	addPrograms(ShaderProgram newValue)	Add single child node to existing array of programs nodes (if any).
void	addPrograms(X3DNode[] newValue)	Add array of child programs nodes to array of existing nodes (if any).
ProgramShader	clearIS()	Utility method to clear SFNode value of IS field.
ProgramShader	clearMetadata()	Utility method to clear SFNode value of metadata field.
ProgramShader	clearPrograms()	Utility method to clear MFNode value of programs field.
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.
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.
X3DConcreteNode	findNodeByDEF(String DEFvalue)	Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
String	getAccessType(String fieldName)	Indicate accessType corresponding to given fieldName.
final String	getComponent()	Defines X3D component for the ProgramShader element: Shaders
final int	getComponentLevel()	Provides default X3D component level for this element: 1
final String	getContainerFieldDefault()	containerField describes typical field relationship of a node to its parent.
String	getCssClass()	Provide String value from inputOutput SFString field named class.
String	getCssStyle()	Provide String value from inputOutput SFString field named style.
String	getDEF()	Provide String value from inputOutput SFString field named DEF.
final String	getElementName()	Provides name of this element: ProgramShader
String	getFieldType(String fieldName)	Indicate type corresponding to given fieldName.
String	getHtmlID()	Provide String value from inputOutput SFString field named id.
IS	getIS()	Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.
boolean	getIsSelected()	Provide boolean value from outputOnly SFBool field named isSelected.
boolean	getIsValid()	Provide boolean value from outputOnly SFBool field named isValid.
String	getLanguage()	Provide String enumeration value (baseType xs:NMTOKEN) ["Cg" | "GLSL" | "HLSL" | 'etc.'] from initializeOnly SFString field named language.
X3DMetadataObject	getMetadata()	Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
X3DNode[]	getPrograms()	Provide array of org.web3d.x3d.sai.Shaders.ShaderProgram results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field programs.
ArrayList<X3DNode>	getProgramsList()	Utility method to get ArrayList value of MFNode programs field, similar to getPrograms().
String	getUSE()	Provide String value from inputOutput SFString field named USE.
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.
boolean	hasIS()	Indicate whether an object is available for inputOutput SFNode field IS.
boolean	hasMetadata()	Indicate whether an object is available for inputOutput SFNode field metadata.
boolean	hasNodeByDEF(String DEFvalue)	Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
boolean	hasPrograms()	Indicate whether an object is available for inputOutput MFNode field programs.
final void	initialize()	Initialize all member variables to default values.
ProgramShader	setActivate(boolean newValue)	Accessor method to assign boolean value to inputOnly SFBool field named activate.
ProgramShader	setActivate(SFBool newValue)	Assign typed object value to SFBool activate field, similar to setActivate(boolean). // #0.e
final ProgramShader	setCssClass(String newValue)	Accessor method to assign String value to inputOutput SFString field named class.
ProgramShader	setCssClass(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssClass(String). // #0.e
final ProgramShader	setCssStyle(String newValue)	Accessor method to assign String value to inputOutput SFString field named style.
ProgramShader	setCssStyle(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssStyle(String). // #0.e
final ProgramShader	setDEF(String newValue)	Accessor method to assign String value to inputOutput SFString field named DEF.
ProgramShader	setDEF(SFString newValue)	Assign typed object value to SFString DEF field, similar to setDEF(String). // #0.e
final ProgramShader	setHtmlID(String newValue)	Accessor method to assign String value to inputOutput SFString field named id.
ProgramShader	setHtmlID(SFString newValue)	Assign typed object value to SFString HtmlID field, similar to setHtmlID(String). // #0.e
ProgramShader	setIS(IS newValue)	Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
ProgramShader	setLanguage(String newValue)	Accessor method to assign String enumeration value ("Cg" | "GLSL" | "HLSL") to initializeOnly SFString field named language.
ProgramShader	setLanguage(SFString newValue)	Assign typed object value to SFString language field, similar to setLanguage(String). // #0.e
ProgramShader	setMetadata(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
ProgramShader	setMetadata(X3DMetadataObject newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
ProgramShader	setPrograms(ArrayList<ShaderProgram> newValue)	Assign ArrayList value of MFNode programs field, similar to setPrograms(org.web3d.x3d.sai.Core.X3DNode[]).
void	setPrograms(X3DNode newValue)	Set single child programs node, replacing prior array of existing nodes (if any).
ProgramShader	setPrograms(X3DNode[] newValue)	Accessor method to assign org.web3d.x3d.sai.Shaders.ShaderProgram array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field programs.
final ProgramShader	setUSE(String newValue)	Accessor method to assign String value to inputOutput SFString field named USE.
ProgramShader	setUSE(SFString newValue)	Assign typed object value to SFString USE field, similar to setUSE(String). // #0.e
ProgramShader	setUSE(ProgramShader DEFnode)	Assign a USE reference to another DEF node of same node type, similar to setUSE(String).
String	toStringClassicVRML(int indentLevel)	Recursive method to provide ClassicVRML string serialization.
String	toStringVRML97(int indentLevel)	Recursive method to provide VRML97 string serialization.
String	toStringX3D(int indentLevel)	Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
String	validate()	Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.

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

getContainerFieldAlternateValues, getContainerFieldOverride, getName, hasDEF, hasNameField, hasUSE, includesNameField, isNode, isStatement, resetContainerFieldOverride, setConcreteDEF, setConcreteUSE, setContainerFieldOverride

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

addComments, clearParent, findAncestorElementByName, findAncestorProtoBody, findAncestorScene, findAncestorX3D, getPackageName, getParent, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorScene, hasAncestorX3D, hasParent, isValid, setConcreteCssClass, setConcreteCssStyle, setConcreteHtmlID, setParent, toStringClassicVRML, toStringVRML97, toStringX3D

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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: ProgramShader.

See Also:

• Constant Field Values

COMPONENT

public static final String COMPONENT

String constant COMPONENT defines X3D component for the ProgramShader element: Shaders

See Also:

• Constant Field Values

LEVEL

public static final int LEVEL

Integer constant LEVEL provides default X3D Shaders component level for this element: 1

See Also:

• Constant Field Values

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_PROGRAMS

public static final String fromField_PROGRAMS

fromField ROUTE name for MFNode field named programs.

See Also:

• Constant Field Values

toField_PROGRAMS

public static final String toField_PROGRAMS

toField ROUTE name for MFNode field named programs.

See Also:

• Constant Field Values

Constructor Details

ProgramShader

public ProgramShader()

Constructor for ProgramShader to initialize member variables with default values.

ProgramShader

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

Specified by:

getElementName in class X3DConcreteElement

Returns:

name of this element

getComponent

public final String getComponent()

Defines X3D component for the ProgramShader element: Shaders

Specified by:

getComponent in class X3DConcreteElement

Returns:

X3D component for this element

getComponentLevel

public final int getComponentLevel()

Provides default X3D component level for this element: 1

Specified by:

getComponentLevel in class X3DConcreteElement

Returns:

default X3D component level for this element

getFieldType

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

Specified by:

setActivate in interface X3DShaderNode

Parameters:

newValue - is new value for the activate field.

Returns:

ProgramShader - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setActivate

public ProgramShader setActivate(SFBool newValue)

Assign typed object value to SFBool activate field, similar to setActivate(boolean). // #0.e

Parameters:

newValue - is new value for the activate field.

Returns:

ProgramShader - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

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

ProgramShader - 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 ProgramShader clearIS()

Utility method to clear SFNode value of IS field.

Returns:

ProgramShader - 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 ProgramShader

Specified by:

getIsSelected in interface X3DShaderNode

Returns:

value of isSelected field

getIsValid

public boolean getIsValid()

Provide boolean value from outputOnly SFBool field named isValid.

Tooltip: isValid indicates whether current shader objects can be run as a shader program. Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events. *

Specified by:

getIsValid in interface ProgramShader

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 ProgramShader

Specified by:

getLanguage in interface X3DShaderNode

Returns:

value of language field

setLanguage

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

Specified by:

setLanguage in interface X3DShaderNode

Parameters:

newValue - is new value for the language field.

Returns:

ProgramShader - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setLanguage

public ProgramShader setLanguage(SFString newValue)

Assign typed object value to SFString language field, similar to setLanguage(String). // #0.e

Parameters:

newValue - is new value for the language field.

Returns:

ProgramShader - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getMetadata

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 ProgramShader

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 <a href="https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS//Part01/components/core.html#Metadata" target="_blank">https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS//Part01/components/core.html#Metadata</a> *
  
• X3D Scene Authoring Hints: Metadata Nodes

setMetadata

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

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:

ProgramShader - 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 <a href="https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS//Part01/components/core.html#Metadata" target="_blank">https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS//Part01/components/core.html#Metadata</a> *
  
• X3D Scene Authoring Hints: Metadata Nodes

clearMetadata

public ProgramShader clearMetadata()

Utility method to clear SFNode value of metadata field.

Returns:

ProgramShader - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

setMetadata

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

ProgramShader - 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

getPrograms

public X3DNode[] getPrograms()

Provide array of org.web3d.x3d.sai.Shaders.ShaderProgram results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field programs.

Tooltip: [ShaderProgram] ProgramShader contains zero or more ShaderProgram node instances. In general, only two ShaderProgram instances are needed: one each for vertex and fragment processing. Hint: each shader language defines required behavior for processing this field. *


Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to ShaderProgram.

Specified by:

getPrograms in interface ProgramShader

Returns:

value of programs field

See Also:

• ShaderProgram

getProgramsList

public ArrayList<X3DNode> getProgramsList()

Utility method to get ArrayList value of MFNode programs field, similar to getPrograms().

Returns:

value of programs field

setPrograms

public ProgramShader setPrograms(X3DNode[] newValue)

Accessor method to assign org.web3d.x3d.sai.Shaders.ShaderProgram array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field programs.

Tooltip: [ShaderProgram] ProgramShader contains zero or more ShaderProgram node instances. In general, only two ShaderProgram instances are needed: one each for vertex and fragment processing. Hint: each shader language defines required behavior for processing this field. *


Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to ShaderProgram.

Specified by:

setPrograms in interface ProgramShader

Parameters:

newValue - is new value for the programs field.

Returns:

ProgramShader - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setPrograms

public ProgramShader setPrograms(ArrayList<ShaderProgram> newValue)

Assign ArrayList value of MFNode programs field, similar to setPrograms(org.web3d.x3d.sai.Core.X3DNode[]).

Parameters:

newValue - is new value for the programs field.

Returns:

ProgramShader - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

addPrograms

public ProgramShader addPrograms(ShaderProgram newValue)

Add single child node to existing array of programs nodes (if any).

Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to ShaderProgram and ProtoInstance.

Parameters:

newValue - is new value to be appended the programs field.

Returns:

ProgramShader - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

addPrograms

public ProgramShader addPrograms(ProtoInstance newValue)

Add single ProtoInstance (with appropriate node type and containerField value) to MFNode array for programs 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:

ProgramShader - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

addPrograms

public void addPrograms(X3DNode[] newValue)

Add array of child programs nodes to array of existing nodes (if any).

Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to ShaderProgram.

Specified by:

addPrograms in interface ProgramShader

Parameters:

newValue - is new value array to be appended the programs field.

setPrograms

public void setPrograms(X3DNode newValue)

Set single child programs node, replacing prior array of existing nodes (if any).

Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are restricted to ShaderProgram.

Specified by:

setPrograms in interface ProgramShader

Parameters:

newValue - is new node for the programs field (restricted to ShaderProgram)

clearPrograms

public ProgramShader clearPrograms()

Utility method to clear MFNode value of programs field.

Returns:

ProgramShader - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

hasPrograms

public boolean hasPrograms()

Indicate whether an object is available for inputOutput MFNode field programs.

Returns:

whether a properly typed node or ProtoInstance array or CommentsBlock is available.

See Also:

• getPrograms()

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. Hint: descriptive DEF names improve clarity and help document a model. Hint: well-defined names can simplify design and debugging through improved author understanding. Hint: X3D Scene Authoring Hints, Naming Conventions <a href="https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions" target="_blank">https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions</a> *

Overrides:

getDEF in class X3DConcreteNode

Returns:

value of DEF field

See Also:

• X3D Scene Authoring Hints: Naming Conventions

setDEF

public final ProgramShader 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. Hint: descriptive DEF names improve clarity and help document a model. Hint: well-defined names can simplify design and debugging through improved author understanding. Hint: X3D Scene Authoring Hints, Naming Conventions <a href="https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions" target="_blank">https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions</a> *


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:

ProgramShader - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setDEF

public ProgramShader setDEF(SFString newValue)

Assign typed object value to SFString DEF field, similar to setDEF(String). // #0.e

Parameters:

newValue - is new value for the DEF field.

Returns:

ProgramShader - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

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

ProgramShader - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setUSE

public ProgramShader setUSE(SFString newValue)

Assign typed object value to SFString USE field, similar to setUSE(String). // #0.e

Parameters:

newValue - is new value for the USE field.

Returns:

ProgramShader - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

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:

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

ProgramShader - 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 ProgramShader setCssClass(SFString newValue)

Assign typed object value to SFString cssClass field, similar to setCssClass(String). // #0.e

Parameters:

newValue - is new value for the class field.

Returns:

ProgramShader - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

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:

• 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

setHtmlID

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

ProgramShader - 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
  Warning: the id attribute is in a distinct separate namespace from DEF identifiers and thus not applicable for USE nodes, ROUTE statements, or Script references.
• X3D Architecture Annex L - HTML authoring guidelines, L.3.1 Content definition and page presentation
• HTML 5.2 W3C Recommendation
• Document Object Model (DOM) Technical Reports
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setHtmlID

public ProgramShader setHtmlID(SFString newValue)

Assign typed object value to SFString HtmlID field, similar to setHtmlID(String). // #0.e

Parameters:

newValue - is new value for the id field.

Returns:

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

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

ProgramShader - 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 ProgramShader setCssStyle(SFString newValue)

Assign typed object value to SFString cssClass field, similar to setCssStyle(String). // #0.e

Parameters:

newValue - is new value for the style field.

Returns:

ProgramShader - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setUSE

public ProgramShader setUSE(ProgramShader 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:

ProgramShader - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

addComments

public ProgramShader addComments(String newComment)

Add comment as String to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComment - initial value

Returns:

ProgramShader - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• X3D Architecture, clause 7.2.5.1 Organization

addComments

public ProgramShader addComments(String[] newComments)

Add comments as String[] array to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComments - array of comments

Returns:

ProgramShader - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

addComments

public ProgramShader addComments(CommentsBlock newCommentsBlock)

Add CommentsBlock to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newCommentsBlock - block of comments to add

Returns:

ProgramShader - 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. TODO document specific validation methods.

Specified by:

validate in class X3DConcreteElement

Returns:

validation results (if any)