org.web3d.x3d.sai.Shaders

Interface X3DShaderNode

All Superinterfaces:

X3DAppearanceChildNode, X3DNode

All Known Subinterfaces:

ComposedShader, PackagedShader, ProgramShader

All Known Implementing Classes:

ComposedShaderObject, PackagedShaderObject, ProgramShaderObject

public interface X3DShaderNode
extends X3DAppearanceChildNode

Base type for all nodes that specify a programmable shader.


Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).

See Also:

SAI Java Specification: TODO, X3D Abstract Specification: TODO, X3D Tooltips, X3D Scene Authoring Hints

Method Summary

Modifier and Type	Method and Description
boolean	getIsSelected() Provide boolean value from outputOnly SFBool field named isSelected.
boolean	getIsValid() Provide boolean value from outputOnly SFBool field named isValid.
java.lang.String	getLanguage() Provide String enumeration value ['Cg'|'GLSL'|'HLSL'|'etc.'] from initializeOnly SFString field named language.
X3DMetadataObject	getMetadata() Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
X3DShaderNode	setActivate(boolean newValue) Assign boolean value to inputOnly SFBool field named activate.
X3DShaderNode	setCssClass(java.lang.String newValue) Assign String value to inputOutput SFString field named class.
X3DShaderNode	setDEF(java.lang.String newValue) Assign String value to inputOutput SFString field named DEF.
X3DShaderNode	setLanguage(java.lang.String newValue) Assign String enumeration value ("Cg"|"GLSL"|"HLSL") ['Cg'|'GLSL'|'HLSL'|'etc.'] to initializeOnly SFString field named language.
X3DShaderNode	setMetadata(X3DMetadataObject newValue) Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
X3DShaderNode	setUSE(java.lang.String newValue) Assign String value to inputOutput SFString field named USE.

Method Detail

setActivate

X3DShaderNode setActivate(boolean newValue)

Assign boolean value to inputOnly SFBool field named activate.

Parameters:

newValue - is new value for the activate field.

Returns:

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

getIsSelected

boolean getIsSelected()

Provide boolean value from outputOnly SFBool field named isSelected.

Returns:

value of isSelected field

getIsValid

boolean getIsValid()

Provide boolean value from outputOnly SFBool field named isValid.

Returns:

value of isValid field

getLanguage

java.lang.String getLanguage()

Provide String enumeration value ['Cg'|'GLSL'|'HLSL'|'etc.'] from initializeOnly SFString field named language.

Returns:

value of language field

setLanguage

X3DShaderNode setLanguage(java.lang.String newValue)

Assign String enumeration value ("Cg"|"GLSL"|"HLSL") ['Cg'|'GLSL'|'HLSL'|'etc.'] to initializeOnly SFString field named language.

Parameters:

newValue - is new value for the language field.

Returns:

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

getMetadata

X3DMetadataObject getMetadata()

Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.

Specified by:

getMetadata in interface X3DAppearanceChildNode

Specified by:

getMetadata in interface X3DNode

Returns:

value of metadata field

See Also:

X3D Scene Authoring Hints: Metadata Nodes

setMetadata

X3DShaderNode setMetadata(X3DMetadataObject newValue)

Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.

Specified by:

setMetadata in interface X3DAppearanceChildNode

Specified by:

setMetadata in interface X3DNode

Parameters:

newValue - is new value for the metadata field.

Returns:

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

See Also:

X3D Scene Authoring Hints: Metadata Nodes

setDEF

X3DShaderNode setDEF(java.lang.String newValue)

Assign String value to inputOutput SFString field named DEF.

Note that setting the DEF value clears the USE value.

Specified by:

setDEF in interface X3DAppearanceChildNode

Specified by:

setDEF in interface X3DNode

Parameters:

newValue - is new value for the DEF field.

Returns:

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

setUSE

X3DShaderNode setUSE(java.lang.String newValue)

Assign String value to inputOutput SFString field named USE.

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 interface X3DAppearanceChildNode

Specified by:

setUSE in interface X3DNode

Parameters:

newValue - is new value for the USE field.

Returns:

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

setCssClass

X3DShaderNode setCssClass(java.lang.String newValue)

Assign String value to inputOutput SFString field named class.

Specified by:

setCssClass in interface X3DAppearanceChildNode

Specified by:

setCssClass in interface X3DNode

Parameters:

newValue - is new value for the class field.

Returns:

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