Class TextureProperties

All Implemented Interfaces:
X3DNode, TextureProperties

public class TextureProperties extends X3DConcreteNode implements 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 org.web3d.x3d.jsail classes. X3D node tooltip: [X3DNode] TextureProperties allows precise fine-grained control over application of image textures to geometry. Warning: requires X3D profile='Full' or else include &lt;component name='Shape' level='2'/&gt; Hint: Texture mapping <a href="https://en.wikipedia.org/wiki/Texture_mapping" target="_blank">https://en.wikipedia.org/wiki/Texture_mapping</a> *


Note that SFColor provides a variety of color constants.

Package hint: This org.web3d.x3d.jsail concrete class is used for implementing a standalone X3D object as a Plain Old Java Object (POJO). If you are writing Java code for use inside an X3D Script node, compile separate code using only the org.web3d.x3d.sai package instead.
See Also:
  • Field Details

    • BOUNDARYMODER_CLAMP

      public static final String BOUNDARYMODER_CLAMP
      Tooltip: Clamp texture coordinates to range [0,1]. SFString field named boundaryModeR with X3DUOM simpleType textureBoundaryModeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "CLAMP" (Java syntax) or CLAMP (XML syntax).
      See Also:
    • BOUNDARYMODER_CLAMP_TO_EDGE

      public static final String BOUNDARYMODER_CLAMP_TO_EDGE
      Tooltip: Clamp texture coordinates such that a border texel is never sampled. SFString field named boundaryModeR with X3DUOM simpleType textureBoundaryModeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "CLAMP_TO_EDGE" (Java syntax) or CLAMP_TO_EDGE (XML syntax).
      See Also:
    • BOUNDARYMODER_CLAMP_TO_BOUNDARY

      public static final String BOUNDARYMODER_CLAMP_TO_BOUNDARY
      Tooltip: Clamp texture coordinates such that texture samples are border texels for fragments. SFString field named boundaryModeR with X3DUOM simpleType textureBoundaryModeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "CLAMP_TO_BOUNDARY" (Java syntax) or CLAMP_TO_BOUNDARY (XML syntax).
      See Also:
    • BOUNDARYMODER_MIRRORED_REPEAT

      public static final String BOUNDARYMODER_MIRRORED_REPEAT
      Tooltip: Texture coordinates are mirrored and then clamped as in CLAMP_TO_EDGE. SFString field named boundaryModeR with X3DUOM simpleType textureBoundaryModeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "MIRRORED_REPEAT" (Java syntax) or MIRRORED_REPEAT (XML syntax).
      See Also:
    • BOUNDARYMODER_REPEAT

      public static final String BOUNDARYMODER_REPEAT
      Tooltip: Repeat a texture across the fragment. SFString field named boundaryModeR with X3DUOM simpleType textureBoundaryModeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "REPEAT" (Java syntax) or REPEAT (XML syntax).
      See Also:
    • BOUNDARYMODES_CLAMP

      public static final String BOUNDARYMODES_CLAMP
      Tooltip: Clamp texture coordinates to range [0,1]. SFString field named boundaryModeS with X3DUOM simpleType textureBoundaryModeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "CLAMP" (Java syntax) or CLAMP (XML syntax).
      See Also:
    • BOUNDARYMODES_CLAMP_TO_EDGE

      public static final String BOUNDARYMODES_CLAMP_TO_EDGE
      Tooltip: Clamp texture coordinates such that a border texel is never sampled. SFString field named boundaryModeS with X3DUOM simpleType textureBoundaryModeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "CLAMP_TO_EDGE" (Java syntax) or CLAMP_TO_EDGE (XML syntax).
      See Also:
    • BOUNDARYMODES_CLAMP_TO_BOUNDARY

      public static final String BOUNDARYMODES_CLAMP_TO_BOUNDARY
      Tooltip: Clamp texture coordinates such that texture samples are border texels for fragments. SFString field named boundaryModeS with X3DUOM simpleType textureBoundaryModeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "CLAMP_TO_BOUNDARY" (Java syntax) or CLAMP_TO_BOUNDARY (XML syntax).
      See Also:
    • BOUNDARYMODES_MIRRORED_REPEAT

      public static final String BOUNDARYMODES_MIRRORED_REPEAT
      Tooltip: Texture coordinates are mirrored and then clamped as in CLAMP_TO_EDGE. SFString field named boundaryModeS with X3DUOM simpleType textureBoundaryModeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "MIRRORED_REPEAT" (Java syntax) or MIRRORED_REPEAT (XML syntax).
      See Also:
    • BOUNDARYMODES_REPEAT

      public static final String BOUNDARYMODES_REPEAT
      Tooltip: Repeat a texture across the fragment. SFString field named boundaryModeS with X3DUOM simpleType textureBoundaryModeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "REPEAT" (Java syntax) or REPEAT (XML syntax).
      See Also:
    • BOUNDARYMODET_CLAMP

      public static final String BOUNDARYMODET_CLAMP
      Tooltip: Clamp texture coordinates to range [0,1]. SFString field named boundaryModeT with X3DUOM simpleType textureBoundaryModeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "CLAMP" (Java syntax) or CLAMP (XML syntax).
      See Also:
    • BOUNDARYMODET_CLAMP_TO_EDGE

      public static final String BOUNDARYMODET_CLAMP_TO_EDGE
      Tooltip: Clamp texture coordinates such that a border texel is never sampled. SFString field named boundaryModeT with X3DUOM simpleType textureBoundaryModeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "CLAMP_TO_EDGE" (Java syntax) or CLAMP_TO_EDGE (XML syntax).
      See Also:
    • BOUNDARYMODET_CLAMP_TO_BOUNDARY

      public static final String BOUNDARYMODET_CLAMP_TO_BOUNDARY
      Tooltip: Clamp texture coordinates such that texture samples are border texels for fragments. SFString field named boundaryModeT with X3DUOM simpleType textureBoundaryModeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "CLAMP_TO_BOUNDARY" (Java syntax) or CLAMP_TO_BOUNDARY (XML syntax).
      See Also:
    • BOUNDARYMODET_MIRRORED_REPEAT

      public static final String BOUNDARYMODET_MIRRORED_REPEAT
      Tooltip: Texture coordinates are mirrored and then clamped as in CLAMP_TO_EDGE. SFString field named boundaryModeT with X3DUOM simpleType textureBoundaryModeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "MIRRORED_REPEAT" (Java syntax) or MIRRORED_REPEAT (XML syntax).
      See Also:
    • BOUNDARYMODET_REPEAT

      public static final String BOUNDARYMODET_REPEAT
      Tooltip: Repeat a texture across the fragment. SFString field named boundaryModeT with X3DUOM simpleType textureBoundaryModeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "REPEAT" (Java syntax) or REPEAT (XML syntax).
      See Also:
    • MAGNIFICATIONFILTER_AVG_PIXEL

      public static final String MAGNIFICATIONFILTER_AVG_PIXEL
      Tooltip: weighted average of four texture elements closest to center of pixel being textured. SFString field named magnificationFilter with X3DUOM simpleType textureMagnificationModeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "AVG_PIXEL" (Java syntax) or AVG_PIXEL (XML syntax).
      See Also:
    • MAGNIFICATIONFILTER_DEFAULT

      public static final String MAGNIFICATIONFILTER_DEFAULT
      Tooltip: browser-specified default magnification mode. SFString field named magnificationFilter with X3DUOM simpleType textureMagnificationModeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "DEFAULT" (Java syntax) or DEFAULT (XML syntax).
      See Also:
    • MAGNIFICATIONFILTER_FASTEST

      public static final String MAGNIFICATIONFILTER_FASTEST
      Tooltip: fastest method available. SFString field named magnificationFilter with X3DUOM simpleType textureMagnificationModeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "FASTEST" (Java syntax) or FASTEST (XML syntax).
      See Also:
    • MAGNIFICATIONFILTER_NEAREST_PIXEL

      public static final String MAGNIFICATIONFILTER_NEAREST_PIXEL
      Tooltip: texture element nearest to the center of pixel being textured. SFString field named magnificationFilter with X3DUOM simpleType textureMagnificationModeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "NEAREST_PIXEL" (Java syntax) or NEAREST_PIXEL (XML syntax).
      See Also:
    • MAGNIFICATIONFILTER_NICEST

      public static final String MAGNIFICATIONFILTER_NICEST
      Tooltip: highest quality method available. SFString field named magnificationFilter with X3DUOM simpleType textureMagnificationModeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "NICEST" (Java syntax) or NICEST (XML syntax).
      See Also:
    • MINIFICATIONFILTER_AVG_PIXEL

      public static final String MINIFICATIONFILTER_AVG_PIXEL
      Tooltip: weighted average of four texture elements closest to center of pixel being textured. SFString field named minificationFilter with X3DUOM simpleType textureMinificationModeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "AVG_PIXEL" (Java syntax) or AVG_PIXEL (XML syntax).
      See Also:
    • MINIFICATIONFILTER_AVG_PIXEL_AVG_MIPMAP

      public static final String MINIFICATIONFILTER_AVG_PIXEL_AVG_MIPMAP
      Tooltip: tri-linear mipmap filtering. SFString field named minificationFilter with X3DUOM simpleType textureMinificationModeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "AVG_PIXEL_AVG_MIPMAP" (Java syntax) or AVG_PIXEL_AVG_MIPMAP (XML syntax).
      See Also:
    • MINIFICATIONFILTER_AVG_PIXEL_NEAREST_MIPMAP

      public static final String MINIFICATIONFILTER_AVG_PIXEL_NEAREST_MIPMAP
      Tooltip: choose mipmap that most closely matches size of pixel being textured, use weighted average of four texture elements closest to center of pixel. SFString field named minificationFilter with X3DUOM simpleType textureMinificationModeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "AVG_PIXEL_NEAREST_MIPMAP" (Java syntax) or AVG_PIXEL_NEAREST_MIPMAP (XML syntax).
      See Also:
    • MINIFICATIONFILTER_DEFAULT

      public static final String MINIFICATIONFILTER_DEFAULT
      Tooltip: browser-specified default minification mode. SFString field named minificationFilter with X3DUOM simpleType textureMinificationModeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "DEFAULT" (Java syntax) or DEFAULT (XML syntax).
      See Also:
    • MINIFICATIONFILTER_FASTEST

      public static final String MINIFICATIONFILTER_FASTEST
      Tooltip: fastest method available, use mipmaps if possible. SFString field named minificationFilter with X3DUOM simpleType textureMinificationModeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "FASTEST" (Java syntax) or FASTEST (XML syntax).
      See Also:
    • MINIFICATIONFILTER_NEAREST_PIXEL

      public static final String MINIFICATIONFILTER_NEAREST_PIXEL
      Tooltip: texture element nearest to center of pixel being textured. SFString field named minificationFilter with X3DUOM simpleType textureMinificationModeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "NEAREST_PIXEL" (Java syntax) or NEAREST_PIXEL (XML syntax).
      See Also:
    • MINIFICATIONFILTER_NEAREST_PIXEL_AVG_MIPMAP

      public static final String MINIFICATIONFILTER_NEAREST_PIXEL_AVG_MIPMAP
      Tooltip: texture element nearest to center of pixel being textured, use average of two nearest mipmaps. SFString field named minificationFilter with X3DUOM simpleType textureMinificationModeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "NEAREST_PIXEL_AVG_MIPMAP" (Java syntax) or NEAREST_PIXEL_AVG_MIPMAP (XML syntax).
      See Also:
    • MINIFICATIONFILTER_NEAREST_PIXEL_NEAREST_MIPMAP

      public static final String MINIFICATIONFILTER_NEAREST_PIXEL_NEAREST_MIPMAP
      Tooltip: texture element nearest to center of pixel being textured, use nearest mipmap. SFString field named minificationFilter with X3DUOM simpleType textureMinificationModeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "NEAREST_PIXEL_NEAREST_MIPMAP" (Java syntax) or NEAREST_PIXEL_NEAREST_MIPMAP (XML syntax).
      See Also:
    • MINIFICATIONFILTER_NICEST

      public static final String MINIFICATIONFILTER_NICEST
      Tooltip: highest quality method available. SFString field named minificationFilter with X3DUOM simpleType textureMinificationModeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "NICEST" (Java syntax) or NICEST (XML syntax).
      See Also:
    • TEXTURECOMPRESSION_DEFAULT

      public static final String TEXTURECOMPRESSION_DEFAULT
      Tooltip: browser-specified default compression mode. SFString field named textureCompression with X3DUOM simpleType textureCompressionModeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "DEFAULT" (Java syntax) or DEFAULT (XML syntax).
      See Also:
    • TEXTURECOMPRESSION_FASTEST

      public static final String TEXTURECOMPRESSION_FASTEST
      Tooltip: fastest method available. SFString field named textureCompression with X3DUOM simpleType textureCompressionModeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "FASTEST" (Java syntax) or FASTEST (XML syntax).
      See Also:
    • TEXTURECOMPRESSION_HIGH

      public static final String TEXTURECOMPRESSION_HIGH
      Tooltip: greatest amount of compression. SFString field named textureCompression with X3DUOM simpleType textureCompressionModeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "HIGH" (Java syntax) or HIGH (XML syntax).
      See Also:
    • TEXTURECOMPRESSION_LOW

      public static final String TEXTURECOMPRESSION_LOW
      Tooltip: least amount of compression. SFString field named textureCompression with X3DUOM simpleType textureCompressionModeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "LOW" (Java syntax) or LOW (XML syntax).
      See Also:
    • TEXTURECOMPRESSION_MEDIUM

      public static final String TEXTURECOMPRESSION_MEDIUM
      Tooltip: moderate amount of compressions. SFString field named textureCompression with X3DUOM simpleType textureCompressionModeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "MEDIUM" (Java syntax) or MEDIUM (XML syntax).
      See Also:
    • TEXTURECOMPRESSION_NICEST

      public static final String TEXTURECOMPRESSION_NICEST
      Tooltip: highest quality method available. SFString field named textureCompression with X3DUOM simpleType textureCompressionModeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "NICEST" (Java syntax) or NICEST (XML syntax).
      See Also:
    • NAME

      public static final String NAME
      String constant NAME provides name of this element: TextureProperties.
      See Also:
    • COMPONENT

      public static final String COMPONENT
      String constant COMPONENT defines X3D component for the TextureProperties element: Texturing
      See Also:
    • LEVEL

      public static final int LEVEL
      Integer constant LEVEL provides default X3D Texturing component level for this element: 2
      See Also:
    • ANISOTROPICDEGREE_DEFAULT_VALUE

      public static final float ANISOTROPICDEGREE_DEFAULT_VALUE
      SFFloat field named anisotropicDegree has default value 1f (Java syntax) or 1 (XML syntax).
      See Also:
    • BORDERCOLOR_DEFAULT_VALUE

      public static final float[] BORDERCOLOR_DEFAULT_VALUE
      SFColorRGBA field named borderColor has default value {0f,0f,0f,0f} (Java syntax) or 0 0 0 0 (XML syntax).
    • BORDERWIDTH_DEFAULT_VALUE

      public static final int BORDERWIDTH_DEFAULT_VALUE
      SFInt32 field named borderWidth has default value 0 (Java syntax) or 0 (XML syntax).
      See Also:
    • BOUNDARYMODER_DEFAULT_VALUE

      public static final String BOUNDARYMODER_DEFAULT_VALUE
      SFString field named boundaryModeR has default value "REPEAT" (Java syntax) or REPEAT (XML syntax).
      See Also:
    • BOUNDARYMODES_DEFAULT_VALUE

      public static final String BOUNDARYMODES_DEFAULT_VALUE
      SFString field named boundaryModeS has default value "REPEAT" (Java syntax) or REPEAT (XML syntax).
      See Also:
    • BOUNDARYMODET_DEFAULT_VALUE

      public static final String BOUNDARYMODET_DEFAULT_VALUE
      SFString field named boundaryModeT has default value "REPEAT" (Java syntax) or REPEAT (XML syntax).
      See Also:
    • GENERATEMIPMAPS_DEFAULT_VALUE

      public static final boolean GENERATEMIPMAPS_DEFAULT_VALUE
      SFBool field named generateMipMaps has default value false (Java syntax) or false (XML syntax).
      See Also:
    • IS_DEFAULT_VALUE

      public static final IS IS_DEFAULT_VALUE
      SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).
    • MAGNIFICATIONFILTER_DEFAULT_VALUE

      public static final String MAGNIFICATIONFILTER_DEFAULT_VALUE
      SFString field named magnificationFilter has default value "FASTEST" (Java syntax) or FASTEST (XML syntax).
      See Also:
    • METADATA_DEFAULT_VALUE

      public static final X3DMetadataObject METADATA_DEFAULT_VALUE
      SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).
    • MINIFICATIONFILTER_DEFAULT_VALUE

      public static final String MINIFICATIONFILTER_DEFAULT_VALUE
      SFString field named minificationFilter has default value "FASTEST" (Java syntax) or FASTEST (XML syntax).
      See Also:
    • TEXTURECOMPRESSION_DEFAULT_VALUE

      public static final String TEXTURECOMPRESSION_DEFAULT_VALUE
      SFString field named textureCompression has default value "FASTEST" (Java syntax) or FASTEST (XML syntax).
      See Also:
    • TEXTUREPRIORITY_DEFAULT_VALUE

      public static final float TEXTUREPRIORITY_DEFAULT_VALUE
      SFFloat field named texturePriority has default value 0f (Java syntax) or 0 (XML syntax).
      See Also:
    • containerField_DEFAULT_VALUE

      public static final String containerField_DEFAULT_VALUE
      containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.
      See Also:
    • fromField_ANISOTROPICDEGREE

      public static final String fromField_ANISOTROPICDEGREE
      fromField ROUTE name for SFFloat field named anisotropicDegree.
      See Also:
    • toField_ANISOTROPICDEGREE

      public static final String toField_ANISOTROPICDEGREE
      toField ROUTE name for SFFloat field named anisotropicDegree.
      See Also:
    • fromField_BORDERCOLOR

      public static final String fromField_BORDERCOLOR
      fromField ROUTE name for SFColorRGBA field named borderColor.
      See Also:
    • toField_BORDERCOLOR

      public static final String toField_BORDERCOLOR
      toField ROUTE name for SFColorRGBA field named borderColor.
      See Also:
    • fromField_BORDERWIDTH

      public static final String fromField_BORDERWIDTH
      fromField ROUTE name for SFInt32 field named borderWidth.
      See Also:
    • toField_BORDERWIDTH

      public static final String toField_BORDERWIDTH
      toField ROUTE name for SFInt32 field named borderWidth.
      See Also:
    • fromField_BOUNDARYMODER

      public static final String fromField_BOUNDARYMODER
      fromField ROUTE name for SFString field named boundaryModeR.
      See Also:
    • toField_BOUNDARYMODER

      public static final String toField_BOUNDARYMODER
      toField ROUTE name for SFString field named boundaryModeR.
      See Also:
    • fromField_BOUNDARYMODES

      public static final String fromField_BOUNDARYMODES
      fromField ROUTE name for SFString field named boundaryModeS.
      See Also:
    • toField_BOUNDARYMODES

      public static final String toField_BOUNDARYMODES
      toField ROUTE name for SFString field named boundaryModeS.
      See Also:
    • fromField_BOUNDARYMODET

      public static final String fromField_BOUNDARYMODET
      fromField ROUTE name for SFString field named boundaryModeT.
      See Also:
    • toField_BOUNDARYMODET

      public static final String toField_BOUNDARYMODET
      toField ROUTE name for SFString field named boundaryModeT.
      See Also:
    • fromField_IS

      public static final String fromField_IS
      fromField ROUTE name for SFNode field named IS.
      See Also:
    • fromField_MAGNIFICATIONFILTER

      public static final String fromField_MAGNIFICATIONFILTER
      fromField ROUTE name for SFString field named magnificationFilter.
      See Also:
    • toField_MAGNIFICATIONFILTER

      public static final String toField_MAGNIFICATIONFILTER
      toField ROUTE name for SFString field named magnificationFilter.
      See Also:
    • fromField_METADATA

      public static final String fromField_METADATA
      fromField ROUTE name for SFNode field named metadata.
      See Also:
    • toField_METADATA

      public static final String toField_METADATA
      toField ROUTE name for SFNode field named metadata.
      See Also:
    • fromField_MINIFICATIONFILTER

      public static final String fromField_MINIFICATIONFILTER
      fromField ROUTE name for SFString field named minificationFilter.
      See Also:
    • toField_MINIFICATIONFILTER

      public static final String toField_MINIFICATIONFILTER
      toField ROUTE name for SFString field named minificationFilter.
      See Also:
    • fromField_TEXTURECOMPRESSION

      public static final String fromField_TEXTURECOMPRESSION
      fromField ROUTE name for SFString field named textureCompression.
      See Also:
    • toField_TEXTURECOMPRESSION

      public static final String toField_TEXTURECOMPRESSION
      toField ROUTE name for SFString field named textureCompression.
      See Also:
    • fromField_TEXTUREPRIORITY

      public static final String fromField_TEXTUREPRIORITY
      fromField ROUTE name for SFFloat field named texturePriority.
      See Also:
    • toField_TEXTUREPRIORITY

      public static final String toField_TEXTUREPRIORITY
      toField ROUTE name for SFFloat field named texturePriority.
      See Also:
  • Constructor Details

    • TextureProperties

      public TextureProperties()
      Constructor for TextureProperties to initialize member variables with default values.
    • TextureProperties

      public TextureProperties(String DEFlabel)
      Utility constructor that assigns DEF label after initializing member variables with default values.
      Parameters:
      DEFlabel - unique DEF name for this X3D node
  • Method Details

    • getElementName

      public final String getElementName()
      Provides name of this element: TextureProperties
      Specified by:
      getElementName in class X3DConcreteElement
      Returns:
      name of this element
    • getComponent

      public final String getComponent()
      Defines X3D component for the TextureProperties element: Texturing
      Specified by:
      getComponent in class X3DConcreteElement
      Returns:
      X3D component for this element
    • getComponentLevel

      public final int getComponentLevel()
      Provides default X3D component level for this element: 2
      Specified by:
      getComponentLevel in class X3DConcreteElement
      Returns:
      default X3D component level for this element
    • getFieldType

      public String getFieldType(String fieldName)
      Indicate type corresponding to given fieldName.
      Specified by:
      getFieldType in class X3DConcreteElement
      Parameters:
      fieldName - name of field in this X3D node
      Returns:
      X3D type (SFvec3f etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE if not recognized
      See Also:
    • getAccessType

      public String getAccessType(String fieldName)
      Indicate accessType corresponding to given fieldName.
      Specified by:
      getAccessType in class X3DConcreteElement
      Parameters:
      fieldName - name of field in this X3D node
      Returns:
      X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized
      See Also:
    • getContainerFieldDefault

      public final String getContainerFieldDefault()
      containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.
      Specified by:
      getContainerFieldDefault in class X3DConcreteNode
      Returns:
      default containerField value
      See Also:
    • initialize

      public final void initialize()
      Initialize all member variables to default values.
      Overrides:
      initialize in class X3DConcreteNode
    • getAnisotropicDegree

      public 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. <a href="https://en.wikipedia.org/wiki/Anisotropy" target="_blank">https://en.wikipedia.org/wiki/Anisotropy</a> Hint: OpenGL EXT_texture_filter_anisotropic <a href="https://www.khronos.org/registry/OpenGL/extensions/EXT/EXT_texture_filter_anisotropic.txt" target="_blank">https://www.khronos.org/registry/OpenGL/extensions/EXT/EXT_texture_filter_anisotropic.txt</a> *
      Specified by:
      getAnisotropicDegree in interface TextureProperties
      Returns:
      value of anisotropicDegree field
    • setAnisotropicDegree

      public 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. Hint: Anisotropy indicates directional dependence of properties. <a href="https://en.wikipedia.org/wiki/Anisotropy" target="_blank">https://en.wikipedia.org/wiki/Anisotropy</a> Hint: OpenGL EXT_texture_filter_anisotropic <a href="https://www.khronos.org/registry/OpenGL/extensions/EXT/EXT_texture_filter_anisotropic.txt" target="_blank">https://www.khronos.org/registry/OpenGL/extensions/EXT/EXT_texture_filter_anisotropic.txt</a> *
      Specified by:
      setAnisotropicDegree in interface TextureProperties
      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).
    • setAnisotropicDegree

      public TextureProperties setAnisotropicDegree(SFFloat newValue)
      Assign typed object value to SFFloat anisotropicDegree field, similar to setAnisotropicDegree(float). // #0.e
      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).
    • setAnisotropicDegree

      public TextureProperties setAnisotropicDegree(double newValue)
      Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setAnisotropicDegree(float).
      Parameters:
      newValue - is new value for field
      Returns:
      TextureProperties - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getBorderColor

      public 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 <a href="https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color" target="_blank">https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color</a> *
      Specified by:
      getBorderColor in interface TextureProperties
      Returns:
      value of borderColor field
    • setBorderColor

      public 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. Hint: X3D Scene Authoring Hints, Color <a href="https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color" target="_blank">https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color</a> *
      Specified by:
      setBorderColor in interface TextureProperties
      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).
    • setBorderColor

      public TextureProperties setBorderColor(SFColorRGBA newValue)
      Assign typed object value to SFColorRGBA borderColor field, similar to setBorderColor(float[]). // #0.e
      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).
    • setBorderColor

      public TextureProperties setBorderColor(float red, float green, float blue, float alpha)
      Assign values to SFColorRGBA borderColor field, similar to setBorderColor(float[]).
      Parameters:
      red - first component
      green - second component
      blue - third component
      alpha - fourth component for opaqueness (1 - transparency)
      Returns:
      TextureProperties - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setBorderColor

      public TextureProperties setBorderColor(double red, double green, double blue, double alpha)
      Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setBorderColor(float[]).
      Parameters:
      red - first component [0..1]
      green - second component [0..1]
      blue - third component [0..1]
      alpha - fourth component [0..1]
      Returns:
      TextureProperties - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setBorderColor

      public TextureProperties setBorderColor(double[] newArray)
      Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setBorderColor(float[]).
      Parameters:
      newArray - is new value for field
      Returns:
      TextureProperties - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getBorderWidth

      public 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. *
      Specified by:
      getBorderWidth in interface TextureProperties
      Returns:
      value of borderWidth field
    • setBorderWidth

      public 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. *
      Specified by:
      setBorderWidth in interface TextureProperties
      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).
    • setBorderWidth

      public TextureProperties setBorderWidth(SFInt32 newValue)
      Assign typed object value to SFInt32 borderWidth field, similar to setBorderWidth(int). // #0.e
      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

      public 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 <a href="https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/texturing.html#t-TextureBoundaryModes" target="_blank">https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/texturing.html#t-TextureBoundaryModes</a> for details. *


      Available enumeration values for string comparison: CLAMP, CLAMP_TO_EDGE, CLAMP_TO_BOUNDARY, MIRRORED_REPEAT, REPEAT.
      Specified by:
      getBoundaryModeR in interface TextureProperties
      Returns:
      value of boundaryModeR field
    • setBoundaryModeR

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

      Warning: authors can only choose from a strict list of enumeration values (CLAMP, CLAMP_TO_EDGE, CLAMP_TO_BOUNDARY, MIRRORED_REPEAT, REPEAT).

      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 <a href="https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/texturing.html#t-TextureBoundaryModes" target="_blank">https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/texturing.html#t-TextureBoundaryModes</a> for details. *
      Specified by:
      setBoundaryModeR in interface TextureProperties
      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).
    • setBoundaryModeR

      public TextureProperties setBoundaryModeR(SFString newValue)
      Assign typed object value to SFString boundaryModeR field, similar to setBoundaryModeR(String). // #0.e
      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

      public 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 <a href="https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/texturing.html#t-TextureBoundaryModes" target="_blank">https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/texturing.html#t-TextureBoundaryModes</a> for details. *


      Available enumeration values for string comparison: CLAMP, CLAMP_TO_EDGE, CLAMP_TO_BOUNDARY, MIRRORED_REPEAT, REPEAT.
      Specified by:
      getBoundaryModeS in interface TextureProperties
      Returns:
      value of boundaryModeS field
    • setBoundaryModeS

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

      Warning: authors can only choose from a strict list of enumeration values (CLAMP, CLAMP_TO_EDGE, CLAMP_TO_BOUNDARY, MIRRORED_REPEAT, REPEAT).

      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 <a href="https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/texturing.html#t-TextureBoundaryModes" target="_blank">https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/texturing.html#t-TextureBoundaryModes</a> for details. *
      Specified by:
      setBoundaryModeS in interface TextureProperties
      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).
    • setBoundaryModeS

      public TextureProperties setBoundaryModeS(SFString newValue)
      Assign typed object value to SFString boundaryModeS field, similar to setBoundaryModeS(String). // #0.e
      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

      public 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 <a href="https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/texturing.html#t-TextureBoundaryModes" target="_blank">https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/texturing.html#t-TextureBoundaryModes</a> for details. *


      Available enumeration values for string comparison: CLAMP, CLAMP_TO_EDGE, CLAMP_TO_BOUNDARY, MIRRORED_REPEAT, REPEAT.
      Specified by:
      getBoundaryModeT in interface TextureProperties
      Returns:
      value of boundaryModeT field
    • setBoundaryModeT

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

      Warning: authors can only choose from a strict list of enumeration values (CLAMP, CLAMP_TO_EDGE, CLAMP_TO_BOUNDARY, MIRRORED_REPEAT, REPEAT).

      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 <a href="https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/texturing.html#t-TextureBoundaryModes" target="_blank">https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/texturing.html#t-TextureBoundaryModes</a> for details. *
      Specified by:
      setBoundaryModeT in interface TextureProperties
      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).
    • setBoundaryModeT

      public TextureProperties setBoundaryModeT(SFString newValue)
      Assign typed object value to SFString boundaryModeT field, similar to setBoundaryModeT(String). // #0.e
      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

      public 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 <a href="https://en.wikipedia.org/wiki/Aliasing" target="_blank">https://en.wikipedia.org/wiki/Aliasing</a> and Clipping <a href="https://en.wikipedia.org/wiki/Clipping_(computer_graphics)" target="_blank">https://en.wikipedia.org/wiki/Clipping_(computer_graphics)</a> Hint: Mipmap <a href="https://en.wikipedia.org/wiki/Mipmap" target="_blank">https://en.wikipedia.org/wiki/Mipmap</a> *
      Specified by:
      getGenerateMipMaps in interface TextureProperties
      Returns:
      value of generateMipMaps field
    • setGenerateMipMaps

      public 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 <a href="https://en.wikipedia.org/wiki/Aliasing" target="_blank">https://en.wikipedia.org/wiki/Aliasing</a> and Clipping <a href="https://en.wikipedia.org/wiki/Clipping_(computer_graphics)" target="_blank">https://en.wikipedia.org/wiki/Clipping_(computer_graphics)</a> Hint: Mipmap <a href="https://en.wikipedia.org/wiki/Mipmap" target="_blank">https://en.wikipedia.org/wiki/Mipmap</a> *
      Specified by:
      setGenerateMipMaps in interface TextureProperties
      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).
    • setGenerateMipMaps

      public TextureProperties setGenerateMipMaps(SFBool newValue)
      Assign typed object value to SFBool generateMipMaps field, similar to setGenerateMipMaps(boolean). // #0.e
      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).
    • getIS

      public IS getIS()
      Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.
      Specified by:
      getIS in class X3DConcreteNode
      Returns:
      value of IS field
      See Also:
    • setIS

      public TextureProperties setIS(IS newValue)
      Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
      Specified by:
      setIS in class X3DConcreteNode
      Parameters:
      newValue - is new value for the IS field.
      Returns:
      TextureProperties - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
    • clearIS

      public TextureProperties clearIS()
      Utility method to clear SFNode value of IS field.
      Returns:
      TextureProperties - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • hasIS

      public boolean hasIS()
      Indicate whether an object is available for inputOutput SFNode field IS.
      Returns:
      whether a concrete statement or CommentsBlock is available.
      See Also:
    • getMagnificationFilter

      public 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 <a href="https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/texturing.html#t-TextureMagnificationModes" target="_blank">https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/texturing.html#t-TextureMagnificationModes</a> for details. *


      Available enumeration values for string comparison: AVG_PIXEL, DEFAULT, FASTEST, NEAREST_PIXEL, NICEST.
      Specified by:
      getMagnificationFilter in interface TextureProperties
      Returns:
      value of magnificationFilter field
    • setMagnificationFilter

      public TextureProperties setMagnificationFilter(String newValue)
      Accessor method to assign String enumeration value ("AVG_PIXEL" | "DEFAULT" | "FASTEST" | "NEAREST_PIXEL" | "NICEST") to inputOutput SFString field named magnificationFilter.

      Warning: authors can only choose from a strict list of enumeration values (AVG_PIXEL, DEFAULT, FASTEST, NEAREST_PIXEL, NICEST).

      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 <a href="https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/texturing.html#t-TextureMagnificationModes" target="_blank">https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/texturing.html#t-TextureMagnificationModes</a> for details. *
      Specified by:
      setMagnificationFilter in interface TextureProperties
      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).
    • setMagnificationFilter

      public TextureProperties setMagnificationFilter(SFString newValue)
      Assign typed object value to SFString magnificationFilter field, similar to setMagnificationFilter(String). // #0.e
      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

      public X3DMetadataObject getMetadata()
      Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
      Specified by:
      getMetadata in interface TextureProperties
      Specified by:
      getMetadata in interface X3DNode
      Returns:
      value of metadata field
      See Also:


      • 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 <a href="https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/core.html#Metadata" target="_blank">https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/core.html#Metadata</a> *
      • X3D Scene Authoring Hints: Metadata Nodes
    • setMetadata

      public 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.
      Specified by:
      setMetadata in interface TextureProperties
      Specified by:
      setMetadata in interface X3DNode
      Specified by:
      setMetadata in class X3DConcreteNode
      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:
    • clearMetadata

      public TextureProperties clearMetadata()
      Utility method to clear SFNode value of metadata field.
      Returns:
      TextureProperties - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • setMetadata

      public TextureProperties setMetadata(ProtoInstance newValue)
      Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
      Specified by:
      setMetadata in class X3DConcreteNode
      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:
    • hasMetadata

      public boolean hasMetadata()
      Indicate whether an object is available for inputOutput SFNode field metadata.
      Returns:
      whether a properly typed node or ProtoInstance or CommentsBlock is available.
      See Also:
    • getMinificationFilter

      public 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 <a href="https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/texturing.html#t-TextureMinificationModes" target="_blank">https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/texturing.html#t-TextureMinificationModes</a> for details. *


      Available enumeration values for string comparison: AVG_PIXEL, AVG_PIXEL_AVG_MIPMAP, AVG_PIXEL_NEAREST_MIPMAP, DEFAULT, FASTEST, NEAREST_PIXEL, NEAREST_PIXEL_AVG_MIPMAP, NEAREST_PIXEL_NEAREST_MIPMAP, NICEST.
      Specified by:
      getMinificationFilter in interface TextureProperties
      Returns:
      value of minificationFilter field
    • setMinificationFilter

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

      Warning: authors can only choose from a strict list of enumeration values (AVG_PIXEL, AVG_PIXEL_AVG_MIPMAP, AVG_PIXEL_NEAREST_MIPMAP, DEFAULT, FASTEST, NEAREST_PIXEL, NEAREST_PIXEL_AVG_MIPMAP, NEAREST_PIXEL_NEAREST_MIPMAP, NICEST).

      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 <a href="https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/texturing.html#t-TextureMinificationModes" target="_blank">https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/texturing.html#t-TextureMinificationModes</a> for details. *
      Specified by:
      setMinificationFilter in interface TextureProperties
      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).
    • setMinificationFilter

      public TextureProperties setMinificationFilter(SFString newValue)
      Assign typed object value to SFString minificationFilter field, similar to setMinificationFilter(String). // #0.e
      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

      public 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 <a href="https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/texturing.html#t-TextureCompressionModes" target="_blank">https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/texturing.html#t-TextureCompressionModes</a> for details. Hint: Texture compression <a href="https://en.wikipedia.org/wiki/Texture_compression" target="_blank">https://en.wikipedia.org/wiki/Texture_compression</a> *


      Available enumeration values for string comparison: DEFAULT, FASTEST, HIGH, LOW, MEDIUM, NICEST.
      Specified by:
      getTextureCompression in interface TextureProperties
      Returns:
      value of textureCompression field
    • setTextureCompression

      public TextureProperties setTextureCompression(String newValue)
      Accessor method to assign String enumeration value ("DEFAULT" | "FASTEST" | "HIGH" | "LOW" | "MEDIUM" | "NICEST") to inputOutput SFString field named textureCompression.

      Warning: authors can only choose from a strict list of enumeration values (DEFAULT, FASTEST, HIGH, LOW, MEDIUM, NICEST).

      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 <a href="https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/texturing.html#t-TextureCompressionModes" target="_blank">https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/texturing.html#t-TextureCompressionModes</a> for details. Hint: Texture compression <a href="https://en.wikipedia.org/wiki/Texture_compression" target="_blank">https://en.wikipedia.org/wiki/Texture_compression</a> *
      Specified by:
      setTextureCompression in interface TextureProperties
      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).
    • setTextureCompression

      public TextureProperties setTextureCompression(SFString newValue)
      Assign typed object value to SFString textureCompression field, similar to setTextureCompression(String). // #0.e
      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

      public 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. *
      Specified by:
      getTexturePriority in interface TextureProperties
      Returns:
      value of texturePriority field
    • setTexturePriority

      public 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. *
      Specified by:
      setTexturePriority in interface TextureProperties
      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).
    • setTexturePriority

      public TextureProperties setTexturePriority(SFFloat newValue)
      Assign typed object value to SFFloat texturePriority field, similar to setTexturePriority(float). // #0.e
      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).
    • setTexturePriority

      public TextureProperties setTexturePriority(double newValue)
      Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setTexturePriority(float).
      Parameters:
      newValue - is new value for field
      Returns:
      TextureProperties - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getDEF

      public String getDEF()
      Provide String value from inputOutput SFString field named DEF.

      Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes. Hint: descriptive DEF names improve clarity and help document a model. Hint: well-defined names can simplify design and debugging through improved author understanding. Hint: X3D Scene Authoring Hints, Naming Conventions <a href="https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions" target="_blank">https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions</a> *
      Overrides:
      getDEF in class X3DConcreteNode
      Returns:
      value of DEF field
      See Also:
    • setDEF

      public final TextureProperties setDEF(String newValue)
      Accessor method to assign String value to inputOutput SFString field named DEF.

      Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes. Hint: descriptive DEF names improve clarity and help document a model. Hint: well-defined names can simplify design and debugging through improved author understanding. Hint: X3D Scene Authoring Hints, Naming Conventions <a href="https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions" target="_blank">https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions</a> *


      Note that setting the DEF value clears the USE value.
      Specified by:
      setDEF in class X3DConcreteNode
      Parameters:
      newValue - is new value for the DEF field.
      Returns:
      TextureProperties - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setDEF

      public TextureProperties setDEF(SFString newValue)
      Assign typed object value to SFString DEF field, similar to setDEF(String). // #0.e
      Parameters:
      newValue - is new value for the DEF field.
      Returns:
      TextureProperties - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getUSE

      public String getUSE()
      Provide String value from inputOutput SFString field named USE.

      Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value). Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance. Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute. Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene. *
      Overrides:
      getUSE in class X3DConcreteNode
      Returns:
      value of USE field
      See Also:
    • setUSE

      public final TextureProperties setUSE(String newValue)
      Accessor method to assign String value to inputOutput SFString field named USE.

      Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value). Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance. Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute. Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene. *


      Note: each USE node is still an independent object, with the USE value matching the DEF value in the preceding object.

      Warning: invoking the setUSE() method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.

      Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.
      Specified by:
      setUSE in class X3DConcreteNode
      Parameters:
      newValue - is new value for the USE field.
      Returns:
      TextureProperties - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setUSE

      public TextureProperties setUSE(SFString newValue)
      Assign typed object value to SFString USE field, similar to setUSE(String). // #0.e
      Parameters:
      newValue - is new value for the USE field.
      Returns:
      TextureProperties - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getCssClass

      public String getCssClass()
      Provide String value from inputOutput SFString field named class.
      Overrides:
      getCssClass in class X3DConcreteElement
      Returns:
      value of class field
      See Also:
    • setCssClass

      public final TextureProperties setCssClass(String newValue)
      Accessor method to assign String value to inputOutput SFString field named class.
      Specified by:
      setCssClass in class X3DConcreteNode
      Parameters:
      newValue - is new value for the class field.
      Returns:
      TextureProperties - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
    • setCssClass

      public TextureProperties setCssClass(SFString newValue)
      Assign typed object value to SFString cssClass field, similar to setCssClass(String). // #0.e
      Parameters:
      newValue - is new value for the class field.
      Returns:
      TextureProperties - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getHtmlID

      public String getHtmlID()
      Provide String value from inputOutput SFString field named id.
      Overrides:
      getHtmlID in class X3DConcreteElement
      Returns:
      value of id field
      See Also:
    • setHtmlID

      public final TextureProperties setHtmlID(String newValue)
      Accessor method to assign String value to inputOutput SFString field named id.
      Specified by:
      setHtmlID in class X3DConcreteNode
      Parameters:
      newValue - is new value for the id field.
      Returns:
      TextureProperties - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
    • setHtmlID

      public TextureProperties setHtmlID(SFString newValue)
      Assign typed object value to SFString HtmlID field, similar to setHtmlID(String). // #0.e
      Parameters:
      newValue - is new value for the id field.
      Returns:
      TextureProperties - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getCssStyle

      public String getCssStyle()
      Provide String value from inputOutput SFString field named style.
      Overrides:
      getCssStyle in class X3DConcreteElement
      Returns:
      value of style field
      See Also:
    • setCssStyle

      public final TextureProperties setCssStyle(String newValue)
      Accessor method to assign String value to inputOutput SFString field named style.
      Specified by:
      setCssStyle in class X3DConcreteNode
      Parameters:
      newValue - is new value for the style field.
      Returns:
      TextureProperties - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
    • setCssStyle

      public TextureProperties setCssStyle(SFString newValue)
      Assign typed object value to SFString cssClass field, similar to setCssStyle(String). // #0.e
      Parameters:
      newValue - is new value for the style field.
      Returns:
      TextureProperties - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setUSE

      public TextureProperties setUSE(TextureProperties DEFnode)
      Assign a USE reference to another DEF node of same node type, similar to setUSE(String).

      Warning: note that the setUSE() method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.

      Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.
      Parameters:
      DEFnode - must have a DEF value defined
      Returns:
      TextureProperties - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • addComments

      public TextureProperties addComments(String newComment)
      Add comment as String to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newComment - initial value
      Returns:
      TextureProperties - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
    • addComments

      public TextureProperties addComments(String[] newComments)
      Add comments as String[] array to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newComments - array of comments
      Returns:
      TextureProperties - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • addComments

      public TextureProperties addComments(CommentsBlock newCommentsBlock)
      Add CommentsBlock to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newCommentsBlock - block of comments to add
      Returns:
      TextureProperties - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • toStringX3D

      public String toStringX3D(int indentLevel)
      Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
      Specified by:
      toStringX3D in class X3DConcreteElement
      Parameters:
      indentLevel - number of levels of indentation for this element
      Returns:
      X3D string
      See Also:
    • toStringClassicVRML

      public String toStringClassicVRML(int indentLevel)
      Recursive method to provide ClassicVRML string serialization.
      Specified by:
      toStringClassicVRML in class X3DConcreteElement
      Parameters:
      indentLevel - number of levels of indentation for this element
      Returns:
      ClassicVRML string
      See Also:
    • toStringVRML97

      public String toStringVRML97(int indentLevel)
      Recursive method to provide VRML97 string serialization.
      Specified by:
      toStringVRML97 in class X3DConcreteElement
      Parameters:
      indentLevel - number of levels of indentation for this element
      Returns:
      VRML97 string
      See Also:
    • findElementByNameValue

      public X3DConcreteElement findElementByNameValue(String nameValue)
      Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.

      Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.

      Warning: more than one element may be found that has the same name, this method does not handle that case.
      Specified by:
      findElementByNameValue in class X3DConcreteElement
      Parameters:
      nameValue - is value of the name field being searched for in this element and child elements(if any)
      Returns:
      object reference to found element, null otherwise
      See Also:
    • findElementByNameValue

      public X3DConcreteElement findElementByNameValue(String nameValue, String elementName)
      Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.

      Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.

      Warning: more than one element may be found that has the same name, this method does not handle that case.
      Specified by:
      findElementByNameValue in class X3DConcreteElement
      Parameters:
      nameValue - is value of the name field being searched for in this element and child elements(if any)
      elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
      Returns:
      object reference to found element, null otherwise
      See Also:
    • hasElementByNameValue

      public boolean hasElementByNameValue(String nameValue, String elementName)
      Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
      Parameters:
      nameValue - is value of the name field being searched for in this element and child elements(if any)
      elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
      Returns:
      whether node is found
      See Also:
    • findNodeByDEF

      public X3DConcreteNode findNodeByDEF(String DEFvalue)
      Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.

      Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.

      Warning: more than one element may be found that has the same DEF, this method does not handle that case.
      Specified by:
      findNodeByDEF in class X3DConcreteElement
      Parameters:
      DEFvalue - is value of the name field being searched for in this element and child elements(if any)
      Returns:
      object reference to found node, null otherwise
      See Also:
    • hasNodeByDEF

      public boolean hasNodeByDEF(String DEFvalue)
      Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
      Parameters:
      DEFvalue - is value of the name field being searched for in this element and child elements(if any)
      Returns:
      whether node is found
      See Also:
    • validate

      public String validate()
      Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.
      Specified by:
      validate in class X3DConcreteElement
      Returns:
      validation results (if any)