Package org.web3d.x3d.jsail.CubeMapTexturing

Class ComposedCubeMapTexture

java.lang.Object

org.web3d.x3d.jsail.X3DConcreteElement

org.web3d.x3d.jsail.X3DConcreteNode

org.web3d.x3d.jsail.CubeMapTexturing.ComposedCubeMapTexture

All Implemented Interfaces:

X3DNode, ComposedCubeMapTexture, X3DEnvironmentTextureNode, X3DAppearanceChildNode, X3DTextureNode

public class ComposedCubeMapTexture
extends X3DConcreteNode
implements ComposedCubeMapTexture

ComposedCubeMapTexture is a texture node that defines a cubic environment map source as an explicit set of images drawn from individual 2D texture 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 org.web3d.x3d.jsail classes. ComposedCubeMapTexture node tooltip: (X3D version 3.1 or later) [X3DEnvironmentTextureNode] ComposedCubeMapTexture is a texture node that defines a cubic environment map source as an explicit set of images drawn from individual 2D texture nodes.

• Hint: 0..6 child image nodes are allowed (ImageTexture MovieTexture PixelTexture) with corresponding containerField values: front back left right top bottom.
• Warning: each of the child ImageTexture or PixelTexture nodes must have unique containerField values for backTexture, bottomTexture, frontTexture, leftTexture, rightTexture, or topTexture.
• Warning: fields originally named back, bottom, front, left, right, or top in X3Dv3.

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: ComposedCubeMapTexture
• X3D Tooltips: ComposedCubeMapTexture
• X3D Scene Authoring Hints: Images

Field Summary

Fields

Modifier and Type	Field	Description
static final X3DTexture2DNode	BACKTEXTURE_DEFAULT_VALUE	SFNode field named backTexture has default value null (Java syntax) or NULL (XML syntax).
static final X3DTexture2DNode	BOTTOMTEXTURE_DEFAULT_VALUE	SFNode field named bottomTexture has default value null (Java syntax) or NULL (XML syntax).
static final String	COMPONENT	String constant COMPONENT defines X3D component for the ComposedCubeMapTexture element: CubeMapTexturing
static final String	containerField_DEFAULT_VALUE	containerField describes typical field relationship of a node to its parent.
static final String	DESCRIPTION_DEFAULT_VALUE	SFString field named description has default value equal to an empty string.
static final String	fromField_BACKTEXTURE	fromField ROUTE name for SFNode field named backTexture.
static final String	fromField_BOTTOMTEXTURE	fromField ROUTE name for SFNode field named bottomTexture.
static final String	fromField_DESCRIPTION	fromField ROUTE name for SFString field named description.
static final String	fromField_FRONTTEXTURE	fromField ROUTE name for SFNode field named frontTexture.
static final String	fromField_IS	fromField ROUTE name for SFNode field named IS.
static final String	fromField_LEFTTEXTURE	fromField ROUTE name for SFNode field named leftTexture.
static final String	fromField_METADATA	fromField ROUTE name for SFNode field named metadata.
static final String	fromField_RIGHTTEXTURE	fromField ROUTE name for SFNode field named rightTexture.
static final String	fromField_TOPTEXTURE	fromField ROUTE name for SFNode field named topTexture.
static final X3DTexture2DNode	FRONTTEXTURE_DEFAULT_VALUE	SFNode field named frontTexture has default value null (Java syntax) or NULL (XML syntax).
static final IS	IS_DEFAULT_VALUE	SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).
static final X3DTexture2DNode	LEFTTEXTURE_DEFAULT_VALUE	SFNode field named leftTexture has default value null (Java syntax) or NULL (XML syntax).
static final int	LEVEL	Integer constant LEVEL provides default X3D CubeMapTexturing 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: ComposedCubeMapTexture.
static final X3DTexture2DNode	RIGHTTEXTURE_DEFAULT_VALUE	SFNode field named rightTexture has default value null (Java syntax) or NULL (XML syntax).
static final TextureProperties	TEXTUREPROPERTIES_DEFAULT_VALUE	SFNode field named textureProperties has default value null (Java syntax) or NULL (XML syntax).
static final String	toField_BACKTEXTURE	toField ROUTE name for SFNode field named backTexture.
static final String	toField_BOTTOMTEXTURE	toField ROUTE name for SFNode field named bottomTexture.
static final String	toField_DESCRIPTION	toField ROUTE name for SFString field named description.
static final String	toField_FRONTTEXTURE	toField ROUTE name for SFNode field named frontTexture.
static final String	toField_LEFTTEXTURE	toField ROUTE name for SFNode field named leftTexture.
static final String	toField_METADATA	toField ROUTE name for SFNode field named metadata.
static final String	toField_RIGHTTEXTURE	toField ROUTE name for SFNode field named rightTexture.
static final String	toField_TOPTEXTURE	toField ROUTE name for SFNode field named topTexture.
static final X3DTexture2DNode	TOPTEXTURE_DEFAULT_VALUE	SFNode field named topTexture has default value null (Java syntax) or NULL (XML syntax).

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

