Interface ImageCubeMapTexture
- All Superinterfaces:
X3DAppearanceChildNode
,X3DEnvironmentTextureNode
,X3DNode
,X3DTextureNode
,X3DUrlObject
- All Known Implementing Classes:
ImageCubeMapTexture
public interface ImageCubeMapTexture extends X3DEnvironmentTextureNode, X3DUrlObject
ImageCubeMapTexture is a texture node that defines a cubic environment map source as a single file format that contains multiple images, one for each side.
X3D node tooltip: (X3D version 3.1 or later) [X3DEnvironmentTextureNode,X3DUrlObject] ImageCubeMapTexture is a texture node that defines a cubic environment map source as a single file format that contains multiple images, one for each side.
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
X3D node tooltip: (X3D version 3.1 or later) [X3DEnvironmentTextureNode,X3DUrlObject] ImageCubeMapTexture is a texture node that defines a cubic environment map source as a single file format that contains multiple images, one for each side.
- Hint: can contain a single TextureProperties node.
- Hint: apply containerField='watchList' when parent node is LoadSensor.
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
-
Method Summary
Modifier and Type Method Description java.lang.String
getDescription()
Provide String value from inputOutput SFString field named description.boolean
getLoad()
Provide boolean value from inputOutput SFBool field named load.X3DMetadataObject
getMetadata()
Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.double
getRefresh()
Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named refresh.TextureProperties
getTextureProperties()
Provide org.web3d.x3d.sai.Texturing.TextureProperties instance (using a properly typed node) from initializeOnly SFNode field textureProperties.java.lang.String[]
getUrl()
Provide array of String results from inputOutput MFString field named url.ImageCubeMapTexture
setDescription(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named description.ImageCubeMapTexture
setLoad(boolean newValue)
Accessor method to assign boolean value to inputOutput SFBool field named load.ImageCubeMapTexture
setMetadata(X3DMetadataObject newValue)
Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.ImageCubeMapTexture
setRefresh(double newValue)
Accessor method to assign double value in seconds to inputOutput SFTime field named refresh.ImageCubeMapTexture
setTextureProperties(TextureProperties newValue)
Accessor method to assign org.web3d.x3d.sai.Texturing.TextureProperties instance (using a properly typed node) to initializeOnly SFNode field textureProperties.ImageCubeMapTexture
setUrl(java.lang.String[] newValue)
Accessor method to assign String array to inputOutput MFString field named url.
-
Method Details
-
getDescription
java.lang.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 interfaceX3DEnvironmentTextureNode
- Specified by:
getDescription
in interfaceX3DTextureNode
- Specified by:
getDescription
in interfaceX3DUrlObject
- Returns:
- value of description field
-
setDescription
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 interfaceX3DEnvironmentTextureNode
- Specified by:
setDescription
in interfaceX3DTextureNode
- Specified by:
setDescription
in interfaceX3DUrlObject
- Parameters:
newValue
- is new value for the description field.- Returns:
ImageCubeMapTexture
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getLoad
boolean getLoad()Provide boolean value from inputOutput SFBool field named load.
Tooltip: load=true means load immediately, load=false means defer loading or else unload a previously loaded scene.- Hint: allows author to design when Inline loading occurs via user interaction, event chains or scripting.
- Hint: use a separate LoadSensor node to detect when loading is complete.
- Specified by:
getLoad
in interfaceX3DUrlObject
- Returns:
- value of load field
-
setLoad
Accessor method to assign boolean value to inputOutput SFBool field named load.
Tooltip: load=true means load immediately, load=false means defer loading or else unload a previously loaded scene.- Hint: allows author to design when Inline loading occurs via user interaction, event chains or scripting.
- Hint: use a separate LoadSensor node to detect when loading is complete.
- Specified by:
setLoad
in interfaceX3DUrlObject
- Parameters:
newValue
- is new value for the load field.- Returns:
ImageCubeMapTexture
- 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/X3Dv4Draft/ISO-IEC19775-1v4-WD2/Part01/components/core.html#Metadata
- Specified by:
getMetadata
in interfaceX3DAppearanceChildNode
- Specified by:
getMetadata
in interfaceX3DEnvironmentTextureNode
- Specified by:
getMetadata
in interfaceX3DNode
- Specified by:
getMetadata
in interfaceX3DTextureNode
- Returns:
- value of metadata field
- See Also:
- X3D Scene Authoring Hints: Metadata Nodes
-
setMetadata
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/X3Dv4Draft/ISO-IEC19775-1v4-WD2/Part01/components/core.html#Metadata
- Specified by:
setMetadata
in interfaceX3DAppearanceChildNode
- Specified by:
setMetadata
in interfaceX3DEnvironmentTextureNode
- Specified by:
setMetadata
in interfaceX3DNode
- Specified by:
setMetadata
in interfaceX3DTextureNode
- Parameters:
newValue
- is new value for the metadata field.- Returns:
ImageCubeMapTexture
- 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
-
getRefresh
double getRefresh()Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named refresh.
Tooltip: refresh defines interval in seconds before automatic reload of current url asset is performed.- Hint: if preceding file loading fails or load field is false, no refresh is performed.
- Hint: repeated refresh attempts to reload currently loaded entry of url list. If that fails, the browser retries other entries in the url list.
- Warning: automatically reloading content has security considerations and needs to be considered carefully.
- Specified by:
getRefresh
in interfaceX3DUrlObject
- Returns:
- value of refresh field
-
setRefresh
Accessor method to assign double value in seconds to inputOutput SFTime field named refresh.
Tooltip: refresh defines interval in seconds before automatic reload of current url asset is performed.- Hint: if preceding file loading fails or load field is false, no refresh is performed.
- Hint: repeated refresh attempts to reload currently loaded entry of url list. If that fails, the browser retries other entries in the url list.
- Warning: automatically reloading content has security considerations and needs to be considered carefully.
- Specified by:
setRefresh
in interfaceX3DUrlObject
- Parameters:
newValue
- is new value for the refresh field.- Returns:
ImageCubeMapTexture
- 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.- Returns:
- value of textureProperties field
-
setTextureProperties
Accessor method to assign org.web3d.x3d.sai.Texturing.TextureProperties instance (using a properly typed node) to initializeOnly SFNode field textureProperties.- Parameters:
newValue
- is new value for the textureProperties field.- Returns:
ImageCubeMapTexture
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getUrl
java.lang.String[] getUrl()Provide array of String results from inputOutput MFString field named url.
Tooltip: Location and filename of image. Multiple locations are more reliable, and including a Web address lets e-mail attachments work.- 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.
- Hint: X3D Scene Authoring Hints, urls https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#urls
- Specified by:
getUrl
in interfaceX3DUrlObject
- Returns:
- value of url field
-
setUrl
Accessor method to assign String array to inputOutput MFString field named url.
Tooltip: Location and filename of image. Multiple locations are more reliable, and including a Web address lets e-mail attachments work.- 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.
- Hint: X3D Scene Authoring Hints, urls https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#urls
- Specified by:
setUrl
in interfaceX3DUrlObject
- Parameters:
newValue
- is new value for the url field.- Returns:
ImageCubeMapTexture
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-