Class RenderedTexture

java.lang.Object

org.web3d.x3d.jsail.X3DConcreteElement

org.web3d.x3d.jsail.X3DConcreteNode

org.web3d.x3d.jsail.Texturing.RenderedTexture

All Implemented Interfaces:

X3DNode, X3DUrlOutputObject, X3DAppearanceChildNode, RenderedTexture, X3DSingleTextureNode, X3DTexture2DNode, X3DTextureNode

public class RenderedTexture
extends X3DConcreteNode
implements RenderedTexture

RenderedTexture is a texture node that renders the view from a local viewpoint or separate scene into an offscreen buffer, producing an image or depth map that can be rendered from model geometry in real time.

RenderedTexture node tooltip: (X3D version 4.1 draft) [X3DTexture2DNode, X3DUrlOutputObject, X3DNetworkSensorNode] RenderedTexture is a texture node that renders the view from a local viewpoint or separate scene into an offscreen buffer, producing an image or depth map that can be rendered from model geometry in real time. The output renderings can optionally be saved via the url field as a local file or a stream source. RenderedTexture enables effects such as dynamic reflections, live video screens, or portal views by continuously updating the texture based on the rendered content. RenderedTexture creates a 2D-image texture map using a numeric array of pixel values. Texture maps have a 2D coordinate system (s, t) horizontal and vertical, with (s, t) texture-coordinate values in range [0.0, 1.0] for opposite corners of the image.

• Hint: if no Viewpoint or OrthoViewpoint is a child node, then the currently bound viewpoint in the scene is used as the perspective point.
• Warning: aggregate file size can grow dramatically.
• Hint: can contain a single TextureProperties node.
• Hint: insert parent Shape and Appearance nodes before adding texture.
• Hint: X3D Scene Authoring Hints, Images and Videos https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Images
• Warning: see ComposedCubeMapTexture and TextureBackground for special containerField values.
• Hint: if a texture is opaque, omitting values in the alpha channel can help avoid rendering artifacts related to transparency.
• Hint: Texture coordinates are reapplied (or else recomputed if textureTransform field initially NULL) whenever the corresponding vertex-based geometry changes.
• Hint: Texture mapping https://en.wikipedia.org/wiki/Texture_mapping
• Hint: X3D Architecture 17.2.2 Lighting model https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/lighting.html#Lightingmodel

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

Field Summary

Fields

Modifier and Type	Field	Description
static final int	COLORDEPTH_DEFAULT_VALUE	SFInt32 field named colorDepth has default value 4 (Java syntax) or 4 (XML syntax).
static final String	COMPONENT	String constant COMPONENT defines X3D component for the RenderedTexture element: Texturing
static final String	containerField_DEFAULT_VALUE	containerField describes typical field relationship of a node to its parent.
static final boolean	DEPTHMAP_DEFAULT_VALUE	SFBool field named depthMap has default value false (Java syntax) or false (XML syntax).
static final String	DESCRIPTION_DEFAULT_VALUE	SFString field named description has default value equal to an empty string.
static final String	fromField_COLORDEPTH	fromField ROUTE name for SFInt32 field named colorDepth.
static final String	fromField_DEPTHMAP	fromField ROUTE name for SFBool field named depthMap.
static final String	fromField_DESCRIPTION	fromField ROUTE name for SFString field named description.
static final String	fromField_IS	fromField ROUTE name for SFNode field named IS.
static final String	fromField_ISACTIVE	fromField ROUTE name for SFBool field named isActive.
static final String	fromField_MAXNUMBERFRAMES	fromField ROUTE name for SFInt32 field named maxNumberFrames.
static final String	fromField_METADATA	fromField ROUTE name for SFNode field named metadata.
static final String	fromField_REPLACEIMAGE	fromField ROUTE name for SFBool field named replaceImage.
static final String	fromField_SINGLEFRAME	fromField ROUTE name for SFBool field named singleFrame.
static final String	fromField_UPDATE	fromField ROUTE name for SFString field named update.
static final String	fromField_UPDATEINTERVAL	fromField ROUTE name for SFTime field named updateInterval.
static final String	fromField_URL	fromField ROUTE name for MFString field named url.
static final String	fromField_WIDTH	fromField ROUTE name for SFInt32 field named width.
static final int	HEIGHT_DEFAULT_VALUE	SFInt32 field named height has default value 128 (Java syntax) or 128 (XML syntax).
static final IS	IS_DEFAULT_VALUE	SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).
static final int	LEVEL	Integer constant LEVEL provides default X3D Texturing component level for this element: 4
static final int	MAXNUMBERFRAMES_DEFAULT_VALUE	SFInt32 field named maxNumberFrames has default value 1000 (Java syntax) or 1000 (XML syntax).
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: RenderedTexture.
static final boolean	REPEATS_DEFAULT_VALUE	SFBool field named repeatS has default value true (Java syntax) or true (XML syntax).
static final boolean	REPEATT_DEFAULT_VALUE	SFBool field named repeatT has default value true (Java syntax) or true (XML syntax).
static final boolean	REPLACEIMAGE_DEFAULT_VALUE	SFBool field named replaceImage has default value true (Java syntax) or true (XML syntax).
static final boolean	SINGLEFRAME_DEFAULT_VALUE	SFBool field named singleFrame has default value true (Java syntax) or true (XML syntax).
static final TextureProperties	TEXTUREPROPERTIES_DEFAULT_VALUE	SFNode field named textureProperties has default value null (Java syntax) or NULL (XML syntax).
static final String	toField_COLORDEPTH	toField ROUTE name for SFInt32 field named colorDepth.
static final String	toField_DEPTHMAP	toField ROUTE name for SFBool field named depthMap.
static final String	toField_DESCRIPTION	toField ROUTE name for SFString field named description.
static final String	toField_MAXNUMBERFRAMES	toField ROUTE name for SFInt32 field named maxNumberFrames.
static final String	toField_METADATA	toField ROUTE name for SFNode field named metadata.
static final String	toField_REPLACEIMAGE	toField ROUTE name for SFBool field named replaceImage.
static final String	toField_SINGLEFRAME	toField ROUTE name for SFBool field named singleFrame.
static final String	toField_UPDATE	toField ROUTE name for SFString field named update.
static final String	toField_UPDATEINTERVAL	toField ROUTE name for SFTime field named updateInterval.
static final String	toField_URL	toField ROUTE name for MFString field named url.
static final String	toField_WIDTH	toField ROUTE name for SFInt32 field named width.
static final String	UPDATE_ALWAYS	Tooltip: texture to be rendered every frame.
static final String	UPDATE_DEFAULT_VALUE	SFString field named update has default value "NONE" (Java syntax) or NONE (XML syntax).
static final String	UPDATE_NEXT_FRAME_ONLY	Tooltip: render texture once at end of frame.
static final String	UPDATE_NONE	Tooltip: no further texture updates are rendered.
static final double	UPDATEINTERVAL_DEFAULT_VALUE	SFTime field named updateInterval has default value 0.1 (Java syntax) or 0.1 (XML syntax).
static final int	WIDTH_DEFAULT_VALUE	SFInt32 field named width has default value 128 (Java syntax) or 128 (XML syntax).

