Interface RenderedTexture

All Superinterfaces:

X3DAppearanceChildNode, X3DNode, X3DSingleTextureNode, X3DTexture2DNode, X3DTextureNode, X3DUrlOutputObject

All Known Implementing Classes:

RenderedTexture

public interface RenderedTexture
extends X3DTexture2DNode, X3DUrlOutputObject

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 interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).

See Also:

• SAI Java Specification
• X3D Abstract Specification: RenderedTexture
• X3D Tooltips: RenderedTexture
• X3D Scene Authoring Hints: Images

Method Summary

Modifier and Type	Method	Description
int	getColorDepth()	Provide int value using RGB values [0..1] from inputOutput SFInt32 field named colorDepth.
boolean	getDepthMap()	Provide boolean value from inputOutput SFBool field named depthMap.
String	getDescription()	Provide String value from inputOutput SFString field named description.
int	getHeight()	Provide int value from initializeOnly SFInt32 field named height.
boolean	getIsActive()	Provide boolean value from outputOnly SFBool field named isActive.
int	getMaxNumberFrames()	Provide int value from inputOutput SFInt32 field named maxNumberFrames.
X3DMetadataObject	getMetadata()	Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
boolean	getRepeatS()	Provide boolean value from initializeOnly SFBool field named repeatS.
boolean	getRepeatT()	Provide boolean value from initializeOnly SFBool field named repeatT.
boolean	getReplaceImage()	Provide boolean value from inputOutput SFBool field named replaceImage.
boolean	getSingleFrame()	Provide boolean value from inputOutput SFBool field named singleFrame.
TextureProperties	getTextureProperties()	Provide org.web3d.x3d.sai.Texturing.TextureProperties instance (using a properly typed node) from initializeOnly SFNode field textureProperties.
String	getUpdate()	Provide String enumeration value (baseType xs:NMTOKEN) ["NONE" | "NEXT_FRAME_ONLY" | "ALWAYS"] from inputOutput SFString field named update.
double	getUpdateInterval()	Provide double value in seconds from inputOutput SFTime field named updateInterval.
String[]	getUrl()	Provide array of String results from inputOutput MFString field named url.
int	getWidth()	Provide int value from inputOutput SFInt32 field named width.
RenderedTexture	setColorDepth(int newValue)	Accessor method to assign int value to inputOutput SFInt32 field named colorDepth.
RenderedTexture	setDepthMap(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named depthMap.
RenderedTexture	setDescription(String newValue)	Accessor method to assign String value to inputOutput SFString field named description.
RenderedTexture	setHeight(int newValue)	Accessor method to assign int value to initializeOnly SFInt32 field named height.
RenderedTexture	setMaxNumberFrames(int newValue)	Accessor method to assign int value to inputOutput SFInt32 field named maxNumberFrames.
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	setRepeatT(boolean newValue)	Accessor method to assign boolean value to initializeOnly SFBool field named repeatT.
RenderedTexture	setReplaceImage(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named replaceImage.
RenderedTexture	setSingleFrame(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named singleFrame.
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	setUpdateInterval(double newValue)	Accessor method to assign double value in seconds to inputOutput SFTime field named updateInterval.
RenderedTexture	setUrl(String[] newValue)	Accessor method to assign String array to inputOutput MFString field named url.
RenderedTexture	setWidth(int newValue)	Accessor method to assign int value to inputOutput SFInt32 field named width.

Method Details

getColorDepth

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

Returns:

value of colorDepth field

setColorDepth

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

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

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

Returns:

value of depthMap field

setDepthMap

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

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

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 X3DSingleTextureNode

Specified by:

getDescription in interface X3DTexture2DNode

Specified by:

getDescription in interface X3DTextureNode

Returns:

value of description field

setDescription

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

getHeight

int getHeight()

Provide int value from initializeOnly SFInt32 field named height.

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

Returns:

value of height field

setHeight

RenderedTexture setHeight(int newValue)

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

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

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

getIsActive

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

Returns:

value of isActive field

getMaxNumberFrames

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

Returns:

value of maxNumberFrames field

setMaxNumberFrames

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

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

X3DMetadataObject getMetadata()

Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.

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

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:

• X3D Scene Authoring Hints: Metadata Nodes

setMetadata

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.

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

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

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:

• X3D Scene Authoring Hints: Metadata Nodes

getRepeatS

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 X3DTexture2DNode

Returns:

value of repeatS field

setRepeatS

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

getRepeatT

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 X3DTexture2DNode

Returns:

value of repeatT field

setRepeatT

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

getReplaceImage

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

Returns:

value of replaceImage field

setReplaceImage

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

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

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

Returns:

value of singleFrame field

setSingleFrame

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

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

TextureProperties getTextureProperties()

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

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

Specified by:

getTextureProperties in interface X3DTexture2DNode

Returns:

value of textureProperties field

setTextureProperties

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.

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

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

getUpdate

String getUpdate()

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

Returns:

value of update field

setUpdate

RenderedTexture setUpdate(String newValue)

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

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

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

Returns:

value of updateInterval field

setUpdateInterval

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

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

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 X3DUrlOutputObject

Returns:

value of url field

setUrl

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

getWidth

int getWidth()

Provide int value from inputOutput SFInt32 field named width.

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

Returns:

value of width field

setWidth

RenderedTexture setWidth(int newValue)

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

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

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