Package VASSAL.tools.image

Interface ImageTileSource

All Known Implementing Classes:
ImageTileDiskCache
public interface ImageTileSource
An interface for classes which supply image tiles.
Since:
3.2.0
Author:
Joel Uckelman

  • Method Summary

    Modifier and Type
    Method
    Description
    BufferedImage
    getTile​(String name, int tileX, int tileY, double scale)
    Gets an image tile.
    Dimension
    getTileSize​(String name, int tileX, int tileY, double scale)
    Gets the size of an image tile.
    boolean
    tileExists​(String name, int tileX, int tileY, double scale)
    Checks whether an image tile exists.

  • Method Details

    • getTile

      BufferedImage getTile​(String name, int tileX, int tileY, double scale) throws ImageIOException
      Gets an image tile.
      Parameters:
      name - the image name
      tileX - the X coordinate of the tile
      tileY - the Y coordinate of the tile
      scale - the scale of the tile
      Returns:
      the tile
      Throws:
      ImageIOException - if the tile can't be read

    • getTileSize

      Dimension getTileSize​(String name, int tileX, int tileY, double scale) throws ImageIOException
      Gets the size of an image tile.
      Parameters:
      name - the image name
      tileX - the X coordinate of the tile
      tileY - the Y coordinate of the tile
      scale - the scale of the tile
      Returns:
      the size of the tile
      Throws:
      ImageIOException - if the tile can't be read

    • tileExists

      boolean tileExists​(String name, int tileX, int tileY, double scale) throws ImageIOException
      Checks whether an image tile exists.
      Parameters:
      name - the image name
      tileX - the X coordinate of the tile
      tileY - the Y coordinate of the tile
      scale - the scale of the tile
      Throws:
      ImageIOException - if the image can't be read