Package org.web3d.x3d.sai.Texturing3D
Interface PixelTexture3D
- All Superinterfaces:
X3DAppearanceChildNode
,X3DNode
,X3DTexture3DNode
,X3DTextureNode
- All Known Implementing Classes:
PixelTexture3D
PixelTexture3D defines a 3D image-based texture map as an explicit array of pixel values (image field).
Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the
org.web3d.x3d.jsail
classes.
PixelTexture3D node tooltip: (X3D version 3.1 or later) [X3DTexture3DNode] PixelTexture3D defines a 3D image-based texture map as an explicit array of pixel values (image field).
- Hint: can contain a single TextureProperties node.
- Hint: insert Shape and Appearance nodes before adding texture.
- Hint: X3D Architecture 33.2.2 3D texturing concepts https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/texture3D.html#3DTextureconcepts
- Warning: requires X3D profile='Full' or else include <component name='Texturing3D' level='1'/>
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionProvide String value from inputOutput SFString field named description.int[]
getImage()
Provide array of int results from inputOutput MFInt32 field named image.Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.boolean
Provide boolean value from initializeOnly SFBool field named repeatR.boolean
Provide boolean value from initializeOnly SFBool field named repeatS.boolean
Provide boolean value from initializeOnly SFBool field named repeatT.Provide org.web3d.x3d.sai.Texturing.TextureProperties instance (using a properly typed node) from initializeOnly SFNode field textureProperties.setDescription
(String newValue) Accessor method to assign String value to inputOutput SFString field named description.setImage
(int[] newValue) Accessor method to assign int array to inputOutput MFInt32 field named image.setMetadata
(X3DMetadataObject newValue) Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.setRepeatR
(boolean newValue) Accessor method to assign boolean value to initializeOnly SFBool field named repeatR.setRepeatS
(boolean newValue) Accessor method to assign boolean value to initializeOnly SFBool field named repeatS.setRepeatT
(boolean newValue) Accessor method to assign boolean value to initializeOnly SFBool field named repeatT.setTextureProperties
(TextureProperties newValue) Accessor method to assign org.web3d.x3d.sai.Texturing.TextureProperties instance (using a properly typed node) to initializeOnly SFNode field textureProperties.
-
Method Details
-
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 interfaceX3DTexture3DNode
- Specified by:
getDescription
in interfaceX3DTextureNode
- 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 interfaceX3DTexture3DNode
- Specified by:
setDescription
in interfaceX3DTextureNode
- Parameters:
newValue
- is new value for the description field.- Returns:
PixelTexture3D
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getImage
int[] getImage()Provide array of int results from inputOutput MFInt32 field named image.
Tooltip: image describes raw data for this 3D texture: number of components to the image [0,4], width, height and depth of the texture, followed by (width x height x depth) pixel values.- Warning: the order of initial values in PixelTexture and PixelTexture3D image arrays are different.
- Returns:
- value of image field
-
setImage
Accessor method to assign int array to inputOutput MFInt32 field named image.
Tooltip: image describes raw data for this 3D texture: number of components to the image [0,4], width, height and depth of the texture, followed by (width x height x depth) pixel values.- Warning: the order of initial values in PixelTexture and PixelTexture3D image arrays are different.
- Parameters:
newValue
- is new value for the image field.- Returns:
PixelTexture3D
- 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 interfaceX3DAppearanceChildNode
- Specified by:
getMetadata
in interfaceX3DNode
- Specified by:
getMetadata
in interfaceX3DTexture3DNode
- Specified by:
getMetadata
in interfaceX3DTextureNode
- Returns:
- value of metadata field
- See Also:
-
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/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/core.html#Metadata
- Specified by:
setMetadata
in interfaceX3DAppearanceChildNode
- Specified by:
setMetadata
in interfaceX3DNode
- Specified by:
setMetadata
in interfaceX3DTexture3DNode
- Specified by:
setMetadata
in interfaceX3DTextureNode
- Parameters:
newValue
- is new value for the metadata field.- Returns:
PixelTexture3D
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
getRepeatR
boolean getRepeatR()Provide boolean value from initializeOnly SFBool field named repeatR.
Tooltip: Whether to repeat texture along R axis from front to back. *- Specified by:
getRepeatR
in interfaceX3DTexture3DNode
- Returns:
- value of repeatR field
-
setRepeatR
Accessor method to assign boolean value to initializeOnly SFBool field named repeatR.
Tooltip: Whether to repeat texture along R axis from front to back. *- Specified by:
setRepeatR
in interfaceX3DTexture3DNode
- Parameters:
newValue
- is new value for the repeatR field.- Returns:
PixelTexture3D
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
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 interfaceX3DTexture3DNode
- Returns:
- value of repeatS field
-
setRepeatS
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 interfaceX3DTexture3DNode
- Parameters:
newValue
- is new value for the repeatS field.- Returns:
PixelTexture3D
- 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 interfaceX3DTexture3DNode
- Returns:
- value of repeatT field
-
setRepeatT
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 interfaceX3DTexture3DNode
- Parameters:
newValue
- is new value for the repeatT field.- Returns:
PixelTexture3D
- 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] Single contained TextureProperties node that can specify additional visual attributes applied to corresponding texture images. *- Specified by:
getTextureProperties
in interfaceX3DTexture3DNode
- 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.
Tooltip: [TextureProperties] Single contained TextureProperties node that can specify additional visual attributes applied to corresponding texture images. *- Specified by:
setTextureProperties
in interfaceX3DTexture3DNode
- Parameters:
newValue
- is new value for the textureProperties field.- Returns:
PixelTexture3D
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-