net.sf.freecol.client.gui

Class TileViewer

java.lang.Object

net.sf.freecol.client.gui.TileViewer

public final class TileViewer
extends java.lang.Object

TileViewer is a private helper class of MapViewer and SwingGUI. This class is responsible for drawing map tiles for MapViewer and some GUI-panels.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	TileViewer.SortableImage

Field Summary

Fields

Modifier and Type	Field and Description
private java.awt.geom.GeneralPath	fog
private FreeColClient	freeColClient
private int	halfHeight
private int	halfWidth
private ImageLibrary	lib
private static java.util.logging.Logger	logger
private RoadPainter	rp
(package private) static int	STATE_OFFSET_X
(package private) static int	STATE_OFFSET_Y
private int	tileHeight
private int	tileWidth

Constructor Summary

Constructors

Constructor and Description
TileViewer(FreeColClient freeColClient) The constructor to use.

Method Summary

Modifier and Type	Method and Description
(package private) java.awt.image.BufferedImage	createColonyTileImage(Tile tile, Colony colony) Create a BufferedImage and draw a Tile on it.
(package private) java.awt.image.BufferedImage	createTileImage(Tile tile) Create a BufferedImage and draw a Tile on it.
(package private) java.awt.image.BufferedImage	createTileImageWithBeachBorderAndItems(Tile tile) Create a BufferedImage and draw a Tile on it.
(package private) static java.awt.image.BufferedImage	createTileImageWithOverlayAndForest(TileType type, java.awt.Dimension size) Returns the scaled terrain-image for a terrain type (and position 0, 0).
(package private) void	displayCenteredImage(java.awt.Graphics2D g, java.awt.image.BufferedImage image) Centers the given Image on the tile.
private void	displayColonyTile(java.awt.Graphics2D g, Tile tile, Colony colony, java.awt.image.BufferedImage overlayImage) Displays the given colony tile.
(package private) void	displayColonyTiles(java.awt.Graphics2D g, Tile[][] tiles, Colony colony) Displays the 3x3 tiles for the TilesPanel in ColonyPanel.
(package private) void	displayFogOfWar(java.awt.Graphics2D g, Tile tile) Displays the given Tile onto the given Graphics2D object at the location specified by the coordinates.
(package private) void	displayLargeCenteredImage(java.awt.Graphics2D g, java.awt.image.BufferedImage image) Centers the given Image on the tile, ensuring it is not drawing over tiles south of it.
private void	displayLostCityRumour(java.awt.Graphics2D g)
(package private) void	displayOptionalTileText(java.awt.Graphics2D g, Tile tile) Displays the Tile text for a Tile.
private void	displayResourceTileItem(java.awt.Graphics2D g, Resource item)
(package private) void	displaySettlementWithChipsOrPopulationNumber(java.awt.Graphics2D g, Tile tile, boolean withNumber) Displays the given Tile onto the given Graphics2D object at the location specified by the coordinates.
private void	displayTile(java.awt.Graphics2D g, Tile tile, java.awt.image.BufferedImage overlayImage) Displays the given Tile.
private void	displayTileImprovement(java.awt.Graphics2D g, Tile tile, TileImprovement ti)
private void	displayTileItem(java.awt.Graphics2D g, Tile tile, TileItem item) Draws the given TileItem on the given Tile.
(package private) void	displayTileItems(java.awt.Graphics2D g, Tile tile, java.awt.image.BufferedImage overlayImage) Displays the given tile's items onto the given Graphics2D object.
(package private) void	displayTileWithBeachAndBorder(java.awt.Graphics2D g, Tile tile) Displays the given Tile onto the given Graphics2D object at the location specified by the coordinates.
(package private) void	displayUnknownTileBorder(java.awt.Graphics2D g, Tile tile)
(package private) ImageLibrary	getImageLibrary() Gets the contained ImageLibrary.
(package private) void	setImageLibraryAndUpdateData(ImageLibrary lib) Sets the ImageLibrary and calculates various items that depend on tile size.

Methods inherited from class java.lang.Object

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

Field Detail

logger

private static final java.util.logging.Logger logger

freeColClient

private final FreeColClient freeColClient

lib

private ImageLibrary lib

rp

private RoadPainter rp

tileHeight

private int tileHeight

tileWidth

private int tileWidth

halfHeight

private int halfHeight

halfWidth

private int halfWidth

STATE_OFFSET_X

static final int STATE_OFFSET_X

See Also:

Constant Field Values

STATE_OFFSET_Y

static final int STATE_OFFSET_Y

See Also:

Constant Field Values

fog

private final java.awt.geom.GeneralPath fog

Constructor Detail

TileViewer

TileViewer(FreeColClient freeColClient)

The constructor to use.

Parameters:

freeColClient - The FreeColClient for the game.

Method Detail

getImageLibrary

ImageLibrary getImageLibrary()

Gets the contained ImageLibrary.

Returns:

The image library;

createTileImageWithOverlayAndForest

static java.awt.image.BufferedImage createTileImageWithOverlayAndForest(TileType type,
                                                                        java.awt.Dimension size)

Returns the scaled terrain-image for a terrain type (and position 0, 0).

Parameters:

type - The type of the terrain-image to return.

size - The maximum size of the terrain image to return.

Returns:

The terrain-image

createTileImageWithBeachBorderAndItems

