Class TextureBackground

java.lang.Object

org.web3d.x3d.jsail.X3DConcreteElement

org.web3d.x3d.jsail.X3DConcreteNode

org.web3d.x3d.jsail.EnvironmentalEffects.TextureBackground

All Implemented Interfaces:

X3DBindableNode, X3DChildNode, X3DNode, TextureBackground, X3DBackgroundNode

public class TextureBackground
extends X3DConcreteNode
implements TextureBackground

TextureBackground simulates ground and sky, using vertical arrays of wraparound color values, TextureBackground can also provide backdrop texture images on all six sides.

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. TextureBackground node tooltip: [X3DBackgroundNode] TextureBackground simulates ground and sky, using vertical arrays of wraparound color values, TextureBackground can also provide backdrop texture images on all six sides.

• Hint: Background, Fog, GeoViewpoint, NavigationInfo, OrthoViewpoint, TextureBackground and Viewpoint are bindable nodes, meaning that no more than one of each node type can be active at a given time.
• Warning: results are undefined if a bindable node (Background, Fog, NavigationInfo, OrthoViewpoint, TextureBackground, Viewpoint) is a contained descendant node of either LOD or Switch. Avoid this authoring pattern.
• Warning: each of the child ImageTexture or PixelTexture nodes must have unique containerField values for backTexture, bottomTexture, frontTexture, leftTexture, rightTexture, or topTexture.
• Hint: authors can have LoadSensor nodes receive notifications and send reporting events when background texture node(s) are loaded.

Note that SFColor provides a variety of color constants.

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

Field Summary

Fields

