prajna.image

Class TiledImageRepository

java.lang.Object

prajna.image.TiledImageRepository

public class TiledImageRepository
extends java.lang.Object

Class representing a directory of hierarchical tiled image files. The files within this directory are of the form LLXXYY.png, where LL is the level, XX is the X coordinate of the map cell, and YY is the Y coordinate of the map cell. X and Y start at zero, which is in the upper left corner of the map. LL starts at 1 for a cell representing the entire world, and goes as high as the repository creator wants it to. Each grid cell image is 256x256 pixels.

Author:

Edward Swing

Constructor Summary

Constructors

Constructor and Description
TiledImageRepository(java.io.File reposDir) Create a new TiledImageRepository at the specified location.
TiledImageRepository(java.lang.String directory) Create a new TiledImageRepository at the specified location.

Method Summary

Methods

Modifier and Type	Method and Description
void	clean() Clean the repository.
java.awt.image.BufferedImage	composeImage(int level, int xCoord, int yCoord, java.lang.String suffixes) Compose an image from the base cell and all overlays whose overlay characters occur in the suffixes argument, in order.
void	extractOverlay(java.io.File imageFile, int level, int xCoord, int yCoord, char suffix) Extract an overlay file from the provided image file.
java.io.File	getDirectory() Get the current repository directory
java.awt.image.BufferedImage	getImage(int level, int xCoord, int yCoord, char suffix) Get the specified image cell
int	getMaxLevel() Return the maximum level the repository contains
java.util.SortedMap<java.lang.Character,java.lang.String>	getOverlayList() Get the set of overlay characters and their names
java.awt.image.BufferedImage	getTmpImage(int level, int xCoord, int yCoord, char suffix) Get the temporary image for the specified image cell.
void	insetImage(int level, int xCoord, int yCoord, char suffix, java.awt.image.BufferedImage image, int xOffset, int yOffset, boolean tmp) Adds an image to the set of tile images.
void	storePaddedImage(java.io.File imageFile, java.awt.Color margin, boolean center) Store an image file into the repository.
void	storePaddedImage(java.awt.Image image, java.awt.Color margin, boolean center) Store an image into the repository.
void	storeScaledImage(java.awt.image.BufferedImage image) Store an image into the repository.
void	storeScaledImage(java.io.File imageFile) Store an image file into the repository.
java.lang.String	toImageName(int level, int xCoord, int yCoord, char suffix) Get the image name based on the level, coordinates and suffix.
void	updateFromChildren(int level, int xCoord, int yCoord, char suffix) Update an image from its children.
boolean	updateTree(int level, int xCoord, int yCoord, char suffix) Update the tree by descending and updating each tile whose children are more current than it is.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TiledImageRepository

public TiledImageRepository(java.io.File reposDir)

Create a new TiledImageRepository at the specified location. This method creates a repository directory if necessary.

Parameters:

reposDir - the directory where the image repository should reside

TiledImageRepository

public TiledImageRepository(java.lang.String directory)

Create a new TiledImageRepository at the specified location. This method creates a repository directory if necessary.

Parameters:

directory - the directory where the image repository should reside

Method Detail

clean

public void clean()

Clean the repository. This method removes any backup and temporary files

composeImage

public java.awt.image.BufferedImage composeImage(int level,
                                        int xCoord,
                                        int yCoord,
                                        java.lang.String suffixes)
                                          throws java.io.IOException

Compose an image from the base cell and all overlays whose overlay characters occur in the suffixes argument, in order.

Parameters:

level - level of the tile cell

xCoord - X coordinate of the tile cell.

yCoord - Y coordinate of the tile cell

suffixes - set of suffixes indicating which overlays to add to the resulting cell.

Returns:

a composite image cell with the base image and the specified overlay cells

Throws:

java.io.IOException - if there is trouble reading the image files

extractOverlay

public void extractOverlay(java.io.File imageFile,
                  int level,
                  int xCoord,
                  int yCoord,
                  char suffix)
                    throws java.io.IOException

Extract an overlay file from the provided image file. The image file is compared with the base image, and the differences are stored in an overlay file

Parameters:

imageFile - the image cell file

level - level of the tile cell

xCoord - X coordinate of the tile cell.

yCoord - Y coordinate of the tile cell

suffix - suffix character indicating the overlay. A space indicates the base set of tiles.

Throws:

java.io.IOException - if there is trouble reading or writing the image files

getDirectory

public java.io.File getDirectory()

Get the current repository directory

Returns:

the current repository directory

getImage

public java.awt.image.BufferedImage getImage(int level,
                                    int xCoord,
                                    int yCoord,
                                    char suffix)
                                      throws java.io.IOException

Get the specified image cell

Parameters:

level - level of the tile cell

xCoord - X coordinate of the tile cell.

yCoord - Y coordinate of the tile cell

suffix - suffix character indicating the overlay. A space indicates the base set of tiles.

Returns:

the image for the specified parameters

Throws:

java.io.IOException - if there is trouble reading the image files

getMaxLevel

public int getMaxLevel()

Return the maximum level the repository contains

Returns:

the maximum level for this repository

getOverlayList

