Package org.web3d.x3d.jsail.EnvironmentalEffects

Class Background

java.lang.Object

org.web3d.x3d.jsail.X3DConcreteElement

org.web3d.x3d.jsail.X3DConcreteNode

org.web3d.x3d.jsail.EnvironmentalEffects.Background

All Implemented Interfaces:

X3DBindableNode, X3DChildNode, X3DNode, Background, X3DBackgroundNode

public class Background
extends X3DConcreteNode
implements Background

Background simulates ground and sky, using vertical arrays of wraparound color values.

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. Background node tooltip: [X3DBackgroundNode] Background simulates ground and sky, using vertical arrays of wraparound color values. Background can also provide url addresses for backdrop textures 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.
• Hint: Background node is not sensed by LoadSensor due to node typing and multiple-image ambiguity, alternatively utilize TextureBackground node with multiple ImageTexture nodes each referenced inside LoadSensor.
• Hint: X3D Example Archives, Basic, Universal Media Panoramas https://www.web3d.org/x3d/content/examples/Basic/UniversalMediaPanoramas

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

Field Summary

Fields

Modifier and Type	Field	Description
static final ArrayList<String>	BACKURL_DEFAULT_VALUE	MFString field named backUrl has default value equal to an empty list.
static final ArrayList<String>	BOTTOMURL_DEFAULT_VALUE	MFString field named bottomUrl has default value equal to an empty list.
static final String	COMPONENT	String constant COMPONENT defines X3D component for the Background element: EnvironmentalEffects
static final String	containerField_DEFAULT_VALUE	containerField describes typical field relationship of a node to its parent.
static final String	fromField_BACKURL	fromField ROUTE name for MFString field named backUrl.
static final String	fromField_BINDTIME	fromField ROUTE name for SFTime field named bindTime.
static final String	fromField_BOTTOMURL	fromField ROUTE name for MFString field named bottomUrl.
static final String	fromField_FRONTURL	fromField ROUTE name for MFString field named frontUrl.
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_LEFTURL	fromField ROUTE name for MFString field named leftUrl.
static final String	fromField_METADATA	fromField ROUTE name for SFNode field named metadata.
static final String	fromField_RIGHTURL	fromField ROUTE name for MFString field named rightUrl.
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_TOPURL	fromField ROUTE name for MFString field named topUrl.
static final String	fromField_TRANSPARENCY	fromField ROUTE name for SFFloat field named transparency.
static final ArrayList<String>	FRONTURL_DEFAULT_VALUE	MFString field named frontUrl has default value equal to an empty list.
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 ArrayList<String>	LEFTURL_DEFAULT_VALUE	MFString field named leftUrl has default value equal to an empty list.
static final int	LEVEL	Integer constant LEVEL provides default X3D EnvironmentalEffects 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: Background.
static final ArrayList<String>	RIGHTURL_DEFAULT_VALUE	MFString field named rightUrl has default value equal to an empty list.
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_BACKURL	toField ROUTE name for MFString field named backUrl.
static final String	toField_BOTTOMURL	toField ROUTE name for MFString field named bottomUrl.
static final String	toField_FRONTURL	toField ROUTE name for MFString field named frontUrl.
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_LEFTURL	toField ROUTE name for MFString field named leftUrl.
static final String	toField_METADATA	toField ROUTE name for SFNode field named metadata.
static final String	toField_RIGHTURL	toField ROUTE name for MFString field named rightUrl.
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_TOPURL	toField ROUTE name for MFString field named topUrl.
static final String	toField_TRANSPARENCY	toField ROUTE name for SFFloat field named transparency.
static final ArrayList<String>	TOPURL_DEFAULT_VALUE	MFString field named topUrl has default value equal to an empty list.
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
Background()	Constructor for Background to initialize member variables with default values.
Background(String DEFlabel)	Utility constructor that assigns DEF label after initializing member variables with default values.

Method Summary