Fields inherited from class X3DConcreteNode

containerField_ALLOWED_VALUES, containerFieldOverride

Modifier and Type	Field	Description
String[]	containerField_ALLOWED_VALUES	This string array provides all allowed containerField values for this node, starting with the default value.
String	containerFieldOverride	Warning: containerFieldOverride describes a non-default field relationship of a node to its parent, overriding the default or alternate containerField value.

Fields inherited from class X3DConcreteElement

validationResult

Modifier and Type	Field	Description
protected StringBuilder	validationResult	Results log of local validation.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
RenderedTexture	addComments(String newComment)	Add comment as String to contained commentsList.
RenderedTexture	addComments(String[] newComments)	Add comments as String[] array to contained commentsList.
RenderedTexture	addComments(CommentsBlock newCommentsBlock)	Add CommentsBlock to contained commentsList.
RenderedTexture	addUrl(String newValue)	Add singleton String value to MFString url field, allowing duplicate and empty string values if provided.
RenderedTexture	addUrl(SFString newValue)	Add singleton SFString value to MFString url field, allowing duplicate or empty string values if provided.
RenderedTexture	clearIS()	Utility method to clear SFNode value of IS field.
RenderedTexture	clearMetadata()	Utility method to clear SFNode value of metadata field.
RenderedTexture	clearTextureProperties()	Utility method to clear SFNode value of textureProperties field.
RenderedTexture	clearUrl()	Utility method to clear MFString value of url 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.
int	getColorDepth()	Provide int value using RGB values [0..1] from inputOutput SFInt32 field named colorDepth.
static final int	getColorDepthDefault()	Public accessor for encapsulated SFInt32 default value 4, returned as int.
final String	getComponent()	Defines X3D component for the RenderedTexture element: Texturing
final int	getComponentLevel()	Provides default X3D component level for this element: 4
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.
boolean	getDepthMap()	Provide boolean value from inputOutput SFBool field named depthMap.
static final boolean	getDepthMapDefault()	Public accessor for encapsulated SFBool default value false, returned as boolean.
String	getDescription()	Provide String value from inputOutput SFString field named description.
static final String	getDescriptionDefault()	Public accessor for encapsulated SFString default value, returned as String.
final String	getElementName()	Provides name of this element: RenderedTexture
String	getFieldType(String fieldName)	Indicate type corresponding to given fieldName.
int	getHeight()	Provide int value from initializeOnly SFInt32 field named height.
static final int	getHeightDefault()	Public accessor for encapsulated SFInt32 default value 128, returned as int.
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	getIsActive()	Provide boolean value from outputOnly SFBool field named isActive.
static final IS	getISDefault()	Public accessor for encapsulated SFNode default value null, returned as IS.
int	getMaxNumberFrames()	Provide int value from inputOutput SFInt32 field named maxNumberFrames.
static final int	getMaxNumberFramesDefault()	Public accessor for encapsulated SFInt32 default value 1000, returned as int.
X3DMetadataObject	getMetadata()	Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
static final X3DMetadataObject	getMetadataDefault()	Public accessor for encapsulated SFNode default value null, returned as org.web3d.x3d.sai.Core.X3DMetadataObject.
boolean	getRepeatS()	Provide boolean value from initializeOnly SFBool field named repeatS.
static final boolean	getRepeatSDefault()	Public accessor for encapsulated SFBool default value true, returned as boolean.
boolean	getRepeatT()	Provide boolean value from initializeOnly SFBool field named repeatT.
static final boolean	getRepeatTDefault()	Public accessor for encapsulated SFBool default value true, returned as boolean.
boolean	getReplaceImage()	Provide boolean value from inputOutput SFBool field named replaceImage.
static final boolean	getReplaceImageDefault()	Public accessor for encapsulated SFBool default value true, returned as boolean.
boolean	getSingleFrame()	Provide boolean value from inputOutput SFBool field named singleFrame.
static final boolean	getSingleFrameDefault()	Public accessor for encapsulated SFBool default value true, returned as boolean.
TextureProperties	getTextureProperties()	Provide org.web3d.x3d.sai.Texturing.TextureProperties instance (using a properly typed node) from initializeOnly SFNode field textureProperties.
static final TextureProperties	getTexturePropertiesDefault()	Public accessor for encapsulated SFNode default value null, returned as org.web3d.x3d.sai.Texturing.TextureProperties.
String	getUpdate()	Provide String enumeration value (baseType xs:NMTOKEN) ["NONE" | "NEXT_FRAME_ONLY" | "ALWAYS"] from inputOutput SFString field named update.
static final String	getUpdateDefault()	Public accessor for encapsulated SFString default value "NONE", returned as String.
double	getUpdateInterval()	Provide double value in seconds from inputOutput SFTime field named updateInterval.
static final double	getUpdateIntervalDefault()	Public accessor for encapsulated SFTime default value 0.1, returned as double.
String[]	getUrl()	Provide array of String results from inputOutput MFString field named url.
static final String[]	getUrlDefault()	Public accessor for encapsulated MFString default value array, returned as String array.
static final ArrayList<String>	getUrlDefaultList()	Public accessor for encapsulated MFString default value , returned as ArrayList
ArrayList<String>	getUrlList()	Utility method to get ArrayList value of MFString url field, similar to getUrl().
String	getUrlString()	Utility method to get String value of MFString url field, similar to getUrl().
String	getUSE()	Provide String value from inputOutput SFString field named USE.
int	getWidth()	Provide int value from inputOutput SFInt32 field named width.
static final int	getWidthDefault()	Public accessor for encapsulated SFInt32 default value 128, returned as int.
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.
boolean	hasTextureProperties()	Indicate whether an object is available for initializeOnly SFNode field textureProperties.
final void	initialize()	Initialize all member variables to default values.
RenderedTexture	setColorDepth(int newValue)	Accessor method to assign int value to inputOutput SFInt32 field named colorDepth.
RenderedTexture	setColorDepth(SFInt32 newValue)	Assign typed object value to SFInt32 colorDepth field, similar to setColorDepth(int).
final RenderedTexture	setCssClass(String newValue)	Accessor method to assign String value to inputOutput SFString field named class.
RenderedTexture	setCssClass(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssClass(String).
final RenderedTexture	setCssStyle(String newValue)	Accessor method to assign String value to inputOutput SFString field named style.
RenderedTexture	setCssStyle(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssStyle(String).
final RenderedTexture	setDEF(String newValue)	Accessor method to assign String value to inputOutput SFString field named DEF.
RenderedTexture	setDEF(SFString newValue)	Assign typed object value to SFString DEF field, similar to setDEF(String).
RenderedTexture	setDepthMap(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named depthMap.
RenderedTexture	setDepthMap(SFBool newValue)	Assign typed object value to SFBool depthMap field, similar to setDepthMap(boolean).
RenderedTexture	setDescription(String newValue)	Accessor method to assign String value to inputOutput SFString field named description.
RenderedTexture	setDescription(SFString newValue)	Assign typed object value to SFString description field, similar to setDescription(String).
RenderedTexture	setHeight(int newValue)	Accessor method to assign int value to initializeOnly SFInt32 field named height.
RenderedTexture	setHeight(SFInt32 newValue)	Assign typed object value to SFInt32 height field, similar to setHeight(int).
final RenderedTexture	setHtmlId(String newValue)	Accessor method to assign String value to inputOutput SFString field named id.
RenderedTexture	setHtmlId(SFString newValue)	Assign typed object value to SFString HtmlId field, similar to setHtmlId(String).
RenderedTexture	setIS(IS newValue)	Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
RenderedTexture	setMaxNumberFrames(int newValue)	Accessor method to assign int value to inputOutput SFInt32 field named maxNumberFrames.
RenderedTexture	setMaxNumberFrames(SFInt32 newValue)	Assign typed object value to SFInt32 maxNumberFrames field, similar to setMaxNumberFrames(int).
RenderedTexture	setMetadata(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
RenderedTexture	setMetadata(X3DMetadataObject newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
RenderedTexture	setRepeatS(boolean newValue)	Accessor method to assign boolean value to initializeOnly SFBool field named repeatS.
RenderedTexture	setRepeatS(SFBool newValue)	Assign typed object value to SFBool repeatS field, similar to setRepeatS(boolean).
RenderedTexture	setRepeatT(boolean newValue)	Accessor method to assign boolean value to initializeOnly SFBool field named repeatT.
RenderedTexture	setRepeatT(SFBool newValue)	Assign typed object value to SFBool repeatT field, similar to setRepeatT(boolean).
RenderedTexture	setReplaceImage(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named replaceImage.
RenderedTexture	setReplaceImage(SFBool newValue)	Assign typed object value to SFBool replaceImage field, similar to setReplaceImage(boolean).
RenderedTexture	setSingleFrame(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named singleFrame.
RenderedTexture	setSingleFrame(SFBool newValue)	Assign typed object value to SFBool singleFrame field, similar to setSingleFrame(boolean).
RenderedTexture	setTextureProperties(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to initializeOnly SFNode field textureProperties.
RenderedTexture	setTextureProperties(TextureProperties newValue)	Accessor method to assign org.web3d.x3d.sai.Texturing.TextureProperties instance (using a properly typed node) to initializeOnly SFNode field textureProperties.
RenderedTexture	setUpdate(String newValue)	Accessor method to assign String enumeration value ("NONE" | "NEXT_FRAME_ONLY" | "ALWAYS") to inputOutput SFString field named update.
RenderedTexture	setUpdate(SFString newValue)	Assign typed object value to SFString update field, similar to setUpdate(String).
RenderedTexture	setUpdateInterval(double newValue)	Accessor method to assign double value in seconds to inputOutput SFTime field named updateInterval.
RenderedTexture	setUpdateInterval(SFTime newValue)	Assign typed object value to SFTime updateInterval field, similar to setUpdateInterval(double).
RenderedTexture	setUrl(String newValue)	Assign singleton String value to MFString url field, similar to setUrl(String[]).
RenderedTexture	setUrl(String[] newValue)	Accessor method to assign String array to inputOutput MFString field named url.
RenderedTexture	setUrl(ArrayList<String> newValue)	Assign ArrayList value of MFString url field, similar to setUrl(String[]).
RenderedTexture	setUrl(MFString newValue)	Assign typed object value to MFString url field, similar to setUrl(String[]).
RenderedTexture	setUrl(SFString newValue)	Assign single SFString object value to MFString url field, similar to setUrl(String[]).
final RenderedTexture	setUSE(String newValue)	Accessor method to assign String value to inputOutput SFString field named USE.
RenderedTexture	setUSE(SFString newValue)	Assign typed object value to SFString USE field, similar to setUSE(String).
RenderedTexture	setUSE(RenderedTexture DEFnode)	Assign a USE reference to another DEF node of same node type, similar to setUSE(String).
RenderedTexture	setWidth(int newValue)	Accessor method to assign int value to inputOutput SFInt32 field named width.
RenderedTexture	setWidth(SFInt32 newValue)	Assign typed object value to SFInt32 width field, similar to setWidth(int).
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 X3DConcreteNode

getContainerFieldAllowedValues, getContainerFieldOverride, getDEFDefault, getName, getUSEDefault, hasDEF, hasNameField, hasUSE, includesNameField, isNode, isStatement, resetContainerFieldOverride, setConcreteDEF, setConcreteUSE, setContainerFieldOverride

Modifier and Type	Method	Description
String[]	getContainerFieldAllowedValues()	containerField describes the field relationship of a node to its parent.
String	getContainerFieldOverride()	Warning: containerFieldOverride describes a non-default field relationship of a node to its parent, overriding the default or alternate containerField value.
String	getDEFDefault()	Public SFString accessor for field named DEF has default value equal to an empty string.
String	getName()	Utility method to permit querying name value
String	getUSEDefault()	Public SFString accessor for field named USE has default value equal to an empty string.
boolean	hasDEF()	Utility method to indicate whether this element has a DEF identifier.
boolean	hasNameField()	Whether or not this class has a getName() method
boolean	hasUSE()	Utility method to indicate whether this element has a USE reference to another previously defined element (which means other fields must be empty).
protected void	includesNameField()	Protected method for X3DJSAIL class initialize() methods to indicate whether the current concrete node has a getName() method
static final boolean	isNode()	Utility method to indicate whether this element is an X3D Graphics node (implementing X3DConcreteNode), returns true.
static final boolean	isStatement()	Utility method to indicate whether this element is an X3D Graphics statement (implementing X3DConcreteStatement), returns false.
void	resetContainerFieldOverride()	Warning: containerFieldOverride describes a non-default field relationship of a node to its parent, overriding the default or alternate containerField value.
protected void	setConcreteDEF(String newValue)	Protected internal superclass method to keep DEF private, scene authors should use method setDEF(newValue) instead.
protected final void	setConcreteUSE(String newValue)	Protected internal superclass method to keep USE private, scene authors should use method setUse(newValue) instead.
X3DConcreteNode	setContainerFieldOverride(String value)	Warning: containerFieldOverride describes a non-default field relationship of a node to its parent, overriding the default or alternate containerField value.

Methods inherited from class X3DConcreteElement

addComments, clearParent, findAncestorElementByName, findAncestorProtoBody, findAncestorScene, findAncestorX3D, getCssClassDefault, getCssStyleDefault, getHtmlIdDefault, getPackageName, getParent, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorScene, hasAncestorX3D, hasParent, isValid, setConcreteCssClass, setConcreteCssStyle, setConcreteHtmlId, setParent, toStringClassicVRML, toStringVRML97, toStringX3D

Modifier and Type	Method	Description
X3DConcreteElement	addComments()	Debug support: adding empty comment as CommentsBlock to children field has no effect.
void	clearParent()	Package-protected internal method to clear local reference to parent object, if any.
X3DConcreteElement	findAncestorElementByName(String ancestorElementName)	Find object reference to ancestor element (i.e. node or statement), if this object is an attached child.
ProtoBody	findAncestorProtoBody()	Find object reference to ancestor ProtoBody, if this node or statement is a child.
Scene	findAncestorScene()	Find object reference to ancestor Scene element, assumes this object is an attached child.
X3D	findAncestorX3D()	Find object reference to ancestor X3D element, if this node or statement is part of an X3D object.
static final String	getCssClassDefault()	Public SFString accessor for field named class for CSS has default value equal to an empty string.
static final String	getCssStyleDefault()	Public SFString accessor for field named style for CSS has default value equal to an empty string.
static final String	getHtmlIdDefault()	Public SFString accessor for field named id for html has default value equal to an empty string.
static String	getPackageName(String className)	Provide fully qualified package for a given element object, including className.
X3DConcreteElement	getParent()	Provide object reference to parent X3D node or statement, if any.
String	getValidationResult()	Get output of results from prior validation, if any
boolean	hasAncestorElementByName(String ancestorElementName)	Determine whether ancestor element (i.e. node or statement) is found, meaning this object is an attached child.
boolean	hasAncestorProtoBody()	Determine whether ancestor ProtoBody element is found, meaning this object is an attached child.
boolean	hasAncestorScene()	Determine whether ancestor Scene element is found, meaning this object is an attached child.
boolean	hasAncestorX3D()	Determine whether ancestor X3D element is found, meaning this object is an attached child.
boolean	hasParent()	Whether parent object exists.
boolean	isValid()	Recursive method to determine whether this element is valid.
protected void	setConcreteCssClass(String newValue)	Protected internal superclass method to keep cssClass private, scene authors should use method setCssClass(newValue) instead.
protected void	setConcreteCssStyle(String newValue)	Protected internal superclass method to keep cssStyles private, scene authors should use method setCssStyle(newValue) instead.
protected void	setConcreteHtmlId(String newValue)	Protected internal superclass method to keep HTML id private, scene authors should use method setHtmlId(newValue) instead.
void	setParent(X3DConcreteElement newParentObject)	Package-internal method to set parent object reference.
String	toStringClassicVRML()	Recursive method to provide ClassicVRML string serialization.
String	toStringVRML97()	Recursive method to provide VRML97 string serialization.
String	toStringX3D()	Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.

Methods inherited from class Object

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

Field Details

UPDATE_NONE

public static final String UPDATE_NONE

Tooltip: no further texture updates are rendered. SFString field named update with X3DUOM simpleType generatedCubeMapTextureUpdateChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "NONE" (Java syntax) or NONE (XML syntax).

See Also:

• XML Schema: generatedCubeMapTextureUpdateChoices
• Constant Field Values

UPDATE_NEXT_FRAME_ONLY

public static final String UPDATE_NEXT_FRAME_ONLY

Tooltip: render texture once at end of frame. SFString field named update with X3DUOM simpleType generatedCubeMapTextureUpdateChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "NEXT_FRAME_ONLY" (Java syntax) or NEXT_FRAME_ONLY (XML syntax).

See Also:

• XML Schema: generatedCubeMapTextureUpdateChoices
• Constant Field Values

UPDATE_ALWAYS

public static final String UPDATE_ALWAYS

Tooltip: texture to be rendered every frame. SFString field named update with X3DUOM simpleType generatedCubeMapTextureUpdateChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "ALWAYS" (Java syntax) or ALWAYS (XML syntax).

See Also:

• XML Schema: generatedCubeMapTextureUpdateChoices
• Constant Field Values

NAME

public static final String NAME

String constant NAME provides name of this element: RenderedTexture.

See Also:

• Constant Field Values

COMPONENT

public static final String COMPONENT

String constant COMPONENT defines X3D component for the RenderedTexture element: Texturing

See Also:

• Constant Field Values

LEVEL

public static final int LEVEL

Integer constant LEVEL provides default X3D Texturing component level for this element: 4

See Also:

• Constant Field Values

COLORDEPTH_DEFAULT_VALUE

public static final int COLORDEPTH_DEFAULT_VALUE

SFInt32 field named colorDepth has default value 4 (Java syntax) or 4 (XML syntax).

See Also:

• Constant Field Values

DEPTHMAP_DEFAULT_VALUE

public static final boolean DEPTHMAP_DEFAULT_VALUE

SFBool field named depthMap has default value false (Java syntax) or false (XML syntax).

See Also:

• Constant Field Values

DESCRIPTION_DEFAULT_VALUE

public static final String DESCRIPTION_DEFAULT_VALUE

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

See Also:

• Constant Field Values

HEIGHT_DEFAULT_VALUE

public static final int HEIGHT_DEFAULT_VALUE

SFInt32 field named height has default value 128 (Java syntax) or 128 (XML syntax).

See Also:

• Constant Field Values

IS_DEFAULT_VALUE

public static final IS IS_DEFAULT_VALUE

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

MAXNUMBERFRAMES_DEFAULT_VALUE

public static final int MAXNUMBERFRAMES_DEFAULT_VALUE

SFInt32 field named maxNumberFrames has default value 1000 (Java syntax) or 1000 (XML syntax).

See Also:

• Constant Field Values

METADATA_DEFAULT_VALUE

public static final X3DMetadataObject METADATA_DEFAULT_VALUE

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

REPEATS_DEFAULT_VALUE

public static final boolean REPEATS_DEFAULT_VALUE

SFBool field named repeatS has default value true (Java syntax) or true (XML syntax).

See Also:

• Constant Field Values

REPEATT_DEFAULT_VALUE

public static final boolean REPEATT_DEFAULT_VALUE

SFBool field named repeatT has default value true (Java syntax) or true (XML syntax).

See Also:

• Constant Field Values

REPLACEIMAGE_DEFAULT_VALUE

public static final boolean REPLACEIMAGE_DEFAULT_VALUE

SFBool field named replaceImage has default value true (Java syntax) or true (XML syntax).

See Also:

• Constant Field Values

SINGLEFRAME_DEFAULT_VALUE

public static final boolean SINGLEFRAME_DEFAULT_VALUE

SFBool field named singleFrame has default value true (Java syntax) or true (XML syntax).

See Also:

• Constant Field Values

TEXTUREPROPERTIES_DEFAULT_VALUE

public static final TextureProperties TEXTUREPROPERTIES_DEFAULT_VALUE

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

UPDATE_DEFAULT_VALUE

public static final String UPDATE_DEFAULT_VALUE

SFString field named update has default value "NONE" (Java syntax) or NONE (XML syntax).

See Also:

• Constant Field Values

UPDATEINTERVAL_DEFAULT_VALUE

public static final double UPDATEINTERVAL_DEFAULT_VALUE

SFTime field named updateInterval has default value 0.1 (Java syntax) or 0.1 (XML syntax).

See Also:

• Constant Field Values

WIDTH_DEFAULT_VALUE

public static final int WIDTH_DEFAULT_VALUE

SFInt32 field named width has default value 128 (Java syntax) or 128 (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 = "texture";
containerField_ALLOWED_VALUES = {"texture" }; type X3DUOM containerFieldChoicesX3DTexture2DNode

See Also:

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

fromField_COLORDEPTH

public static final String fromField_COLORDEPTH

fromField ROUTE name for SFInt32 field named colorDepth.

See Also:

• Constant Field Values

toField_COLORDEPTH

public static final String toField_COLORDEPTH

toField ROUTE name for SFInt32 field named colorDepth.

See Also:

• Constant Field Values

fromField_DEPTHMAP

public static final String fromField_DEPTHMAP

fromField ROUTE name for SFBool field named depthMap.

See Also:

• Constant Field Values

toField_DEPTHMAP

public static final String toField_DEPTHMAP

toField ROUTE name for SFBool field named depthMap.

See Also:

• Constant Field Values

fromField_DESCRIPTION

public static final String fromField_DESCRIPTION

fromField ROUTE name for SFString field named description.

See Also:

• Constant Field Values

toField_DESCRIPTION

public static final String toField_DESCRIPTION

toField ROUTE name for SFString field named description.

See Also:

• Constant Field Values

fromField_IS

public static final String fromField_IS

fromField ROUTE name for SFNode field named IS.

See Also:

• Constant Field Values

fromField_ISACTIVE

public static final String fromField_ISACTIVE

fromField ROUTE name for SFBool field named isActive.

See Also:

• Constant Field Values

fromField_MAXNUMBERFRAMES

public static final String fromField_MAXNUMBERFRAMES

fromField ROUTE name for SFInt32 field named maxNumberFrames.

See Also:

• Constant Field Values

toField_MAXNUMBERFRAMES

public static final String toField_MAXNUMBERFRAMES

toField ROUTE name for SFInt32 field named maxNumberFrames.

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_REPLACEIMAGE

public static final String fromField_REPLACEIMAGE

fromField ROUTE name for SFBool field named replaceImage.

See Also:

• Constant Field Values

toField_REPLACEIMAGE

public static final String toField_REPLACEIMAGE

toField ROUTE name for SFBool field named replaceImage.

See Also:

• Constant Field Values

fromField_SINGLEFRAME

public static final String fromField_SINGLEFRAME

fromField ROUTE name for SFBool field named singleFrame.

See Also:

• Constant Field Values

toField_SINGLEFRAME

public static final String toField_SINGLEFRAME

toField ROUTE name for SFBool field named singleFrame.

See Also:

• Constant Field Values

fromField_UPDATE

public static final String fromField_UPDATE

fromField ROUTE name for SFString field named update.

See Also:

• Constant Field Values

toField_UPDATE

public static final String toField_UPDATE

toField ROUTE name for SFString field named update.

See Also:

• Constant Field Values

fromField_UPDATEINTERVAL

public static final String fromField_UPDATEINTERVAL

fromField ROUTE name for SFTime field named updateInterval.

See Also:

• Constant Field Values

toField_UPDATEINTERVAL

public static final String toField_UPDATEINTERVAL

toField ROUTE name for SFTime field named updateInterval.

See Also:

• Constant Field Values

fromField_URL

public static final String fromField_URL

fromField ROUTE name for MFString field named url.

See Also:

• Constant Field Values

toField_URL

public static final String toField_URL

toField ROUTE name for MFString field named url.

See Also:

• Constant Field Values

fromField_WIDTH

public static final String fromField_WIDTH

fromField ROUTE name for SFInt32 field named width.

See Also:

• Constant Field Values

toField_WIDTH

public static final String toField_WIDTH

toField ROUTE name for SFInt32 field named width.

See Also:

• Constant Field Values

Constructor Details

RenderedTexture

public RenderedTexture()

Constructor for RenderedTexture to initialize member variables with default values.

RenderedTexture

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

Specified by:

getElementName in class X3DConcreteElement

Returns:

name of this element

getComponent

public final String getComponent()

Defines X3D component for the RenderedTexture element: Texturing

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

Specified by:

getComponentLevel in class X3DConcreteElement

Returns:

default X3D component level for this element

getColorDepthDefault

public static final int getColorDepthDefault()

Public accessor for encapsulated SFInt32 default value 4, returned as int.

Returns:

default value

getDepthMapDefault

public static final boolean getDepthMapDefault()

Public accessor for encapsulated SFBool default value false, returned as boolean.

Returns:

default value

getDescriptionDefault

public static final String getDescriptionDefault()

Public accessor for encapsulated SFString default value, returned as String.

Returns:

default value

getHeightDefault

public static final int getHeightDefault()

Public accessor for encapsulated SFInt32 default value 128, returned as int.

Returns:

default value

getISDefault

public static final IS getISDefault()

Public accessor for encapsulated SFNode default value null, returned as IS.

Returns:

default value

getMaxNumberFramesDefault

public static final int getMaxNumberFramesDefault()

Public accessor for encapsulated SFInt32 default value 1000, returned as int.

Returns:

default value

getMetadataDefault

public static final X3DMetadataObject getMetadataDefault()

Public accessor for encapsulated SFNode default value null, returned as org.web3d.x3d.sai.Core.X3DMetadataObject.

Returns:

default value

getRepeatSDefault

public static final boolean getRepeatSDefault()

Public accessor for encapsulated SFBool default value true, returned as boolean.

Returns:

default value

getRepeatTDefault

public static final boolean getRepeatTDefault()

Public accessor for encapsulated SFBool default value true, returned as boolean.

Returns:

default value

getReplaceImageDefault

public static final boolean getReplaceImageDefault()

Public accessor for encapsulated SFBool default value true, returned as boolean.

Returns:

default value

getSingleFrameDefault

public static final boolean getSingleFrameDefault()

Public accessor for encapsulated SFBool default value true, returned as boolean.

Returns:

default value

getTexturePropertiesDefault

public static final TextureProperties getTexturePropertiesDefault()

Public accessor for encapsulated SFNode default value null, returned as org.web3d.x3d.sai.Texturing.TextureProperties.

Returns:

default value

getUpdateDefault

public static final String getUpdateDefault()

Public accessor for encapsulated SFString default value "NONE", returned as String.

Returns:

default value

getUpdateIntervalDefault

public static final double getUpdateIntervalDefault()

Public accessor for encapsulated SFTime default value 0.1, returned as double.

Returns:

default value

getUrlDefault

public static final String[] getUrlDefault()

Public accessor for encapsulated MFString default value array, returned as String array.

Returns:

default value

getUrlDefaultList

public static final ArrayList<String> getUrlDefaultList()

Public accessor for encapsulated MFString default value , returned as ArrayList

Returns:

default value

getWidthDefault

public static final int getWidthDefault()

Public accessor for encapsulated SFInt32 default value 128, returned as int.

Returns:

default value

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

getColorDepth

public int getColorDepth()

Provide int value using RGB values [0..1] from inputOutput SFInt32 field named colorDepth.

Tooltip: [1,4] number of color components for the rendered texture.

• Hint: components in each pixel value are 1 (intensity), 2 (intensity alpha), 3 (RGB red green blue), 4 (RGBA red green blue alpha-opacity).

Specified by:

getColorDepth in interface RenderedTexture

Returns:

value of colorDepth field

setColorDepth

public RenderedTexture setColorDepth(int newValue)

Accessor method to assign int value to inputOutput SFInt32 field named colorDepth.

Tooltip: [1,4] number of color components for the rendered texture.

• Hint: components in each pixel value are 1 (intensity), 2 (intensity alpha), 3 (RGB red green blue), 4 (RGBA red green blue alpha-opacity).

Specified by:

setColorDepth in interface RenderedTexture

Parameters:

newValue - is new value for the colorDepth field.

Returns:

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

setColorDepth

public RenderedTexture setColorDepth(SFInt32 newValue)

Assign typed object value to SFInt32 colorDepth field, similar to setColorDepth(int).

Parameters:

newValue - is new value for the colorDepth field.

Returns:

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

getDepthMap

public boolean getDepthMap()

Provide boolean value from inputOutput SFBool field named depthMap.

Tooltip: indicates that a generated texture contains a depth buffer for the image, instead of a color buffer. Depth maps have a single component in each pixel of the output image. *

Specified by:

getDepthMap in interface RenderedTexture

Returns:

value of depthMap field

setDepthMap

public RenderedTexture setDepthMap(boolean newValue)

Accessor method to assign boolean value to inputOutput SFBool field named depthMap.

Tooltip: indicates that a generated texture contains a depth buffer for the image, instead of a color buffer. Depth maps have a single component in each pixel of the output image. *

Specified by:

setDepthMap in interface RenderedTexture

Parameters:

newValue - is new value for the depthMap field.

Returns:

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

setDepthMap

public RenderedTexture setDepthMap(SFBool newValue)

Assign typed object value to SFBool depthMap field, similar to setDepthMap(boolean).

Parameters:

newValue - is new value for the depthMap field.

Returns:

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

getDescription

public String getDescription()

Provide String value from inputOutput SFString field named description.

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

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

Specified by:

getDescription in interface RenderedTexture

Specified by:

getDescription in interface X3DSingleTextureNode

Specified by:

getDescription in interface X3DTexture2DNode

Specified by:

getDescription in interface X3DTextureNode

Returns:

value of description field

setDescription

public RenderedTexture setDescription(String newValue)

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

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

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

Specified by:

setDescription in interface RenderedTexture

Specified by:

setDescription in interface X3DSingleTextureNode

Specified by:

setDescription in interface X3DTexture2DNode

Specified by:

setDescription in interface X3DTextureNode

Parameters:

newValue - is new value for the description field.

Returns:

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

setDescription

public RenderedTexture setDescription(SFString newValue)

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

Parameters:

newValue - is new value for the description field.

Returns:

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

getHeight

public int getHeight()

Provide int value from initializeOnly SFInt32 field named height.

Tooltip: [0,+infinity) image height in pixels. *

Specified by:

getHeight in interface RenderedTexture

Returns:

value of height field

setHeight

public RenderedTexture setHeight(int newValue)

Accessor method to assign int value to initializeOnly SFInt32 field named height.

Tooltip: [0,+infinity) image height in pixels. *

Specified by:

setHeight in interface RenderedTexture

Parameters:

newValue - is new value for the height field.

Returns:

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

setHeight

public RenderedTexture setHeight(SFInt32 newValue)

Assign typed object value to SFInt32 height field, similar to setHeight(int).

Parameters:

newValue - is new value for the height field.

Returns:

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

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

Utility method to clear SFNode value of IS field.

Returns:

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

getIsActive

public boolean getIsActive()

Provide boolean value from outputOnly SFBool field named isActive.

Tooltip: provides a TRUE event when the data output process becomes active, and a FALSE event when the data output process is stopped. *

Specified by:

getIsActive in interface RenderedTexture

Returns:

value of isActive field

getMaxNumberFrames

public int getMaxNumberFrames()

Provide int value from inputOutput SFInt32 field named maxNumberFrames.

Tooltip: [0,+infinity) indicates the maximum number of independent frame files (or movie frames) that can be saved for a single series of image captures. A value of 0 indicates no limit. *

Specified by:

getMaxNumberFrames in interface RenderedTexture

Returns:

value of maxNumberFrames field

setMaxNumberFrames

public RenderedTexture setMaxNumberFrames(int newValue)

Accessor method to assign int value to inputOutput SFInt32 field named maxNumberFrames.

Tooltip: [0,+infinity) indicates the maximum number of independent frame files (or movie frames) that can be saved for a single series of image captures. A value of 0 indicates no limit. *

Specified by:

setMaxNumberFrames in interface RenderedTexture

Parameters:

newValue - is new value for the maxNumberFrames field.

Returns:

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

setMaxNumberFrames

public RenderedTexture setMaxNumberFrames(SFInt32 newValue)

Assign typed object value to SFInt32 maxNumberFrames field, similar to setMaxNumberFrames(int).

Parameters:

newValue - is new value for the maxNumberFrames field.

Returns:

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

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 RenderedTexture

Specified by:

getMetadata in interface X3DAppearanceChildNode

Specified by:

getMetadata in interface X3DNode

Specified by:

getMetadata in interface X3DSingleTextureNode

Specified by:

getMetadata in interface X3DTexture2DNode

Specified by:

getMetadata in interface X3DTextureNode

Returns:

value of metadata field

See Also:

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

setMetadata

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

Specified by:

setMetadata in interface X3DAppearanceChildNode

Specified by:

setMetadata in interface X3DNode

Specified by:

setMetadata in interface X3DSingleTextureNode

Specified by:

setMetadata in interface X3DTexture2DNode

Specified by:

setMetadata in interface X3DTextureNode

Specified by:

setMetadata in class X3DConcreteNode

Parameters:

newValue - is new value for the metadata field.

Returns:

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

Utility method to clear SFNode value of metadata field.

Returns:

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

setMetadata

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

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

getRepeatS

public boolean getRepeatS()

Provide boolean value from initializeOnly SFBool field named repeatS.

Tooltip: Whether to repeat texture along S axis horizontally from left to right. *

Specified by:

getRepeatS in interface RenderedTexture

Specified by:

getRepeatS in interface X3DTexture2DNode

Returns:

value of repeatS field

setRepeatS

public RenderedTexture setRepeatS(boolean newValue)

Accessor method to assign boolean value to initializeOnly SFBool field named repeatS.

Tooltip: Whether to repeat texture along S axis horizontally from left to right. *

Specified by:

setRepeatS in interface RenderedTexture

Specified by:

setRepeatS in interface X3DTexture2DNode

Parameters:

newValue - is new value for the repeatS field.

Returns:

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

setRepeatS

public RenderedTexture setRepeatS(SFBool newValue)

Assign typed object value to SFBool repeatS field, similar to setRepeatS(boolean).

Parameters:

newValue - is new value for the repeatS field.

Returns:

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

getRepeatT

public boolean getRepeatT()

Provide boolean value from initializeOnly SFBool field named repeatT.

Tooltip: Whether to repeat texture along T axis vertically from top to bottom. *

Specified by:

getRepeatT in interface RenderedTexture

Specified by:

getRepeatT in interface X3DTexture2DNode

Returns:

value of repeatT field

setRepeatT

public RenderedTexture setRepeatT(boolean newValue)

Accessor method to assign boolean value to initializeOnly SFBool field named repeatT.

Tooltip: Whether to repeat texture along T axis vertically from top to bottom. *

Specified by:

setRepeatT in interface RenderedTexture

Specified by:

setRepeatT in interface X3DTexture2DNode

Parameters:

newValue - is new value for the repeatT field.

Returns:

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

setRepeatT

public RenderedTexture setRepeatT(SFBool newValue)

Assign typed object value to SFBool repeatT field, similar to setRepeatT(boolean).

Parameters:

newValue - is new value for the repeatT field.

Returns:

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

getReplaceImage

public boolean getReplaceImage()

Provide boolean value from inputOutput SFBool field named replaceImage.

Tooltip: Whether only a single updated image file or multiple image files can be saved. *

Specified by:

getReplaceImage in interface RenderedTexture

Returns:

value of replaceImage field

setReplaceImage

public RenderedTexture setReplaceImage(boolean newValue)

Accessor method to assign boolean value to inputOutput SFBool field named replaceImage.

Tooltip: Whether only a single updated image file or multiple image files can be saved. *

Specified by:

setReplaceImage in interface RenderedTexture

Parameters:

newValue - is new value for the replaceImage field.

Returns:

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

setReplaceImage

public RenderedTexture setReplaceImage(SFBool newValue)

Assign typed object value to SFBool replaceImage field, similar to setReplaceImage(boolean).

Parameters:

newValue - is new value for the replaceImage field.

Returns:

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

getSingleFrame

public boolean getSingleFrame()

Provide boolean value from inputOutput SFBool field named singleFrame.

Tooltip: if TRUE only a single image is captured, otherwise continuous updates are captured. *

Specified by:

getSingleFrame in interface RenderedTexture

Returns:

value of singleFrame field

setSingleFrame

public RenderedTexture setSingleFrame(boolean newValue)

Accessor method to assign boolean value to inputOutput SFBool field named singleFrame.

Tooltip: if TRUE only a single image is captured, otherwise continuous updates are captured. *

Specified by:

setSingleFrame in interface RenderedTexture

Parameters:

newValue - is new value for the singleFrame field.

Returns:

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

setSingleFrame

public RenderedTexture setSingleFrame(SFBool newValue)

Assign typed object value to SFBool singleFrame field, similar to setSingleFrame(boolean).

Parameters:

newValue - is new value for the singleFrame field.

Returns:

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

getTextureProperties

public TextureProperties getTextureProperties()

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

Specified by:

getTextureProperties in interface RenderedTexture

Specified by:

getTextureProperties in interface X3DTexture2DNode

Returns:

value of textureProperties field

See Also:

• 
  
  Tooltip: [TextureProperties] Optional single contained TextureProperties node that can specify additional visual attributes applied to corresponding texture images. *
  

setTextureProperties

public RenderedTexture setTextureProperties(TextureProperties newValue)

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

Specified by:

setTextureProperties in interface RenderedTexture

Specified by:

setTextureProperties in interface X3DTexture2DNode

Parameters:

newValue - is new value for the textureProperties field.

Returns:

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

See Also:

• 
  
  Tooltip: [TextureProperties] Optional single contained TextureProperties node that can specify additional visual attributes applied to corresponding texture images. *
  

clearTextureProperties

public RenderedTexture clearTextureProperties()

Utility method to clear SFNode value of textureProperties field.

Returns:

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

setTextureProperties

public RenderedTexture setTextureProperties(ProtoInstance newValue)

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

Parameters:

newValue - is new value for the textureProperties field.

Returns:

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

See Also:

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

hasTextureProperties

public boolean hasTextureProperties()

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

Returns:

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

See Also:

• getTextureProperties()
• getTexturePropertiesProtoInstance()

getUpdate

public String getUpdate()

Provide String enumeration value (baseType xs:NMTOKEN) ["NONE" | "NEXT_FRAME_ONLY" | "ALWAYS"] from inputOutput SFString field named update.

Available enumeration values for string comparison: NONE, NEXT_FRAME_ONLY, ALWAYS.

Specified by:

getUpdate in interface RenderedTexture

Returns:

value of update field

setUpdate

public RenderedTexture setUpdate(String newValue)

Accessor method to assign String enumeration value ("NONE" | "NEXT_FRAME_ONLY" | "ALWAYS") to inputOutput SFString field named update.

Warning: authors can only choose from a strict list of enumeration values (NONE, NEXT_FRAME_ONLY, ALWAYS).

Specified by:

setUpdate in interface RenderedTexture

Parameters:

newValue - is new value for the update field.

Returns:

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

setUpdate

public RenderedTexture setUpdate(SFString newValue)

Assign typed object value to SFString update field, similar to setUpdate(String).

Parameters:

newValue - is new value for the update field.

Returns:

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

getUpdateInterval

public double getUpdateInterval()

Provide double value in seconds from inputOutput SFTime field named updateInterval.

Tooltip: [0,+infinity) indicates time intervals between render captures when the update field is "ALWAYS". A value of 0 indicates full frame rate for render captures. *

Specified by:

getUpdateInterval in interface RenderedTexture

Returns:

value of updateInterval field

setUpdateInterval

public RenderedTexture setUpdateInterval(double newValue)

Accessor method to assign double value in seconds to inputOutput SFTime field named updateInterval.

Tooltip: [0,+infinity) indicates time intervals between render captures when the update field is "ALWAYS". A value of 0 indicates full frame rate for render captures. *

Specified by:

setUpdateInterval in interface RenderedTexture

Parameters:

newValue - is new value for the updateInterval field.

Returns:

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

setUpdateInterval

public RenderedTexture setUpdateInterval(SFTime newValue)

Assign typed object value to SFTime updateInterval field, similar to setUpdateInterval(double).

Parameters:

newValue - is new value for the updateInterval field.

Returns:

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

getUrl

public String[] getUrl()

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

Tooltip: The url field typically defines a relative address to a file name that can be used for storing one or more rendered textures, and can also provide a destination for output of successive image files as a video file or video stream.

• 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.
• Warning: direct or indirect recursion by Inline and/or ExternProtoDeclare url reloading is a security error.
• Hint: X3D Scene Authoring Hints, urls https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#urls

Specified by:

getUrl in interface RenderedTexture

Specified by:

getUrl in interface X3DUrlOutputObject

Returns:

value of url field

getUrlList

public ArrayList<String> getUrlList()

Utility method to get ArrayList value of MFString url field, similar to getUrl().

Returns:

value of url field

getUrlString

public String getUrlString()

Utility method to get String value of MFString url field, similar to getUrl().

Returns:

value of url field

setUrl

public RenderedTexture setUrl(String[] newValue)

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

Tooltip: The url field typically defines a relative address to a file name that can be used for storing one or more rendered textures, and can also provide a destination for output of successive image files as a video file or video stream.

• 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.
• Warning: direct or indirect recursion by Inline and/or ExternProtoDeclare url reloading is a security error.
• Hint: X3D Scene Authoring Hints, urls https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#urls

Specified by:

setUrl in interface RenderedTexture

Specified by:

setUrl in interface X3DUrlOutputObject

Parameters:

newValue - is new value for the url field.

Returns:

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

setUrl

public RenderedTexture setUrl(MFString newValue)

Assign typed object value to MFString url field, similar to setUrl(String[]).

Parameters:

newValue - is new value for the url field.

Returns:

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

setUrl

public RenderedTexture setUrl(SFString newValue)

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

Parameters:

newValue - is new value for the url field.

Returns:

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

setUrl

public RenderedTexture setUrl(String newValue)

Assign singleton String value to MFString url field, similar to setUrl(String[]).

Parameters:

newValue - is new value for the url field.

Returns:

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

setUrl

public RenderedTexture setUrl(ArrayList<String> newValue)

Assign ArrayList value of MFString url field, similar to setUrl(String[]).

Parameters:

newValue - is new value for the url field.

Returns:

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

clearUrl

public RenderedTexture clearUrl()

Utility method to clear MFString value of url field. This method does not initialize with URL_DEFAULT_VALUE.

Returns:

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

addUrl

public RenderedTexture addUrl(String newValue)

Add singleton String value to MFString url field, allowing duplicate and empty string values if provided.

Parameters:

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

Returns:

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

See Also:

• MFString.cleanupEnumerationValues(String)
• MFString.hasDuplicateValues()

addUrl

public RenderedTexture addUrl(SFString newValue)

Add singleton SFString value to MFString url field, allowing duplicate or empty string values if provided.

Parameters:

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

Returns:

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

See Also:

• MFString.cleanupEnumerationValues(String)
• MFString.hasDuplicateValues()

getWidth

public int getWidth()

Provide int value from inputOutput SFInt32 field named width.

Tooltip: [0,+infinity) image height in pixels. *

Specified by:

getWidth in interface RenderedTexture

Returns:

value of width field

setWidth

public RenderedTexture setWidth(int newValue)

Accessor method to assign int value to inputOutput SFInt32 field named width.

Tooltip: [0,+infinity) image height in pixels. *

Specified by:

setWidth in interface RenderedTexture

Parameters:

newValue - is new value for the width field.

Returns:

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

setWidth

public RenderedTexture setWidth(SFInt32 newValue)

Assign typed object value to SFInt32 width field, similar to setWidth(int).

Parameters:

newValue - is new value for the width field.

Returns:

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

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

setDEF

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

RenderedTexture - 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 reference a separately 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 separately 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) within a USE node.
• Warning: each USE value must match a corresponding DEF value that is defined elsewhere in the scene.
• Hint: a USE node is no longer required to follow the corresponding DEF node being referenced.

Overrides:

getUSE in class X3DConcreteNode

Returns:

value of USE field

See Also:

• X3D Scene Authoring Hints: Naming Conventions

setUSE

public final RenderedTexture setUSE(String newValue)

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

Tooltip: USE means reference a separately 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 separately 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) within a USE node.
• Warning: each USE value must match a corresponding DEF value that is defined elsewhere in the scene.
• Hint: a USE node is no longer required to follow the corresponding DEF node being referenced.

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:

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

setUSE

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

RenderedTexture - 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 tutorial: Starting with HTML + CSS
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssClass

public final RenderedTexture 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:

RenderedTexture - 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 tutorial: Starting with HTML + CSS
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssClass

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

RenderedTexture - 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 tutorial: Starting with HTML + CSS
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setHtmlId

public final RenderedTexture 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:

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

RenderedTexture - 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 tutorial: Starting with HTML + CSS
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssStyle

public final RenderedTexture 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:

RenderedTexture - 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 tutorial: Starting with HTML + CSS
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssStyle

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

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

setUSE

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

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

addComments

public RenderedTexture addComments(String newComment)

Add comment as String to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComment - initial value

Returns:

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

Add comments as String[] array to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComments - array of comments

Returns:

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

addComments

public RenderedTexture addComments(CommentsBlock newCommentsBlock)

Add CommentsBlock to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newCommentsBlock - block of comments to add

Returns:

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