java.awt.image.BufferedImage createTileImageWithBeachBorderAndItems(Tile tile)

Create a BufferedImage and draw a Tile on it. Draws the terrain and improvements.

Parameters:

tile - The Tile to draw.

Returns:

The image.

createTileImage

java.awt.image.BufferedImage createTileImage(Tile tile)

Create a BufferedImage and draw a Tile on it.

Parameters:

tile - The Tile to draw.

Returns:

The image.

createColonyTileImage

java.awt.image.BufferedImage createColonyTileImage(Tile tile,
                                                   Colony colony)

Create a BufferedImage and draw a Tile on it. The visualization of the Tile also includes information from the corresponding ColonyTile of the given Colony.

Parameters:

tile - The Tile to draw.

colony - The Colony to create the visualization of the Tile for. This object is also used to get the ColonyTile for the given Tile.

Returns:

The image.

displayColonyTiles

void displayColonyTiles(java.awt.Graphics2D g,
                        Tile[][] tiles,
                        Colony colony)

Displays the 3x3 tiles for the TilesPanel in ColonyPanel.

Parameters:

g - The Graphics2D object on which to draw the Tile.

tiles - The array containing the Tile objects to draw.

colony - The Colony to create the visualization of the Tile objects for.

displayColonyTile

private void displayColonyTile(java.awt.Graphics2D g,
                               Tile tile,
                               Colony colony,
                               java.awt.image.BufferedImage overlayImage)

Displays the given colony tile. The visualization of the Tile also includes information from the corresponding ColonyTile from the given Colony.

Parameters:

g - The Graphics2D on which to draw.

tile - The Tile to draw.

colony - The Colony to create the visualization of the Tile for. This object is also used to get the ColonyTile for the given Tile.

overlayImage - The BufferedImage of the tile overlay.

displayTile

private void displayTile(java.awt.Graphics2D g,
                         Tile tile,
                         java.awt.image.BufferedImage overlayImage)

Displays the given Tile.

Parameters:

g - The Graphics2D on which to draw the Tile.

tile - The Tile to draw.

overlayImage - The BufferedImage for the tile overlay.

setImageLibraryAndUpdateData

void setImageLibraryAndUpdateData(ImageLibrary lib)

Sets the ImageLibrary and calculates various items that depend on tile size.

Parameters:

lib - an ImageLibrary value

displayCenteredImage

void displayCenteredImage(java.awt.Graphics2D g,
                          java.awt.image.BufferedImage image)

Centers the given Image on the tile.

Parameters:

g - a Graphics2D

image - the BufferedImage

displayLargeCenteredImage

void displayLargeCenteredImage(java.awt.Graphics2D g,
                               java.awt.image.BufferedImage image)

Centers the given Image on the tile, ensuring it is not drawing over tiles south of it.

Parameters:

g - a Graphics2D

image - the BufferedImage

displayTileWithBeachAndBorder

void displayTileWithBeachAndBorder(java.awt.Graphics2D g,
                                   Tile tile)

Displays the given Tile onto the given Graphics2D object at the location specified by the coordinates. Only base terrain will be drawn.

Parameters:

g - The Graphics2D object on which to draw the Tile.

tile - The Tile to draw.

displayUnknownTileBorder

void displayUnknownTileBorder(java.awt.Graphics2D g,
                              Tile tile)

displayFogOfWar

void displayFogOfWar(java.awt.Graphics2D g,
                     Tile tile)

Displays the given Tile onto the given Graphics2D object at the location specified by the coordinates. Fog of war will be drawn.

Parameters:

g - The Graphics2D object on which to draw the Tile.

tile - The Tile to draw.

displayOptionalTileText

void displayOptionalTileText(java.awt.Graphics2D g,
                             Tile tile)

Displays the Tile text for a Tile. Shows tile names, coordinates and colony values.

Parameters:

g - The Graphics2D object on which the text gets drawn.

tile - The Tile to draw the text on.

displaySettlementWithChipsOrPopulationNumber

void displaySettlementWithChipsOrPopulationNumber(java.awt.Graphics2D g,
                                                  Tile tile,
                                                  boolean withNumber)

Displays the given Tile onto the given Graphics2D object at the location specified by the coordinates. Settlements and Lost City Rumours will be shown.

Parameters:

g - The Graphics2D object on which to draw the Tile.

tile - The Tile to draw.

withNumber - Whether to display the number of units present.

displayTileItems

void displayTileItems(java.awt.Graphics2D g,
                      Tile tile,
                      java.awt.image.BufferedImage overlayImage)

Displays the given tile's items onto the given Graphics2D object. Additions and improvements to Tile will be drawn. Only works for explored tiles.

Parameters:

g - The Graphics2D object on which to draw the Tile.

tile - The Tile to draw.

overlayImage - The BufferedImage for the tile overlay.

displayTileItem

private void displayTileItem(java.awt.Graphics2D g,
                             Tile tile,
                             TileItem item)

Draws the given TileItem on the given Tile.

displayResourceTileItem

private void displayResourceTileItem(java.awt.Graphics2D g,
                                     Resource item)

displayLostCityRumour

private void displayLostCityRumour(java.awt.Graphics2D g)

displayTileImprovement

private void displayTileImprovement(java.awt.Graphics2D g,
                                    Tile tile,
                                    TileImprovement ti)