org.web3d.x3d.sai.CubeMapTexturing

Interface GeneratedCubeMapTexture

All Superinterfaces:

X3DAppearanceChildNode, X3DEnvironmentTextureNode, X3DNode, X3DTextureNode

All Known Implementing Classes:

GeneratedCubeMapTextureObject

public interface GeneratedCubeMapTexture
extends X3DEnvironmentTextureNode

Abstract node interface, defined by X3D specification to support X3D Java interoperability.

X3D node tooltip: (X3D version 3.1 or later) [X3DEnvironmentTextureNode] GeneratedCubeMapTexture is a texture node that defines a cubic environment map that sources its data from internally generated images. The viewpoint of the generated texture is the location and orientation of the associated geometry in world space.

• Hint: can contain a single TextureProperties node.
• Hint: typically a Box is used for applying the GeneratedCubeMapTexture.

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: GeneratedCubeMapTexture, X3D Tooltips: GeneratedCubeMapTexture, X3D Scene Authoring Hints: Images

Method Summary

Modifier and Type	Method and Description
X3DMetadataObject	getMetadata() Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
int	getSize() Provide int value within allowed range of (0,infinity) from initializeOnly SFInt32 field named size.
TextureProperties	getTextureProperties() Provide TextureProperties instance (using a properly typed node) from initializeOnly SFNode field textureProperties.
java.lang.String	getUpdate() Provide String enumeration value ['NONE'|'NEXT_FRAME_ONLY'|'ALWAYS'] from inputOutput SFString field named update.
GeneratedCubeMapTexture	setCssClass(java.lang.String newValue) Assign String value to inputOutput SFString field named class.
GeneratedCubeMapTexture	setDEF(java.lang.String newValue) Assign String value to inputOutput SFString field named DEF.
GeneratedCubeMapTexture	setMetadata(X3DMetadataObject newValue) Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
GeneratedCubeMapTexture	setSize(int newValue) Assign int value within allowed range of (0,infinity) to initializeOnly SFInt32 field named size.
GeneratedCubeMapTexture	setTextureProperties(TextureProperties newValue) Assign TextureProperties instance (using a properly typed node) to initializeOnly SFNode field textureProperties.
GeneratedCubeMapTexture	setUpdate(java.lang.String newValue) Assign String enumeration value ("NONE"|"NEXT_FRAME_ONLY"|"ALWAYS") ['NONE'|'NEXT_FRAME_ONLY'|'ALWAYS'] to inputOutput SFString field named update.
GeneratedCubeMapTexture	setUSE(java.lang.String newValue) Assign String value to inputOutput SFString field named USE.

Method Detail

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 X3DEnvironmentTextureNode

Specified by:

getMetadata in interface X3DNode

Specified by:

getMetadata in interface X3DTextureNode

Returns:

value of metadata field

See Also:

X3D Scene Authoring Hints: Metadata Nodes

setMetadata

GeneratedCubeMapTexture 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 X3DEnvironmentTextureNode

Specified by:

setMetadata in interface X3DNode

Specified by:

setMetadata in interface X3DTextureNode

Parameters:

newValue - is new value for the metadata field.

Returns:

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

getSize

int getSize()

Provide int value within allowed range of (0,infinity) from initializeOnly SFInt32 field named size.

Tooltip: (0,+infinity) size indicates the resolution of the generated images in number of pixels per side. *

Returns:

value of size field

setSize

GeneratedCubeMapTexture setSize(int newValue)

Assign int value within allowed range of (0,infinity) to initializeOnly SFInt32 field named size.

Tooltip: (0,+infinity) size indicates the resolution of the generated images in number of pixels per side.

Parameters:

newValue - is new value for the size field.

Returns:

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

getTextureProperties

TextureProperties getTextureProperties()

Provide TextureProperties instance (using a properly typed node) from initializeOnly SFNode field textureProperties.

Returns:

value of textureProperties field

setTextureProperties

GeneratedCubeMapTexture setTextureProperties(TextureProperties newValue)

Assign TextureProperties instance (using a properly typed node) to initializeOnly SFNode field textureProperties.

Parameters:

newValue - is new value for the textureProperties field.

Returns:

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

getUpdate

java.lang.String getUpdate()

Provide String enumeration value ['NONE'|'NEXT_FRAME_ONLY'|'ALWAYS'] from inputOutput SFString field named update.

Tooltip: update controls regeneration of the texture.

• Warning: An object trying to render itself in the scene graph can cause infinite loops.
• Warning: do not wrap extra quotation marks around these SFString enumeration values, since "quotation" "marks" are only used for MFString values.

Returns:

value of update field

setUpdate

GeneratedCubeMapTexture setUpdate(java.lang.String newValue)

Assign String enumeration value ("NONE"|"NEXT_FRAME_ONLY"|"ALWAYS") ['NONE'|'NEXT_FRAME_ONLY'|'ALWAYS'] to inputOutput SFString field named update.

Tooltip: update controls regeneration of the texture. Warning: An object trying to render itself in the scene graph can cause infinite loops. Warning: do not wrap extra quotation marks around these SFString enumeration values, since "quotation" "marks" are only used for MFString values.

Parameters:

newValue - is new value for the update field.

Returns:

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

setDEF

GeneratedCubeMapTexture setDEF(java.lang.String newValue)

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 http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions

Note that setting the DEF value clears the USE value.

Specified by:

setDEF in interface X3DAppearanceChildNode

Specified by:

setDEF in interface X3DEnvironmentTextureNode

Specified by:

setDEF in interface X3DNode

Specified by:

setDEF in interface X3DTextureNode

Parameters:

newValue - is new value for the DEF field.

Returns:

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

setUSE

GeneratedCubeMapTexture setUSE(java.lang.String newValue)

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

Specified by:

setUSE in interface X3DEnvironmentTextureNode

Specified by:

setUSE in interface X3DNode

Specified by:

setUSE in interface X3DTextureNode

Parameters:

newValue - is new value for the USE field.

Returns:

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

setCssClass

GeneratedCubeMapTexture setCssClass(java.lang.String newValue)

Assign String value to inputOutput SFString field named class.

Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets. Warning: currently the class attribute is only supported in XML encoding of X3D scenes. Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS

Specified by:

setCssClass in interface X3DAppearanceChildNode

Specified by:

setCssClass in interface X3DEnvironmentTextureNode

Specified by:

setCssClass in interface X3DNode

Specified by:

setCssClass in interface X3DTextureNode

Parameters:

newValue - is new value for the class field.

Returns:

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