Modifier and Type	Field	Description
static final X3DNode	BACKTEXTURE_DEFAULT_VALUE	SFNode field named backTexture has default value null (Java syntax) or NULL (XML syntax).
static final X3DNode	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 TextureBackground element: EnvironmentalEffects
static final String	containerField_DEFAULT_VALUE	containerField describes typical field relationship of a node to its parent.
static final String	fromField_BACKTEXTURE	fromField ROUTE name for SFNode field named backTexture.
static final String	fromField_BINDTIME	fromField ROUTE name for SFTime field named bindTime.
static final String	fromField_BOTTOMTEXTURE	fromField ROUTE name for SFNode field named bottomTexture.
static final String	fromField_FRONTTEXTURE	fromField ROUTE name for SFNode field named frontTexture.
static final String	fromField_GROUNDANGLE	fromField ROUTE name for MFFloat field named groundAngle.
static final String	fromField_GROUNDCOLOR	fromField ROUTE name for MFColor field named groundColor.
static final String	fromField_IS	fromField ROUTE name for SFNode field named IS.
static final String	fromField_ISBOUND	fromField ROUTE name for SFBool field named isBound.
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_SKYANGLE	fromField ROUTE name for MFFloat field named skyAngle.
static final String	fromField_SKYCOLOR	fromField ROUTE name for MFColor field named skyColor.
static final String	fromField_TOPTEXTURE	fromField ROUTE name for SFNode field named topTexture.
static final String	fromField_TRANSPARENCY	fromField ROUTE name for SFFloat field named transparency.
static final X3DNode	FRONTTEXTURE_DEFAULT_VALUE	SFNode field named frontTexture has default value null (Java syntax) or NULL (XML syntax).
static final ArrayList<Float>	GROUNDANGLE_DEFAULT_VALUE	MFFloat field named groundAngle has default value equal to an empty list.
static final float[]	GROUNDCOLOR_DEFAULT_VALUE	MFColor field named groundColor has default value equal to an empty list.
static final IS	IS_DEFAULT_VALUE	SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).
static final X3DNode	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 EnvironmentalEffects component level for this element: 3
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: TextureBackground.
static final X3DNode	RIGHTTEXTURE_DEFAULT_VALUE	SFNode field named rightTexture has default value null (Java syntax) or NULL (XML syntax).
static final ArrayList<Float>	SKYANGLE_DEFAULT_VALUE	MFFloat field named skyAngle has default value equal to an empty list.
static final float[]	SKYCOLOR_DEFAULT_VALUE	MFColor field named skyColor has default value {0f,0f,0f} (Java syntax) or 0 0 0 (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_FRONTTEXTURE	toField ROUTE name for SFNode field named frontTexture.
static final String	toField_GROUNDANGLE	toField ROUTE name for MFFloat field named groundAngle.
static final String	toField_GROUNDCOLOR	toField ROUTE name for MFColor field named groundColor.
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_SET_BIND	toField ROUTE name for SFBool field named set_bind.
static final String	toField_SKYANGLE	toField ROUTE name for MFFloat field named skyAngle.
static final String	toField_SKYCOLOR	toField ROUTE name for MFColor field named skyColor.
static final String	toField_TOPTEXTURE	toField ROUTE name for SFNode field named topTexture.
static final String	toField_TRANSPARENCY	toField ROUTE name for SFFloat field named transparency.
static final X3DNode	TOPTEXTURE_DEFAULT_VALUE	SFNode field named topTexture has default value null (Java syntax) or NULL (XML syntax).
static final float	TRANSPARENCY_DEFAULT_VALUE	SFFloat field named transparency has default value 0f (Java syntax) or 0 (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
TextureBackground()	Constructor for TextureBackground to initialize member variables with default values.
TextureBackground(String DEFlabel)	Utility constructor that assigns DEF label after initializing member variables with default values.

Method Summary

Modifier and Type	Method	Description
TextureBackground	addComments(String newComment)	Add comment as String to contained commentsList.
TextureBackground	addComments(String[] newComments)	Add comments as String[] array to contained commentsList.
TextureBackground	addComments(CommentsBlock newCommentsBlock)	Add CommentsBlock to contained commentsList.
TextureBackground	addGroundAngle(float newValue)	Add singleton float value to MFFloat groundAngle field.
TextureBackground	addGroundAngle(SFFloat newValue)	Add singleton SFFloat value to MFFloat groundAngle field.
TextureBackground	addGroundColor(SFColor newValue)	Add singleton SFColor value to MFColor groundColor field.
TextureBackground	addSkyAngle(float newValue)	Add singleton float value to MFFloat skyAngle field.
TextureBackground	addSkyAngle(SFFloat newValue)	Add singleton SFFloat value to MFFloat skyAngle field.
TextureBackground	addSkyColor(SFColor newValue)	Add singleton SFColor value to MFColor skyColor field.
TextureBackground	clearBackTexture()	Utility method to clear SFNode value of backTexture field.
TextureBackground	clearBottomTexture()	Utility method to clear SFNode value of bottomTexture field.
TextureBackground	clearFrontTexture()	Utility method to clear SFNode value of frontTexture field.
TextureBackground	clearGroundAngle()	Utility method to clear MFFloat value of groundAngle field.
TextureBackground	clearIS()	Utility method to clear SFNode value of IS field.
TextureBackground	clearLeftTexture()	Utility method to clear SFNode value of leftTexture field.
TextureBackground	clearMetadata()	Utility method to clear SFNode value of metadata field.
TextureBackground	clearRightTexture()	Utility method to clear SFNode value of rightTexture field.
TextureBackground	clearSkyAngle()	Utility method to clear MFFloat value of skyAngle field.
TextureBackground	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.
X3DNode	getBackTexture()	Provide org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) with acceptable node types limited to X3DTexture2DNode|MultiTexture, from inputOutput SFNode field backTexture.
double	getBindTime()	Provide double value in seconds from outputOnly SFTime field named bindTime.
X3DNode	getBottomTexture()	Provide org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) with acceptable node types limited to X3DTexture2DNode|MultiTexture, from inputOutput SFNode field bottomTexture.
final String	getComponent()	Defines X3D component for the TextureBackground element: EnvironmentalEffects
final int	getComponentLevel()	Provides default X3D component level for this element: 3
final String	getContainerFieldDefault()	containerField describes typical field relationship of a node to its parent.
String	getCssClass()	Provide String value from inputOutput SFString field named class.
String	getCssStyle()	Provide String value from inputOutput SFString field named style.
String	getDEF()	Provide String value from inputOutput SFString field named DEF.
final String	getElementName()	Provides name of this element: TextureBackground
String	getFieldType(String fieldName)	Indicate type corresponding to given fieldName.
X3DNode	getFrontTexture()	Provide org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) with acceptable node types limited to X3DTexture2DNode|MultiTexture, from inputOutput SFNode field frontTexture.
float[]	getGroundAngle()	Provide array of Float results unit axis, angle (in radians) within allowed range of [0,1.5708] from inputOutput MFFloat field named groundAngle.
ArrayList<Float>	getGroundAngleList()	Utility method to get ArrayList value of MFFloat groundAngle field, similar to getGroundAngle().
String	getGroundAngleString()	Utility method to get String value of MFFloat groundAngle field, similar to getGroundAngle().
float[]	getGroundColor()	Provide array of 3-tuple float results using RGB values [0..1] using RGB values [0..1] from inputOutput MFColor field named groundColor.
String	getHtmlID()	Provide String value from inputOutput SFString field named id.
IS	getIS()	Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.
boolean	getIsBound()	Provide boolean value from outputOnly SFBool field named isBound.
X3DNode	getLeftTexture()	Provide org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) with acceptable node types limited to X3DTexture2DNode|MultiTexture, 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.
X3DNode	getRightTexture()	Provide org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) with acceptable node types limited to X3DTexture2DNode|MultiTexture, from inputOutput SFNode field rightTexture.
float[]	getSkyAngle()	Provide array of Float results unit axis, angle (in radians) within allowed range of [0,3.1416] from inputOutput MFFloat field named skyAngle.
ArrayList<Float>	getSkyAngleList()	Utility method to get ArrayList value of MFFloat skyAngle field, similar to getSkyAngle().
String	getSkyAngleString()	Utility method to get String value of MFFloat skyAngle field, similar to getSkyAngle().
float[]	getSkyColor()	Provide array of 3-tuple float results using RGB values [0..1] using RGB values [0..1] from inputOutput MFColor field named skyColor.
X3DNode	getTopTexture()	Provide org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) with acceptable node types limited to X3DTexture2DNode|MultiTexture, from inputOutput SFNode field topTexture.
float	getTransparency()	Provide float value within allowed range of [0,1] from inputOutput SFFloat field named transparency.
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	hasTopTexture()	Indicate whether an object is available for inputOutput SFNode field topTexture.
final void	initialize()	Initialize all member variables to default values.
TextureBackground	setBackTexture(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field backTexture.
TextureBackground	setBackTexture(X3DNode newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) to inputOutput SFNode field backTexture.
TextureBackground	setBottomTexture(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field bottomTexture.
TextureBackground	setBottomTexture(X3DNode newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) to inputOutput SFNode field bottomTexture.
final TextureBackground	setCssClass(String newValue)	Accessor method to assign String value to inputOutput SFString field named class.
TextureBackground	setCssClass(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssClass(String).
final TextureBackground	setCssStyle(String newValue)	Accessor method to assign String value to inputOutput SFString field named style.
TextureBackground	setCssStyle(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssStyle(String).
final TextureBackground	setDEF(String newValue)	Accessor method to assign String value to inputOutput SFString field named DEF.
TextureBackground	setDEF(SFString newValue)	Assign typed object value to SFString DEF field, similar to setDEF(String).
TextureBackground	setFrontTexture(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field frontTexture.
TextureBackground	setFrontTexture(X3DNode newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) to inputOutput SFNode field frontTexture.
TextureBackground	setGroundAngle(double[] newArray)	Utility method: double-precision set-array accessor for X3D floating-point type, similar to setGroundAngle(float[]).
TextureBackground	setGroundAngle(float[] newValue)	Accessor method to assign Float array unit axis, angle (in radians) to inputOutput MFFloat field named groundAngle.
TextureBackground	setGroundAngle(int[] newValue)	Assign floating-point array value of MFFloat groundAngle field, similar to setGroundAngle(float[]).
TextureBackground	setGroundAngle(ArrayList<Float> newValue)	Assign ArrayList value of MFFloat groundAngle field, similar to setGroundAngle(float[]).
TextureBackground	setGroundAngle(MFFloat newValue)	Assign typed object value to MFFloat groundAngle field, similar to setGroundAngle(float[]).
TextureBackground	setGroundColor(double[] newArray)	Utility method: double-precision set-array accessor for X3D floating-point type, similar to setGroundColor(float[]).
TextureBackground	setGroundColor(float[] newValue)	Accessor method to assign 3-tuple float array using RGB values [0..1] to inputOutput MFColor field named groundColor.
TextureBackground	setGroundColor(MFColor newValue)	Assign typed object value to MFColor groundColor field, similar to setGroundColor(float[]).
final TextureBackground	setHtmlID(String newValue)	Accessor method to assign String value to inputOutput SFString field named id.
TextureBackground	setHtmlID(SFString newValue)	Assign typed object value to SFString HtmlID field, similar to setHtmlID(String).
TextureBackground	setIS(IS newValue)	Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
TextureBackground	setLeftTexture(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field leftTexture.
TextureBackground	setLeftTexture(X3DNode newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) to inputOutput SFNode field leftTexture.
TextureBackground	setMetadata(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
TextureBackground	setMetadata(X3DMetadataObject newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
TextureBackground	setRightTexture(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field rightTexture.
TextureBackground	setRightTexture(X3DNode newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) to inputOutput SFNode field rightTexture.
TextureBackground	setSkyAngle(double[] newArray)	Utility method: double-precision set-array accessor for X3D floating-point type, similar to setSkyAngle(float[]).
TextureBackground	setSkyAngle(float[] newValue)	Accessor method to assign Float array unit axis, angle (in radians) to inputOutput MFFloat field named skyAngle.
TextureBackground	setSkyAngle(int[] newValue)	Assign floating-point array value of MFFloat skyAngle field, similar to setSkyAngle(float[]).
TextureBackground	setSkyAngle(ArrayList<Float> newValue)	Assign ArrayList value of MFFloat skyAngle field, similar to setSkyAngle(float[]).
TextureBackground	setSkyAngle(MFFloat newValue)	Assign typed object value to MFFloat skyAngle field, similar to setSkyAngle(float[]).
TextureBackground	setSkyColor(double[] newArray)	Utility method: double-precision set-array accessor for X3D floating-point type, similar to setSkyColor(float[]).
TextureBackground	setSkyColor(float[] newValue)	Accessor method to assign 3-tuple float array using RGB values [0..1] to inputOutput MFColor field named skyColor.
TextureBackground	setSkyColor(MFColor newValue)	Assign typed object value to MFColor skyColor field, similar to setSkyColor(float[]).
TextureBackground	setTopTexture(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field topTexture.
TextureBackground	setTopTexture(X3DNode newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) to inputOutput SFNode field topTexture.
TextureBackground	setTransparency(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setTransparency(float).
TextureBackground	setTransparency(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named transparency.
TextureBackground	setTransparency(SFFloat newValue)	Assign typed object value to SFFloat transparency field, similar to setTransparency(float).
final TextureBackground	setUSE(String newValue)	Accessor method to assign String value to inputOutput SFString field named USE.
TextureBackground	setUSE(TextureBackground DEFnode)	Assign a USE reference to another DEF node of same node type, similar to setUSE(String).
TextureBackground	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: TextureBackground.

See Also:

• Constant Field Values

COMPONENT

public static final String COMPONENT

String constant COMPONENT defines X3D component for the TextureBackground element: EnvironmentalEffects

See Also:

• Constant Field Values

LEVEL

public static final int LEVEL

Integer constant LEVEL provides default X3D EnvironmentalEffects component level for this element: 3

See Also:

• Constant Field Values

BACKTEXTURE_DEFAULT_VALUE

public static final X3DNode BACKTEXTURE_DEFAULT_VALUE

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

BOTTOMTEXTURE_DEFAULT_VALUE

public static final X3DNode BOTTOMTEXTURE_DEFAULT_VALUE

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

FRONTTEXTURE_DEFAULT_VALUE

public static final X3DNode FRONTTEXTURE_DEFAULT_VALUE

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

GROUNDANGLE_DEFAULT_VALUE

public static final ArrayList<Float> GROUNDANGLE_DEFAULT_VALUE

MFFloat field named groundAngle has default value equal to an empty list.

GROUNDCOLOR_DEFAULT_VALUE

public static final float[] GROUNDCOLOR_DEFAULT_VALUE

MFColor field named groundColor has default value equal to an empty list.

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 X3DNode 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 X3DNode RIGHTTEXTURE_DEFAULT_VALUE

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

SKYANGLE_DEFAULT_VALUE

public static final ArrayList<Float> SKYANGLE_DEFAULT_VALUE

MFFloat field named skyAngle has default value equal to an empty list.

SKYCOLOR_DEFAULT_VALUE

public static final float[] SKYCOLOR_DEFAULT_VALUE

MFColor field named skyColor has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).

TOPTEXTURE_DEFAULT_VALUE

public static final X3DNode TOPTEXTURE_DEFAULT_VALUE

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

TRANSPARENCY_DEFAULT_VALUE

public static final float TRANSPARENCY_DEFAULT_VALUE

SFFloat field named transparency has default value 0f (Java syntax) or 0 (XML syntax).

See Also:

• Constant Field Values

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 = "children";
containerField_ALLOWED_VALUES = {"children" }; 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_BINDTIME

public static final String fromField_BINDTIME

fromField ROUTE name for SFTime field named bindTime.

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_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_GROUNDANGLE

public static final String fromField_GROUNDANGLE

fromField ROUTE name for MFFloat field named groundAngle.

See Also:

• Constant Field Values

toField_GROUNDANGLE

public static final String toField_GROUNDANGLE

toField ROUTE name for MFFloat field named groundAngle.

See Also:

• Constant Field Values

fromField_GROUNDCOLOR

public static final String fromField_GROUNDCOLOR

fromField ROUTE name for MFColor field named groundColor.

See Also:

• Constant Field Values

toField_GROUNDCOLOR

public static final String toField_GROUNDCOLOR

toField ROUTE name for MFColor field named groundColor.

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_ISBOUND

public static final String fromField_ISBOUND

fromField ROUTE name for SFBool field named isBound.

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

toField_SET_BIND

public static final String toField_SET_BIND

toField ROUTE name for SFBool field named set_bind.

See Also:

• Constant Field Values

fromField_SKYANGLE

public static final String fromField_SKYANGLE

fromField ROUTE name for MFFloat field named skyAngle.

See Also:

• Constant Field Values

toField_SKYANGLE

public static final String toField_SKYANGLE

toField ROUTE name for MFFloat field named skyAngle.

See Also:

• Constant Field Values

fromField_SKYCOLOR

public static final String fromField_SKYCOLOR

fromField ROUTE name for MFColor field named skyColor.

See Also:

• Constant Field Values

toField_SKYCOLOR

public static final String toField_SKYCOLOR

toField ROUTE name for MFColor field named skyColor.

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

fromField_TRANSPARENCY

public static final String fromField_TRANSPARENCY

fromField ROUTE name for SFFloat field named transparency.

See Also:

• Constant Field Values

toField_TRANSPARENCY

public static final String toField_TRANSPARENCY

toField ROUTE name for SFFloat field named transparency.

See Also:

• Constant Field Values

Constructor Details

TextureBackground

public TextureBackground()

Constructor for TextureBackground to initialize member variables with default values.

TextureBackground

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

Specified by:

getElementName in class X3DConcreteElement

Returns:

name of this element

getComponent

public final String getComponent()

Defines X3D component for the TextureBackground element: EnvironmentalEffects

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

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 X3DNode getBackTexture()

Provide org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) with acceptable node types limited to X3DTexture2DNode|MultiTexture, from inputOutput SFNode field backTexture.

Specified by:

getBackTexture in interface TextureBackground

Returns:

value of backTexture field

See Also:

• 
  
  Tooltip: [X3DTexture2DNode|MultiTexture] Parent TextureBackground element can contain up to six image nodes (ImageTexture PixelTexture MovieTexture MultiTexture).
  • Warning: each child image node must have a different containerField value.

setBackTexture

public TextureBackground setBackTexture(X3DNode newValue)

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

Specified by:

setBackTexture in interface TextureBackground

Parameters:

newValue - is new value for the backTexture field.

Returns:

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

See Also:

• 
  
  Tooltip: [X3DTexture2DNode|MultiTexture] Parent TextureBackground element can contain up to six image nodes (ImageTexture PixelTexture MovieTexture MultiTexture).
  • Warning: each child image node must have a different containerField value.

clearBackTexture

public TextureBackground clearBackTexture()

Utility method to clear SFNode value of backTexture field.

Returns:

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

setBackTexture

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

TextureBackground - 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.Core.X3DNode)

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

getBindTime

public double getBindTime()

Provide double value in seconds from outputOnly SFTime field named bindTime.

Tooltip: event sent when node becomes active/inactive.

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

getBindTime in interface TextureBackground

Specified by:

getBindTime in interface X3DBackgroundNode

Specified by:

getBindTime in interface X3DBindableNode

Returns:

value of bindTime field

getBottomTexture

public X3DNode getBottomTexture()

Provide org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) with acceptable node types limited to X3DTexture2DNode|MultiTexture, from inputOutput SFNode field bottomTexture.

Specified by:

getBottomTexture in interface TextureBackground

Returns:

value of bottomTexture field

See Also:

• 
  
  Tooltip: [X3DTexture2DNode|MultiTexture] Parent TextureBackground element can contain up to six image nodes (ImageTexture PixelTexture MovieTexture MultiTexture).
  • Warning: each child image node must have a different containerField value.

setBottomTexture

public TextureBackground setBottomTexture(X3DNode newValue)

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

Specified by:

setBottomTexture in interface TextureBackground

Parameters:

newValue - is new value for the bottomTexture field.

Returns:

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

See Also:

• 
  
  Tooltip: [X3DTexture2DNode|MultiTexture] Parent TextureBackground element can contain up to six image nodes (ImageTexture PixelTexture MovieTexture MultiTexture).
  • Warning: each child image node must have a different containerField value.

clearBottomTexture

public TextureBackground clearBottomTexture()

Utility method to clear SFNode value of bottomTexture field.

Returns:

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

setBottomTexture

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

TextureBackground - 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.Core.X3DNode)

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

getFrontTexture

public X3DNode getFrontTexture()

Provide org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) with acceptable node types limited to X3DTexture2DNode|MultiTexture, from inputOutput SFNode field frontTexture.

Specified by:

getFrontTexture in interface TextureBackground

Returns:

value of frontTexture field

See Also:

• 
  
  Tooltip: [X3DTexture2DNode|MultiTexture] Parent TextureBackground element can contain up to six image nodes (ImageTexture PixelTexture MovieTexture MultiTexture).
  • Warning: each child image node must have a different containerField value.

setFrontTexture

public TextureBackground setFrontTexture(X3DNode newValue)

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

Specified by:

setFrontTexture in interface TextureBackground

Parameters:

newValue - is new value for the frontTexture field.

Returns:

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

See Also:

• 
  
  Tooltip: [X3DTexture2DNode|MultiTexture] Parent TextureBackground element can contain up to six image nodes (ImageTexture PixelTexture MovieTexture MultiTexture).
  • Warning: each child image node must have a different containerField value.

clearFrontTexture

public TextureBackground clearFrontTexture()

Utility method to clear SFNode value of frontTexture field.

Returns:

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

setFrontTexture

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

TextureBackground - 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.Core.X3DNode)

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

getGroundAngle

public float[] getGroundAngle()

Provide array of Float results unit axis, angle (in radians) within allowed range of [0,1.5708] from inputOutput MFFloat field named groundAngle.

Tooltip: [0,pi/2] The angle array values increase from 0.0 nadir (straight down) to pi/2=1.570796 (horizon).

• Warning: you must have one more groundColor value than groundAngle values.
• Warning: colors at groundAngle=0 are ignored. Interchange profile
• Hint: this field may be ignored, applying the default value regardless.
• Hint: radian units for angular measure https://en.wikipedia.org/wiki/Radian

Specified by:

getGroundAngle in interface TextureBackground

Specified by:

getGroundAngle in interface X3DBackgroundNode

Returns:

value of groundAngle field

getGroundAngleList

public ArrayList<Float> getGroundAngleList()

Utility method to get ArrayList value of MFFloat groundAngle field, similar to getGroundAngle().

Returns:

value of groundAngle field

getGroundAngleString

public String getGroundAngleString()

Utility method to get String value of MFFloat groundAngle field, similar to getGroundAngle().

Returns:

value of groundAngle field

setGroundAngle

public TextureBackground setGroundAngle(float[] newValue)

Accessor method to assign Float array unit axis, angle (in radians) to inputOutput MFFloat field named groundAngle.

Tooltip: [0,pi/2] The angle array values increase from 0.0 nadir (straight down) to pi/2=1.570796 (horizon).

• Warning: you must have one more groundColor value than groundAngle values.
• Warning: colors at groundAngle=0 are ignored. Interchange profile
• Hint: this field may be ignored, applying the default value regardless.
• Hint: radian units for angular measure https://en.wikipedia.org/wiki/Radian

Specified by:

setGroundAngle in interface TextureBackground

Specified by:

setGroundAngle in interface X3DBackgroundNode

Parameters:

newValue - is new value for the groundAngle field.

Returns:

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

setGroundAngle

public TextureBackground setGroundAngle(MFFloat newValue)

Assign typed object value to MFFloat groundAngle field, similar to setGroundAngle(float[]).

Parameters:

newValue - is new value for the groundAngle field.

Returns:

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

setGroundAngle

public TextureBackground setGroundAngle(ArrayList<Float> newValue)

Assign ArrayList value of MFFloat groundAngle field, similar to setGroundAngle(float[]).

Parameters:

newValue - is new value for the groundAngle field.

Returns:

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

clearGroundAngle

public TextureBackground clearGroundAngle()

Utility method to clear MFFloat value of groundAngle field. This method does not initialize withGROUNDANGLE_DEFAULT_VALUE.

Returns:

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

setGroundAngle

public TextureBackground setGroundAngle(int[] newValue)

Assign floating-point array value of MFFloat groundAngle field, similar to setGroundAngle(float[]).

Parameters:

newValue - is new value for the groundAngle field.

Returns:

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

addGroundAngle

public TextureBackground addGroundAngle(float newValue)

Add singleton float value to MFFloat groundAngle field.

Parameters:

newValue - is new value to add to the groundAngle field.

Returns:

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

addGroundAngle

public TextureBackground addGroundAngle(SFFloat newValue)

Add singleton SFFloat value to MFFloat groundAngle field.

Parameters:

newValue - is new value to add to the groundAngle field.

Returns:

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

setGroundAngle

public TextureBackground setGroundAngle(double[] newArray)

Utility method: double-precision set-array accessor for X3D floating-point type, similar to setGroundAngle(float[]).

Parameters:

newArray - is new value for field

Returns:

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

getGroundColor

public float[] getGroundColor()

Provide array of 3-tuple float results using RGB values [0..1] using RGB values [0..1] from inputOutput MFColor field named groundColor.

Tooltip: Color of the ground at the various angles on the ground partial sphere. First value is color of ground at 0.0 radians representing the nadir (straight down).

• Hint: setting the same color at two consecutive angles produces a solid color band.
• Warning: you must have one more groundColor value than groundAngle values. Interchange profile
• Hint: this field may be ignored, applying the default value regardless.
• Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color

Specified by:

getGroundColor in interface TextureBackground

Specified by:

getGroundColor in interface X3DBackgroundNode

Returns:

value of groundColor field

setGroundColor

public TextureBackground setGroundColor(float[] newValue)

Accessor method to assign 3-tuple float array using RGB values [0..1] to inputOutput MFColor field named groundColor.

Tooltip: Color of the ground at the various angles on the ground partial sphere. First value is color of ground at 0.0 radians representing the nadir (straight down).

• Hint: setting the same color at two consecutive angles produces a solid color band.
• Warning: you must have one more groundColor value than groundAngle values. Interchange profile
• Hint: this field may be ignored, applying the default value regardless.
• Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color

Specified by:

setGroundColor in interface TextureBackground

Specified by:

setGroundColor in interface X3DBackgroundNode

Parameters:

newValue - is new value for the groundColor field.

Returns:

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

setGroundColor

public TextureBackground setGroundColor(MFColor newValue)

Assign typed object value to MFColor groundColor field, similar to setGroundColor(float[]).

Parameters:

newValue - is new value for the groundColor field.

Returns:

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

addGroundColor

public TextureBackground addGroundColor(SFColor newValue)

Add singleton SFColor value to MFColor groundColor field.

Parameters:

newValue - is new value to add to the groundColor field.

Returns:

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

setGroundColor

public TextureBackground setGroundColor(double[] newArray)

Utility method: double-precision set-array accessor for X3D floating-point type, similar to setGroundColor(float[]).

Parameters:

newArray - is new value for field

Returns:

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

getIS

public IS getIS()

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

Specified by:

getIS in class X3DConcreteNode

Returns:

value of IS field

See Also:

• X3D Tooltips: IS
• X3D Tooltips: connect

setIS

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

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

Utility method to clear SFNode value of IS field.

Returns:

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

getIsBound

public boolean getIsBound()

Provide boolean value from outputOnly SFBool field named isBound.

Tooltip: event true sent when node becomes active, event false sent when unbound by another node.

• Hint: paired node operations can be established by connecting set_bind and isBound fields of corresponding bindable nodes.
• 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:

getIsBound in interface TextureBackground

Specified by:

getIsBound in interface X3DBackgroundNode

Specified by:

getIsBound in interface X3DBindableNode

Returns:

value of isBound field

getLeftTexture

public X3DNode getLeftTexture()

Provide org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) with acceptable node types limited to X3DTexture2DNode|MultiTexture, from inputOutput SFNode field leftTexture.

Specified by:

getLeftTexture in interface TextureBackground

Returns:

value of leftTexture field

See Also:

• 
  
  Tooltip: [X3DTexture2DNode|MultiTexture] Parent TextureBackground element can contain up to six image nodes (ImageTexture PixelTexture MovieTexture MultiTexture).
  • Warning: each child image node must have a different containerField value.

setLeftTexture

public TextureBackground setLeftTexture(X3DNode newValue)

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

Specified by:

setLeftTexture in interface TextureBackground

Parameters:

newValue - is new value for the leftTexture field.

Returns:

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

See Also:

• 
  
  Tooltip: [X3DTexture2DNode|MultiTexture] Parent TextureBackground element can contain up to six image nodes (ImageTexture PixelTexture MovieTexture MultiTexture).
  • Warning: each child image node must have a different containerField value.

clearLeftTexture

public TextureBackground clearLeftTexture()

Utility method to clear SFNode value of leftTexture field.

Returns:

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

setLeftTexture

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

TextureBackground - 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.Core.X3DNode)

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 TextureBackground

Specified by:

getMetadata in interface X3DBackgroundNode

Specified by:

getMetadata in interface X3DBindableNode

Specified by:

getMetadata in interface X3DChildNode

Specified by:

getMetadata in interface X3DNode

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

Specified by:

setMetadata in interface X3DBackgroundNode

Specified by:

setMetadata in interface X3DBindableNode

Specified by:

setMetadata in interface X3DChildNode

Specified by:

setMetadata in interface X3DNode

Specified by:

setMetadata in class X3DConcreteNode

Parameters:

newValue - is new value for the metadata field.

Returns:

TextureBackground - 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 TextureBackground clearMetadata()

Utility method to clear SFNode value of metadata field.

Returns:

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

setMetadata

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

TextureBackground - 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 X3DNode getRightTexture()

Provide org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) with acceptable node types limited to X3DTexture2DNode|MultiTexture, from inputOutput SFNode field rightTexture.

Specified by:

getRightTexture in interface TextureBackground

Returns:

value of rightTexture field

See Also:

• 
  
  Tooltip: [X3DTexture2DNode|MultiTexture] Parent TextureBackground element can contain up to six image nodes (ImageTexture PixelTexture MovieTexture MultiTexture).
  • Warning: each child image node must have a different containerField value.

setRightTexture

public TextureBackground setRightTexture(X3DNode newValue)

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

Specified by:

setRightTexture in interface TextureBackground

Parameters:

newValue - is new value for the rightTexture field.

Returns:

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

See Also:

• 
  
  Tooltip: [X3DTexture2DNode|MultiTexture] Parent TextureBackground element can contain up to six image nodes (ImageTexture PixelTexture MovieTexture MultiTexture).
  • Warning: each child image node must have a different containerField value.

clearRightTexture

public TextureBackground clearRightTexture()

Utility method to clear SFNode value of rightTexture field.

Returns:

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

setRightTexture

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

TextureBackground - 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.Core.X3DNode)

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

getSkyAngle

public float[] getSkyAngle()

Provide array of Float results unit axis, angle (in radians) within allowed range of [0,3.1416] from inputOutput MFFloat field named skyAngle.

Tooltip: [0,pi] The angle array values increase from 0.0 zenith (straight up) to pi/2=1.570796 (horizon) to pi=3.14159 (nadir).

• Warning: you must have one more skyColor value than skyAngle values.
• Warning: colors at skyAngle=0 are ignored. Interchange profile
• Hint: this field may be ignored, applying the default value regardless.
• Hint: radian units for angular measure https://en.wikipedia.org/wiki/Radian

Specified by:

getSkyAngle in interface TextureBackground

Specified by:

getSkyAngle in interface X3DBackgroundNode

Returns:

value of skyAngle field

getSkyAngleList

public ArrayList<Float> getSkyAngleList()

Utility method to get ArrayList value of MFFloat skyAngle field, similar to getSkyAngle().

Returns:

value of skyAngle field

getSkyAngleString

public String getSkyAngleString()

Utility method to get String value of MFFloat skyAngle field, similar to getSkyAngle().

Returns:

value of skyAngle field

setSkyAngle

public TextureBackground setSkyAngle(float[] newValue)

Accessor method to assign Float array unit axis, angle (in radians) to inputOutput MFFloat field named skyAngle.

Tooltip: [0,pi] The angle array values increase from 0.0 zenith (straight up) to pi/2=1.570796 (horizon) to pi=3.14159 (nadir).

• Warning: you must have one more skyColor value than skyAngle values.
• Warning: colors at skyAngle=0 are ignored. Interchange profile
• Hint: this field may be ignored, applying the default value regardless.
• Hint: radian units for angular measure https://en.wikipedia.org/wiki/Radian

Specified by:

setSkyAngle in interface TextureBackground

Specified by:

setSkyAngle in interface X3DBackgroundNode

Parameters:

newValue - is new value for the skyAngle field.

Returns:

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

setSkyAngle

public TextureBackground setSkyAngle(MFFloat newValue)

Assign typed object value to MFFloat skyAngle field, similar to setSkyAngle(float[]).

Parameters:

newValue - is new value for the skyAngle field.

Returns:

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

setSkyAngle

public TextureBackground setSkyAngle(ArrayList<Float> newValue)

Assign ArrayList value of MFFloat skyAngle field, similar to setSkyAngle(float[]).

Parameters:

newValue - is new value for the skyAngle field.

Returns:

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

clearSkyAngle

public TextureBackground clearSkyAngle()

Utility method to clear MFFloat value of skyAngle field. This method does not initialize withSKYANGLE_DEFAULT_VALUE.

Returns:

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

setSkyAngle

public TextureBackground setSkyAngle(int[] newValue)

Assign floating-point array value of MFFloat skyAngle field, similar to setSkyAngle(float[]).

Parameters:

newValue - is new value for the skyAngle field.

Returns:

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

addSkyAngle

public TextureBackground addSkyAngle(float newValue)

Add singleton float value to MFFloat skyAngle field.

Parameters:

newValue - is new value to add to the skyAngle field.

Returns:

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

addSkyAngle

public TextureBackground addSkyAngle(SFFloat newValue)

Add singleton SFFloat value to MFFloat skyAngle field.

Parameters:

newValue - is new value to add to the skyAngle field.

Returns:

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

setSkyAngle

public TextureBackground setSkyAngle(double[] newArray)

Utility method: double-precision set-array accessor for X3D floating-point type, similar to setSkyAngle(float[]).

Parameters:

newArray - is new value for field

Returns:

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

getSkyColor

public float[] getSkyColor()

Provide array of 3-tuple float results using RGB values [0..1] using RGB values [0..1] from inputOutput MFColor field named skyColor.

Tooltip: Color of the sky at various angles on the sky sphere. First value is color of sky at 0.0 radians representing the zenith (straight up).

• Hint: setting the same color at two consecutive angles produces a solid color band.
• Warning: you must have one more skyColor value than skyAngle values. Interchange profile
• Hint: only one color might be rendered, others can be ignored.
• Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color

Specified by:

getSkyColor in interface TextureBackground

Specified by:

getSkyColor in interface X3DBackgroundNode

Returns:

value of skyColor field

setSkyColor

public TextureBackground setSkyColor(float[] newValue)

Accessor method to assign 3-tuple float array using RGB values [0..1] to inputOutput MFColor field named skyColor.

Tooltip: Color of the sky at various angles on the sky sphere. First value is color of sky at 0.0 radians representing the zenith (straight up).

• Hint: setting the same color at two consecutive angles produces a solid color band.
• Warning: you must have one more skyColor value than skyAngle values. Interchange profile
• Hint: only one color might be rendered, others can be ignored.
• Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color

Specified by:

setSkyColor in interface TextureBackground

Specified by:

setSkyColor in interface X3DBackgroundNode

Parameters:

newValue - is new value for the skyColor field.

Returns:

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

setSkyColor

public TextureBackground setSkyColor(MFColor newValue)

Assign typed object value to MFColor skyColor field, similar to setSkyColor(float[]).

Parameters:

newValue - is new value for the skyColor field.

Returns:

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

addSkyColor

public TextureBackground addSkyColor(SFColor newValue)

Add singleton SFColor value to MFColor skyColor field.

Parameters:

newValue - is new value to add to the skyColor field.

Returns:

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

setSkyColor

public TextureBackground setSkyColor(double[] newArray)

Utility method: double-precision set-array accessor for X3D floating-point type, similar to setSkyColor(float[]).

Parameters:

newArray - is new value for field

Returns:

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

getTopTexture

public X3DNode getTopTexture()

Provide org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) with acceptable node types limited to X3DTexture2DNode|MultiTexture, from inputOutput SFNode field topTexture.

