Package org.web3d.x3d.jsail.Shaders
Class ComposedShader
java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.Shaders.ComposedShader
- All Implemented Interfaces:
X3DNode
,ComposedShader
,X3DProgrammableShaderObject
,X3DShaderNode
,X3DAppearanceChildNode
ComposedShader can contain field declarations, but no CDATA section of plain-text source code, since programs are composed from child ShaderPart nodes.
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
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.
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.
ComposedShader 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:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
String constant COMPONENT defines X3D component for the ComposedShader element: Shadersstatic final String
containerField describes typical field relationship of a node to its parent.static final String
fromField ROUTE name for SFNode field named IS.static final String
fromField ROUTE name for SFBool field named isSelected.static final String
fromField ROUTE name for SFBool field named isValid.static final String
fromField ROUTE name for SFNode field named metadata.static final String
fromField ROUTE name for MFNode field named parts.static final IS
SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).static final String
Tooltip: nVidia Cg shading language.static final String
SFString field named language has default value equal to an empty string.static final String
Tooltip: OpenGL shading language (GLSL).static final String
Tooltip: Microsoft High Level Shading Language (HLSL).static final int
Integer constant LEVEL provides default X3D Shaders component level for this element: 1static final X3DMetadataObject
SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).static final String
String constant NAME provides name of this element: ComposedShader.static final String
toField ROUTE name for SFBool field named activate.static final String
toField ROUTE name for SFNode field named metadata.static final String
toField ROUTE name for MFNode field named parts.Fields inherited from class org.web3d.x3d.jsail.X3DConcreteNode
containerField_ALLOWED_VALUES, containerFieldOverride, 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
ConstructorsConstructorDescriptionConstructor for ComposedShader to initialize member variables with default values.ComposedShader
(String DEFlabel) Utility constructor that assigns DEF label after initializing member variables with default values. -
Method Summary
Modifier and TypeMethodDescriptionaddComments
(String newComment) Add comment as String to contained commentsList.addComments
(String[] newComments) Add comments as String[] array to contained commentsList.addComments
(CommentsBlock newCommentsBlock) Add CommentsBlock to contained commentsList.Add field to fieldList for this ComposedShaderaddParts
(ProtoInstance newValue) Add single ProtoInstance (with appropriate node type and containerField value) to MFNode array for parts field.addParts
(ShaderPart newValue) Add single child node to existing array of parts nodes (if any).void
Add array of child parts nodes to array of existing nodes (if any).Utility method to clear MFNode value of fieldList field.void
Clear all fieldsclearIS()
Utility method to clear SFNode value of IS field.Utility method to clear SFNode value of metadata field.Utility method to clear MFNode value of parts field.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.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.findFieldByName
(String fieldName) Find contained field statement by name, if present.findNodeByDEF
(String DEFvalue) Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.getAccessType
(String fieldName) Indicate accessType corresponding to given fieldName.final String
Defines X3D component for the ComposedShader element: Shadersfinal int
Provides default X3D component level for this element: 1final String
containerField describes typical field relationship of a node to its parent.Provide String value from inputOutput SFString field named class.Provide String value from inputOutput SFString field named style.getDEF()
Provide String value from inputOutput SFString field named DEF.final String
Provides name of this element: ComposedShaderProvide array of field results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field field.getFieldType
(String fieldName) Indicate type corresponding to given fieldName.Provide String value from inputOutput SFString field named id.getIS()
Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.boolean
Provide boolean value from outputOnly SFBool field named isSelected.boolean
Provide boolean value from outputOnly SFBool field named isValid.Provide String enumeration value (baseType xs:NMTOKEN) ["Cg" | "GLSL" | "HLSL" | 'etc.'] from initializeOnly SFString field named language.Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.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.Utility method to get ArrayList value of MFNode parts field, similar togetParts()
.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
hasField()
Indicate whether an object is available for inputOutput MFNode field fieldList.boolean
Determine if field statement is present.boolean
hasIS()
Indicate whether an object is available for inputOutput SFNode field IS.boolean
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
hasParts()
Indicate whether an object is available for inputOutput MFNode field parts.final void
Initialize all member variables to default values.boolean
removeField
(String fieldName) Remove a field by name from contained fieldListboolean
removeField
(field fieldToRemove) Remove a field from contained fieldListsetActivate
(boolean newValue) Accessor method to assign boolean value to inputOnly SFBool field named activate.setActivate
(SFBool newValue) Assign typed object value to SFBool activate field, similar tosetActivate(boolean)
.final ComposedShader
setCssClass
(String newValue) Accessor method to assign String value to inputOutput SFString field named class.setCssClass
(SFString newValue) Assign typed object value to SFString cssClass field, similar tosetCssClass(String)
.final ComposedShader
setCssStyle
(String newValue) Accessor method to assign String value to inputOutput SFString field named style.setCssStyle
(SFString newValue) Assign typed object value to SFString cssClass field, similar tosetCssStyle(String)
.final ComposedShader
Accessor method to assign String value to inputOutput SFString field named DEF.Assign typed object value to SFString DEF field, similar tosetDEF(String)
.Set single child field node, replacing prior array of existing nodes (if any).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.final ComposedShader
Accessor method to assign String value to inputOutput SFString field named id.Assign typed object value to SFString HtmlID field, similar tosetHtmlID(String)
.Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.setLanguage
(String newValue) Accessor method to assign String enumeration value ("Cg" | "GLSL" | "HLSL") to initializeOnly SFString field named language.setLanguage
(SFString newValue) Assign typed object value to SFString language field, similar tosetLanguage(String)
.setMetadata
(ProtoInstance newValue) Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.setMetadata
(X3DMetadataObject newValue) Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.setParts
(ArrayList<ShaderPart> newValue) Assign ArrayList value of MFNode parts field, similar tosetParts(org.web3d.x3d.sai.Core.X3DNode[])
.void
Set single child parts node, replacing prior array of existing nodes (if any).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.final ComposedShader
Accessor method to assign String value to inputOutput SFString field named USE.Assign typed object value to SFString USE field, similar tosetUSE(String)
.setUSE
(ComposedShader DEFnode) Assign a USE reference to another DEF node of same node type, similar tosetUSE(String)
.toStringClassicVRML
(int indentLevel) Recursive method to provide ClassicVRML string serialization.toStringVRML97
(int indentLevel) Recursive method to provide VRML97 string serialization.toStringX3D
(int indentLevel) Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.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
getContainerFieldAllowedValues, 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
-
Field Details
-
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:
-
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:
-
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:
-
NAME
String constant NAME provides name of this element: ComposedShader.- See Also:
-
COMPONENT
String constant COMPONENT defines X3D component for the ComposedShader element: Shaders- See Also:
-
LEVEL
public static final int LEVELInteger constant LEVEL provides default X3D Shaders component level for this element: 1- See Also:
-
IS_DEFAULT_VALUE
SFNode field named IS has default value null (Java syntax) or NULL (XML syntax). -
LANGUAGE_DEFAULT_VALUE
SFString field named language has default value equal to an empty string.- See Also:
-
METADATA_DEFAULT_VALUE
SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax). -
containerField_DEFAULT_VALUE
containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, this default value is provided for informational purposes only.
containerField_DEFAULT_VALUE = "shaders";
containerField_ALLOWED_VALUES = {"shaders" }; type xs:NMTOKEN- See Also:
-
toField_ACTIVATE
toField ROUTE name for SFBool field named activate.- See Also:
-
fromField_IS
-
fromField_ISSELECTED
fromField ROUTE name for SFBool field named isSelected.- See Also:
-
fromField_ISVALID
fromField ROUTE name for SFBool field named isValid.- See Also:
-
fromField_METADATA
fromField ROUTE name for SFNode field named metadata.- See Also:
-
toField_METADATA
toField ROUTE name for SFNode field named metadata.- See Also:
-
fromField_PARTS
fromField ROUTE name for MFNode field named parts.- See Also:
-
toField_PARTS
-
-
Constructor Details
-
ComposedShader
public ComposedShader()Constructor for ComposedShader to initialize member variables with default values. -
ComposedShader
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
Provides name of this element: ComposedShader- Specified by:
getElementName
in classX3DConcreteElement
- Returns:
- name of this element
-
getComponent
Defines X3D component for the ComposedShader element: Shaders- Specified by:
getComponent
in classX3DConcreteElement
- Returns:
- X3D component for this element
-
getComponentLevel
public final int getComponentLevel()Provides default X3D component level for this element: 1- Specified by:
getComponentLevel
in classX3DConcreteElement
- Returns:
- default X3D component level for this element
-
getFieldType
Indicate type corresponding to given fieldName.- Specified by:
getFieldType
in classX3DConcreteElement
- Parameters:
fieldName
- name of field in this X3D node- Returns:
- X3D type (SFvec3f etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE if not recognized
- See Also:
-
getAccessType
Indicate accessType corresponding to given fieldName.- Specified by:
getAccessType
in classX3DConcreteElement
- Parameters:
fieldName
- name of field in this X3D node- Returns:
- X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized
- See Also:
-
getContainerFieldDefault
containerField describes typical field relationship of a node to its parent. Programmer usage is not ordinarily needed when using this API, since this default value is provided for informational purposes only.- Specified by:
getContainerFieldDefault
in classX3DConcreteNode
- Returns:
- default containerField value
- See Also:
-
initialize
public final void initialize()Initialize all member variables to default values.- Overrides:
initialize
in classX3DConcreteNode
-
setActivate
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 interfaceComposedShader
- Specified by:
setActivate
in interfaceX3DShaderNode
- 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
Assign typed object value to SFBool activate field, similar tosetActivate(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
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:
-
setFieldList
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
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
Utility method to clear MFNode value of fieldList field. This method does not initialize withFIELD_DEFAULT_VALUE.- 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:
-
getIS
Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.- Specified by:
getIS
in classX3DConcreteNode
- Returns:
- value of IS field
- See Also:
-
setIS
Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.- Specified by:
setIS
in classX3DConcreteNode
- 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:
-
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:
-
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 interfaceComposedShader
- Specified by:
getIsSelected
in interfaceX3DShaderNode
- 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 interfaceComposedShader
- Specified by:
getIsValid
in interfaceX3DShaderNode
- Returns:
- value of isValid field
-
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 interfaceComposedShader
- Specified by:
getLanguage
in interfaceX3DShaderNode
- Returns:
- value of language field
-
setLanguage
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 interfaceComposedShader
- Specified by:
setLanguage
in interfaceX3DShaderNode
- 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
Assign typed object value to SFString language field, similar tosetLanguage(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
Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.- Specified by:
getMetadata
in interfaceComposedShader
- Specified by:
getMetadata
in interfaceX3DAppearanceChildNode
- Specified by:
getMetadata
in interfaceX3DNode
- Specified by:
getMetadata
in interfaceX3DShaderNode
- Returns:
- value of metadata field
- See Also:
-
setMetadata
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 interfaceComposedShader
- Specified by:
setMetadata
in interfaceX3DAppearanceChildNode
- Specified by:
setMetadata
in interfaceX3DNode
- Specified by:
setMetadata
in interfaceX3DShaderNode
- Specified by:
setMetadata
in classX3DConcreteNode
- 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:
-
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
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.- Specified by:
setMetadata
in classX3DConcreteNode
- 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:
-
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:
-
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 interfaceComposedShader
- Returns:
- value of parts field
- See Also:
-
getPartsList
Utility method to get ArrayList value of MFNode parts field, similar togetParts()
.- Returns:
- value of parts field
-
setParts
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 interfaceComposedShader
- 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
Assign ArrayList value of MFNode parts field, similar tosetParts(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
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
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
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 interfaceComposedShader
- Parameters:
newValue
- is new value array to be appended the parts field.
-
setParts
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 interfaceComposedShader
- Parameters:
newValue
- is new node for the parts field (restricted to ShaderPart)
-
clearParts
Utility method to clear MFNode value of parts field. This method does not initialize withPARTS_DEFAULT_VALUE.- 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:
-
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 https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
- Overrides:
getDEF
in classX3DConcreteNode
- Returns:
- value of DEF field
- See Also:
-
setDEF
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 https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
Note that setting the DEF value clears the USE value.- Specified by:
setDEF
in classX3DConcreteNode
- 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
Assign typed object value to SFString DEF field, similar tosetDEF(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
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 classX3DConcreteNode
- Returns:
- value of USE field
- See Also:
-
setUSE
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: eachUSE
node is still an independent object, with theUSE
value matching theDEF
value in the preceding object.
Warning: invoking thesetUSE()
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 classX3DConcreteNode
- 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
Assign typed object value to SFString USE field, similar tosetUSE(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
Provide String value from inputOutput SFString field named class.- Overrides:
getCssClass
in classX3DConcreteElement
- Returns:
- value of class field
- See Also:
-
setCssClass
Accessor method to assign String value to inputOutput SFString field named class.- Specified by:
setCssClass
in classX3DConcreteNode
- 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:
-
setCssClass
Assign typed object value to SFString cssClass field, similar tosetCssClass(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).
-
getHtmlID
Provide String value from inputOutput SFString field named id.- Overrides:
getHtmlID
in classX3DConcreteElement
- Returns:
- value of id field
- See Also:
-
setHtmlID
Accessor method to assign String value to inputOutput SFString field named id.- Specified by:
setHtmlID
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the id field.- Returns:
ComposedShader
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
setHtmlID
Assign typed object value to SFString HtmlID field, similar tosetHtmlID(String)
.- Parameters:
newValue
- is new value for the id field.- Returns:
ComposedShader
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getCssStyle
Provide String value from inputOutput SFString field named style.- Overrides:
getCssStyle
in classX3DConcreteElement
- Returns:
- value of style field
- See Also:
-
setCssStyle
Accessor method to assign String value to inputOutput SFString field named style.- Specified by:
setCssStyle
in classX3DConcreteNode
- 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:
-
setCssStyle
Assign typed object value to SFString cssClass field, similar tosetCssStyle(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
Assign a USE reference to another DEF node of same node type, similar tosetUSE(String)
.
Warning: note that thesetUSE()
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
Add comment as String to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newComment
- initial value- Returns:
ComposedShader
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
addComments
Add comments as String[] array to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newComments
- array of comments- Returns:
ComposedShader
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
addComments
Add CommentsBlock to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- 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
Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.- Specified by:
toStringX3D
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- X3D string
- See Also:
-
toStringClassicVRML
Recursive method to provide ClassicVRML string serialization.- Specified by:
toStringClassicVRML
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- ClassicVRML string
- See Also:
-
toStringVRML97
Recursive method to provide VRML97 string serialization.- Specified by:
toStringVRML97
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- VRML97 string
- See Also:
-
findElementByNameValue
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 classX3DConcreteElement
- Parameters:
nameValue
- is value of the name field being searched for in this element and child elements(if any)- Returns:
- object reference to found element, null otherwise
- See Also:
-
findElementByNameValue
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 classX3DConcreteElement
- Parameters:
nameValue
- is value of the name field being searched for in this element and child elements(if any)elementName
- identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)- Returns:
- object reference to found element, null otherwise
- See Also:
-
hasElementByNameValue
Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.- Parameters:
nameValue
- is value of the name field being searched for in this element and child elements(if any)elementName
- identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)- Returns:
- whether node is found
- See Also:
-
findNodeByDEF
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 classX3DConcreteElement
- Parameters:
DEFvalue
- is value of the name field being searched for in this element and child elements(if any)- Returns:
- object reference to found node, null otherwise
- See Also:
-
hasNodeByDEF
Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.- Parameters:
DEFvalue
- is value of the name field being searched for in this element and child elements(if any)- Returns:
- whether node is found
- See Also:
-
validate
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 classX3DConcreteElement
- Returns:
- validation results (if any)
-
addField
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
Remove a field from contained fieldList- Parameters:
fieldToRemove
- matching field of interest- Returns:
- whether field was removed
- See Also:
-
removeField
Remove a field by name from contained fieldList- Parameters:
fieldName
- matching field of interest- Returns:
- whether field was removed
- See Also:
-
clearFields
public void clearFields()Clear all fields -
findFieldByName
-
hasField
Determine if field statement is present.- Parameters:
fieldName
- is name attribute for field of interest- Returns:
- whether field is found
-