Modifier and Type	Method	Description
Background	addBackUrl(String newValue)	Add singleton String value to MFString backUrl field.
Background	addBackUrl(SFString newValue)	Add singleton SFString value to MFString backUrl field.
Background	addBottomUrl(String newValue)	Add singleton String value to MFString bottomUrl field.
Background	addBottomUrl(SFString newValue)	Add singleton SFString value to MFString bottomUrl field.
Background	addComments(String newComment)	Add comment as String to contained commentsList.
Background	addComments(String[] newComments)	Add comments as String[] array to contained commentsList.
Background	addComments(CommentsBlock newCommentsBlock)	Add CommentsBlock to contained commentsList.
Background	addFrontUrl(String newValue)	Add singleton String value to MFString frontUrl field.
Background	addFrontUrl(SFString newValue)	Add singleton SFString value to MFString frontUrl field.
Background	addGroundAngle(float newValue)	Add singleton float value to MFFloat groundAngle field.
Background	addGroundAngle(SFFloat newValue)	Add singleton SFFloat value to MFFloat groundAngle field.
Background	addGroundColor(SFColor newValue)	Add singleton SFColor value to MFColor groundColor field.
Background	addLeftUrl(String newValue)	Add singleton String value to MFString leftUrl field.
Background	addLeftUrl(SFString newValue)	Add singleton SFString value to MFString leftUrl field.
Background	addRightUrl(String newValue)	Add singleton String value to MFString rightUrl field.
Background	addRightUrl(SFString newValue)	Add singleton SFString value to MFString rightUrl field.
Background	addSkyAngle(float newValue)	Add singleton float value to MFFloat skyAngle field.
Background	addSkyAngle(SFFloat newValue)	Add singleton SFFloat value to MFFloat skyAngle field.
Background	addSkyColor(SFColor newValue)	Add singleton SFColor value to MFColor skyColor field.
Background	addTopUrl(String newValue)	Add singleton String value to MFString topUrl field.
Background	addTopUrl(SFString newValue)	Add singleton SFString value to MFString topUrl field.
Background	clearBackUrl()	Utility method to clear MFString value of backUrl field.
Background	clearBottomUrl()	Utility method to clear MFString value of bottomUrl field.
Background	clearFrontUrl()	Utility method to clear MFString value of frontUrl field.
Background	clearGroundAngle()	Utility method to clear MFFloat value of groundAngle field.
Background	clearIS()	Utility method to clear SFNode value of IS field.
Background	clearLeftUrl()	Utility method to clear MFString value of leftUrl field.
Background	clearMetadata()	Utility method to clear SFNode value of metadata field.
Background	clearRightUrl()	Utility method to clear MFString value of rightUrl field.
Background	clearSkyAngle()	Utility method to clear MFFloat value of skyAngle field.
Background	clearTopUrl()	Utility method to clear MFString value of topUrl 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.
String[]	getBackUrl()	Provide array of String results from inputOutput MFString field named backUrl.
ArrayList<String>	getBackUrlList()	Utility method to get ArrayList value of MFString backUrl field, similar to getBackUrl().
String	getBackUrlString()	Utility method to get String value of MFString backUrl field, similar to getBackUrl().
double	getBindTime()	Provide double value in seconds from outputOnly SFTime field named bindTime.
String[]	getBottomUrl()	Provide array of String results from inputOutput MFString field named bottomUrl.
ArrayList<String>	getBottomUrlList()	Utility method to get ArrayList value of MFString bottomUrl field, similar to getBottomUrl().
String	getBottomUrlString()	Utility method to get String value of MFString bottomUrl field, similar to getBottomUrl().
final String	getComponent()	Defines X3D component for the Background element: EnvironmentalEffects
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.
final String	getElementName()	Provides name of this element: Background
String	getFieldType(String fieldName)	Indicate type corresponding to given fieldName.
String[]	getFrontUrl()	Provide array of String results from inputOutput MFString field named frontUrl.
ArrayList<String>	getFrontUrlList()	Utility method to get ArrayList value of MFString frontUrl field, similar to getFrontUrl().
String	getFrontUrlString()	Utility method to get String value of MFString frontUrl field, similar to getFrontUrl().
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.
String[]	getLeftUrl()	Provide array of String results from inputOutput MFString field named leftUrl.
ArrayList<String>	getLeftUrlList()	Utility method to get ArrayList value of MFString leftUrl field, similar to getLeftUrl().
String	getLeftUrlString()	Utility method to get String value of MFString leftUrl field, similar to getLeftUrl().
X3DMetadataObject	getMetadata()	Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
String[]	getRightUrl()	Provide array of String results from inputOutput MFString field named rightUrl.
ArrayList<String>	getRightUrlList()	Utility method to get ArrayList value of MFString rightUrl field, similar to getRightUrl().
String	getRightUrlString()	Utility method to get String value of MFString rightUrl field, similar to getRightUrl().
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.
String[]	getTopUrl()	Provide array of String results from inputOutput MFString field named topUrl.
ArrayList<String>	getTopUrlList()	Utility method to get ArrayList value of MFString topUrl field, similar to getTopUrl().
String	getTopUrlString()	Utility method to get String value of MFString topUrl field, similar to getTopUrl().
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	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	hasIS()	Indicate whether an object is available for inputOutput SFNode field IS.
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.
final void	initialize()	Initialize all member variables to default values.
Background	setBackUrl(String newValue)	Assign singleton String value to MFString backUrl field, similar to setBackUrl(String[]).
Background	setBackUrl(String[] newValue)	Accessor method to assign String array to inputOutput MFString field named backUrl.
Background	setBackUrl(ArrayList<String> newValue)	Assign ArrayList value of MFString backUrl field, similar to setBackUrl(String[]).
Background	setBackUrl(MFString newValue)	Assign typed object value to MFString backUrl field, similar to setBackUrl(String[]).
Background	setBackUrl(SFString newValue)	Assign single SFString object value to MFString backUrl field, similar to setBackUrl(String[]).
Background	setBottomUrl(String newValue)	Assign singleton String value to MFString bottomUrl field, similar to setBottomUrl(String[]).
Background	setBottomUrl(String[] newValue)	Accessor method to assign String array to inputOutput MFString field named bottomUrl.
Background	setBottomUrl(ArrayList<String> newValue)	Assign ArrayList value of MFString bottomUrl field, similar to setBottomUrl(String[]).
Background	setBottomUrl(MFString newValue)	Assign typed object value to MFString bottomUrl field, similar to setBottomUrl(String[]).
Background	setBottomUrl(SFString newValue)	Assign single SFString object value to MFString bottomUrl field, similar to setBottomUrl(String[]).
final Background	setCssClass(String newValue)	Accessor method to assign String value to inputOutput SFString field named class.
Background	setCssClass(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssClass(String).
final Background	setCssStyle(String newValue)	Accessor method to assign String value to inputOutput SFString field named style.
Background	setCssStyle(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssStyle(String).
final Background	setDEF(String newValue)	Accessor method to assign String value to inputOutput SFString field named DEF.
Background	setDEF(SFString newValue)	Assign typed object value to SFString DEF field, similar to setDEF(String).
Background	setFrontUrl(String newValue)	Assign singleton String value to MFString frontUrl field, similar to setFrontUrl(String[]).
Background	setFrontUrl(String[] newValue)	Accessor method to assign String array to inputOutput MFString field named frontUrl.
Background	setFrontUrl(ArrayList<String> newValue)	Assign ArrayList value of MFString frontUrl field, similar to setFrontUrl(String[]).
Background	setFrontUrl(MFString newValue)	Assign typed object value to MFString frontUrl field, similar to setFrontUrl(String[]).
Background	setFrontUrl(SFString newValue)	Assign single SFString object value to MFString frontUrl field, similar to setFrontUrl(String[]).
Background	setGroundAngle(double[] newArray)	Utility method: double-precision set-array accessor for X3D floating-point type, similar to setGroundAngle(float[]).
Background	setGroundAngle(float[] newValue)	Accessor method to assign Float array unit axis, angle (in radians) to inputOutput MFFloat field named groundAngle.
Background	setGroundAngle(int[] newValue)	Assign floating-point array value of MFFloat groundAngle field, similar to setGroundAngle(float[]).
Background	setGroundAngle(ArrayList<Float> newValue)	Assign ArrayList value of MFFloat groundAngle field, similar to setGroundAngle(float[]).
Background	setGroundAngle(MFFloat newValue)	Assign typed object value to MFFloat groundAngle field, similar to setGroundAngle(float[]).
Background	setGroundColor(double[] newArray)	Utility method: double-precision set-array accessor for X3D floating-point type, similar to setGroundColor(float[]).
Background	setGroundColor(float[] newValue)	Accessor method to assign 3-tuple float array using RGB values [0..1] to inputOutput MFColor field named groundColor.
Background	setGroundColor(MFColor newValue)	Assign typed object value to MFColor groundColor field, similar to setGroundColor(float[]).
final Background	setHtmlID(String newValue)	Accessor method to assign String value to inputOutput SFString field named id.
Background	setHtmlID(SFString newValue)	Assign typed object value to SFString HtmlID field, similar to setHtmlID(String).
Background	setIS(IS newValue)	Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
Background	setLeftUrl(String newValue)	Assign singleton String value to MFString leftUrl field, similar to setLeftUrl(String[]).
Background	setLeftUrl(String[] newValue)	Accessor method to assign String array to inputOutput MFString field named leftUrl.
Background	setLeftUrl(ArrayList<String> newValue)	Assign ArrayList value of MFString leftUrl field, similar to setLeftUrl(String[]).
Background	setLeftUrl(MFString newValue)	Assign typed object value to MFString leftUrl field, similar to setLeftUrl(String[]).
Background	setLeftUrl(SFString newValue)	Assign single SFString object value to MFString leftUrl field, similar to setLeftUrl(String[]).
Background	setMetadata(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
Background	setMetadata(X3DMetadataObject newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
Background	setRightUrl(String newValue)	Assign singleton String value to MFString rightUrl field, similar to setRightUrl(String[]).
Background	setRightUrl(String[] newValue)	Accessor method to assign String array to inputOutput MFString field named rightUrl.
Background	setRightUrl(ArrayList<String> newValue)	Assign ArrayList value of MFString rightUrl field, similar to setRightUrl(String[]).
Background	setRightUrl(MFString newValue)	Assign typed object value to MFString rightUrl field, similar to setRightUrl(String[]).
Background	setRightUrl(SFString newValue)	Assign single SFString object value to MFString rightUrl field, similar to setRightUrl(String[]).
Background	setSkyAngle(double[] newArray)	Utility method: double-precision set-array accessor for X3D floating-point type, similar to setSkyAngle(float[]).
Background	setSkyAngle(float[] newValue)	Accessor method to assign Float array unit axis, angle (in radians) to inputOutput MFFloat field named skyAngle.
Background	setSkyAngle(int[] newValue)	Assign floating-point array value of MFFloat skyAngle field, similar to setSkyAngle(float[]).
Background	setSkyAngle(ArrayList<Float> newValue)	Assign ArrayList value of MFFloat skyAngle field, similar to setSkyAngle(float[]).
Background	setSkyAngle(MFFloat newValue)	Assign typed object value to MFFloat skyAngle field, similar to setSkyAngle(float[]).
Background	setSkyColor(double[] newArray)	Utility method: double-precision set-array accessor for X3D floating-point type, similar to setSkyColor(float[]).
Background	setSkyColor(float[] newValue)	Accessor method to assign 3-tuple float array using RGB values [0..1] to inputOutput MFColor field named skyColor.
Background	setSkyColor(MFColor newValue)	Assign typed object value to MFColor skyColor field, similar to setSkyColor(float[]).
Background	setTopUrl(String newValue)	Assign singleton String value to MFString topUrl field, similar to setTopUrl(String[]).
Background	setTopUrl(String[] newValue)	Accessor method to assign String array to inputOutput MFString field named topUrl.
Background	setTopUrl(ArrayList<String> newValue)	Assign ArrayList value of MFString topUrl field, similar to setTopUrl(String[]).
Background	setTopUrl(MFString newValue)	Assign typed object value to MFString topUrl field, similar to setTopUrl(String[]).
Background	setTopUrl(SFString newValue)	Assign single SFString object value to MFString topUrl field, similar to setTopUrl(String[]).
Background	setTransparency(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setTransparency(float).
Background	setTransparency(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named transparency.
Background	setTransparency(SFFloat newValue)	Assign typed object value to SFFloat transparency field, similar to setTransparency(float).
final Background	setUSE(String newValue)	Accessor method to assign String value to inputOutput SFString field named USE.
Background	setUSE(Background DEFnode)	Assign a USE reference to another DEF node of same node type, similar to setUSE(String).
Background	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: Background.

See Also:

• Constant Field Values

COMPONENT

public static final String COMPONENT

String constant COMPONENT defines X3D component for the Background 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: 1

See Also:

• Constant Field Values

BACKURL_DEFAULT_VALUE

public static final ArrayList<String> BACKURL_DEFAULT_VALUE

MFString field named backUrl has default value equal to an empty list.

BOTTOMURL_DEFAULT_VALUE

public static final ArrayList<String> BOTTOMURL_DEFAULT_VALUE

MFString field named bottomUrl has default value equal to an empty list.

FRONTURL_DEFAULT_VALUE

public static final ArrayList<String> FRONTURL_DEFAULT_VALUE

MFString field named frontUrl has default value equal to an empty list.

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

LEFTURL_DEFAULT_VALUE

public static final ArrayList<String> LEFTURL_DEFAULT_VALUE

MFString field named leftUrl has default value equal to an empty list.

METADATA_DEFAULT_VALUE

public static final X3DMetadataObject METADATA_DEFAULT_VALUE

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

RIGHTURL_DEFAULT_VALUE

public static final ArrayList<String> RIGHTURL_DEFAULT_VALUE

MFString field named rightUrl has default value equal to an empty list.

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

TOPURL_DEFAULT_VALUE

public static final ArrayList<String> TOPURL_DEFAULT_VALUE

MFString field named topUrl has default value equal to an empty list.

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_BACKURL

public static final String fromField_BACKURL

fromField ROUTE name for MFString field named backUrl.

See Also:

• Constant Field Values

toField_BACKURL

public static final String toField_BACKURL

toField ROUTE name for MFString field named backUrl.

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_BOTTOMURL

public static final String fromField_BOTTOMURL

fromField ROUTE name for MFString field named bottomUrl.

See Also:

• Constant Field Values

toField_BOTTOMURL

public static final String toField_BOTTOMURL

toField ROUTE name for MFString field named bottomUrl.

See Also:

• Constant Field Values

fromField_FRONTURL

public static final String fromField_FRONTURL

fromField ROUTE name for MFString field named frontUrl.

See Also:

• Constant Field Values

toField_FRONTURL

public static final String toField_FRONTURL

toField ROUTE name for MFString field named frontUrl.

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_LEFTURL

public static final String fromField_LEFTURL

fromField ROUTE name for MFString field named leftUrl.

See Also:

• Constant Field Values

toField_LEFTURL

public static final String toField_LEFTURL

toField ROUTE name for MFString field named leftUrl.

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_RIGHTURL

public static final String fromField_RIGHTURL

fromField ROUTE name for MFString field named rightUrl.

See Also:

• Constant Field Values

toField_RIGHTURL

public static final String toField_RIGHTURL

toField ROUTE name for MFString field named rightUrl.

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_TOPURL

public static final String fromField_TOPURL

fromField ROUTE name for MFString field named topUrl.

See Also:

• Constant Field Values

toField_TOPURL

public static final String toField_TOPURL

toField ROUTE name for MFString field named topUrl.

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

Background

public Background()

Constructor for Background to initialize member variables with default values.

Background

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

Specified by:

getElementName in class X3DConcreteElement

Returns:

name of this element

getComponent

public final String getComponent()

Defines X3D component for the Background 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: 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

getBackUrl

public String[] getBackUrl()

Provide array of String results from inputOutput MFString field named backUrl.

Tooltip: Image background panorama between ground/sky backdrop and scene's geometry.

• Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "https://www.web3d.org" "https://www.web3d.org/about" "etc."
• Hint: alternative XML encoding for quotation mark " is " (which is an example of a character entity).
• Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all case sensitive and intolerant of uppercase/lowercase mismatches.
• Hint: can replace embedded blank(s) in url queries with %20 for each blank character. Interchange profile
• Hint: this field may be ignored, applying the default value regardless.

Specified by:

getBackUrl in interface Background

Returns:

value of backUrl field

getBackUrlList

public ArrayList<String> getBackUrlList()

Utility method to get ArrayList value of MFString backUrl field, similar to getBackUrl().

Returns:

value of backUrl field

getBackUrlString

public String getBackUrlString()

Utility method to get String value of MFString backUrl field, similar to getBackUrl().

Returns:

value of backUrl field

setBackUrl

public Background setBackUrl(String[] newValue)

Accessor method to assign String array to inputOutput MFString field named backUrl.

Tooltip: Image background panorama between ground/sky backdrop and scene's geometry.

• Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "https://www.web3d.org" "https://www.web3d.org/about" "etc."
• Hint: alternative XML encoding for quotation mark " is " (which is an example of a character entity).
• Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all case sensitive and intolerant of uppercase/lowercase mismatches.
• Hint: can replace embedded blank(s) in url queries with %20 for each blank character. Interchange profile
• Hint: this field may be ignored, applying the default value regardless.

Specified by:

setBackUrl in interface Background

Parameters:

newValue - is new value for the backUrl field.

Returns:

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

setBackUrl

public Background setBackUrl(MFString newValue)

Assign typed object value to MFString backUrl field, similar to setBackUrl(String[]).

Parameters:

newValue - is new value for the backUrl field.

Returns:

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

setBackUrl

public Background setBackUrl(SFString newValue)

Assign single SFString object value to MFString backUrl field, similar to setBackUrl(String[]).

Parameters:

newValue - is new value for the backUrl field.

Returns:

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

setBackUrl

public Background setBackUrl(String newValue)

Assign singleton String value to MFString backUrl field, similar to setBackUrl(String[]).

Parameters:

newValue - is new value for the backUrl field.

Returns:

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

setBackUrl

public Background setBackUrl(ArrayList<String> newValue)

Assign ArrayList value of MFString backUrl field, similar to setBackUrl(String[]).

Parameters:

newValue - is new value for the backUrl field.

Returns:

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

clearBackUrl

public Background clearBackUrl()

Utility method to clear MFString value of backUrl field. This method does not initialize withBACKURL_DEFAULT_VALUE.

Returns:

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

addBackUrl

public Background addBackUrl(String newValue)

Add singleton String value to MFString backUrl field.

Parameters:

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

Returns:

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

See Also:

• MFString.cleanupEnumerationValues(String)

addBackUrl

public Background addBackUrl(SFString newValue)

Add singleton SFString value to MFString backUrl field.

Parameters:

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

Returns:

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

See Also:

• MFString.cleanupEnumerationValues(String)

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 Background

Specified by:

getBindTime in interface X3DBackgroundNode

Specified by:

getBindTime in interface X3DBindableNode

Returns:

value of bindTime field

getBottomUrl

public String[] getBottomUrl()

Provide array of String results from inputOutput MFString field named bottomUrl.

Tooltip: Image background panorama between ground/sky backdrop and scene's geometry.

• Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "https://www.web3d.org" "https://www.web3d.org/about" "etc."
• Hint: alternative XML encoding for quotation mark " is " (which is an example of a character entity).
• Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all case sensitive and intolerant of uppercase/lowercase mismatches.
• Hint: can replace embedded blank(s) in url queries with %20 for each blank character. Interchange profile
• Hint: this field may be ignored, applying the default value regardless.

Specified by:

getBottomUrl in interface Background

Returns:

value of bottomUrl field

getBottomUrlList

public ArrayList<String> getBottomUrlList()

Utility method to get ArrayList value of MFString bottomUrl field, similar to getBottomUrl().

Returns:

value of bottomUrl field

getBottomUrlString

public String getBottomUrlString()

Utility method to get String value of MFString bottomUrl field, similar to getBottomUrl().

Returns:

value of bottomUrl field

setBottomUrl

public Background setBottomUrl(String[] newValue)

Accessor method to assign String array to inputOutput MFString field named bottomUrl.

Tooltip: Image background panorama between ground/sky backdrop and scene's geometry.

• Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "https://www.web3d.org" "https://www.web3d.org/about" "etc."
• Hint: alternative XML encoding for quotation mark " is " (which is an example of a character entity).
• Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all case sensitive and intolerant of uppercase/lowercase mismatches.
• Hint: can replace embedded blank(s) in url queries with %20 for each blank character. Interchange profile
• Hint: this field may be ignored, applying the default value regardless.

Specified by:

setBottomUrl in interface Background

Parameters:

newValue - is new value for the bottomUrl field.

Returns:

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

setBottomUrl

public Background setBottomUrl(MFString newValue)

Assign typed object value to MFString bottomUrl field, similar to setBottomUrl(String[]).

Parameters:

newValue - is new value for the bottomUrl field.

Returns:

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

setBottomUrl

public Background setBottomUrl(SFString newValue)

Assign single SFString object value to MFString bottomUrl field, similar to setBottomUrl(String[]).

Parameters:

newValue - is new value for the bottomUrl field.

Returns:

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

setBottomUrl

public Background setBottomUrl(String newValue)

Assign singleton String value to MFString bottomUrl field, similar to setBottomUrl(String[]).

Parameters:

newValue - is new value for the bottomUrl field.

Returns:

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

setBottomUrl

public Background setBottomUrl(ArrayList<String> newValue)

Assign ArrayList value of MFString bottomUrl field, similar to setBottomUrl(String[]).

Parameters:

newValue - is new value for the bottomUrl field.

Returns:

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

clearBottomUrl

public Background clearBottomUrl()

Utility method to clear MFString value of bottomUrl field. This method does not initialize withBOTTOMURL_DEFAULT_VALUE.

Returns:

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

addBottomUrl

public Background addBottomUrl(String newValue)

Add singleton String value to MFString bottomUrl field.

Parameters:

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

Returns:

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

See Also:

• MFString.cleanupEnumerationValues(String)

addBottomUrl

public Background addBottomUrl(SFString newValue)

Add singleton SFString value to MFString bottomUrl field.

Parameters:

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

Returns:

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

See Also:

• MFString.cleanupEnumerationValues(String)

getFrontUrl

public String[] getFrontUrl()

Provide array of String results from inputOutput MFString field named frontUrl.

Tooltip: Image background panorama between ground/sky backdrop and scene's geometry.

• Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "https://www.web3d.org" "https://www.web3d.org/about" "etc."
• Hint: alternative XML encoding for quotation mark " is " (which is an example of a character entity).
• Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all case sensitive and intolerant of uppercase/lowercase mismatches.
• Hint: can replace embedded blank(s) in url queries with %20 for each blank character. Interchange profile
• Hint: this field may be ignored, applying the default value regardless.

Specified by:

getFrontUrl in interface Background

Returns:

value of frontUrl field

getFrontUrlList

public ArrayList<String> getFrontUrlList()

Utility method to get ArrayList value of MFString frontUrl field, similar to getFrontUrl().

Returns:

value of frontUrl field

getFrontUrlString

public String getFrontUrlString()

Utility method to get String value of MFString frontUrl field, similar to getFrontUrl().

Returns:

value of frontUrl field

setFrontUrl

public Background setFrontUrl(String[] newValue)

Accessor method to assign String array to inputOutput MFString field named frontUrl.

Tooltip: Image background panorama between ground/sky backdrop and scene's geometry.

• Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "https://www.web3d.org" "https://www.web3d.org/about" "etc."
• Hint: alternative XML encoding for quotation mark " is " (which is an example of a character entity).
• Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all case sensitive and intolerant of uppercase/lowercase mismatches.
• Hint: can replace embedded blank(s) in url queries with %20 for each blank character. Interchange profile
• Hint: this field may be ignored, applying the default value regardless.

Specified by:

setFrontUrl in interface Background

Parameters:

newValue - is new value for the frontUrl field.

Returns:

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

setFrontUrl

public Background setFrontUrl(MFString newValue)

Assign typed object value to MFString frontUrl field, similar to setFrontUrl(String[]).

Parameters:

newValue - is new value for the frontUrl field.

Returns:

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

setFrontUrl

public Background setFrontUrl(SFString newValue)

Assign single SFString object value to MFString frontUrl field, similar to setFrontUrl(String[]).

Parameters:

newValue - is new value for the frontUrl field.

Returns:

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

setFrontUrl

public Background setFrontUrl(String newValue)

Assign singleton String value to MFString frontUrl field, similar to setFrontUrl(String[]).

Parameters:

newValue - is new value for the frontUrl field.

Returns:

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

setFrontUrl

public Background setFrontUrl(ArrayList<String> newValue)

Assign ArrayList value of MFString frontUrl field, similar to setFrontUrl(String[]).

Parameters:

newValue - is new value for the frontUrl field.

Returns:

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

clearFrontUrl

public Background clearFrontUrl()

Utility method to clear MFString value of frontUrl field. This method does not initialize withFRONTURL_DEFAULT_VALUE.

Returns:

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

addFrontUrl

public Background addFrontUrl(String newValue)

Add singleton String value to MFString frontUrl field.

Parameters:

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

Returns:

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

See Also:

• MFString.cleanupEnumerationValues(String)

addFrontUrl

public Background addFrontUrl(SFString newValue)

Add singleton SFString value to MFString frontUrl field.

Parameters:

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

Returns:

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

See Also:

• MFString.cleanupEnumerationValues(String)

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 Background

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

Specified by:

setGroundAngle in interface X3DBackgroundNode

Parameters:

newValue - is new value for the groundAngle field.

Returns:

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

setGroundAngle

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

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

setGroundAngle

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

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

clearGroundAngle

public Background clearGroundAngle()

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

Returns:

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

setGroundAngle

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

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

addGroundAngle

public Background addGroundAngle(float newValue)

Add singleton float value to MFFloat groundAngle field.

Parameters:

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

Returns:

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

addGroundAngle

public Background addGroundAngle(SFFloat newValue)

Add singleton SFFloat value to MFFloat groundAngle field.

Parameters:

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

Returns:

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

setGroundAngle

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

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

Specified by:

getGroundColor in interface X3DBackgroundNode

Returns:

value of groundColor field

setGroundColor

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

Specified by:

setGroundColor in interface X3DBackgroundNode

Parameters:

newValue - is new value for the groundColor field.

Returns:

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

setGroundColor

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

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

addGroundColor

public Background addGroundColor(SFColor newValue)

Add singleton SFColor value to MFColor groundColor field.

Parameters:

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

Returns:

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

setGroundColor

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

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

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

Utility method to clear SFNode value of IS field.

Returns:

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

Specified by:

getIsBound in interface X3DBackgroundNode

Specified by:

getIsBound in interface X3DBindableNode

Returns:

value of isBound field

getLeftUrl

public String[] getLeftUrl()

Provide array of String results from inputOutput MFString field named leftUrl.

Tooltip: Image background panorama between ground/sky backdrop and scene's geometry.

• Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "https://www.web3d.org" "https://www.web3d.org/about" "etc."
• Hint: alternative XML encoding for quotation mark " is " (which is an example of a character entity).
• Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all case sensitive and intolerant of uppercase/lowercase mismatches.
• Hint: can replace embedded blank(s) in url queries with %20 for each blank character. Interchange profile
• Hint: this field may be ignored, applying the default value regardless.

Specified by:

getLeftUrl in interface Background

Returns:

value of leftUrl field

getLeftUrlList

public ArrayList<String> getLeftUrlList()

Utility method to get ArrayList value of MFString leftUrl field, similar to getLeftUrl().

Returns:

value of leftUrl field

getLeftUrlString

public String getLeftUrlString()

Utility method to get String value of MFString leftUrl field, similar to getLeftUrl().

Returns:

value of leftUrl field

setLeftUrl

public Background setLeftUrl(String[] newValue)

Accessor method to assign String array to inputOutput MFString field named leftUrl.

Tooltip: Image background panorama between ground/sky backdrop and scene's geometry.

• Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "https://www.web3d.org" "https://www.web3d.org/about" "etc."
• Hint: alternative XML encoding for quotation mark " is " (which is an example of a character entity).
• Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all case sensitive and intolerant of uppercase/lowercase mismatches.
• Hint: can replace embedded blank(s) in url queries with %20 for each blank character. Interchange profile
• Hint: this field may be ignored, applying the default value regardless.

Specified by:

setLeftUrl in interface Background

Parameters:

newValue - is new value for the leftUrl field.

Returns:

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

setLeftUrl

public Background setLeftUrl(MFString newValue)

Assign typed object value to MFString leftUrl field, similar to setLeftUrl(String[]).

Parameters:

newValue - is new value for the leftUrl field.

Returns:

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

setLeftUrl

public Background setLeftUrl(SFString newValue)

Assign single SFString object value to MFString leftUrl field, similar to setLeftUrl(String[]).

Parameters:

newValue - is new value for the leftUrl field.

Returns:

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

setLeftUrl

public Background setLeftUrl(String newValue)

Assign singleton String value to MFString leftUrl field, similar to setLeftUrl(String[]).

Parameters:

newValue - is new value for the leftUrl field.

Returns:

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

setLeftUrl

public Background setLeftUrl(ArrayList<String> newValue)

Assign ArrayList value of MFString leftUrl field, similar to setLeftUrl(String[]).

Parameters:

newValue - is new value for the leftUrl field.

Returns:

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

clearLeftUrl

public Background clearLeftUrl()

Utility method to clear MFString value of leftUrl field. This method does not initialize withLEFTURL_DEFAULT_VALUE.

Returns:

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

addLeftUrl

public Background addLeftUrl(String newValue)

Add singleton String value to MFString leftUrl field.

Parameters:

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

Returns:

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

See Also:

• MFString.cleanupEnumerationValues(String)

addLeftUrl

public Background addLeftUrl(SFString newValue)

Add singleton SFString value to MFString leftUrl field.

Parameters:

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

Returns:

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

See Also:

• MFString.cleanupEnumerationValues(String)

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 Background

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

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:

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

Utility method to clear SFNode value of metadata field.

Returns:

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

setMetadata

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

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

getRightUrl

public String[] getRightUrl()

Provide array of String results from inputOutput MFString field named rightUrl.

Tooltip: Image background panorama between ground/sky backdrop and scene's geometry.

• Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "https://www.web3d.org" "https://www.web3d.org/about" "etc."
• Hint: alternative XML encoding for quotation mark " is " (which is an example of a character entity).
• Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all case sensitive and intolerant of uppercase/lowercase mismatches.
• Hint: can replace embedded blank(s) in url queries with %20 for each blank character. Interchange profile
• Hint: this field may be ignored, applying the default value regardless.

Specified by:

getRightUrl in interface Background

Returns:

value of rightUrl field

getRightUrlList

public ArrayList<String> getRightUrlList()

Utility method to get ArrayList value of MFString rightUrl field, similar to getRightUrl().

Returns:

value of rightUrl field

getRightUrlString

public String getRightUrlString()

Utility method to get String value of MFString rightUrl field, similar to getRightUrl().

Returns:

value of rightUrl field

setRightUrl

public Background setRightUrl(String[] newValue)

Accessor method to assign String array to inputOutput MFString field named rightUrl.

Tooltip: Image background panorama between ground/sky backdrop and scene's geometry.

• Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "https://www.web3d.org" "https://www.web3d.org/about" "etc."
• Hint: alternative XML encoding for quotation mark " is " (which is an example of a character entity).
• Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all case sensitive and intolerant of uppercase/lowercase mismatches.
• Hint: can replace embedded blank(s) in url queries with %20 for each blank character. Interchange profile
• Hint: this field may be ignored, applying the default value regardless.

Specified by:

setRightUrl in interface Background

Parameters:

newValue - is new value for the rightUrl field.

Returns:

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

setRightUrl

public Background setRightUrl(MFString newValue)

Assign typed object value to MFString rightUrl field, similar to setRightUrl(String[]).

Parameters:

newValue - is new value for the rightUrl field.

Returns:

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

setRightUrl

public Background setRightUrl(SFString newValue)

Assign single SFString object value to MFString rightUrl field, similar to setRightUrl(String[]).

Parameters:

newValue - is new value for the rightUrl field.

Returns:

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

setRightUrl

public Background setRightUrl(String newValue)

Assign singleton String value to MFString rightUrl field, similar to setRightUrl(String[]).

Parameters:

newValue - is new value for the rightUrl field.

Returns:

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

setRightUrl

public Background setRightUrl(ArrayList<String> newValue)

Assign ArrayList value of MFString rightUrl field, similar to setRightUrl(String[]).

Parameters:

newValue - is new value for the rightUrl field.

Returns:

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

clearRightUrl

public Background clearRightUrl()

Utility method to clear MFString value of rightUrl field. This method does not initialize withRIGHTURL_DEFAULT_VALUE.

Returns:

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

addRightUrl

public Background addRightUrl(String newValue)

Add singleton String value to MFString rightUrl field.

Parameters:

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

Returns:

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

See Also:

• MFString.cleanupEnumerationValues(String)

addRightUrl

public Background addRightUrl(SFString newValue)

Add singleton SFString value to MFString rightUrl field.

Parameters:

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

Returns:

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

See Also:

• MFString.cleanupEnumerationValues(String)

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 Background

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

Specified by:

setSkyAngle in interface X3DBackgroundNode

Parameters:

newValue - is new value for the skyAngle field.

Returns:

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

setSkyAngle

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

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

setSkyAngle

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

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

clearSkyAngle

public Background clearSkyAngle()

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

Returns:

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

setSkyAngle

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

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

addSkyAngle

public Background addSkyAngle(float newValue)

Add singleton float value to MFFloat skyAngle field.

Parameters:

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

Returns:

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

addSkyAngle

public Background addSkyAngle(SFFloat newValue)

Add singleton SFFloat value to MFFloat skyAngle field.

Parameters:

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

Returns:

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

setSkyAngle

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

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

Specified by:

getSkyColor in interface X3DBackgroundNode

Returns:

value of skyColor field

setSkyColor

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

Specified by:

setSkyColor in interface X3DBackgroundNode

Parameters:

newValue - is new value for the skyColor field.

Returns:

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

setSkyColor

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

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

addSkyColor

public Background addSkyColor(SFColor newValue)

Add singleton SFColor value to MFColor skyColor field.

Parameters:

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

Returns:

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

setSkyColor

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

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

getTopUrl

public String[] getTopUrl()

Provide array of String results from inputOutput MFString field named topUrl.

Tooltip: Image background panorama between ground/sky backdrop and scene's geometry.

• Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "https://www.web3d.org" "https://www.web3d.org/about" "etc."
• Hint: alternative XML encoding for quotation mark " is " (which is an example of a character entity).
• Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all case sensitive and intolerant of uppercase/lowercase mismatches.
• Hint: can replace embedded blank(s) in url queries with %20 for each blank character. Interchange profile
• Hint: this field may be ignored, applying the default value regardless.

Specified by:

getTopUrl in interface Background

Returns:

value of topUrl field

getTopUrlList

public ArrayList<String> getTopUrlList()

Utility method to get ArrayList value of MFString topUrl field, similar to getTopUrl().

Returns:

value of topUrl field

getTopUrlString

public String getTopUrlString()

Utility method to get String value of MFString topUrl field, similar to getTopUrl().

Returns:

value of topUrl field

setTopUrl

public Background setTopUrl(String[] newValue)

Accessor method to assign String array to inputOutput MFString field named topUrl.

Tooltip: Image background panorama between ground/sky backdrop and scene's geometry.

• Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "https://www.web3d.org" "https://www.web3d.org/about" "etc."
• Hint: alternative XML encoding for quotation mark " is " (which is an example of a character entity).
• Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all case sensitive and intolerant of uppercase/lowercase mismatches.
• Hint: can replace embedded blank(s) in url queries with %20 for each blank character. Interchange profile
• Hint: this field may be ignored, applying the default value regardless.

Specified by:

setTopUrl in interface Background

Parameters:

newValue - is new value for the topUrl field.

Returns:

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

setTopUrl

public Background setTopUrl(MFString newValue)

Assign typed object value to MFString topUrl field, similar to setTopUrl(String[]).

Parameters:

newValue - is new value for the topUrl field.

Returns:

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

setTopUrl

public Background setTopUrl(SFString newValue)

Assign single SFString object value to MFString topUrl field, similar to setTopUrl(String[]).

Parameters:

newValue - is new value for the topUrl field.

Returns:

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

setTopUrl

public Background setTopUrl(String newValue)

Assign singleton String value to MFString topUrl field, similar to setTopUrl(String[]).

Parameters:

newValue - is new value for the topUrl field.

Returns:

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

setTopUrl

public Background setTopUrl(ArrayList<String> newValue)

Assign ArrayList value of MFString topUrl field, similar to setTopUrl(String[]).

Parameters:

newValue - is new value for the topUrl field.

Returns:

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

clearTopUrl

public Background clearTopUrl()

Utility method to clear MFString value of topUrl field. This method does not initialize withTOPURL_DEFAULT_VALUE.

Returns:

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

addTopUrl

public Background addTopUrl(String newValue)

Add singleton String value to MFString topUrl field.

Parameters:

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

Returns:

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

See Also:

• MFString.cleanupEnumerationValues(String)

addTopUrl

public Background addTopUrl(SFString newValue)

Add singleton SFString value to MFString topUrl field.

Parameters:

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

Returns:

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

See Also:

• MFString.cleanupEnumerationValues(String)

getTransparency

public float getTransparency()

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

Tooltip: [0,1] how "clear" the background is, allows underlying page to show through: 1.0 is completely transparent, 0.0 is completely opaque. Interchange profile

• Hint: transparency < .5 opaque, transparency > .5 transparent.

Specified by:

getTransparency in interface Background

Specified by:

getTransparency in interface X3DBackgroundNode

Returns:

value of transparency field

setTransparency

public Background setTransparency(float newValue)

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

Tooltip: [0,1] how "clear" the background is, allows underlying page to show through: 1.0 is completely transparent, 0.0 is completely opaque. Interchange profile

• Hint: transparency < .5 opaque, transparency > .5 transparent.

Specified by:

setTransparency in interface Background

Specified by:

setTransparency in interface X3DBackgroundNode

Parameters:

newValue - is new value for the transparency field.

Returns:

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

setTransparency

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

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

setTransparency

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

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

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

setDEF

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

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

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

setUSE

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

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

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

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

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

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

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

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

setUSE

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

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

addComments

public Background addComments(String newComment)

Add comment as String to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComment - initial value

Returns:

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

Add comments as String[] array to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComments - array of comments

Returns:

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

addComments

public Background addComments(CommentsBlock newCommentsBlock)

Add CommentsBlock to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newCommentsBlock - block of comments to add

Returns:

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