Specified by:

getTopTexture in interface TextureBackground

Returns:

value of topTexture field

See Also:

• 
  
  Tooltip: [X3DTexture2DNode|MultiTexture] Parent TextureBackground element can contain up to six image nodes (ImageTexture PixelTexture MovieTexture MultiTexture).
  • Warning: each child image node must have a different containerField value.

setTopTexture

public TextureBackground setTopTexture(X3DNode newValue)

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

Specified by:

setTopTexture in interface TextureBackground

Parameters:

newValue - is new value for the topTexture field.

Returns:

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

See Also:

• 
  
  Tooltip: [X3DTexture2DNode|MultiTexture] Parent TextureBackground element can contain up to six image nodes (ImageTexture PixelTexture MovieTexture MultiTexture).
  • Warning: each child image node must have a different containerField value.

clearTopTexture

public TextureBackground clearTopTexture()

Utility method to clear SFNode value of topTexture field.

Returns:

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

setTopTexture

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

TextureBackground - 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.Core.X3DNode)

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

getTransparency

public float getTransparency()

Provide float value within allowed range of [0,1] from inputOutput SFFloat field named transparency.

Tooltip: transparency applied to texture images, enabling an X3D scene to overlay an HTML page or desktop. *

Specified by:

getTransparency in interface TextureBackground

