Package org.web3d.x3d.sai.Texturing
Interface TextureProperties
- All Superinterfaces:
X3DNode
- All Known Implementing Classes:
TextureProperties
TextureProperties allows precise fine-grained control over application of image textures to geometry.
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.
TextureProperties node tooltip: [X3DNode] TextureProperties allows precise fine-grained control over application of image textures to geometry.
- Warning: requires X3D profile='Full' or else include <component name='Shape' level='2'/>
- Hint: Texture mapping https://en.wikipedia.org/wiki/Texture_mapping
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 TypeMethodDescriptionfloat
Provide float value within allowed range of [1,infinity) from inputOutput SFFloat field named anisotropicDegree.float[]
Provide array of 4-tuple float results using RGBA values [0..1] using RGBA values [0..1] from inputOutput SFColorRGBA field named borderColor.int
Provide int value within allowed range of [0,infinity) from inputOutput SFInt32 field named borderWidth.Provide String enumeration value (baseType xs:NMTOKEN) ["CLAMP" | "CLAMP_TO_EDGE" | "CLAMP_TO_BOUNDARY" | "MIRRORED_REPEAT" | "REPEAT"] from inputOutput SFString field named boundaryModeR.Provide String enumeration value (baseType xs:NMTOKEN) ["CLAMP" | "CLAMP_TO_EDGE" | "CLAMP_TO_BOUNDARY" | "MIRRORED_REPEAT" | "REPEAT"] from inputOutput SFString field named boundaryModeS.Provide String enumeration value (baseType xs:NMTOKEN) ["CLAMP" | "CLAMP_TO_EDGE" | "CLAMP_TO_BOUNDARY" | "MIRRORED_REPEAT" | "REPEAT"] from inputOutput SFString field named boundaryModeT.boolean
Provide boolean value from initializeOnly SFBool field named generateMipMaps.Provide String enumeration value (baseType xs:NMTOKEN) ["AVG_PIXEL" | "DEFAULT" | "FASTEST" | "NEAREST_PIXEL" | "NICEST"] from inputOutput SFString field named magnificationFilter.Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.Provide String enumeration value (baseType xs:NMTOKEN) ["AVG_PIXEL" | "AVG_PIXEL_AVG_MIPMAP" | "AVG_PIXEL_NEAREST_MIPMAP" | "DEFAULT" | "FASTEST" | "NEAREST_PIXEL" | "NEAREST_PIXEL_AVG_MIPMAP" | "NEAREST_PIXEL_NEAREST_MIPMAP" | "NICEST"] from inputOutput SFString field named minificationFilter.Provide String enumeration value (baseType xs:NMTOKEN) ["DEFAULT" | "FASTEST" | "HIGH" | "LOW" | "MEDIUM" | "NICEST"] from inputOutput SFString field named textureCompression.float
Provide float value within allowed range of [0,1] from inputOutput SFFloat field named texturePriority.setAnisotropicDegree
(float newValue) Accessor method to assign float value to inputOutput SFFloat field named anisotropicDegree.setBorderColor
(float[] newValue) Accessor method to assign 4-tuple float array using RGBA values [0..1] to inputOutput SFColorRGBA field named borderColor.setBorderWidth
(int newValue) Accessor method to assign int value to inputOutput SFInt32 field named borderWidth.setBoundaryModeR
(String newValue) Accessor method to assign String enumeration value ("CLAMP" | "CLAMP_TO_EDGE" | "CLAMP_TO_BOUNDARY" | "MIRRORED_REPEAT" | "REPEAT") to inputOutput SFString field named boundaryModeR.setBoundaryModeS
(String newValue) Accessor method to assign String enumeration value ("CLAMP" | "CLAMP_TO_EDGE" | "CLAMP_TO_BOUNDARY" | "MIRRORED_REPEAT" | "REPEAT") to inputOutput SFString field named boundaryModeS.setBoundaryModeT
(String newValue) Accessor method to assign String enumeration value ("CLAMP" | "CLAMP_TO_EDGE" | "CLAMP_TO_BOUNDARY" | "MIRRORED_REPEAT" | "REPEAT") to inputOutput SFString field named boundaryModeT.setGenerateMipMaps
(boolean newValue) Accessor method to assign boolean value to initializeOnly SFBool field named generateMipMaps.setMagnificationFilter
(String newValue) Accessor method to assign String enumeration value ("AVG_PIXEL" | "DEFAULT" | "FASTEST" | "NEAREST_PIXEL" | "NICEST") to inputOutput SFString field named magnificationFilter.setMetadata
(X3DMetadataObject newValue) Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.setMinificationFilter
(String newValue) Accessor method to assign String enumeration value ("AVG_PIXEL" | "AVG_PIXEL_AVG_MIPMAP" | "AVG_PIXEL_NEAREST_MIPMAP" | "DEFAULT" | "FASTEST" | "NEAREST_PIXEL" | "NEAREST_PIXEL_AVG_MIPMAP" | "NEAREST_PIXEL_NEAREST_MIPMAP" | "NICEST") to inputOutput SFString field named minificationFilter.setTextureCompression
(String newValue) Accessor method to assign String enumeration value ("DEFAULT" | "FASTEST" | "HIGH" | "LOW" | "MEDIUM" | "NICEST") to inputOutput SFString field named textureCompression.setTexturePriority
(float newValue) Accessor method to assign float value to inputOutput SFFloat field named texturePriority.
-
Method Details
-
getAnisotropicDegree
float getAnisotropicDegree()Provide float value within allowed range of [1,infinity) from inputOutput SFFloat field named anisotropicDegree.
Tooltip: [1,+infinity) anisotropicDegree defines minimum degree of anisotropy to account for in texture filtering (1=no effect for symmetric filtering, otherwise provide higher value). At least 2-to-1 anisotropy is often supported in low-level graphics rendering software and hardware, relative to horizontal and vertical directions.- Hint: Anisotropy indicates directional dependence of properties. https://en.wikipedia.org/wiki/Anisotropy
- Hint: OpenGL EXT_texture_filter_anisotropic https://www.khronos.org/registry/OpenGL/extensions/EXT/EXT_texture_filter_anisotropic.txt
- Returns:
- value of anisotropicDegree field
-
setAnisotropicDegree
Accessor method to assign float value to inputOutput SFFloat field named anisotropicDegree.
Tooltip: [1,+infinity) anisotropicDegree defines minimum degree of anisotropy to account for in texture filtering (1=no effect for symmetric filtering, otherwise provide higher value). At least 2-to-1 anisotropy is often supported in low-level graphics rendering software and hardware, relative to horizontal and vertical directions.- Hint: Anisotropy indicates directional dependence of properties. https://en.wikipedia.org/wiki/Anisotropy
- Hint: OpenGL EXT_texture_filter_anisotropic https://www.khronos.org/registry/OpenGL/extensions/EXT/EXT_texture_filter_anisotropic.txt
- Parameters:
newValue
- is new value for the anisotropicDegree field.- Returns:
TextureProperties
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getBorderColor
float[] getBorderColor()Provide array of 4-tuple float results using RGBA values [0..1] using RGBA values [0..1] from inputOutput SFColorRGBA field named borderColor.
Tooltip: [0,1] borderColor defines border pixel color.- Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color
- Returns:
- value of borderColor field
-
setBorderColor
Accessor method to assign 4-tuple float array using RGBA values [0..1] to inputOutput SFColorRGBA field named borderColor.
Tooltip: [0,1] borderColor defines border pixel color.- Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color
- Parameters:
newValue
- is new value for the borderColor field.- Returns:
TextureProperties
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getBorderWidth
int getBorderWidth()Provide int value within allowed range of [0,infinity) from inputOutput SFInt32 field named borderWidth.
Tooltip: [0,+infinity) borderWidth number of pixels for texture border. *- Returns:
- value of borderWidth field
-
setBorderWidth
Accessor method to assign int value to inputOutput SFInt32 field named borderWidth.
Tooltip: [0,+infinity) borderWidth number of pixels for texture border. *- Parameters:
newValue
- is new value for the borderWidth field.- Returns:
TextureProperties
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getBoundaryModeR
String getBoundaryModeR()Provide String enumeration value (baseType xs:NMTOKEN) ["CLAMP" | "CLAMP_TO_EDGE" | "CLAMP_TO_BOUNDARY" | "MIRRORED_REPEAT" | "REPEAT"] from inputOutput SFString field named boundaryModeR.
Tooltip: boundaryModeR describes handling of texture-coordinate boundaries.- Warning: do not wrap extra quotation marks around these SFString enumeration values, since "quotation" "marks" are only used for MFString values.
- Hint: X3D Architecture Table 18.7 Texture boundary modes https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/texturing.html#t-TextureBoundaryModes for details.
- Returns:
- value of boundaryModeR field
-
setBoundaryModeR
Accessor method to assign String enumeration value ("CLAMP" | "CLAMP_TO_EDGE" | "CLAMP_TO_BOUNDARY" | "MIRRORED_REPEAT" | "REPEAT") to inputOutput SFString field named boundaryModeR.
Tooltip: boundaryModeR describes handling of texture-coordinate boundaries.- Warning: do not wrap extra quotation marks around these SFString enumeration values, since "quotation" "marks" are only used for MFString values.
- Hint: X3D Architecture Table 18.7 Texture boundary modes https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/texturing.html#t-TextureBoundaryModes for details.
- Parameters:
newValue
- is new value for the boundaryModeR field.- Returns:
TextureProperties
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getBoundaryModeS
String getBoundaryModeS()Provide String enumeration value (baseType xs:NMTOKEN) ["CLAMP" | "CLAMP_TO_EDGE" | "CLAMP_TO_BOUNDARY" | "MIRRORED_REPEAT" | "REPEAT"] from inputOutput SFString field named boundaryModeS.
Tooltip: boundaryModeS describes handling of texture-coordinate boundaries.- Warning: do not wrap extra quotation marks around these SFString enumeration values, since "quotation" "marks" are only used for MFString values.
- Hint: X3D Architecture Table 18.7 Texture boundary modes https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/texturing.html#t-TextureBoundaryModes for details.
- Returns:
- value of boundaryModeS field
-
setBoundaryModeS
Accessor method to assign String enumeration value ("CLAMP" | "CLAMP_TO_EDGE" | "CLAMP_TO_BOUNDARY" | "MIRRORED_REPEAT" | "REPEAT") to inputOutput SFString field named boundaryModeS.
Tooltip: boundaryModeS describes handling of texture-coordinate boundaries.- Warning: do not wrap extra quotation marks around these SFString enumeration values, since "quotation" "marks" are only used for MFString values.
- Hint: X3D Architecture Table 18.7 Texture boundary modes https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/texturing.html#t-TextureBoundaryModes for details.
- Parameters:
newValue
- is new value for the boundaryModeS field.- Returns:
TextureProperties
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getBoundaryModeT
String getBoundaryModeT()Provide String enumeration value (baseType xs:NMTOKEN) ["CLAMP" | "CLAMP_TO_EDGE" | "CLAMP_TO_BOUNDARY" | "MIRRORED_REPEAT" | "REPEAT"] from inputOutput SFString field named boundaryModeT.
Tooltip: boundaryModeT describes handling of texture-coordinate boundaries.- Warning: do not wrap extra quotation marks around these SFString enumeration values, since "quotation" "marks" are only used for MFString values.
- Hint: X3D Architecture Table 18.7 Texture boundary modes https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/texturing.html#t-TextureBoundaryModes for details.
- Returns:
- value of boundaryModeT field
-
setBoundaryModeT
Accessor method to assign String enumeration value ("CLAMP" | "CLAMP_TO_EDGE" | "CLAMP_TO_BOUNDARY" | "MIRRORED_REPEAT" | "REPEAT") to inputOutput SFString field named boundaryModeT.
Tooltip: boundaryModeT describes handling of texture-coordinate boundaries.- Warning: do not wrap extra quotation marks around these SFString enumeration values, since "quotation" "marks" are only used for MFString values.
- Hint: X3D Architecture Table 18.7 Texture boundary modes https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/texturing.html#t-TextureBoundaryModes for details.
- Parameters:
newValue
- is new value for the boundaryModeT field.- Returns:
TextureProperties
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getGenerateMipMaps
boolean getGenerateMipMaps()Provide boolean value from initializeOnly SFBool field named generateMipMaps.
Tooltip: Determines whether MIPMAPs are generated for texture images.- Warning: must declare generateMipMaps='true' for minificationFilter modes with MIPMAP in their value.
- Hint: mipmap preprocessing is a low-level rendering technique that can increase rendering speed and reduce aliasing artifacts.
- Hint: Mipmap pyramids are pre-calculated, optimized sequences of images, each of which is a progressively lower resolution representation of the same image. The height and width of each image level in the mipmap is a power of two smaller than the previous level.
- Hint: Aliasing https://en.wikipedia.org/wiki/Aliasing and Clipping https://en.wikipedia.org/wiki/Clipping_(computer_graphics)
- Hint: Mipmap https://en.wikipedia.org/wiki/Mipmap
- Returns:
- value of generateMipMaps field
-
setGenerateMipMaps
Accessor method to assign boolean value to initializeOnly SFBool field named generateMipMaps.
Tooltip: Determines whether MIPMAPs are generated for texture images.- Warning: must declare generateMipMaps='true' for minificationFilter modes with MIPMAP in their value.
- Hint: mipmap preprocessing is a low-level rendering technique that can increase rendering speed and reduce aliasing artifacts.
- Hint: Mipmap pyramids are pre-calculated, optimized sequences of images, each of which is a progressively lower resolution representation of the same image. The height and width of each image level in the mipmap is a power of two smaller than the previous level.
- Hint: Aliasing https://en.wikipedia.org/wiki/Aliasing and Clipping https://en.wikipedia.org/wiki/Clipping_(computer_graphics)
- Hint: Mipmap https://en.wikipedia.org/wiki/Mipmap
- Parameters:
newValue
- is new value for the generateMipMaps field.- Returns:
TextureProperties
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getMagnificationFilter
String getMagnificationFilter()Provide String enumeration value (baseType xs:NMTOKEN) ["AVG_PIXEL" | "DEFAULT" | "FASTEST" | "NEAREST_PIXEL" | "NICEST"] from inputOutput SFString field named magnificationFilter.
Tooltip: magnificationFilter indicates texture filter when image is smaller than screen space representation.- Warning: do not wrap extra quotation marks around these SFString enumeration values, since "quotation" "marks" are only used for MFString values.
- Hint: X3D Architecture Table 18.8 Texture magnification modes https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/texturing.html#t-TextureMagnificationModes for details.
- Returns:
- value of magnificationFilter field
-
setMagnificationFilter
Accessor method to assign String enumeration value ("AVG_PIXEL" | "DEFAULT" | "FASTEST" | "NEAREST_PIXEL" | "NICEST") to inputOutput SFString field named magnificationFilter.
Tooltip: magnificationFilter indicates texture filter when image is smaller than screen space representation.- Warning: do not wrap extra quotation marks around these SFString enumeration values, since "quotation" "marks" are only used for MFString values.
- Hint: X3D Architecture Table 18.8 Texture magnification modes https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/texturing.html#t-TextureMagnificationModes for details.
- Parameters:
newValue
- is new value for the magnificationFilter field.- Returns:
TextureProperties
- 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 interfaceX3DNode
- 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 interfaceX3DNode
- Parameters:
newValue
- is new value for the metadata field.- Returns:
TextureProperties
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
getMinificationFilter
String getMinificationFilter()Provide String enumeration value (baseType xs:NMTOKEN) ["AVG_PIXEL" | "AVG_PIXEL_AVG_MIPMAP" | "AVG_PIXEL_NEAREST_MIPMAP" | "DEFAULT" | "FASTEST" | "NEAREST_PIXEL" | "NEAREST_PIXEL_AVG_MIPMAP" | "NEAREST_PIXEL_NEAREST_MIPMAP" | "NICEST"] from inputOutput SFString field named minificationFilter.
Tooltip: minificationFilter indicates texture filter when image is larger than screen space representation.- Warning: do not wrap extra quotation marks around these SFString enumeration values, since "quotation" "marks" are only used for MFString values.
- Hint: X3D Architecture Table 18.9 Texture minification modes https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/texturing.html#t-TextureMinificationModes for details.
- Returns:
- value of minificationFilter field
-
setMinificationFilter
Accessor method to assign String enumeration value ("AVG_PIXEL" | "AVG_PIXEL_AVG_MIPMAP" | "AVG_PIXEL_NEAREST_MIPMAP" | "DEFAULT" | "FASTEST" | "NEAREST_PIXEL" | "NEAREST_PIXEL_AVG_MIPMAP" | "NEAREST_PIXEL_NEAREST_MIPMAP" | "NICEST") to inputOutput SFString field named minificationFilter.
Tooltip: minificationFilter indicates texture filter when image is larger than screen space representation.- Warning: do not wrap extra quotation marks around these SFString enumeration values, since "quotation" "marks" are only used for MFString values.
- Hint: X3D Architecture Table 18.9 Texture minification modes https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/texturing.html#t-TextureMinificationModes for details.
- Parameters:
newValue
- is new value for the minificationFilter field.- Returns:
TextureProperties
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getTextureCompression
String getTextureCompression()Provide String enumeration value (baseType xs:NMTOKEN) ["DEFAULT" | "FASTEST" | "HIGH" | "LOW" | "MEDIUM" | "NICEST"] from inputOutput SFString field named textureCompression.
Tooltip: textureCompression indicates compression algorithm selection mode.- Warning: do not wrap extra quotation marks around these SFString enumeration values, since "quotation" "marks" are only used for MFString values.
- Hint: X3D Architecture Table 18.10 Texture compression modes https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/texturing.html#t-TextureCompressionModes for details.
- Hint: Texture compression https://en.wikipedia.org/wiki/Texture_compression
- Returns:
- value of textureCompression field
-
setTextureCompression
Accessor method to assign String enumeration value ("DEFAULT" | "FASTEST" | "HIGH" | "LOW" | "MEDIUM" | "NICEST") to inputOutput SFString field named textureCompression.
Tooltip: textureCompression indicates compression algorithm selection mode.- Warning: do not wrap extra quotation marks around these SFString enumeration values, since "quotation" "marks" are only used for MFString values.
- Hint: X3D Architecture Table 18.10 Texture compression modes https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/texturing.html#t-TextureCompressionModes for details.
- Hint: Texture compression https://en.wikipedia.org/wiki/Texture_compression
- Parameters:
newValue
- is new value for the textureCompression field.- Returns:
TextureProperties
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getTexturePriority
float getTexturePriority()Provide float value within allowed range of [0,1] from inputOutput SFFloat field named texturePriority.
Tooltip: [0,1] texturePriority defines relative priority for this texture when allocating texture memory, an important rendering resource in graphics-card hardware. Default value 0 is lowest, 1 is highest. *- Returns:
- value of texturePriority field
-
setTexturePriority
Accessor method to assign float value to inputOutput SFFloat field named texturePriority.
Tooltip: [0,1] texturePriority defines relative priority for this texture when allocating texture memory, an important rendering resource in graphics-card hardware. Default value 0 is lowest, 1 is highest. *- Parameters:
newValue
- is new value for the texturePriority field.- Returns:
TextureProperties
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-