jv.geom

## Class PgTexture

- java.lang.Object
- - jv.object.PsObject
  - - jv.geom.PgTexture

- All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable, PsUpdateIf

      public class PgTexture
      extends PsObject

  Texture image associated to a geometry. The geometry must supply texture coordinates in [0,1]*[0,1], either at vertices or for elements. Texture coordinates outside the normalized texture square are mapped by modulo computation inside the domain.

  Repetition of texture image within the texture domain is possible in two ways: either texture coordinates of a geometry are scaled to rectangles [0,m]*[0,n], or alternatively by setting the repetition factors to m and n.

  See Also:
    `PgPointSet`, Serialized Form

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `static int` | `BLEND_MATERIAL` Deprecated. since 3.96.022, use same instance variables of PgGeometryIf instead.
    `static int` | `BLEND_REPLACE` Deprecated. since 3.96.022, use same instance variables of PgGeometryIf instead.
    `static int` | `FILTER_DIRECT` Deprecated. since 3.96.022, use same instance variables of PgGeometryIf instead.
    `static int` | `FILTER_LINEAR` Deprecated. since 3.96.022, use same instance variables of PgGeometryIf instead.
    `static int` | `FILTER_QUADRATIC` Deprecated. since 3.96.022, use same instance variables of PgGeometryIf instead.

    - ### Fields inherited from class jv.object.PsObject

      `HAS_BOUNDARY_PANEL, HAS_CONFIG_PANEL, HAS_INFO_PANEL, HAS_LABEL_PANEL, HAS_MATERIAL_PANEL, HAS_TEXTURE_PANEL, HAS_VECTOR_PANEL, INSPECTOR_INFO, INSPECTOR_INFO_EXT, IS_DELETED, IS_FIXED, IS_FOCUSSED, IS_PICKED, IS_SELECTED, IS_USED, NUM_TAGS`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `PgTexture()`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | `blend(double s, PgTexture a, double t, PgTexture b)` Blend between two texture objects using `this = s*ag + t*bg`.
    `java.lang.Object` | `clone()` Duplicate texture by recursively cloning all instance variables except inspector panels and lists of registered listeners.
    `void` | `copy(PgTexture tex)` Copy base instance variables and prepend "Copy of" to name if identical to original object name.
    `int` | `getBlendingMode()` Get mode how texture color is applied to surface.
    `int` | `getFilterType()` Get mode how texture image is sampled to compute color of pixel.
    `int` | `getHeight()` Get height of used region in texture image.
    `int` | `getHeightTiling()` Get number of repetitions of texture image along height.
    `java.awt.Image` | `getImage()` Get image of texture.
    `java.lang.String` | `getImageName()` Get file name of texture image.
    `int` | `getPeriodic()` Get type of periodic extension of texture outside the unit texture square.
    `PdVector[]` | `getTextureImageBnd()` Get bounds of texture image in normalized texture coordinates.
    `int` | `getTextureSide()` Determines whether texture is shown on front, back or both sides of a surface, if texture is shown at all.
    `java.awt.Dimension` | `getTiling()` Get number of repetitions of texture image in both directions.
    `int` | `getUMax()` Get upper width of used region in texture image.
    `int` | `getUMin()` Get lower width value of used region in texture image.
    `int` | `getVMax()` Get upper height of used region in texture image.
    `int` | `getVMin()` Get lower height value of used region in texture image.
    `int` | `getWidth()` Get width of used region in texture image.
    `int` | `getWidthTiling()` Get number of repetitions of texture image along width.
    `void` | `init()` If instance has missing name then assign default name 'Object_NUMBER' where number is the total number of already created instances.
    `boolean` | `isEnabledMove()` Get mode if size sliders are either used to resize the used sector of the texture image or to move the shown sector over the image.
    `java.awt.Image` | `loadImage()` Load image whose name was previously assigned to this class.
    `java.awt.Image` | `loadImage(java.awt.Component comp)` Load image whose name was previously assigned to this class.
    `void` | `setBlendingMode(int blendingMode)` Set mode how texture color is applied to surface.
    `void` | `setEnabledMove(boolean flag)` Set mode that size sliders are either used to resize the used sector of the texture image or to move the shown sector over the image.
    `void` | `setFilterType(int filterType)` Set mode how texture image is sampled to compute color of pixel.
    `void` | `setImage(java.awt.Image image)` Set image of texture.
    `void` | `setImage(java.lang.String name)` Deprecated. use #setImageName(String) instead.
    `void` | `setImageName(java.lang.String name)` Set file name of texture image including relative or full path or full url.
    `void` | `setPeriodic(int periodic)` Set number of repetitions of texture image in both directions.
    `void` | `setTextureImageBnd(PdVector[] bnd)` Set bounds of texture image in normalized texture coordinates.
    `void` | `setTextureSide(int side)` Set flag whether texture is shown on front, back or both sides of a surface, if texture is shown at all.
    `void` | `setTiling(java.awt.Dimension repeat)` Set number of repetitions of texture image in both directions.
    `void` | `setTiling(int width, int height)` Set number of repetitions of texture image in both directions.
    `void` | `setUMax(int value)` Set upper width of used region in texture image.
    `void` | `setUMin(int value)` Set lower width value of used region in texture image.
    `void` | `setVMax(int value)` Set upper height of used region in texture image.
    `void` | `setVMin(int value)` Set lower height value of used region in texture image.
    `boolean` | `update(java.lang.Object event)` Update the class whenever a child has changed.

    - ### Methods inherited from class jv.object.PsObject

      `addInspector, addUpdateListener, assureInspector, clearTag, clone, clone, copy, getFather, getInfoPanel, getInspector, getName, getNumObjects, getSymbol, hasInspector, hasTag, hasUpdateListener, instanceOf, instanceOf, newInspector, newInspector, removeInspector, removeInspector, removeUpdateListener, setName, setParent, setSymbol, setTag, toString, updatePanels`

    - ### Methods inherited from class java.lang.Object

      `equals, getClass, hashCode, notify, notifyAll, wait, wait, wait`

