Interface TextureProperties

All Superinterfaces:
X3DNode
All Known Implementing Classes:
TextureProperties
public interface TextureProperties extends X3DNode
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 org.web3d.x3d.jsail classes. TextureProperties node tooltip: [X3DNode] TextureProperties allows precise fine-grained control over application of image textures to geometry.
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 Type
    Method
    Description
    float
    getAnisotropicDegree()
    Provide float value within allowed range of [1,infinity) from inputOutput SFFloat field named anisotropicDegree.
    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.
    int
    getBorderWidth()
    Provide int value within allowed range of [0,infinity) from inputOutput SFInt32 field named borderWidth.
    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.
    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.
    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.
    boolean
    getGenerateMipMaps()
    Provide boolean value from initializeOnly SFBool field named generateMipMaps.
    String
    getMagnificationFilter()
    Provide String enumeration value (baseType xs:NMTOKEN) ["AVG_PIXEL" | "DEFAULT" | "FASTEST" | "NEAREST_PIXEL" | "NICEST"] from inputOutput SFString field named magnificationFilter.
    X3DMetadataObject
    getMetadata()
    Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    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.
    String
    getTextureCompression()
    Provide String enumeration value (baseType xs:NMTOKEN) ["DEFAULT" | "FASTEST" | "HIGH" | "LOW" | "MEDIUM" | "NICEST"] from inputOutput SFString field named textureCompression.
    float
    getTexturePriority()
    Provide float value within allowed range of [0,1] from inputOutput SFFloat field named texturePriority.
    TextureProperties
    setAnisotropicDegree(float newValue)
    Accessor method to assign float value to inputOutput SFFloat field named anisotropicDegree.
    TextureProperties
    setBorderColor(float[] newValue)
    Accessor method to assign 4-tuple float array using RGBA values [0..1] to inputOutput SFColorRGBA field named borderColor.
    TextureProperties
    setBorderWidth(int newValue)
    Accessor method to assign int value to inputOutput SFInt32 field named borderWidth.
    TextureProperties
    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.
    TextureProperties
    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.
    TextureProperties
    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.
    TextureProperties
    setGenerateMipMaps(boolean newValue)
    Accessor method to assign boolean value to initializeOnly SFBool field named generateMipMaps.
    TextureProperties
    setMagnificationFilter(String newValue)
    Accessor method to assign String enumeration value ("AVG_PIXEL" | "DEFAULT" | "FASTEST" | "NEAREST_PIXEL" | "NICEST") to inputOutput SFString field named magnificationFilter.
    TextureProperties
    setMetadata(X3DMetadataObject newValue)
    Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    TextureProperties
    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.
    TextureProperties
    setTextureCompression(String newValue)
    Accessor method to assign String enumeration value ("DEFAULT" | "FASTEST" | "HIGH" | "LOW" | "MEDIUM" | "NICEST") to inputOutput SFString field named textureCompression.
    TextureProperties
    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.
      Returns:
      value of anisotropicDegree field

    • setAnisotropicDegree

      TextureProperties setAnisotropicDegree(float newValue)
      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.
      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.
      Returns:
      value of borderColor field

    • setBorderColor

      TextureProperties setBorderColor(float[] newValue)
      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.
      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

      TextureProperties setBorderWidth(int newValue)
      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.
      Returns:
      value of boundaryModeR field

    • setBoundaryModeR

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

      Tooltip: boundaryModeR describes handling of texture-coordinate boundaries.
      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.
      Returns:
      value of boundaryModeS field

    • setBoundaryModeS

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

      Tooltip: boundaryModeS describes handling of texture-coordinate boundaries.
      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.
      Returns:
      value of boundaryModeT field

    • setBoundaryModeT

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

      Tooltip: boundaryModeT describes handling of texture-coordinate boundaries.
      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

      TextureProperties setGenerateMipMaps(boolean newValue)
      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.
      Returns:
      value of magnificationFilter field

    • setMagnificationFilter

      TextureProperties setMagnificationFilter(String newValue)
      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.
      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.
      Specified by:
      getMetadata in interface X3DNode
      Returns:
      value of metadata field
      See Also:

    • setMetadata

      TextureProperties 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.
      Specified by:
      setMetadata in interface X3DNode
      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.
      Returns:
      value of minificationFilter field

    • setMinificationFilter

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

      Tooltip: minificationFilter indicates texture filter when image is larger than screen space representation.
      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.
      Returns:
      value of textureCompression field

    • setTextureCompression

      TextureProperties setTextureCompression(String newValue)
      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.
      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

      TextureProperties setTexturePriority(float newValue)
      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).