public java.util.SortedMap<java.lang.Character,java.lang.String> getOverlayList()

Get the set of overlay characters and their names

Returns:

the set of overlay characters and their names

getTmpImage

public java.awt.image.BufferedImage getTmpImage(int level,
                                       int xCoord,
                                       int yCoord,
                                       char suffix)
                                         throws java.io.IOException

Get the temporary image for the specified image cell. If a temporary image has been created, this method returns the temporary image. Otherwise it returns the permanent cell for the specified parametets.

Parameters:

level - level of the tile cell

xCoord - X coordinate of the tile cell.

yCoord - Y coordinate of the tile cell

suffix - suffix character indicating the overlay. A space indicates the base set of tiles.

Returns:

the image for the specified parameters

Throws:

java.io.IOException - if there is trouble reading the image files

insetImage

public void insetImage(int level,
              int xCoord,
              int yCoord,
              char suffix,
              java.awt.image.BufferedImage image,
              int xOffset,
              int yOffset,
              boolean tmp)
                throws java.io.IOException

Adds an image to the set of tile images. This method overlays the specified image onto the underlying tiles, creating a composite image. The resulting image tiles are stored as temporary files if the temporary flag is set. Otherwise, the composite image is stored as the new image.

Parameters:

level - level of the tile cell

xCoord - X coordinate of the tile cell. This cell indicates which cell contains the upper left corner of the inset image

yCoord - Y coordinate of the tile cell. This cell indicates which cell contains the upper left corner of the inset image

suffix - suffix character indicating the overlay. A space indicates the base set of tiles.

image - the image being overlaid

xOffset - X Offset from the upper left corner of the starting cell

yOffset - Y Offset from the upper left corner of the starting cell

tmp - flag indicating whether to use temporary or permanent storage for the composite image

Throws:

java.io.IOException - if there is a problem reading or writing the image files

storePaddedImage

public void storePaddedImage(java.io.File imageFile,
                    java.awt.Color margin,
                    boolean center)
                      throws java.io.IOException

Store an image file into the repository. The image is split into 256 x 256 tiles. If the image does not split evenly, this method adds a margin in the specified color. The margin is either centered or added to the bottom and right side of the image.

Parameters:

imageFile - the original image file

margin - the color of the margin

center - whether to center the image or to place it in the upper left corner of the resulting image tiles

Throws:

java.io.IOException - if there is trouble reading or writing the image files

storePaddedImage

public void storePaddedImage(java.awt.Image image,
                    java.awt.Color margin,
                    boolean center)
                      throws java.io.IOException

Store an image into the repository. The image is split into 256 x 256 tiles. If the image does not split evenly, this method adds a margin in the specified color. The margin is either centered or added to the bottom and right side of the image.

Parameters:

image - the original image

margin - the color of the margin

center - whether to center the image or to place it in the upper left corner of the resulting image tiles

Throws:

java.io.IOException - if there is trouble reading or writing the image files

storeScaledImage

public void storeScaledImage(java.awt.image.BufferedImage image)
                      throws java.io.IOException

Store an image into the repository. The image is scaled up to fit into the next largest size of the grid cells.

Parameters:

image - the original image

Throws:

java.io.IOException - if there is trouble writing the image files

storeScaledImage

public void storeScaledImage(java.io.File imageFile)
                      throws java.io.IOException

Store an image file into the repository. The image is scaled up to fit into the next largest size of the grid cells.

Parameters:

imageFile - the original image file

Throws:

java.io.IOException - if there is trouble reading or writing the image files

toImageName

public java.lang.String toImageName(int level,
                           int xCoord,
                           int yCoord,
                           char suffix)

Get the image name based on the level, coordinates and suffix. This method also ensures the coordinates do not exceed the maximum for the level.

Parameters:

level - level of the tile cell

xCoord - X coordinate of the tile cell.

yCoord - Y coordinate of the tile cell

suffix - suffix character indicating the overlay. A space indicates the base set of tiles.

Returns:

the base name of the file

updateFromChildren

public void updateFromChildren(int level,
                      int xCoord,
                      int yCoord,
                      char suffix)
                        throws java.io.IOException

Update an image from its children. When this method is called, the cell is updated querying the cell's four children, and composing them. The resulting image is scaled to the cell size and stored as the new image for this cell. This method will then propagate the changes upward in the tree.

Parameters:

level - level of the tile cell

xCoord - X coordinate of the tile cell.

yCoord - Y coordinate of the tile cell

suffix - suffix character indicating the overlay. A space indicates the base set of tiles.

Throws:

java.io.IOException - if there is trouble reading or writing the image files

updateTree

public boolean updateTree(int level,
                 int xCoord,
                 int yCoord,
                 char suffix)
                   throws java.io.IOException

Update the tree by descending and updating each tile whose children are more current than it is.

Parameters:

level - level of the tile cell

xCoord - X coordinate of the tile cell.

yCoord - Y coordinate of the tile cell

suffix - suffix character indicating the overlay. A space indicates the base set of tiles.

Returns:

whether the tile has been updated

Throws:

java.io.IOException - if there is trouble reading or writing the image files