Constructors

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

Method Summary

Modifier and Type	Method	Description
ComposedCubeMapTexture	addComments(String newComment)	Add comment as String to contained commentsList.
ComposedCubeMapTexture	addComments(String[] newComments)	Add comments as String[] array to contained commentsList.
ComposedCubeMapTexture	addComments(CommentsBlock newCommentsBlock)	Add CommentsBlock to contained commentsList.
ComposedCubeMapTexture	clearBackTexture()	Utility method to clear SFNode value of backTexture field.
ComposedCubeMapTexture	clearBottomTexture()	Utility method to clear SFNode value of bottomTexture field.
ComposedCubeMapTexture	clearFrontTexture()	Utility method to clear SFNode value of frontTexture field.
ComposedCubeMapTexture	clearIS()	Utility method to clear SFNode value of IS field.
ComposedCubeMapTexture	clearLeftTexture()	Utility method to clear SFNode value of leftTexture field.
ComposedCubeMapTexture	clearMetadata()	Utility method to clear SFNode value of metadata field.
ComposedCubeMapTexture	clearRightTexture()	Utility method to clear SFNode value of rightTexture field.
ComposedCubeMapTexture	clearTextureProperties()	Utility method to clear SFNode value of textureProperties field.
ComposedCubeMapTexture	clearTopTexture()	Utility method to clear SFNode value of topTexture 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.
X3DTexture2DNode	getBackTexture()	Provide org.web3d.x3d.sai.Texturing.X3DTexture2DNode instance (using a properly typed node) from inputOutput SFNode field backTexture.
X3DTexture2DNode	getBottomTexture()	Provide org.web3d.x3d.sai.Texturing.X3DTexture2DNode instance (using a properly typed node) from inputOutput SFNode field bottomTexture.
final String	getComponent()	Defines X3D component for the ComposedCubeMapTexture element: CubeMapTexturing
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.
String	getDescription()	Provide String value from inputOutput SFString field named description.
final String	getElementName()	Provides name of this element: ComposedCubeMapTexture
String	getFieldType(String fieldName)	Indicate type corresponding to given fieldName.
X3DTexture2DNode	getFrontTexture()	Provide org.web3d.x3d.sai.Texturing.X3DTexture2DNode instance (using a properly typed node) from inputOutput SFNode field frontTexture.
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.
X3DTexture2DNode	getLeftTexture()	Provide org.web3d.x3d.sai.Texturing.X3DTexture2DNode instance (using a properly typed node) from inputOutput SFNode field leftTexture.
X3DMetadataObject	getMetadata()	Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
X3DTexture2DNode	getRightTexture()	Provide org.web3d.x3d.sai.Texturing.X3DTexture2DNode instance (using a properly typed node) from inputOutput SFNode field rightTexture.
TextureProperties	getTextureProperties()	Provide org.web3d.x3d.sai.Texturing.TextureProperties instance (using a properly typed node) from initializeOnly SFNode field textureProperties.
X3DTexture2DNode	getTopTexture()	Provide org.web3d.x3d.sai.Texturing.X3DTexture2DNode instance (using a properly typed node) from inputOutput SFNode field topTexture.
String	getUSE()	Provide String value from inputOutput SFString field named USE.
boolean	hasBackTexture()	Indicate whether an object is available for inputOutput SFNode field backTexture.
boolean	hasBottomTexture()	Indicate whether an object is available for inputOutput SFNode field bottomTexture.
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	hasFrontTexture()	Indicate whether an object is available for inputOutput SFNode field frontTexture.
boolean	hasIS()	Indicate whether an object is available for inputOutput SFNode field IS.
boolean	hasLeftTexture()	Indicate whether an object is available for inputOutput SFNode field leftTexture.
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	hasRightTexture()	Indicate whether an object is available for inputOutput SFNode field rightTexture.
boolean	hasTextureProperties()	Indicate whether an object is available for initializeOnly SFNode field textureProperties.
boolean	hasTopTexture()	Indicate whether an object is available for inputOutput SFNode field topTexture.
final void	initialize()	Initialize all member variables to default values.
ComposedCubeMapTexture	setBackTexture(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field backTexture.
ComposedCubeMapTexture	setBackTexture(X3DTexture2DNode newValue)	Accessor method to assign org.web3d.x3d.sai.Texturing.X3DTexture2DNode instance (using a properly typed node) to inputOutput SFNode field backTexture.
ComposedCubeMapTexture	setBottomTexture(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field bottomTexture.
ComposedCubeMapTexture	setBottomTexture(X3DTexture2DNode newValue)	Accessor method to assign org.web3d.x3d.sai.Texturing.X3DTexture2DNode instance (using a properly typed node) to inputOutput SFNode field bottomTexture.
final ComposedCubeMapTexture	setCssClass(String newValue)	Accessor method to assign String value to inputOutput SFString field named class.
ComposedCubeMapTexture	setCssClass(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssClass(String).
final ComposedCubeMapTexture	setCssStyle(String newValue)	Accessor method to assign String value to inputOutput SFString field named style.
ComposedCubeMapTexture	setCssStyle(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssStyle(String).
final ComposedCubeMapTexture	setDEF(String newValue)	Accessor method to assign String value to inputOutput SFString field named DEF.
ComposedCubeMapTexture	setDEF(SFString newValue)	Assign typed object value to SFString DEF field, similar to setDEF(String).
ComposedCubeMapTexture	setDescription(String newValue)	Accessor method to assign String value to inputOutput SFString field named description.
ComposedCubeMapTexture	setDescription(SFString newValue)	Assign typed object value to SFString description field, similar to setDescription(String).
ComposedCubeMapTexture	setFrontTexture(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field frontTexture.
ComposedCubeMapTexture	setFrontTexture(X3DTexture2DNode newValue)	Accessor method to assign org.web3d.x3d.sai.Texturing.X3DTexture2DNode instance (using a properly typed node) to inputOutput SFNode field frontTexture.
final ComposedCubeMapTexture	setHtmlID(String newValue)	Accessor method to assign String value to inputOutput SFString field named id.
ComposedCubeMapTexture	setHtmlID(SFString newValue)	Assign typed object value to SFString HtmlID field, similar to setHtmlID(String).
ComposedCubeMapTexture	setIS(IS newValue)	Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
ComposedCubeMapTexture	setLeftTexture(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field leftTexture.
ComposedCubeMapTexture	setLeftTexture(X3DTexture2DNode newValue)	Accessor method to assign org.web3d.x3d.sai.Texturing.X3DTexture2DNode instance (using a properly typed node) to inputOutput SFNode field leftTexture.
ComposedCubeMapTexture	setMetadata(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
ComposedCubeMapTexture	setMetadata(X3DMetadataObject newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
ComposedCubeMapTexture	setRightTexture(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field rightTexture.
ComposedCubeMapTexture	setRightTexture(X3DTexture2DNode newValue)	Accessor method to assign org.web3d.x3d.sai.Texturing.X3DTexture2DNode instance (using a properly typed node) to inputOutput SFNode field rightTexture.
ComposedCubeMapTexture	setTextureProperties(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to initializeOnly SFNode field textureProperties.
ComposedCubeMapTexture	setTextureProperties(TextureProperties newValue)	Accessor method to assign org.web3d.x3d.sai.Texturing.TextureProperties instance (using a properly typed node) to initializeOnly SFNode field textureProperties.
ComposedCubeMapTexture	setTopTexture(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field topTexture.
ComposedCubeMapTexture	setTopTexture(X3DTexture2DNode newValue)	Accessor method to assign org.web3d.x3d.sai.Texturing.X3DTexture2DNode instance (using a properly typed node) to inputOutput SFNode field topTexture.
final ComposedCubeMapTexture	setUSE(String newValue)	Accessor method to assign String value to inputOutput SFString field named USE.
ComposedCubeMapTexture	setUSE(ComposedCubeMapTexture DEFnode)	Assign a USE reference to another DEF node of same node type, similar to setUSE(String).
ComposedCubeMapTexture	setUSE(SFString newValue)	Assign typed object value to SFString USE field, 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

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

Methods inherited from class java.lang.Object

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

Field Details

NAME

public static final String NAME

String constant NAME provides name of this element: ComposedCubeMapTexture.

See Also:

• Constant Field Values

COMPONENT

public static final String COMPONENT

String constant COMPONENT defines X3D component for the ComposedCubeMapTexture element: CubeMapTexturing

See Also:

• Constant Field Values

LEVEL

public static final int LEVEL

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

See Also:

• Constant Field Values

BACKTEXTURE_DEFAULT_VALUE

public static final X3DTexture2DNode BACKTEXTURE_DEFAULT_VALUE

SFNode field named backTexture has default value null (Java syntax) or NULL (XML syntax).

BOTTOMTEXTURE_DEFAULT_VALUE

public static final X3DTexture2DNode BOTTOMTEXTURE_DEFAULT_VALUE

SFNode field named bottomTexture has default value null (Java syntax) or NULL (XML syntax).

DESCRIPTION_DEFAULT_VALUE

public static final String DESCRIPTION_DEFAULT_VALUE

SFString field named description has default value equal to an empty string.

See Also:

• Constant Field Values

FRONTTEXTURE_DEFAULT_VALUE

public static final X3DTexture2DNode FRONTTEXTURE_DEFAULT_VALUE

SFNode field named frontTexture has default value null (Java syntax) or NULL (XML syntax).

IS_DEFAULT_VALUE

public static final IS IS_DEFAULT_VALUE

SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).

LEFTTEXTURE_DEFAULT_VALUE

public static final X3DTexture2DNode LEFTTEXTURE_DEFAULT_VALUE

SFNode field named leftTexture has default value null (Java syntax) or NULL (XML syntax).

METADATA_DEFAULT_VALUE

public static final X3DMetadataObject METADATA_DEFAULT_VALUE

SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).

RIGHTTEXTURE_DEFAULT_VALUE

public static final X3DTexture2DNode RIGHTTEXTURE_DEFAULT_VALUE

SFNode field named rightTexture has default value null (Java syntax) or NULL (XML syntax).

TEXTUREPROPERTIES_DEFAULT_VALUE

public static final TextureProperties TEXTUREPROPERTIES_DEFAULT_VALUE

SFNode field named textureProperties has default value null (Java syntax) or NULL (XML syntax).

TOPTEXTURE_DEFAULT_VALUE

public static final X3DTexture2DNode TOPTEXTURE_DEFAULT_VALUE

SFNode field named topTexture 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, this default value is provided for informational purposes only.
containerField_DEFAULT_VALUE = "texture";
containerField_ALLOWED_VALUES = {"texture" }; type xs:NMTOKEN

See Also:

• X3D Scene Authoring Hints: containerField
• X3D Scene Authoring Hints: validation choices for containerField
• X3D Unified Object Model (X3DUOM)
• Constant Field Values

fromField_BACKTEXTURE

public static final String fromField_BACKTEXTURE

fromField ROUTE name for SFNode field named backTexture.

See Also:

• Constant Field Values

toField_BACKTEXTURE

public static final String toField_BACKTEXTURE

toField ROUTE name for SFNode field named backTexture.

See Also:

• Constant Field Values

fromField_BOTTOMTEXTURE

public static final String fromField_BOTTOMTEXTURE

fromField ROUTE name for SFNode field named bottomTexture.

See Also:

• Constant Field Values

toField_BOTTOMTEXTURE

public static final String toField_BOTTOMTEXTURE

toField ROUTE name for SFNode field named bottomTexture.

See Also:

• Constant Field Values

fromField_DESCRIPTION

public static final String fromField_DESCRIPTION

fromField ROUTE name for SFString field named description.

See Also:

• Constant Field Values

toField_DESCRIPTION

public static final String toField_DESCRIPTION

toField ROUTE name for SFString field named description.

See Also:

• Constant Field Values

fromField_FRONTTEXTURE

public static final String fromField_FRONTTEXTURE

fromField ROUTE name for SFNode field named frontTexture.

See Also:

• Constant Field Values

toField_FRONTTEXTURE

public static final String toField_FRONTTEXTURE

toField ROUTE name for SFNode field named frontTexture.

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_LEFTTEXTURE

public static final String fromField_LEFTTEXTURE

fromField ROUTE name for SFNode field named leftTexture.

See Also:

• Constant Field Values

toField_LEFTTEXTURE

public static final String toField_LEFTTEXTURE

toField ROUTE name for SFNode field named leftTexture.

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_RIGHTTEXTURE

public static final String fromField_RIGHTTEXTURE

fromField ROUTE name for SFNode field named rightTexture.

See Also:

• Constant Field Values

toField_RIGHTTEXTURE

public static final String toField_RIGHTTEXTURE

toField ROUTE name for SFNode field named rightTexture.

See Also:

• Constant Field Values

fromField_TOPTEXTURE

public static final String fromField_TOPTEXTURE

fromField ROUTE name for SFNode field named topTexture.

See Also:

• Constant Field Values

toField_TOPTEXTURE

public static final String toField_TOPTEXTURE

toField ROUTE name for SFNode field named topTexture.

See Also:

• Constant Field Values

Constructor Details

ComposedCubeMapTexture

public ComposedCubeMapTexture()

Constructor for ComposedCubeMapTexture to initialize member variables with default values.

ComposedCubeMapTexture

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

Specified by:

getElementName in class X3DConcreteElement

Returns:

name of this element

getComponent

public final String getComponent()

Defines X3D component for the ComposedCubeMapTexture element: CubeMapTexturing

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. Programmer usage is not ordinarily needed when using this API, since this default value is provided for informational purposes only.

Specified by:

getContainerFieldDefault in class X3DConcreteNode

Returns:

default containerField value

See Also:

• containerField_DEFAULT_VALUE
• X3DConcreteNode.containerField_ALLOWED_VALUES
• X3D Scene Authoring Hints: containerField
• X3D Scene Authoring Hints: validation choices for containerField
• X3D Unified Object Model (X3DUOM)

initialize

public final void initialize()

Initialize all member variables to default values.

Overrides:

initialize in class X3DConcreteNode

getBackTexture

public X3DTexture2DNode getBackTexture()

Provide org.web3d.x3d.sai.Texturing.X3DTexture2DNode instance (using a properly typed node) from inputOutput SFNode field backTexture.

Specified by:

getBackTexture in interface ComposedCubeMapTexture

Returns:

value of backTexture field

See Also:

• 
  
  Tooltip: [X3DTexture2DNode] Parent ComposedCubeMapTexture element can contain up to six image nodes (ImageTexture PixelTexture MovieTexture, other texture nodes).
  • Warning: each child image node must have a different containerField value.
  • Warning: field originally named 'back' in X3Dv3. https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#fieldNameChanges

setBackTexture

public ComposedCubeMapTexture setBackTexture(X3DTexture2DNode newValue)

Accessor method to assign org.web3d.x3d.sai.Texturing.X3DTexture2DNode instance (using a properly typed node) to inputOutput SFNode field backTexture.

Specified by:

setBackTexture in interface ComposedCubeMapTexture

Parameters:

newValue - is new value for the backTexture field.

Returns:

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

See Also:

• 
  
  Tooltip: [X3DTexture2DNode] Parent ComposedCubeMapTexture element can contain up to six image nodes (ImageTexture PixelTexture MovieTexture, other texture nodes).
  • Warning: each child image node must have a different containerField value.
  • Warning: field originally named 'back' in X3Dv3. https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#fieldNameChanges

clearBackTexture

public ComposedCubeMapTexture clearBackTexture()

Utility method to clear SFNode value of backTexture field.

Returns:

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

setBackTexture

public ComposedCubeMapTexture setBackTexture(ProtoInstance newValue)

Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field backTexture.

Parameters:

newValue - is new value for the backTexture field.

Returns:

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

See Also:

• setBackTexture(org.web3d.x3d.sai.Texturing.X3DTexture2DNode)

hasBackTexture

public boolean hasBackTexture()

Indicate whether an object is available for inputOutput SFNode field backTexture.

Returns:

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

See Also:

• getBackTexture()
• getBackTextureProtoInstance()

getBottomTexture

public X3DTexture2DNode getBottomTexture()

Provide org.web3d.x3d.sai.Texturing.X3DTexture2DNode instance (using a properly typed node) from inputOutput SFNode field bottomTexture.

Specified by:

getBottomTexture in interface ComposedCubeMapTexture

Returns:

value of bottomTexture field

See Also:

• 
  
  Tooltip: [X3DTexture2DNode] Parent ComposedCubeMapTexture element can contain up to six image nodes (ImageTexture PixelTexture, other texture nodes).
  • Warning: each child image node must have a different containerField value.
  • Warning: field originally named 'bottom' in X3Dv3. https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#fieldNameChanges

setBottomTexture

public ComposedCubeMapTexture setBottomTexture(X3DTexture2DNode newValue)

Accessor method to assign org.web3d.x3d.sai.Texturing.X3DTexture2DNode instance (using a properly typed node) to inputOutput SFNode field bottomTexture.

Specified by:

setBottomTexture in interface ComposedCubeMapTexture

Parameters:

newValue - is new value for the bottomTexture field.

Returns:

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

See Also:

• 
  
  Tooltip: [X3DTexture2DNode] Parent ComposedCubeMapTexture element can contain up to six image nodes (ImageTexture PixelTexture, other texture nodes).
  • Warning: each child image node must have a different containerField value.
  • Warning: field originally named 'bottom' in X3Dv3. https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#fieldNameChanges

clearBottomTexture

public ComposedCubeMapTexture clearBottomTexture()

Utility method to clear SFNode value of bottomTexture field.

Returns:

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

setBottomTexture

public ComposedCubeMapTexture setBottomTexture(ProtoInstance newValue)

Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field bottomTexture.

Parameters:

newValue - is new value for the bottomTexture field.

Returns:

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

See Also:

• setBottomTexture(org.web3d.x3d.sai.Texturing.X3DTexture2DNode)

hasBottomTexture

public boolean hasBottomTexture()

Indicate whether an object is available for inputOutput SFNode field bottomTexture.

Returns:

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

See Also:

• getBottomTexture()
• getBottomTextureProtoInstance()

getDescription

public String getDescription()

Provide String value from inputOutput SFString field named description.

Tooltip: Author-provided prose that describes intended purpose of the url asset.

• Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).

Specified by:

getDescription in interface ComposedCubeMapTexture

Specified by:

getDescription in interface X3DEnvironmentTextureNode

Specified by:

getDescription in interface X3DTextureNode

Returns:

value of description field

setDescription

public ComposedCubeMapTexture setDescription(String newValue)

Accessor method to assign String value to inputOutput SFString field named description.

Tooltip: Author-provided prose that describes intended purpose of the url asset.

• Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).

Specified by:

setDescription in interface ComposedCubeMapTexture

Specified by:

setDescription in interface X3DEnvironmentTextureNode

Specified by:

setDescription in interface X3DTextureNode

Parameters:

newValue - is new value for the description field.

Returns:

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

setDescription

public ComposedCubeMapTexture setDescription(SFString newValue)

Assign typed object value to SFString description field, similar to setDescription(String).

Parameters:

newValue - is new value for the description field.

Returns:

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

getFrontTexture

public X3DTexture2DNode getFrontTexture()

Provide org.web3d.x3d.sai.Texturing.X3DTexture2DNode instance (using a properly typed node) from inputOutput SFNode field frontTexture.

Specified by:

getFrontTexture in interface ComposedCubeMapTexture

Returns:

value of frontTexture field

See Also:

• 
  
  Tooltip: [X3DTexture2DNode] Parent ComposedCubeMapTexture element can contain up to six image nodes (ImageTexture PixelTexture MovieTexture, other texture nodes).
  • Warning: each child image node must have a different containerField value.
  • Warning: field originally named 'front' in X3Dv3. https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#fieldNameChanges

setFrontTexture

public ComposedCubeMapTexture setFrontTexture(X3DTexture2DNode newValue)

Accessor method to assign org.web3d.x3d.sai.Texturing.X3DTexture2DNode instance (using a properly typed node) to inputOutput SFNode field frontTexture.

Specified by:

setFrontTexture in interface ComposedCubeMapTexture

Parameters:

newValue - is new value for the frontTexture field.

Returns:

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

See Also:

• 
  
  Tooltip: [X3DTexture2DNode] Parent ComposedCubeMapTexture element can contain up to six image nodes (ImageTexture PixelTexture MovieTexture, other texture nodes).
  • Warning: each child image node must have a different containerField value.
  • Warning: field originally named 'front' in X3Dv3. https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#fieldNameChanges

clearFrontTexture

public ComposedCubeMapTexture clearFrontTexture()

Utility method to clear SFNode value of frontTexture field.

Returns:

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

setFrontTexture

public ComposedCubeMapTexture setFrontTexture(ProtoInstance newValue)

Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field frontTexture.

Parameters:

newValue - is new value for the frontTexture field.

Returns:

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

See Also:

• setFrontTexture(org.web3d.x3d.sai.Texturing.X3DTexture2DNode)

hasFrontTexture

public boolean hasFrontTexture()

Indicate whether an object is available for inputOutput SFNode field frontTexture.

Returns:

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

See Also:

• getFrontTexture()
• getFrontTextureProtoInstance()

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

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

Utility method to clear SFNode value of IS field.

Returns:

ComposedCubeMapTexture - 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()

getLeftTexture

public X3DTexture2DNode getLeftTexture()

Provide org.web3d.x3d.sai.Texturing.X3DTexture2DNode instance (using a properly typed node) from inputOutput SFNode field leftTexture.

Specified by:

getLeftTexture in interface ComposedCubeMapTexture

Returns:

value of leftTexture field

See Also:

• 
  
  Tooltip: [X3DTexture2DNode] Parent ComposedCubeMapTexture element can contain up to six image nodes (ImageTexture PixelTexture MovieTexture, other texture nodese).
  • Warning: each child image node must have a different containerField value.
  • Warning: field originally named 'left' in X3Dv3. https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#fieldNameChanges

setLeftTexture

public ComposedCubeMapTexture setLeftTexture(X3DTexture2DNode newValue)

Accessor method to assign org.web3d.x3d.sai.Texturing.X3DTexture2DNode instance (using a properly typed node) to inputOutput SFNode field leftTexture.

Specified by:

setLeftTexture in interface ComposedCubeMapTexture

Parameters:

newValue - is new value for the leftTexture field.

Returns:

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

See Also:

• 
  
  Tooltip: [X3DTexture2DNode] Parent ComposedCubeMapTexture element can contain up to six image nodes (ImageTexture PixelTexture MovieTexture, other texture nodese).
  • Warning: each child image node must have a different containerField value.
  • Warning: field originally named 'left' in X3Dv3. https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#fieldNameChanges

clearLeftTexture

public ComposedCubeMapTexture clearLeftTexture()

Utility method to clear SFNode value of leftTexture field.

Returns:

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

setLeftTexture

public ComposedCubeMapTexture setLeftTexture(ProtoInstance newValue)

Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field leftTexture.

Parameters:

newValue - is new value for the leftTexture field.

Returns:

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

See Also:

• setLeftTexture(org.web3d.x3d.sai.Texturing.X3DTexture2DNode)

hasLeftTexture

public boolean hasLeftTexture()

Indicate whether an object is available for inputOutput SFNode field leftTexture.

Returns:

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

See Also:

• getLeftTexture()
• getLeftTextureProtoInstance()

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 ComposedCubeMapTexture

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:

• 
  
  Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
  • Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/core.html#Metadata
• X3D Scene Authoring Hints: Metadata Nodes

setMetadata

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

Specified by:

setMetadata in interface X3DAppearanceChildNode

Specified by:

setMetadata in interface X3DEnvironmentTextureNode

Specified by:

setMetadata in interface X3DNode

Specified by:

setMetadata in interface X3DTextureNode

Specified by:

setMetadata in class X3DConcreteNode

Parameters:

newValue - is new value for the metadata field.

Returns:

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

See Also:

• 
  
  Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
  • Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/core.html#Metadata
• X3D Scene Authoring Hints: Metadata Nodes

clearMetadata

public ComposedCubeMapTexture clearMetadata()

Utility method to clear SFNode value of metadata field.

Returns:

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

setMetadata

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

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

getRightTexture

public X3DTexture2DNode getRightTexture()

Provide org.web3d.x3d.sai.Texturing.X3DTexture2DNode instance (using a properly typed node) from inputOutput SFNode field rightTexture.

Specified by:

getRightTexture in interface ComposedCubeMapTexture

Returns:

value of rightTexture field

See Also:

• 
  
  Tooltip: [X3DTexture2DNode] Parent ComposedCubeMapTexture element can contain up to six image nodes (ImageTexture PixelTexture MovieTexture, other texture nodes).
  • Warning: each child image node must have a different containerField value.
  • Warning: field originally named 'right' in X3Dv3. https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#fieldNameChanges

setRightTexture

public ComposedCubeMapTexture setRightTexture(X3DTexture2DNode newValue)

Accessor method to assign org.web3d.x3d.sai.Texturing.X3DTexture2DNode instance (using a properly typed node) to inputOutput SFNode field rightTexture.

Specified by:

setRightTexture in interface ComposedCubeMapTexture

Parameters:

newValue - is new value for the rightTexture field.

Returns:

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

See Also:

• 
  
  Tooltip: [X3DTexture2DNode] Parent ComposedCubeMapTexture element can contain up to six image nodes (ImageTexture PixelTexture MovieTexture, other texture nodes).
  • Warning: each child image node must have a different containerField value.
  • Warning: field originally named 'right' in X3Dv3. https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#fieldNameChanges

clearRightTexture

public ComposedCubeMapTexture clearRightTexture()

Utility method to clear SFNode value of rightTexture field.

Returns:

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

setRightTexture

public ComposedCubeMapTexture setRightTexture(ProtoInstance newValue)

Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field rightTexture.

Parameters:

newValue - is new value for the rightTexture field.

Returns:

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

See Also:

• setRightTexture(org.web3d.x3d.sai.Texturing.X3DTexture2DNode)

hasRightTexture

public boolean hasRightTexture()

Indicate whether an object is available for inputOutput SFNode field rightTexture.

Returns:

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

See Also:

• getRightTexture()
• getRightTextureProtoInstance()

getTextureProperties

public TextureProperties getTextureProperties()

Provide org.web3d.x3d.sai.Texturing.TextureProperties instance (using a properly typed node) from initializeOnly SFNode field textureProperties.

Specified by:

getTextureProperties in interface ComposedCubeMapTexture

Returns:

value of textureProperties field

See Also:

• 
  
  Tooltip: [TextureProperties] Single contained TextureProperties node that can specify additional visual attributes applied to corresponding texture images.
  • Warning: TextureProperties must follow other textures in order to meet XML validation requirements.

setTextureProperties

public ComposedCubeMapTexture setTextureProperties(TextureProperties newValue)

Accessor method to assign org.web3d.x3d.sai.Texturing.TextureProperties instance (using a properly typed node) to initializeOnly SFNode field textureProperties.

Specified by:

setTextureProperties in interface ComposedCubeMapTexture

Parameters:

newValue - is new value for the textureProperties field.

Returns:

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

See Also:

• 
  
  Tooltip: [TextureProperties] Single contained TextureProperties node that can specify additional visual attributes applied to corresponding texture images.
  • Warning: TextureProperties must follow other textures in order to meet XML validation requirements.

clearTextureProperties

public ComposedCubeMapTexture clearTextureProperties()

Utility method to clear SFNode value of textureProperties field.

Returns:

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

setTextureProperties

public ComposedCubeMapTexture setTextureProperties(ProtoInstance newValue)

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

Parameters:

newValue - is new value for the textureProperties field.

Returns:

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

See Also:

• setTextureProperties(org.web3d.x3d.sai.Texturing.TextureProperties)

hasTextureProperties

public boolean hasTextureProperties()

Indicate whether an object is available for initializeOnly SFNode field textureProperties.

Returns:

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

See Also:

• getTextureProperties()
• getTexturePropertiesProtoInstance()

getTopTexture

public X3DTexture2DNode getTopTexture()

Provide org.web3d.x3d.sai.Texturing.X3DTexture2DNode instance (using a properly typed node) from inputOutput SFNode field topTexture.

Specified by:

getTopTexture in interface ComposedCubeMapTexture

Returns:

value of topTexture field

See Also:

• 
  
  Tooltip: [X3DTexture2DNode] Parent ComposedCubeMapTexture element can contain up to six image nodes (ImageTexture PixelTexture MovieTexture, other texture nodes).
  • Warning: each child image node must have a different containerField value.
  • Warning: field originally named 'top' in X3Dv3. https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#fieldNameChanges

setTopTexture

public ComposedCubeMapTexture setTopTexture(X3DTexture2DNode newValue)

Accessor method to assign org.web3d.x3d.sai.Texturing.X3DTexture2DNode instance (using a properly typed node) to inputOutput SFNode field topTexture.

Specified by:

setTopTexture in interface ComposedCubeMapTexture

Parameters:

newValue - is new value for the topTexture field.

Returns:

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

See Also:

• 
  
  Tooltip: [X3DTexture2DNode] Parent ComposedCubeMapTexture element can contain up to six image nodes (ImageTexture PixelTexture MovieTexture, other texture nodes).
  • Warning: each child image node must have a different containerField value.
  • Warning: field originally named 'top' in X3Dv3. https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#fieldNameChanges

clearTopTexture

public ComposedCubeMapTexture clearTopTexture()

Utility method to clear SFNode value of topTexture field.

Returns:

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

setTopTexture

public ComposedCubeMapTexture setTopTexture(ProtoInstance newValue)

Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field topTexture.

Parameters:

newValue - is new value for the topTexture field.

Returns:

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

See Also:

• setTopTexture(org.web3d.x3d.sai.Texturing.X3DTexture2DNode)

hasTopTexture

public boolean hasTopTexture()

Indicate whether an object is available for inputOutput SFNode field topTexture.

Returns:

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

See Also:

• getTopTexture()
• getTopTextureProtoInstance()

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

Overrides:

getDEF in class X3DConcreteNode

Returns:

value of DEF field

See Also:

• X3D Scene Authoring Hints: Naming Conventions

setDEF

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

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:

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

setDEF

public ComposedCubeMapTexture setDEF(SFString newValue)

Assign typed object value to SFString DEF field, similar to setDEF(String).

Parameters:

newValue - is new value for the DEF field.

Returns:

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

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

setUSE

public ComposedCubeMapTexture setUSE(SFString newValue)

Assign typed object value to SFString USE field, similar to setUSE(String).

Parameters:

newValue - is new value for the USE field.

Returns:

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

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

Assign typed object value to SFString cssClass field, similar to setCssClass(String).

Parameters:

newValue - is new value for the class field.

Returns:

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

ComposedCubeMapTexture - 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 ComposedCubeMapTexture setHtmlID(SFString newValue)

Assign typed object value to SFString HtmlID field, similar to setHtmlID(String).

Parameters:

newValue - is new value for the id field.

Returns:

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

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

Assign typed object value to SFString cssClass field, similar to setCssStyle(String).

Parameters:

newValue - is new value for the style field.

Returns:

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

setUSE

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

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

addComments

public ComposedCubeMapTexture addComments(String newComment)

Add comment as String to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComment - initial value

Returns:

ComposedCubeMapTexture - 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 ComposedCubeMapTexture addComments(String[] newComments)

Add comments as String[] array to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComments - array of comments

Returns:

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

addComments

public ComposedCubeMapTexture addComments(CommentsBlock newCommentsBlock)

Add CommentsBlock to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newCommentsBlock - block of comments to add

Returns:

ComposedCubeMapTexture - 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)