Class TextureBackgroundObject
java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.EnvironmentalEffects.TextureBackgroundObject
- All Implemented Interfaces:
X3DBindableNode
,X3DChildNode
,X3DNode
,TextureBackground
,X3DBackgroundNode
public class TextureBackgroundObject extends X3DConcreteNode implements TextureBackground
TextureBackground simulates ground and sky, using vertical arrays of wraparound color values, TextureBackground can also provide backdrop texture images on all six sides.
X3D node tooltip: [X3DBackgroundNode] TextureBackground simulates ground and sky, using vertical arrays of wraparound color values, TextureBackground can also provide backdrop texture images on all six sides.
Note that SFColorObject 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.
X3D node tooltip: [X3DBackgroundNode] TextureBackground simulates ground and sky, using vertical arrays of wraparound color values, TextureBackground can also provide backdrop texture images on all six sides.
- Hint: Background, Fog, GeoViewpoint, NavigationInfo, OrthoViewpoint, TextureBackground and Viewpoint are bindable nodes, meaning that no more than one of each node type can be active at a given time.
- Warning: results are undefined if a bindable node (Background, Fog, NavigationInfo, OrthoViewpoint, TextureBackground, Viewpoint) is a contained descendant node of either LOD or Switch.
- Warning: each of the child ImageTexture or PixelTexture nodes must have unique containerField values for backTexture, bottomTexture, frontTexture, leftTexture, rightTexture, or topTexture.
- Hint: authors can have LoadSensor nodes receive notifications and send reporting events when background texture node(s) are loaded.
Note that SFColorObject 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.
-
Field Summary
Fields Modifier and Type Field Description static X3DNode
BACKTEXTURE_DEFAULT_VALUE
SFNode field named backTexture has default value null (Java syntax) or NULL (XML syntax).static X3DNode
BOTTOMTEXTURE_DEFAULT_VALUE
SFNode field named bottomTexture has default value null (Java syntax) or NULL (XML syntax).static java.lang.String
COMPONENT
String constant COMPONENT defines X3D component for the TextureBackground element: EnvironmentalEffectsstatic java.lang.String
containerField_DEFAULT_VALUE
containerField describes typical field relationship of a node to its parent.static java.lang.String
fromField_BACKTEXTURE
fromField ROUTE name for SFNode field named backTexture.static java.lang.String
fromField_BINDTIME
fromField ROUTE name for SFTime field named bindTime.static java.lang.String
fromField_BOTTOMTEXTURE
fromField ROUTE name for SFNode field named bottomTexture.static java.lang.String
fromField_FRONTTEXTURE
fromField ROUTE name for SFNode field named frontTexture.static java.lang.String
fromField_GROUNDANGLE
fromField ROUTE name for MFFloat field named groundAngle.static java.lang.String
fromField_GROUNDCOLOR
fromField ROUTE name for MFColor field named groundColor.static java.lang.String
fromField_IS
fromField ROUTE name for SFNode field named IS.static java.lang.String
fromField_ISBOUND
fromField ROUTE name for SFBool field named isBound.static java.lang.String
fromField_LEFTTEXTURE
fromField ROUTE name for SFNode field named leftTexture.static java.lang.String
fromField_METADATA
fromField ROUTE name for SFNode field named metadata.static java.lang.String
fromField_RIGHTTEXTURE
fromField ROUTE name for SFNode field named rightTexture.static java.lang.String
fromField_SKYANGLE
fromField ROUTE name for MFFloat field named skyAngle.static java.lang.String
fromField_SKYCOLOR
fromField ROUTE name for MFColor field named skyColor.static java.lang.String
fromField_TOPTEXTURE
fromField ROUTE name for SFNode field named topTexture.static java.lang.String
fromField_TRANSPARENCY
fromField ROUTE name for SFFloat field named transparency.static X3DNode
FRONTTEXTURE_DEFAULT_VALUE
SFNode field named frontTexture has default value null (Java syntax) or NULL (XML syntax).static java.util.ArrayList<java.lang.Float>
GROUNDANGLE_DEFAULT_VALUE
MFFloat field named groundAngle has default value equal to an empty list.static float[]
GROUNDCOLOR_DEFAULT_VALUE
MFColor field named groundColor has default value equal to an empty list.static ISObject
IS_DEFAULT_VALUE
SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).static X3DNode
LEFTTEXTURE_DEFAULT_VALUE
SFNode field named leftTexture has default value null (Java syntax) or NULL (XML syntax).static int
LEVEL
Integer constant LEVEL provides default X3D EnvironmentalEffects component level for this element: 3static X3DMetadataObject
METADATA_DEFAULT_VALUE
SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).static java.lang.String
NAME
String constant NAME provides name of this element: TextureBackground.static X3DNode
RIGHTTEXTURE_DEFAULT_VALUE
SFNode field named rightTexture has default value null (Java syntax) or NULL (XML syntax).static java.util.ArrayList<java.lang.Float>
SKYANGLE_DEFAULT_VALUE
MFFloat field named skyAngle has default value equal to an empty list.static float[]
SKYCOLOR_DEFAULT_VALUE
MFColor field named skyColor has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).static java.lang.String
toField_BACKTEXTURE
toField ROUTE name for SFNode field named backTexture.static java.lang.String
toField_BOTTOMTEXTURE
toField ROUTE name for SFNode field named bottomTexture.static java.lang.String
toField_FRONTTEXTURE
toField ROUTE name for SFNode field named frontTexture.static java.lang.String
toField_GROUNDANGLE
toField ROUTE name for MFFloat field named groundAngle.static java.lang.String
toField_GROUNDCOLOR
toField ROUTE name for MFColor field named groundColor.static java.lang.String
toField_LEFTTEXTURE
toField ROUTE name for SFNode field named leftTexture.static java.lang.String
toField_METADATA
toField ROUTE name for SFNode field named metadata.static java.lang.String
toField_RIGHTTEXTURE
toField ROUTE name for SFNode field named rightTexture.static java.lang.String
toField_SET_BIND
toField ROUTE name for SFBool field named set_bind.static java.lang.String
toField_SKYANGLE
toField ROUTE name for MFFloat field named skyAngle.static java.lang.String
toField_SKYCOLOR
toField ROUTE name for MFColor field named skyColor.static java.lang.String
toField_TOPTEXTURE
toField ROUTE name for SFNode field named topTexture.static java.lang.String
toField_TRANSPARENCY
toField ROUTE name for SFFloat field named transparency.static X3DNode
TOPTEXTURE_DEFAULT_VALUE
SFNode field named topTexture has default value null (Java syntax) or NULL (XML syntax).static 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
CLASS_DEFAULT_VALUE, containerField_ALTERNATE_VALUES, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE
-
Constructor Summary
Constructors Constructor Description TextureBackgroundObject()
Constructor for TextureBackgroundObject to initialize member variables with default values.TextureBackgroundObject(java.lang.String DEFlabel)
Utility constructor that assigns DEF label after initializing member variables with default values. -
Method Summary
Modifier and Type Method Description TextureBackgroundObject
addComments(java.lang.String newComment)
Add comment as String to contained commentsList.TextureBackgroundObject
addComments(java.lang.String[] newComments)
Add comments as String[] array to contained commentsList.TextureBackgroundObject
addComments(CommentsBlock newCommentsBlock)
Add CommentsBlock to contained commentsList.TextureBackgroundObject
addGroundAngle(float newValue)
Add singleton float value to MFFloat groundAngle field.TextureBackgroundObject
addGroundAngle(SFFloatObject newValue)
Add singleton SFFloatObject value to MFFloat groundAngle field.TextureBackgroundObject
addGroundColor(SFColorObject newValue)
Add singleton SFColorObject value to MFColor groundColor field.TextureBackgroundObject
addSkyAngle(float newValue)
Add singleton float value to MFFloat skyAngle field.TextureBackgroundObject
addSkyAngle(SFFloatObject newValue)
Add singleton SFFloatObject value to MFFloat skyAngle field.TextureBackgroundObject
addSkyColor(SFColorObject newValue)
Add singleton SFColorObject value to MFColor skyColor field.TextureBackgroundObject
clearBackTexture()
Utility method to clear SFNode value of backTexture field.TextureBackgroundObject
clearBottomTexture()
Utility method to clear SFNode value of bottomTexture field.TextureBackgroundObject
clearFrontTexture()
Utility method to clear SFNode value of frontTexture field.TextureBackgroundObject
clearGroundAngle()
Utility method to clear MFFloat value of groundAngle field.TextureBackgroundObject
clearIS()
Utility method to clear SFNode value of IS field.TextureBackgroundObject
clearLeftTexture()
Utility method to clear SFNode value of leftTexture field.TextureBackgroundObject
clearMetadata()
Utility method to clear SFNode value of metadata field.TextureBackgroundObject
clearRightTexture()
Utility method to clear SFNode value of rightTexture field.TextureBackgroundObject
clearSkyAngle()
Utility method to clear MFFloat value of skyAngle field.TextureBackgroundObject
clearTopTexture()
Utility method to clear SFNode value of topTexture field.X3DConcreteElement
findElementByNameValue(java.lang.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(java.lang.String nameValue, java.lang.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(java.lang.String DEFvalue)
Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.java.lang.String
getAccessType(java.lang.String fieldName)
Indicate accessType corresponding to given fieldName.X3DNode
getBackTexture()
Provide X3DNode instance (using a properly typed node) with acceptable node types limited to X3DTexture2DNode|MultiTexture, from inputOutput SFNode field backTexture.double
getBindTime()
Provide double value in seconds from outputOnly SFTime field named bindTime.X3DNode
getBottomTexture()
Provide X3DNode instance (using a properly typed node) with acceptable node types limited to X3DTexture2DNode|MultiTexture, from inputOutput SFNode field bottomTexture.java.lang.String
getComponent()
Defines X3D component for the TextureBackground element: EnvironmentalEffectsint
getComponentLevel()
Provides default X3D component level for this element: 3java.lang.String
getContainerFieldDefault()
containerField describes typical field relationship of a node to its parent.java.lang.String
getCssClass()
Provide String value from inputOutput SFString field named class.java.lang.String
getDEF()
Provide String value from inputOutput SFString field named DEF.java.lang.String
getElementName()
Provides name of this element: TextureBackgroundjava.lang.String
getFieldType(java.lang.String fieldName)
Indicate type corresponding to given fieldName.X3DNode
getFrontTexture()
Provide X3DNode instance (using a properly typed node) with acceptable node types limited to X3DTexture2DNode|MultiTexture, from inputOutput SFNode field frontTexture.float[]
getGroundAngle()
Provide array of Float results unit axis, angle (in radians) within allowed range of [0,1.5708] from inputOutput MFFloat field named groundAngle.java.util.ArrayList<java.lang.Float>
getGroundAngleList()
Utility method to get ArrayList value of MFFloat groundAngle field, similar togetGroundAngle()
.java.lang.String
getGroundAngleString()
Utility method to get String value of MFFloat groundAngle field, similar togetGroundAngle()
.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.ISObject
getIS()
Provide ISObject instance (using a properly typed node) from inputOutput SFNode field IS.boolean
getIsBound()
Provide boolean value from outputOnly SFBool field named isBound.X3DNode
getLeftTexture()
Provide X3DNode instance (using a properly typed node) with acceptable node types limited to X3DTexture2DNode|MultiTexture, from inputOutput SFNode field leftTexture.X3DMetadataObject
getMetadata()
Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.X3DNode
getRightTexture()
Provide X3DNode instance (using a properly typed node) with acceptable node types limited to X3DTexture2DNode|MultiTexture, from inputOutput SFNode field rightTexture.float[]
getSkyAngle()
Provide array of Float results unit axis, angle (in radians) within allowed range of [0,3.1416] from inputOutput MFFloat field named skyAngle.java.util.ArrayList<java.lang.Float>
getSkyAngleList()
Utility method to get ArrayList value of MFFloat skyAngle field, similar togetSkyAngle()
.java.lang.String
getSkyAngleString()
Utility method to get String value of MFFloat skyAngle field, similar togetSkyAngle()
.float[]
getSkyColor()
Provide array of 3-tuple float results using RGB values [0..1] using RGB values [0..1] from inputOutput MFColor field named skyColor.X3DNode
getTopTexture()
Provide X3DNode instance (using a properly typed node) with acceptable node types limited to X3DTexture2DNode|MultiTexture, from inputOutput SFNode field topTexture.float
getTransparency()
Provide float value within allowed range of [0,1] from inputOutput SFFloat field named transparency.java.lang.String
getUSE()
Provide String value from inputOutput SFString field named USE.boolean
hasBackTexture()
Indicate whether an object is available for inputOutput SFNode field backTexture.boolean
hasBottomTexture()
Indicate whether an object is available for inputOutput SFNode field bottomTexture.boolean
hasElementByNameValue(java.lang.String nameValue, java.lang.String elementName)
Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.boolean
hasFrontTexture()
Indicate whether an object is available for inputOutput SFNode field frontTexture.boolean
hasIS()
Indicate whether an object is available for inputOutput SFNode field IS.boolean
hasLeftTexture()
Indicate whether an object is available for inputOutput SFNode field leftTexture.boolean
hasMetadata()
Indicate whether an object is available for inputOutput SFNode field metadata.boolean
hasNodeByDEF(java.lang.String DEFvalue)
Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.boolean
hasRightTexture()
Indicate whether an object is available for inputOutput SFNode field rightTexture.boolean
hasTopTexture()
Indicate whether an object is available for inputOutput SFNode field topTexture.void
initialize()
Initialize all member variables to default values.TextureBackgroundObject
setBackTexture(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field backTexture.TextureBackgroundObject
setBackTexture(X3DNode newValue)
Accessor method to assign X3DNode instance (using a properly typed node) to inputOutput SFNode field backTexture. // newValueInstanceAcceptableNodeTypesTest checks are needed for methods that override/subset X3DNode interfaces #1 boolean isNodeTypeAllowed = (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.sai.Texturing.X3DTexture2DNode) || (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.jsail.Texturing.MultiTextureObject); if (!TextureBackgroundObject
setBottomTexture(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field bottomTexture.TextureBackgroundObject
setBottomTexture(X3DNode newValue)
Accessor method to assign X3DNode instance (using a properly typed node) to inputOutput SFNode field bottomTexture. // newValueInstanceAcceptableNodeTypesTest checks are needed for methods that override/subset X3DNode interfaces #1 boolean isNodeTypeAllowed = (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.sai.Texturing.X3DTexture2DNode) || (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.jsail.Texturing.MultiTextureObject); if (!TextureBackgroundObject
setCssClass(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named class.TextureBackgroundObject
setCssClass(SFStringObject newValue)
Assign typed object value to SFString cssClass field, similar tosetCssClass(String)
.TextureBackgroundObject
setDEF(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named DEF.TextureBackgroundObject
setDEF(SFStringObject newValue)
Assign typed object value to SFString DEF field, similar tosetDEF(String)
.TextureBackgroundObject
setFrontTexture(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field frontTexture.TextureBackgroundObject
setFrontTexture(X3DNode newValue)
Accessor method to assign X3DNode instance (using a properly typed node) to inputOutput SFNode field frontTexture. // newValueInstanceAcceptableNodeTypesTest checks are needed for methods that override/subset X3DNode interfaces #1 boolean isNodeTypeAllowed = (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.sai.Texturing.X3DTexture2DNode) || (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.jsail.Texturing.MultiTextureObject); if (!TextureBackgroundObject
setGroundAngle(double[] newArray)
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetGroundAngle(float[])
.TextureBackgroundObject
setGroundAngle(float[] newValue)
Accessor method to assign Float array unit axis, angle (in radians) to inputOutput MFFloat field named groundAngle.TextureBackgroundObject
setGroundAngle(int[] newValue)
Assign floating-point array value of MFFloat groundAngle field, similar tosetGroundAngle(float[])
.TextureBackgroundObject
setGroundAngle(java.util.ArrayList<java.lang.Float> newValue)
Assign ArrayList value of MFFloat groundAngle field, similar tosetGroundAngle(float[])
.TextureBackgroundObject
setGroundAngle(MFFloatObject newValue)
Assign typed object value to MFFloat groundAngle field, similar tosetGroundAngle(float[])
.TextureBackgroundObject
setGroundColor(double[] newArray)
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetGroundColor(float[])
.TextureBackgroundObject
setGroundColor(float[] newValue)
Accessor method to assign 3-tuple float array using RGB values [0..1] to inputOutput MFColor field named groundColor.TextureBackgroundObject
setGroundColor(MFColorObject newValue)
Assign typed object value to MFColor groundColor field, similar tosetGroundColor(float[])
.TextureBackgroundObject
setIS(ISObject newValue)
Accessor method to assign ISObject instance (using a properly typed node) to inputOutput SFNode field IS.TextureBackgroundObject
setLeftTexture(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field leftTexture.TextureBackgroundObject
setLeftTexture(X3DNode newValue)
Accessor method to assign X3DNode instance (using a properly typed node) to inputOutput SFNode field leftTexture. // newValueInstanceAcceptableNodeTypesTest checks are needed for methods that override/subset X3DNode interfaces #1 boolean isNodeTypeAllowed = (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.sai.Texturing.X3DTexture2DNode) || (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.jsail.Texturing.MultiTextureObject); if (!TextureBackgroundObject
setMetadata(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.TextureBackgroundObject
setMetadata(X3DMetadataObject newValue)
Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.TextureBackgroundObject
setRightTexture(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field rightTexture.TextureBackgroundObject
setRightTexture(X3DNode newValue)
Accessor method to assign X3DNode instance (using a properly typed node) to inputOutput SFNode field rightTexture. // newValueInstanceAcceptableNodeTypesTest checks are needed for methods that override/subset X3DNode interfaces #1 boolean isNodeTypeAllowed = (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.sai.Texturing.X3DTexture2DNode) || (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.jsail.Texturing.MultiTextureObject); if (!TextureBackgroundObject
setSkyAngle(double[] newArray)
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetSkyAngle(float[])
.TextureBackgroundObject
setSkyAngle(float[] newValue)
Accessor method to assign Float array unit axis, angle (in radians) to inputOutput MFFloat field named skyAngle.TextureBackgroundObject
setSkyAngle(int[] newValue)
Assign floating-point array value of MFFloat skyAngle field, similar tosetSkyAngle(float[])
.TextureBackgroundObject
setSkyAngle(java.util.ArrayList<java.lang.Float> newValue)
Assign ArrayList value of MFFloat skyAngle field, similar tosetSkyAngle(float[])
.TextureBackgroundObject
setSkyAngle(MFFloatObject newValue)
Assign typed object value to MFFloat skyAngle field, similar tosetSkyAngle(float[])
.TextureBackgroundObject
setSkyColor(double[] newArray)
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetSkyColor(float[])
.TextureBackgroundObject
setSkyColor(float[] newValue)
Accessor method to assign 3-tuple float array using RGB values [0..1] to inputOutput MFColor field named skyColor.TextureBackgroundObject
setSkyColor(MFColorObject newValue)
Assign typed object value to MFColor skyColor field, similar tosetSkyColor(float[])
.TextureBackgroundObject
setTopTexture(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field topTexture.TextureBackgroundObject
setTopTexture(X3DNode newValue)
Accessor method to assign X3DNode instance (using a properly typed node) to inputOutput SFNode field topTexture. // newValueInstanceAcceptableNodeTypesTest checks are needed for methods that override/subset X3DNode interfaces #1 boolean isNodeTypeAllowed = (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.sai.Texturing.X3DTexture2DNode) || (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.jsail.Texturing.MultiTextureObject); if (!TextureBackgroundObject
setTransparency(double newValue)
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetTransparency(float)
.TextureBackgroundObject
setTransparency(float newValue)
Accessor method to assign float value to inputOutput SFFloat field named transparency.TextureBackgroundObject
setTransparency(SFFloatObject newValue)
Assign typed object value to SFFloat transparency field, similar tosetTransparency(float)
.TextureBackgroundObject
setUSE(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named USE.TextureBackgroundObject
setUSE(TextureBackgroundObject DEFnode)
Assign a USE reference to another DEF node of same node type, similar tosetUSE(String)
.TextureBackgroundObject
setUSE(SFStringObject newValue)
Assign typed object value to SFString USE field, similar tosetUSE(String)
.java.lang.String
toStringClassicVRML(int indentLevel)
Recursive method to provide ClassicVRML string serialization.java.lang.String
toStringVRML97(int indentLevel)
Recursive method to provide VRML97 string serialization.java.lang.String
toStringX3D(int indentLevel)
Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.java.lang.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
getContainerFieldAlternateValues, getContainerFieldOverride, isNode, isStatement, isUSE, resetContainerFieldOverride, setConcreteCssClass, setConcreteDEF, setConcreteUSE, setContainerFieldOverride
Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement
clearParentObject, findAncestorElementByName, findAncestorProtoBody, findAncestorSceneObject, findAncestorX3DObject, getPackageName, getParentObject, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorSceneObject, hasAncestorX3DObject, hasParentObject, isValid, setParentObject, toStringClassicVRML, toStringVRML97, toStringX3D
-
Field Details
-
NAME
public static final java.lang.String NAMEString constant NAME provides name of this element: TextureBackground.- See Also:
- Constant Field Values
-
COMPONENT
public static final java.lang.String COMPONENTString constant COMPONENT defines X3D component for the TextureBackground element: EnvironmentalEffects- See Also:
- Constant Field Values
-
LEVEL
public static final int LEVELInteger constant LEVEL provides default X3D EnvironmentalEffects component level for this element: 3- See Also:
- Constant Field Values
-
BACKTEXTURE_DEFAULT_VALUE
SFNode field named backTexture has default value null (Java syntax) or NULL (XML syntax). -
BOTTOMTEXTURE_DEFAULT_VALUE
SFNode field named bottomTexture has default value null (Java syntax) or NULL (XML syntax). -
FRONTTEXTURE_DEFAULT_VALUE
SFNode field named frontTexture has default value null (Java syntax) or NULL (XML syntax). -
GROUNDANGLE_DEFAULT_VALUE
public static final java.util.ArrayList<java.lang.Float> GROUNDANGLE_DEFAULT_VALUEMFFloat field named groundAngle has default value equal to an empty list. -
GROUNDCOLOR_DEFAULT_VALUE
public static final float[] GROUNDCOLOR_DEFAULT_VALUEMFColor field named groundColor has default value equal to an empty list. -
IS_DEFAULT_VALUE
SFNode field named IS has default value null (Java syntax) or NULL (XML syntax). -
LEFTTEXTURE_DEFAULT_VALUE
SFNode field named leftTexture has default value null (Java syntax) or NULL (XML syntax). -
METADATA_DEFAULT_VALUE
SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax). -
RIGHTTEXTURE_DEFAULT_VALUE
SFNode field named rightTexture has default value null (Java syntax) or NULL (XML syntax). -
SKYANGLE_DEFAULT_VALUE
public static final java.util.ArrayList<java.lang.Float> SKYANGLE_DEFAULT_VALUEMFFloat field named skyAngle has default value equal to an empty list. -
SKYCOLOR_DEFAULT_VALUE
public static final float[] SKYCOLOR_DEFAULT_VALUEMFColor field named skyColor has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax). -
TOPTEXTURE_DEFAULT_VALUE
SFNode field named topTexture has default value null (Java syntax) or NULL (XML syntax). -
TRANSPARENCY_DEFAULT_VALUE
public static final float TRANSPARENCY_DEFAULT_VALUESFFloat field named transparency has default value 0f (Java syntax) or 0 (XML syntax).- See Also:
- Constant Field Values
-
containerField_DEFAULT_VALUE
public static final java.lang.String containerField_DEFAULT_VALUEcontainerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes. -
fromField_BACKTEXTURE
public static final java.lang.String fromField_BACKTEXTUREfromField ROUTE name for SFNode field named backTexture.- See Also:
- Constant Field Values
-
toField_BACKTEXTURE
public static final java.lang.String toField_BACKTEXTUREtoField ROUTE name for SFNode field named backTexture.- See Also:
- Constant Field Values
-
fromField_BINDTIME
public static final java.lang.String fromField_BINDTIMEfromField ROUTE name for SFTime field named bindTime.- See Also:
- Constant Field Values
-
fromField_BOTTOMTEXTURE
public static final java.lang.String fromField_BOTTOMTEXTUREfromField ROUTE name for SFNode field named bottomTexture.- See Also:
- Constant Field Values
-
toField_BOTTOMTEXTURE
public static final java.lang.String toField_BOTTOMTEXTUREtoField ROUTE name for SFNode field named bottomTexture.- See Also:
- Constant Field Values
-
fromField_FRONTTEXTURE
public static final java.lang.String fromField_FRONTTEXTUREfromField ROUTE name for SFNode field named frontTexture.- See Also:
- Constant Field Values
-
toField_FRONTTEXTURE
public static final java.lang.String toField_FRONTTEXTUREtoField ROUTE name for SFNode field named frontTexture.- See Also:
- Constant Field Values
-
fromField_GROUNDANGLE
public static final java.lang.String fromField_GROUNDANGLEfromField ROUTE name for MFFloat field named groundAngle.- See Also:
- Constant Field Values
-
toField_GROUNDANGLE
public static final java.lang.String toField_GROUNDANGLEtoField ROUTE name for MFFloat field named groundAngle.- See Also:
- Constant Field Values
-
fromField_GROUNDCOLOR
public static final java.lang.String fromField_GROUNDCOLORfromField ROUTE name for MFColor field named groundColor.- See Also:
- Constant Field Values
-
toField_GROUNDCOLOR
public static final java.lang.String toField_GROUNDCOLORtoField ROUTE name for MFColor field named groundColor.- See Also:
- Constant Field Values
-
fromField_IS
public static final java.lang.String fromField_ISfromField ROUTE name for SFNode field named IS.- See Also:
- Constant Field Values
-
fromField_ISBOUND
public static final java.lang.String fromField_ISBOUNDfromField ROUTE name for SFBool field named isBound.- See Also:
- Constant Field Values
-
fromField_LEFTTEXTURE
public static final java.lang.String fromField_LEFTTEXTUREfromField ROUTE name for SFNode field named leftTexture.- See Also:
- Constant Field Values
-
toField_LEFTTEXTURE
public static final java.lang.String toField_LEFTTEXTUREtoField ROUTE name for SFNode field named leftTexture.- See Also:
- Constant Field Values
-
fromField_METADATA
public static final java.lang.String fromField_METADATAfromField ROUTE name for SFNode field named metadata.- See Also:
- Constant Field Values
-
toField_METADATA
public static final java.lang.String toField_METADATAtoField ROUTE name for SFNode field named metadata.- See Also:
- Constant Field Values
-
fromField_RIGHTTEXTURE
public static final java.lang.String fromField_RIGHTTEXTUREfromField ROUTE name for SFNode field named rightTexture.- See Also:
- Constant Field Values
-
toField_RIGHTTEXTURE
public static final java.lang.String toField_RIGHTTEXTUREtoField ROUTE name for SFNode field named rightTexture.- See Also:
- Constant Field Values
-
toField_SET_BIND
public static final java.lang.String toField_SET_BINDtoField ROUTE name for SFBool field named set_bind.- See Also:
- Constant Field Values
-
fromField_SKYANGLE
public static final java.lang.String fromField_SKYANGLEfromField ROUTE name for MFFloat field named skyAngle.- See Also:
- Constant Field Values
-
toField_SKYANGLE
public static final java.lang.String toField_SKYANGLEtoField ROUTE name for MFFloat field named skyAngle.- See Also:
- Constant Field Values
-
fromField_SKYCOLOR
public static final java.lang.String fromField_SKYCOLORfromField ROUTE name for MFColor field named skyColor.- See Also:
- Constant Field Values
-
toField_SKYCOLOR
public static final java.lang.String toField_SKYCOLORtoField ROUTE name for MFColor field named skyColor.- See Also:
- Constant Field Values
-
fromField_TOPTEXTURE
public static final java.lang.String fromField_TOPTEXTUREfromField ROUTE name for SFNode field named topTexture.- See Also:
- Constant Field Values
-
toField_TOPTEXTURE
public static final java.lang.String toField_TOPTEXTUREtoField ROUTE name for SFNode field named topTexture.- See Also:
- Constant Field Values
-
fromField_TRANSPARENCY
public static final java.lang.String fromField_TRANSPARENCYfromField ROUTE name for SFFloat field named transparency.- See Also:
- Constant Field Values
-
toField_TRANSPARENCY
public static final java.lang.String toField_TRANSPARENCYtoField ROUTE name for SFFloat field named transparency.- See Also:
- Constant Field Values
-
-
Constructor Details
-
TextureBackgroundObject
public TextureBackgroundObject()Constructor for TextureBackgroundObject to initialize member variables with default values. -
TextureBackgroundObject
public TextureBackgroundObject(java.lang.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 java.lang.String getElementName()Provides name of this element: TextureBackground- Specified by:
getElementName
in classX3DConcreteElement
- Returns:
- name of this element
-
getComponent
public final java.lang.String getComponent()Defines X3D component for the TextureBackground element: EnvironmentalEffects- Specified by:
getComponent
in classX3DConcreteElement
- Returns:
- X3D component for this element
-
getComponentLevel
public final int getComponentLevel()Provides default X3D component level for this element: 3- Specified by:
getComponentLevel
in classX3DConcreteElement
- Returns:
- default X3D component level for this element
-
getFieldType
public java.lang.String getFieldType(java.lang.String fieldName)Indicate type corresponding to given fieldName.- Specified by:
getFieldType
in classX3DConcreteElement
- 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 java.lang.String getAccessType(java.lang.String fieldName)Indicate accessType corresponding to given fieldName.- Specified by:
getAccessType
in classX3DConcreteElement
- 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 java.lang.String getContainerFieldDefault()containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.- Specified by:
getContainerFieldDefault
in classX3DConcreteNode
- Returns:
- default containerField value
- See Also:
- X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM)
-
initialize
public final void initialize()Initialize all member variables to default values.- Overrides:
initialize
in classX3DConcreteNode
-
getBackTexture
Provide X3DNode instance (using a properly typed node) with acceptable node types limited to X3DTexture2DNode|MultiTexture, from inputOutput SFNode field backTexture.- Specified by:
getBackTexture
in interfaceTextureBackground
- Returns:
- value of backTexture field
- See Also:
Tooltip: [X3DTexture2DNode | MultiTexture] Parent TextureBackground element can contain up to six image nodes (ImageTexture PixelTexture MovieTexture MultiTexture). Warning: each child image node must have a different containerField value.
-
setBackTexture
Accessor method to assign X3DNode instance (using a properly typed node) to inputOutput SFNode field backTexture. // newValueInstanceAcceptableNodeTypesTest checks are needed for methods that override/subset X3DNode interfaces #1 boolean isNodeTypeAllowed = (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.sai.Texturing.X3DTexture2DNode) || (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.jsail.Texturing.MultiTextureObject); if (!isNodeTypeAllowed) { throw new org.web3d.x3d.sai.InvalidFieldValueException("X3DNode newValue is not instanceof " + "acceptableNodeTypes X3DTexture2DNode|MultiTexture; newValue=" + newValue); }- Specified by:
setBackTexture
in interfaceTextureBackground
- Parameters:
newValue
- is new value for the backTexture field.- Returns:
TextureBackgroundObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
Tooltip: [X3DTexture2DNode | MultiTexture] Parent TextureBackground element can contain up to six image nodes (ImageTexture PixelTexture MovieTexture MultiTexture). Warning: each child image node must have a different containerField value.
-
clearBackTexture
Utility method to clear SFNode value of backTexture field.- Returns:
TextureBackgroundObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setBackTexture
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field backTexture.- Parameters:
newValue
- is new value for the backTexture field.- Returns:
TextureBackgroundObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
setBackTexture(X3DNode)
-
hasBackTexture
public boolean hasBackTexture()Indicate whether an object is available for inputOutput SFNode field backTexture.- Returns:
- whether a properly typed node or ProtoInstance or CommentsBlock is available.
- See Also:
getBackTexture()
,getBackTextureProtoInstance()
-
getBindTime
public double getBindTime()Provide double value in seconds from outputOnly SFTime field named bindTime.
Tooltip: event sent when node becomes active/inactive.- Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
- Specified by:
getBindTime
in interfaceTextureBackground
- Specified by:
getBindTime
in interfaceX3DBackgroundNode
- Specified by:
getBindTime
in interfaceX3DBindableNode
- Returns:
- value of bindTime field
-
getBottomTexture
Provide X3DNode instance (using a properly typed node) with acceptable node types limited to X3DTexture2DNode|MultiTexture, from inputOutput SFNode field bottomTexture.- Specified by:
getBottomTexture
in interfaceTextureBackground
- Returns:
- value of bottomTexture field
- See Also:
Tooltip: [X3DTexture2DNode | MultiTexture] Parent TextureBackground element can contain up to six image nodes (ImageTexture PixelTexture MovieTexture MultiTexture). Warning: each child image node must have a different containerField value.
-
setBottomTexture
Accessor method to assign X3DNode instance (using a properly typed node) to inputOutput SFNode field bottomTexture. // newValueInstanceAcceptableNodeTypesTest checks are needed for methods that override/subset X3DNode interfaces #1 boolean isNodeTypeAllowed = (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.sai.Texturing.X3DTexture2DNode) || (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.jsail.Texturing.MultiTextureObject); if (!isNodeTypeAllowed) { throw new org.web3d.x3d.sai.InvalidFieldValueException("X3DNode newValue is not instanceof " + "acceptableNodeTypes X3DTexture2DNode|MultiTexture; newValue=" + newValue); }- Specified by:
setBottomTexture
in interfaceTextureBackground
- Parameters:
newValue
- is new value for the bottomTexture field.- Returns:
TextureBackgroundObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
Tooltip: [X3DTexture2DNode | MultiTexture] Parent TextureBackground element can contain up to six image nodes (ImageTexture PixelTexture MovieTexture MultiTexture). Warning: each child image node must have a different containerField value.
-
clearBottomTexture
Utility method to clear SFNode value of bottomTexture field.- Returns:
TextureBackgroundObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setBottomTexture
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field bottomTexture.- Parameters:
newValue
- is new value for the bottomTexture field.- Returns:
TextureBackgroundObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
setBottomTexture(X3DNode)
-
hasBottomTexture
public boolean hasBottomTexture()Indicate whether an object is available for inputOutput SFNode field bottomTexture.- Returns:
- whether a properly typed node or ProtoInstance or CommentsBlock is available.
- See Also:
getBottomTexture()
,getBottomTextureProtoInstance()
-
getFrontTexture
Provide X3DNode instance (using a properly typed node) with acceptable node types limited to X3DTexture2DNode|MultiTexture, from inputOutput SFNode field frontTexture.- Specified by:
getFrontTexture
in interfaceTextureBackground
- Returns:
- value of frontTexture field
- See Also:
Tooltip: [X3DTexture2DNode | MultiTexture] Parent TextureBackground element can contain up to six image nodes (ImageTexture PixelTexture MovieTexture MultiTexture). Warning: each child image node must have a different containerField value.
-
setFrontTexture
Accessor method to assign X3DNode instance (using a properly typed node) to inputOutput SFNode field frontTexture. // newValueInstanceAcceptableNodeTypesTest checks are needed for methods that override/subset X3DNode interfaces #1 boolean isNodeTypeAllowed = (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.sai.Texturing.X3DTexture2DNode) || (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.jsail.Texturing.MultiTextureObject); if (!isNodeTypeAllowed) { throw new org.web3d.x3d.sai.InvalidFieldValueException("X3DNode newValue is not instanceof " + "acceptableNodeTypes X3DTexture2DNode|MultiTexture; newValue=" + newValue); }- Specified by:
setFrontTexture
in interfaceTextureBackground
- Parameters:
newValue
- is new value for the frontTexture field.- Returns:
TextureBackgroundObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
Tooltip: [X3DTexture2DNode | MultiTexture] Parent TextureBackground element can contain up to six image nodes (ImageTexture PixelTexture MovieTexture MultiTexture). Warning: each child image node must have a different containerField value.
-
clearFrontTexture
Utility method to clear SFNode value of frontTexture field.- Returns:
TextureBackgroundObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setFrontTexture
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field frontTexture.- Parameters:
newValue
- is new value for the frontTexture field.- Returns:
TextureBackgroundObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
setFrontTexture(X3DNode)
-
hasFrontTexture
public boolean hasFrontTexture()Indicate whether an object is available for inputOutput SFNode field frontTexture.- Returns:
- whether a properly typed node or ProtoInstance or CommentsBlock is available.
- See Also:
getFrontTexture()
,getFrontTextureProtoInstance()
-
getGroundAngle
public float[] getGroundAngle()Provide array of Float results unit axis, angle (in radians) within allowed range of [0,1.5708] from inputOutput MFFloat field named groundAngle.
Tooltip: [0,pi/2] The angle array values increase from 0.0 nadir (straight down) to pi/2=1.570796 (horizon).- Warning: you must have one more groundColor value than groundAngle values.
- Warning: colors at groundAngle=0 are ignored. Interchange profile hint: this field may be ignored, applying the default value regardless.
- Hint: https://en.wikipedia.org/wiki/Radian
- Specified by:
getGroundAngle
in interfaceTextureBackground
- Specified by:
getGroundAngle
in interfaceX3DBackgroundNode
- Returns:
- value of groundAngle field
-
getGroundAngleList
public java.util.ArrayList<java.lang.Float> getGroundAngleList()Utility method to get ArrayList value of MFFloat groundAngle field, similar togetGroundAngle()
.- Returns:
- value of groundAngle field
-
getGroundAngleString
public java.lang.String getGroundAngleString()Utility method to get String value of MFFloat groundAngle field, similar togetGroundAngle()
.- Returns:
- value of groundAngle field
-
setGroundAngle
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: https://en.wikipedia.org/wiki/Radian
- Specified by:
setGroundAngle
in interfaceTextureBackground
- Specified by:
setGroundAngle
in interfaceX3DBackgroundNode
- Parameters:
newValue
- is new value for the groundAngle field.- Returns:
TextureBackgroundObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setGroundAngle
Assign typed object value to MFFloat groundAngle field, similar tosetGroundAngle(float[])
.- Parameters:
newValue
- is new value for the groundAngle field.- Returns:
TextureBackgroundObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setGroundAngle
Assign ArrayList value of MFFloat groundAngle field, similar tosetGroundAngle(float[])
.- Parameters:
newValue
- is new value for the groundAngle field.- Returns:
TextureBackgroundObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
clearGroundAngle
Utility method to clear MFFloat value of groundAngle field.- Returns:
TextureBackgroundObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setGroundAngle
Assign floating-point array value of MFFloat groundAngle field, similar tosetGroundAngle(float[])
.- Parameters:
newValue
- is new value for the groundAngle field.- Returns:
TextureBackgroundObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addGroundAngle
Add singleton float value to MFFloat groundAngle field.- Parameters:
newValue
- is new value to add to the groundAngle field.- Returns:
TextureBackgroundObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addGroundAngle
Add singleton SFFloatObject value to MFFloat groundAngle field.- Parameters:
newValue
- is new value to add to the groundAngle field.- Returns:
TextureBackgroundObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setGroundAngle
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetGroundAngle(float[])
.- Parameters:
newArray
- is new value for field- Returns:
TextureBackgroundObject
- 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 interfaceTextureBackground
- Specified by:
getGroundColor
in interfaceX3DBackgroundNode
- Returns:
- value of groundColor field
-
setGroundColor
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 interfaceTextureBackground
- Specified by:
setGroundColor
in interfaceX3DBackgroundNode
- Parameters:
newValue
- is new value for the groundColor field.- Returns:
TextureBackgroundObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setGroundColor
Assign typed object value to MFColor groundColor field, similar tosetGroundColor(float[])
.- Parameters:
newValue
- is new value for the groundColor field.- Returns:
TextureBackgroundObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addGroundColor
Add singleton SFColorObject value to MFColor groundColor field.- Parameters:
newValue
- is new value to add to the groundColor field.- Returns:
TextureBackgroundObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setGroundColor
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetGroundColor(float[])
.- Parameters:
newArray
- is new value for field- Returns:
TextureBackgroundObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getIS
Provide ISObject instance (using a properly typed node) from inputOutput SFNode field IS.- Specified by:
getIS
in classX3DConcreteNode
- Returns:
- value of IS field
- See Also:
- X3D Tooltips: IS, X3D Tooltips: connect
-
setIS
Accessor method to assign ISObject instance (using a properly typed node) to inputOutput SFNode field IS.- Specified by:
setIS
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the IS field.- Returns:
TextureBackgroundObject
- 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
Utility method to clear SFNode value of IS field.- Returns:
TextureBackgroundObject
- 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 interfaceTextureBackground
- Specified by:
getIsBound
in interfaceX3DBackgroundNode
- Specified by:
getIsBound
in interfaceX3DBindableNode
- Returns:
- value of isBound field
-
getLeftTexture
Provide X3DNode instance (using a properly typed node) with acceptable node types limited to X3DTexture2DNode|MultiTexture, from inputOutput SFNode field leftTexture.- Specified by:
getLeftTexture
in interfaceTextureBackground
- Returns:
- value of leftTexture field
- See Also:
Tooltip: [X3DTexture2DNode | MultiTexture] Parent TextureBackground element can contain up to six image nodes (ImageTexture PixelTexture MovieTexture MultiTexture). Warning: each child image node must have a different containerField value.
-
setLeftTexture
Accessor method to assign X3DNode instance (using a properly typed node) to inputOutput SFNode field leftTexture. // newValueInstanceAcceptableNodeTypesTest checks are needed for methods that override/subset X3DNode interfaces #1 boolean isNodeTypeAllowed = (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.sai.Texturing.X3DTexture2DNode) || (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.jsail.Texturing.MultiTextureObject); if (!isNodeTypeAllowed) { throw new org.web3d.x3d.sai.InvalidFieldValueException("X3DNode newValue is not instanceof " + "acceptableNodeTypes X3DTexture2DNode|MultiTexture; newValue=" + newValue); }- Specified by:
setLeftTexture
in interfaceTextureBackground
- Parameters:
newValue
- is new value for the leftTexture field.- Returns:
TextureBackgroundObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
Tooltip: [X3DTexture2DNode | MultiTexture] Parent TextureBackground element can contain up to six image nodes (ImageTexture PixelTexture MovieTexture MultiTexture). Warning: each child image node must have a different containerField value.
-
clearLeftTexture
Utility method to clear SFNode value of leftTexture field.- Returns:
TextureBackgroundObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setLeftTexture
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field leftTexture.- Parameters:
newValue
- is new value for the leftTexture field.- Returns:
TextureBackgroundObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
setLeftTexture(X3DNode)
-
hasLeftTexture
public boolean hasLeftTexture()Indicate whether an object is available for inputOutput SFNode field leftTexture.- Returns:
- whether a properly typed node or ProtoInstance or CommentsBlock is available.
- See Also:
getLeftTexture()
,getLeftTextureProtoInstance()
-
getMetadata
Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.- Specified by:
getMetadata
in interfaceTextureBackground
- Specified by:
getMetadata
in interfaceX3DBackgroundNode
- Specified by:
getMetadata
in interfaceX3DBindableNode
- Specified by:
getMetadata
in interfaceX3DChildNode
- Specified by:
getMetadata
in interfaceX3DNode
- 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/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
, X3D Scene Authoring Hints: Metadata Nodes
-
setMetadata
Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.- Specified by:
setMetadata
in interfaceTextureBackground
- Specified by:
setMetadata
in interfaceX3DBackgroundNode
- Specified by:
setMetadata
in interfaceX3DBindableNode
- Specified by:
setMetadata
in interfaceX3DChildNode
- Specified by:
setMetadata
in interfaceX3DNode
- Specified by:
setMetadata
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the metadata field.- Returns:
TextureBackgroundObject
- 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/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
, X3D Scene Authoring Hints: Metadata Nodes
-
clearMetadata
Utility method to clear SFNode value of metadata field.- Returns:
TextureBackgroundObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setMetadata
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.- Specified by:
setMetadata
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the metadata field.- Returns:
TextureBackgroundObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
setMetadata(X3DMetadataObject)
-
hasMetadata
public boolean hasMetadata()Indicate whether an object is available for inputOutput SFNode field metadata.- Returns:
- whether a properly typed node or ProtoInstance or CommentsBlock is available.
- See Also:
getMetadata()
,getMetadataProtoInstance()
, X3D Scene Authoring Hints: Metadata Nodes
-
getRightTexture
Provide X3DNode instance (using a properly typed node) with acceptable node types limited to X3DTexture2DNode|MultiTexture, from inputOutput SFNode field rightTexture.- Specified by:
getRightTexture
in interfaceTextureBackground
- Returns:
- value of rightTexture field
- See Also:
Tooltip: [X3DTexture2DNode | MultiTexture] Parent TextureBackground element can contain up to six image nodes (ImageTexture PixelTexture MovieTexture MultiTexture). Warning: each child image node must have a different containerField value.
-
setRightTexture
Accessor method to assign X3DNode instance (using a properly typed node) to inputOutput SFNode field rightTexture. // newValueInstanceAcceptableNodeTypesTest checks are needed for methods that override/subset X3DNode interfaces #1 boolean isNodeTypeAllowed = (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.sai.Texturing.X3DTexture2DNode) || (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.jsail.Texturing.MultiTextureObject); if (!isNodeTypeAllowed) { throw new org.web3d.x3d.sai.InvalidFieldValueException("X3DNode newValue is not instanceof " + "acceptableNodeTypes X3DTexture2DNode|MultiTexture; newValue=" + newValue); }- Specified by:
setRightTexture
in interfaceTextureBackground
- Parameters:
newValue
- is new value for the rightTexture field.- Returns:
TextureBackgroundObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
Tooltip: [X3DTexture2DNode | MultiTexture] Parent TextureBackground element can contain up to six image nodes (ImageTexture PixelTexture MovieTexture MultiTexture). Warning: each child image node must have a different containerField value.
-
clearRightTexture
Utility method to clear SFNode value of rightTexture field.- Returns:
TextureBackgroundObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setRightTexture
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field rightTexture.- Parameters:
newValue
- is new value for the rightTexture field.- Returns:
TextureBackgroundObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
setRightTexture(X3DNode)
-
hasRightTexture
public boolean hasRightTexture()Indicate whether an object is available for inputOutput SFNode field rightTexture.- Returns:
- whether a properly typed node or ProtoInstance or CommentsBlock is available.
- See Also:
getRightTexture()
,getRightTextureProtoInstance()
-
getSkyAngle
public float[] getSkyAngle()Provide array of Float results unit axis, angle (in radians) within allowed range of [0,3.1416] from inputOutput MFFloat field named skyAngle.
Tooltip: [0,pi] The angle array values increase from 0.0 zenith (straight up) to pi/2=1.570796 (horizon) to pi=3.14159 (nadir).- Warning: you must have one more skyColor value than skyAngle values.
- Warning: colors at skyAngle=0 are ignored. Interchange profile hint: this field may be ignored, applying the default value regardless.
- Hint: https://en.wikipedia.org/wiki/Radian
- Specified by:
getSkyAngle
in interfaceTextureBackground
- Specified by:
getSkyAngle
in interfaceX3DBackgroundNode
- Returns:
- value of skyAngle field
-
getSkyAngleList
public java.util.ArrayList<java.lang.Float> getSkyAngleList()Utility method to get ArrayList value of MFFloat skyAngle field, similar togetSkyAngle()
.- Returns:
- value of skyAngle field
-
getSkyAngleString
public java.lang.String getSkyAngleString()Utility method to get String value of MFFloat skyAngle field, similar togetSkyAngle()
.- Returns:
- value of skyAngle field
-
setSkyAngle
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: https://en.wikipedia.org/wiki/Radian
- Specified by:
setSkyAngle
in interfaceTextureBackground
- Specified by:
setSkyAngle
in interfaceX3DBackgroundNode
- Parameters:
newValue
- is new value for the skyAngle field.- Returns:
TextureBackgroundObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setSkyAngle
Assign typed object value to MFFloat skyAngle field, similar tosetSkyAngle(float[])
.- Parameters:
newValue
- is new value for the skyAngle field.- Returns:
TextureBackgroundObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setSkyAngle
Assign ArrayList value of MFFloat skyAngle field, similar tosetSkyAngle(float[])
.- Parameters:
newValue
- is new value for the skyAngle field.- Returns:
TextureBackgroundObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
clearSkyAngle
Utility method to clear MFFloat value of skyAngle field.- Returns:
TextureBackgroundObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setSkyAngle
Assign floating-point array value of MFFloat skyAngle field, similar tosetSkyAngle(float[])
.- Parameters:
newValue
- is new value for the skyAngle field.- Returns:
TextureBackgroundObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addSkyAngle
Add singleton float value to MFFloat skyAngle field.- Parameters:
newValue
- is new value to add to the skyAngle field.- Returns:
TextureBackgroundObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addSkyAngle
Add singleton SFFloatObject value to MFFloat skyAngle field.- Parameters:
newValue
- is new value to add to the skyAngle field.- Returns:
TextureBackgroundObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setSkyAngle
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetSkyAngle(float[])
.- Parameters:
newArray
- is new value for field- Returns:
TextureBackgroundObject
- 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 interfaceTextureBackground
- Specified by:
getSkyColor
in interfaceX3DBackgroundNode
- Returns:
- value of skyColor field
-
setSkyColor
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 interfaceTextureBackground
- Specified by:
setSkyColor
in interfaceX3DBackgroundNode
- Parameters:
newValue
- is new value for the skyColor field.- Returns:
TextureBackgroundObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setSkyColor
Assign typed object value to MFColor skyColor field, similar tosetSkyColor(float[])
.- Parameters:
newValue
- is new value for the skyColor field.- Returns:
TextureBackgroundObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addSkyColor
Add singleton SFColorObject value to MFColor skyColor field.- Parameters:
newValue
- is new value to add to the skyColor field.- Returns:
TextureBackgroundObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setSkyColor
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetSkyColor(float[])
.- Parameters:
newArray
- is new value for field- Returns:
TextureBackgroundObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getTopTexture
Provide X3DNode instance (using a properly typed node) with acceptable node types limited to X3DTexture2DNode|MultiTexture, from inputOutput SFNode field topTexture.- Specified by:
getTopTexture
in interfaceTextureBackground
- Returns:
- value of topTexture field
- See Also:
Tooltip: [X3DTexture2DNode | MultiTexture] Parent TextureBackground element can contain up to six image nodes (ImageTexture PixelTexture MovieTexture MultiTexture). Warning: each child image node must have a different containerField value.
-
setTopTexture
Accessor method to assign X3DNode instance (using a properly typed node) to inputOutput SFNode field topTexture. // newValueInstanceAcceptableNodeTypesTest checks are needed for methods that override/subset X3DNode interfaces #1 boolean isNodeTypeAllowed = (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.sai.Texturing.X3DTexture2DNode) || (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.jsail.Texturing.MultiTextureObject); if (!isNodeTypeAllowed) { throw new org.web3d.x3d.sai.InvalidFieldValueException("X3DNode newValue is not instanceof " + "acceptableNodeTypes X3DTexture2DNode|MultiTexture; newValue=" + newValue); }- Specified by:
setTopTexture
in interfaceTextureBackground
- Parameters:
newValue
- is new value for the topTexture field.- Returns:
TextureBackgroundObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
Tooltip: [X3DTexture2DNode | MultiTexture] Parent TextureBackground element can contain up to six image nodes (ImageTexture PixelTexture MovieTexture MultiTexture). Warning: each child image node must have a different containerField value.
-
clearTopTexture
Utility method to clear SFNode value of topTexture field.- Returns:
TextureBackgroundObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setTopTexture
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field topTexture.- Parameters:
newValue
- is new value for the topTexture field.- Returns:
TextureBackgroundObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
setTopTexture(X3DNode)
-
hasTopTexture
public boolean hasTopTexture()Indicate whether an object is available for inputOutput SFNode field topTexture.- Returns:
- whether a properly typed node or ProtoInstance or CommentsBlock is available.
- See Also:
getTopTexture()
,getTopTextureProtoInstance()
-
getTransparency
public float getTransparency()Provide float value within allowed range of [0,1] from inputOutput SFFloat field named transparency.
Tooltip: transparency applied to texture images, enabling an X3D scene to overlay an HTML page or desktop. *- Specified by:
getTransparency
in interfaceTextureBackground
- Specified by:
getTransparency
in interfaceX3DBackgroundNode
- Returns:
- value of transparency field
-
setTransparency
Accessor method to assign float value to inputOutput SFFloat field named transparency.
Tooltip: transparency applied to texture images, enabling an X3D scene to overlay an HTML page or desktop. *- Specified by:
setTransparency
in interfaceTextureBackground
- Specified by:
setTransparency
in interfaceX3DBackgroundNode
- Parameters:
newValue
- is new value for the transparency field.- Returns:
TextureBackgroundObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setTransparency
Assign typed object value to SFFloat transparency field, similar tosetTransparency(float)
.- Parameters:
newValue
- is new value for the transparency field.- Returns:
TextureBackgroundObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setTransparency
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetTransparency(float)
.- Parameters:
newValue
- is new value for field- Returns:
TextureBackgroundObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getDEF
public java.lang.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 classX3DConcreteNode
- Returns:
- value of DEF field
- See Also:
- X3D Scene Authoring Hints: Naming Conventions
-
setDEF
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 classX3DConcreteNode
- Parameters:
newValue
- is new value for the DEF field.- Returns:
TextureBackgroundObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setDEF
Assign typed object value to SFString DEF field, similar tosetDEF(String)
.- Parameters:
newValue
- is new value for the DEF field.- Returns:
TextureBackgroundObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getUSE
public java.lang.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 classX3DConcreteNode
- Returns:
- value of USE field
- See Also:
- X3D Scene Authoring Hints: Naming Conventions
-
setUSE
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: eachUSE
node is still an independent object, with theUSE
value matching theDEF
value in the preceding object.
Warning: invoking thesetUSE()
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 classX3DConcreteNode
- Parameters:
newValue
- is new value for the USE field.- Returns:
TextureBackgroundObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setUSE
Assign typed object value to SFString USE field, similar tosetUSE(String)
.- Parameters:
newValue
- is new value for the USE field.- Returns:
TextureBackgroundObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getCssClass
public java.lang.String getCssClass()Provide String value from inputOutput SFString field named class.
Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.- Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
- Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
- Overrides:
getCssClass
in classX3DConcreteNode
- Returns:
- value of class field
- See Also:
- W3C Cascading Style Sheets
-
setCssClass
Accessor method to assign String value to inputOutput SFString field named class.
Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.- Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
- Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
- Specified by:
setCssClass
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the class field.- Returns:
TextureBackgroundObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
- W3C Cascading Style Sheets
-
setCssClass
Assign typed object value to SFString cssClass field, similar tosetCssClass(String)
.- Parameters:
newValue
- is new value for the class field.- Returns:
TextureBackgroundObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setUSE
Assign a USE reference to another DEF node of same node type, similar tosetUSE(String)
.
Warning: note that thesetUSE()
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:
TextureBackgroundObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addComments
Add comment as String to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newComment
- initial value- Returns:
TextureBackgroundObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
addComments
Add comments as String[] array to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newComments
- array of comments- Returns:
TextureBackgroundObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
addComments
Add CommentsBlock to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newCommentsBlock
- block of comments to add- Returns:
TextureBackgroundObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
toStringX3D
public java.lang.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 classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- X3D string
- See Also:
X3DObject.FILE_EXTENSION_X3D
,X3DObject.FILE_EXTENSION_XML
,X3DObject.toStringXML()
,X3DObject.toFileXML(String)
,X3DObject.toFileX3D(String)
, X3D XML Encoding, X3D Compressed Binary Encoding: X3D Canonical Form, X3D Canonicalization (C14N) Tool
-
toStringClassicVRML
public java.lang.String toStringClassicVRML(int indentLevel)Recursive method to provide ClassicVRML string serialization.- Specified by:
toStringClassicVRML
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- ClassicVRML string
- See Also:
X3DObject.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 java.lang.String toStringVRML97(int indentLevel)Recursive method to provide VRML97 string serialization.- Specified by:
toStringVRML97
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- VRML97 string
- See Also:
X3DObject.FILE_EXTENSION_VRML97
, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Virtual Reality Modeling Language (VRML) 97 specification, VRML 97 v2.1 Amendment
-
findElementByNameValue
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 findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() 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 classX3DConcreteElement
- 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.hasAncestorSceneObject()
,X3DConcreteElement.findAncestorX3DObject()
-
findElementByNameValue
public X3DConcreteElement findElementByNameValue(java.lang.String nameValue, java.lang.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 findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() 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 classX3DConcreteElement
- 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.hasAncestorSceneObject()
,X3DConcreteElement.findAncestorX3DObject()
-
hasElementByNameValue
public boolean hasElementByNameValue(java.lang.String nameValue, java.lang.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
Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() 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 classX3DConcreteElement
- 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.hasAncestorSceneObject()
,X3DConcreteElement.findAncestorX3DObject()
-
hasNodeByDEF
public boolean hasNodeByDEF(java.lang.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 java.lang.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.- Specified by:
validate
in classX3DConcreteElement
- Returns:
- validation results (if any)
-