- - ### Field Detail

    - #### FILTER_DIRECT

          public static final int FILTER_DIRECT

      Deprecated. since 3.96.022, use same instance variables of PgGeometryIf instead.
      No filtering, for each pixel the texture image is sampled at a single point.
      See Also:
        Constant Field Values

    - #### FILTER_LINEAR

          public static final int FILTER_LINEAR

      Deprecated. since 3.96.022, use same instance variables of PgGeometryIf instead.
      Bilinear filtering, for each pixel the texture image is sampled at a four points.
      See Also:
        Constant Field Values

    - #### FILTER_QUADRATIC

          public static final int FILTER_QUADRATIC

      Deprecated. since 3.96.022, use same instance variables of PgGeometryIf instead.
      Biquadratic filtering, for each pixel the texture image is sampled at a nine points.
      See Also:
        Constant Field Values

    - #### BLEND_REPLACE

          public static final int BLEND_REPLACE

      Deprecated. since 3.96.022, use same instance variables of PgGeometryIf instead.
      Replace surface color with texture color.
      See Also:
        Constant Field Values

    - #### BLEND_MATERIAL

          public static final int BLEND_MATERIAL

      Deprecated. since 3.96.022, use same instance variables of PgGeometryIf instead.
      Blends the surface color with texture color depending on texture alpha.
      See Also:
        Constant Field Values

  - ### Constructor Detail

    - #### PgTexture

          public PgTexture()

  - ### Method Detail

    - #### init

          public void init()

      Description copied from class: `PsObject`
      If instance has missing name then assign default name 'Object_NUMBER' where number is the total number of already created instances.
      Overrides:
        `init` in class `PsObject`

    - #### clone

          public java.lang.Object clone()

      Duplicate texture by recursively cloning all instance variables except inspector panels and lists of registered listeners. The parent relationship is maintained only within this class but not to external classes.

      Link to image is copied. Image is not cloned and not nulled since class Image has no clone() method.

      Overrides:
        `clone` in class `PsObject`
      See Also:
        `PsObject.copy(PsObject)`

    - #### copy

          public void copy(PgTexture tex)

      Copy base instance variables and prepend "Copy of" to name if identical to original object name. In general, only geometry data is copied, no material properties and no external links.
      See Also:
        `clone()`

    - #### update

          public boolean update(java.lang.Object event)

      Update the class whenever a child has changed. Method is usually invoked from the children.
      Specified by:
        `update` in interface `PsUpdateIf`
      Overrides:
        `update` in class `PsObject`
      Parameters:
        `event` - carries a lot of information
      Returns:
        true if event has been handled, otherwise false
      See Also:
        `PsObject.setParent(PsUpdateIf)`, `PsObject.getFather()`, `PsObject.addUpdateListener(PsUpdateIf)`

    - #### getImageName

          public java.lang.String getImageName()

      Get file name of texture image.

    - #### setImageName

          public void setImageName(java.lang.String name)

      Set file name of texture image including relative or full path or full url.
      Parameters:
        `name` - name of image file including a relative path.

    - #### setImage

          public void setImage(java.lang.String name)

      Deprecated. use #setImageName(String) instead.
      Set file name of texture image including relative or full path or full url.

    - #### getImage

          public java.awt.Image getImage()

      Get image of texture.

    - #### setImage

          public void setImage(java.awt.Image image)

      Set image of texture. The cropping values are adjusted to cover the full image.

    - #### getTextureImageBnd

          public PdVector[] getTextureImageBnd()

      Get bounds of texture image in normalized texture coordinates.
      Returns:
        array of length two with position of lower left and upper right position of image.
      Since:
        JavaView 2.86.000

    - #### setTextureImageBnd

          public void setTextureImageBnd(PdVector[] bnd)

      Set bounds of texture image in normalized texture coordinates. Bounds are given by two vectors with the position of lower left and upper right corner of the texture image in normalized texture coordinates. The dimension of each vector must be equal to the dimension of the texture. For a two-dimensional texture the default is {(0,0),(1,1)}.
      Parameters:
        `bnd` - array with bounds of image.
      Since:
        JavaView 2.86.000

    - #### getUMin

          public int getUMin()

      Get lower width value of used region in texture image.
      Returns:
        value in pixel coordinates

    - #### setUMin

          public void setUMin(int value)

      Set lower width value of used region in texture image.
      Parameters:
        `value` - in pixel coordinates

    - #### getVMin

          public int getVMin()

      Get lower height value of used region in texture image.
      Returns:
        value in pixel coordinates

    - #### setVMin

          public void setVMin(int value)

      Set lower height value of used region in texture image.
      Parameters:
        `value` - in pixel coordinates

    - #### getUMax

          public int getUMax()

      Get upper width of used region in texture image.
      Returns:
        value in pixel coordinates

    - #### setUMax

          public void setUMax(int value)

      Set upper width of used region in texture image.
      Parameters:
        `value` - in pixel coordinates

    - #### getVMax

          public int getVMax()

      Get upper height of used region in texture image.
      Returns:
        value in pixel coordinates

    - #### setVMax

          public void setVMax(int value)

      Set upper height of used region in texture image.
      Parameters:
        `value` - in pixel coordinates

    - #### getWidth

          public int getWidth()

      Get width of used region in texture image.
      Returns:
        value in pixel coordinates

    - #### getHeight

          public int getHeight()

      Get height of used region in texture image.
      Returns:
        value in pixel coordinates

    - #### loadImage

          public java.awt.Image loadImage()

      Load image whose name was previously assigned to this class. The loaded image will become the image of this texture.

      Method is a convenience and simply calls `loadImage(PsConfig.getFrame())`.

      Returns:
        the loaded image, or `null` if failure.

    - #### loadImage

          public java.awt.Image loadImage(java.awt.Component comp)

      Load image whose name was previously assigned to this class. The loaded image will become the image of this texture.
      Parameters:
        `comp` - component to draw image on.
      Returns:
        the loaded image, or `null` if failure.

    - #### getPeriodic

          public int getPeriodic()

      Get type of periodic extension of texture outside the unit texture square.
      Returns:
        Type which is a value such as m_periodic.
      Since:
        JavaView 3.96.025

    - #### setPeriodic

          public void setPeriodic(int periodic)

      Set number of repetitions of texture image in both directions.
      Parameters:
        `periodic` - Type of periodic extension such as m_periodic.
      Since:
        JavaView 3.96.025

    - #### getTiling

          public java.awt.Dimension getTiling()

      Get number of repetitions of texture image in both directions.
      Returns:
        Number of repetitions of texture image in both directions.

    - #### setTiling

          public void setTiling(java.awt.Dimension repeat)

      Set number of repetitions of texture image in both directions.
      Parameters:
        `repeat` - Number of repetitions of texture image in both directions.

    - #### setTiling

          public void setTiling(int width,
                       int height)

      Set number of repetitions of texture image in both directions.
      Parameters:
        `width` - Number of repetitions of texture image along width.
        `height` - Number of repetitions of texture image along height.

    - #### getWidthTiling

          public int getWidthTiling()

      Get number of repetitions of texture image along width.
      Returns:
        Number of repetitions of texture image along width.

    - #### getHeightTiling

          public int getHeightTiling()

      Get number of repetitions of texture image along height.
      Returns:
        Number of repetitions of texture image along height.

    - #### getFilterType

          public int getFilterType()

      Get mode how texture image is sampled to compute color of pixel.
      Returns:
        Filter type such as PgGeometryIf.FILTER_DIRECT, PgGeometryIf.FILTER_QUADRATIC ...

    - #### setFilterType

          public void setFilterType(int filterType)

      Set mode how texture image is sampled to compute color of pixel.
      Parameters:
        `filterType` - Filter type such as PgGeometryIf.FILTER_DIRECT, PgGeometryIf.FILTER_QUADRATIC ...

    - #### getBlendingMode

          public int getBlendingMode()

      Get mode how texture color is applied to surface.
      Returns:
        Blending type such as PgGeometryIf.BLEND_REPLACE, PgGeometryIf.BLEND_MATERIAL ...

    - #### setBlendingMode

          public void setBlendingMode(int blendingMode)

      Set mode how texture color is applied to surface.
      Parameters:
        `blendingMode` - Blending type such as PgGeometryIf.BLEND_REPLACE, PgGeometryIf.BLEND_MATERIAL ...

    - #### getTextureSide

          public int getTextureSide()

      Determines whether texture is shown on front, back or both sides of a surface, if texture is shown at all.
      Since:
        JavaView 3.96.022

    - #### setTextureSide

          public void setTextureSide(int side)

      Set flag whether texture is shown on front, back or both sides of a surface, if texture is shown at all.
      Since:
        JavaView 3.96.022

    - #### isEnabledMove

          public boolean isEnabledMove()

      Get mode if size sliders are either used to resize the used sector of the texture image or to move the shown sector over the image.
      Returns:
        Determines if size sliders are used to move rather than rescale image.

    - #### setEnabledMove

          public void setEnabledMove(boolean flag)

      Set mode that size sliders are either used to resize the used sector of the texture image or to move the shown sector over the image.
      Parameters:
        `flag` - Determines if size sliders are used to move rather than rescale image.

    - #### blend

          public boolean blend(double s,
                      PgTexture a,
                      double t,
                      PgTexture b)

      Blend between two texture objects using `this = s*ag + t*bg`. Image class is neither blended nor assigned, instead pixel values are blended.

      Images of both textures must have same dimensions. Otherwise an error is encountered and method returns.

      Parameters:
        `s` - weight of first texture
        `a` - first texture used for blending
        `t` - weight of second texture
        `b` - second texture used for blending
      Returns:
        true on success

"

The software JavaView? is copyright protected. All Rights Reserved.
"