Specified by:

getTransparency in interface X3DBackgroundNode

Returns:

value of transparency field

setTransparency

public TextureBackground setTransparency(float newValue)

Accessor method to assign float value to inputOutput SFFloat field named transparency.

Tooltip: transparency applied to texture images, enabling an X3D scene to overlay an HTML page or desktop. *

Specified by:

setTransparency in interface TextureBackground

Specified by:

setTransparency in interface X3DBackgroundNode

Parameters:

newValue - is new value for the transparency field.

Returns:

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

setTransparency

public TextureBackground setTransparency(SFFloat newValue)

Assign typed object value to SFFloat transparency field, similar to setTransparency(float).

Parameters:

newValue - is new value for the transparency field.

Returns:

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

setTransparency

public TextureBackground setTransparency(double newValue)

Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setTransparency(float).

Parameters:

newValue - is new value for field

Returns:

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

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

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

setDEF

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

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

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

setUSE

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

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

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

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

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

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

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

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

setUSE

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

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

addComments

public TextureBackground addComments(String newComment)

Add comment as String to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComment - initial value

Returns:

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

Add comments as String[] array to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComments - array of comments

Returns:

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

addComments

public TextureBackground addComments(CommentsBlock newCommentsBlock)

Add CommentsBlock to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newCommentsBlock - block of comments to add

Returns:

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