MapViewer (FreeCol Code Documentation)

java.lang.Object
- net.sf.freecol.client.gui.MapViewer

```
public final class MapViewer
extends java.lang.Object
```
MapViewer is a private helper class of Canvas and SwingGUI. This class is responsible for drawing the map/background on the Canvas. In addition, the graphical state of the map (focus, active unit..) is currently handled by this class.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

private static class MapViewer.BorderType

private static class MapViewer.TextSpecification

Nested Classes
Modifier and Type	Class and Description
`private static class`	`MapViewer.BorderType`
`private static class`	`MapViewer.TextSpecification`

Field Summary

Fields
Modifier and Type	Field and Description
`private Unit`	`activeUnit`
`private boolean`	`alignedBottom`
`private boolean`	`alignedLeft`
`private boolean`	`alignedRight`
`private boolean`	`alignedTop`
`private java.util.EnumMap<Direction,java.awt.geom.Point2D.Float>`	`borderPoints`
`private java.awt.Stroke`	`borderStroke`
`private int`	`bottomRow`
`private int`	`bottomRows`
`private int`	`bottomRowY`
`private java.util.EnumMap<Direction,java.awt.geom.Point2D.Float>`	`controlPoints`
`private PathNode`	`currentPath` A path to be displayed on the map.
`private TerrainCursor`	`cursor`
`private Tile`	`focus`
`private FreeColClient`	`freeColClient`
`private PathNode`	`gotoPath` A path for a current goto order.
`private boolean`	`gotoStarted`
`private java.awt.Stroke`	`gridStroke`
`private SwingGUI`	`gui`
`private int`	`halfHeight`
`private int`	`halfWidth`
`private int`	`leftColumn`
`private int`	`leftColumnX`
`private int`	`leftSpace`
`private ImageLibrary`	`lib` Scaled ImageLibrary only used for map painting.
`private static java.util.logging.Logger`	`logger`
`private static float`	`MAP_SCALE_MAX`
`private static float`	`MAP_SCALE_MIN`
`private static float`	`MAP_SCALE_STEP`
`private static int`	`MAX_OTHER_UNITS`
`private static int`	`OTHER_UNITS_OFFSET_X`
`private static int`	`OTHER_UNITS_OFFSET_Y`
`private static int`	`OTHER_UNITS_WIDTH`
`private int`	`rightColumn`
`private int`	`rightSpace`
`private Tile`	`selectedTile`
`private java.awt.Dimension`	`size`
`private int`	`tileHeight`
`private int`	`tileWidth`
`private int`	`topRow`
`private int`	`topRows`
`private int`	`topRowY`
`private int`	`topSpace`
`private TileViewer`	`tv`
`private static int`	`UNIT_OFFSET`
`private java.util.Map<Unit,java.lang.Integer>`	`unitsOutForAnimation`
`private java.util.Map<Unit,javax.swing.JLabel>`	`unitsOutForAnimationLabels`
`private int`	`viewMode` The view mode in use.

Constructor Summary

Constructors
Constructor and Description

MapViewer(FreeColClient freeColClient)
The constructor to use.

Constructors
Constructor and Description
`MapViewer(FreeColClient freeColClient)` The constructor to use.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`(package private) java.awt.Rectangle`	`calculateTileBounds(Tile tile)` Calculate the bounds of the rectangle containing a Tile on the screen, and return it.
`(package private) java.awt.Point`	`calculateTilePosition(Tile t)` Gets the position of the given `Tile` on the drawn map.
`private java.awt.Point`	`calculateUnitImagePositionInTile(java.awt.image.BufferedImage unitImage)` Gets the coordinates to draw a unit in a given tile.
`(package private) java.awt.Point`	`calculateUnitLabelPositionInTile(int labelWidth, int labelHeight, java.awt.Point tileP)` Gets the position where a unitLabel located at tile should be drawn.
`(package private) void`	`centerActiveUnit()` Centers the map on the selected unit.
`(package private) void`	`changeViewMode(int newViewMode)` Change the view mode to a new one.
`(package private) Tile`	`convertToMapTile(int x, int y)` Converts the given screen coordinates to Map coordinates.
`private static java.awt.image.BufferedImage`	`createCapitalLabel(int extent, int padding, java.awt.Color backgroundColor)` Draws the pentagram indicating a native capital.
`private static java.awt.image.BufferedImage`	`createLabel(java.awt.Graphics2D g, MapViewer.TextSpecification[] textSpecs, java.awt.Color backgroundColor)` Creates an BufferedImage that shows the given text centred on a translucent rounded rectangle with the given color.
`private static java.awt.image.BufferedImage`	`createLabel(java.awt.Graphics2D g, java.lang.String text, java.awt.Font font, java.awt.Color backgroundColor)` Creates an BufferedImage that shows the given text centred on a translucent rounded rectangle with the given color.
`private static java.awt.image.BufferedImage`	`createReligiousMissionLabel(int extent, int padding, java.awt.Color backgroundColor, boolean expertMissionary)` Draws a cross indicating a religious mission is present in the native village.
`private javax.swing.JLabel`	`createUnitLabel(Unit unit)` Draw the unit's image and occupation indicator in one JLabel object.
`(package private) void`	`decreaseMapScale()`
`private void`	`displayCursor(java.awt.Graphics2D g)`
`(package private) void`	`displayMap(java.awt.Graphics2D g)` Displays the Map.
`private void`	`displayPath(java.awt.Graphics2D g, PathNode path)` Display a path.
`private void`	`displaySettlementLabels(java.awt.Graphics2D g, Settlement settlement, Player player, int colonyLabels, java.awt.Font font, java.awt.Font italicFont, java.awt.Font productionFont)`
`private void`	`displayTerritorialBorders(java.awt.Graphics2D g, Tile tile, MapViewer.BorderType type, boolean opaque)` Draws the borders of a territory on the given Tile.
`private void`	`displayUnit(java.awt.Graphics2D g, Unit unit)` Displays the given Unit onto the given Graphics2D object at the location specified by the coordinates.
`private javax.swing.JLabel`	`enterUnitOutForAnimation(Unit unit, Tile sourceTile)`
`(package private) void`	`executeWithUnitOutForAnimation(Unit unit, Tile sourceTile, OutForAnimationCallback r)` Run some code with the given unit made invisible.
`private Unit`	`findUnitInFront(Tile unitTile)` Gets the unit that should be displayed on the given tile.
`(package private) void`	`forceReposition()` Force the next screen repaint to reposition the tiles on the window.
`(package private) Unit`	`getActiveUnit()` Gets the active unit.
`(package private) Tile`	`getFocus()` Gets the focus of the map.
`(package private) PathNode`	`getGotoPath()` Gets the path to be drawn on the map.
`(package private) ImageLibrary`	`getImageLibrary()` Gets the contained `ImageLibrary`.
`private int`	`getLeftColumns()` Returns the amount of columns that are to the left of the Tile that is displayed in the center of the Map.
`private int`	`getLeftColumns(int y)` Returns the amount of columns that are to the left of the Tile with the given y-coordinate.
`private int`	`getRightColumns()` Returns the amount of columns that are to the right of the Tile that is displayed in the center of the Map.
`private int`	`getRightColumns(int y)` Returns the amount of columns that are to the right of the Tile with the given y-coordinate.
`(package private) Tile`	`getSelectedTile()` Gets the selected tile.
`(package private) int`	`getTileWidth()`
`(package private) int`	`getViewMode()` Get the view mode.
`(package private) void`	`increaseMapScale()`
`(package private) boolean`	`isAtMaxMapScale()`
`(package private) boolean`	`isAtMinMapScale()`
`(package private) boolean`	`isGotoStarted()` Checks if there is currently a goto operation on the mapboard.
`private boolean`	`isMapNearBottom(int y)` Is a y-coordinate near the bottom?
`private boolean`	`isMapNearLeft(int x, int y)` Is an x,y coordinate near the left?
`private boolean`	`isMapNearRight(int x, int y)` Is an x,y coordinate near the right?
`private boolean`	`isMapNearTop(int y)` Is a y-coordinate near the top?
`private boolean`	`isOutForAnimation(Unit unit)` Returns true if the given Unit is being animated.
`private boolean`	`isTileVisible(Tile tile)`
`(package private) boolean`	`onScreen(Tile tileToCheck)` Checks if the Tile/Units at the given coordinates are displayed on the screen (or, if the map is already displayed and the focus has been changed, whether they will be displayed on the screen the next time it'll be redrawn).
`private void`	`positionMap(Tile pos)` Position the map so that the supplied tile is displayed at the center.
`private void`	`releaseUnitOutForAnimation(Unit unit)`
`private void`	`repositionMapIfNeeded()`
`(package private) void`	`resetMapScale()` Reset the scale of the map to the default.
`(package private) void`	`restartBlinking()`
`(package private) boolean`	`scrollMap(Direction direction)` Scroll the map in the given direction.
`(package private) boolean`	`setActiveUnit(Unit activeUnit)` Sets the active unit.
`(package private) void`	`setCurrentPath(PathNode path)` Set the current active unit path.
`(package private) void`	`setFocus(Tile focus)` Sets the focus of the map.
`(package private) void`	`setGotoPath(PathNode gotoPath)` Sets the path to be drawn on the map.
`private void`	`setImageLibraryAndUpdateData(ImageLibrary lib)` Sets the ImageLibrary and calculates various items that depend on tile size.
`(package private) int`	`setOffsetFocus(Tile tile)` Sets the focus of the map but offset to the left or right so that the focus position can still be visible when a popup is raised.
`(package private) boolean`	`setSelectedTile(Tile newTile)` Selects the tile at the specified position.
`(package private) void`	`setSize(java.awt.Dimension size)`
`(package private) void`	`startCursorBlinking()` Starts the unit-selection-cursor blinking animation.
`(package private) void`	`startGoto()` Starts a goto operation on the mapboard.
`(package private) void`	`stopBlinking()`
`(package private) void`	`stopGoto()` Stops any ongoing goto operation on the mapboard.
`(package private) void`	`toggleViewMode()` Toggle the current view mode.
`(package private) void`	`updateCurrentPathForActiveUnit()` Sets the path of the active unit to display it.
`private void`	`updateMapDisplayVariables()`

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
```
  - gui
```
private final SwingGUI gui
```
  - size
```
private java.awt.Dimension size
```
  - lib
```
private ImageLibrary lib
```
    Scaled ImageLibrary only used for map painting.
  - tv
```
private final TileViewer tv
```
  - cursor
```
private TerrainCursor cursor
```
  - selectedTile
```
private Tile selectedTile
```
  - focus
```
private Tile focus
```
  - activeUnit
```
private Unit activeUnit
```
  - viewMode
```
private int viewMode
```
    The view mode in use.
  - currentPath
```
private PathNode currentPath
```
    A path to be displayed on the map.
  - gotoPath
```
private PathNode gotoPath
```
    A path for a current goto order.
  - gotoStarted
```
private boolean gotoStarted
```
  - tileHeight
```
private int tileHeight
```
  - tileWidth
```
private int tileWidth
```
  - halfHeight
```
private int halfHeight
```
  - halfWidth
```
private int halfWidth
```
  - topSpace
```
private int topSpace
```
  - topRows
```
private int topRows
```
  - bottomRows
```
private int bottomRows
```
  - leftSpace
```
private int leftSpace
```
  - rightSpace
```
private int rightSpace
```
  - bottomRow
```
private int bottomRow
```
  - topRow
```
private int topRow
```
  - bottomRowY
```
private int bottomRowY
```
  - topRowY
```
private int topRowY
```
  - leftColumn
```
private int leftColumn
```
  - rightColumn
```
private int rightColumn
```
  - leftColumnX
```
private int leftColumnX
```
  - alignedTop
```
private boolean alignedTop
```
  - alignedBottom
```
private boolean alignedBottom
```
  - alignedLeft
```
private boolean alignedLeft
```
  - alignedRight
```
private boolean alignedRight
```
  - MAP_SCALE_MIN
```
private static final float MAP_SCALE_MIN
```
    See Also:
    
    Constant Field Values
  - MAP_SCALE_MAX
```
private static final float MAP_SCALE_MAX
```
    See Also:
    
    Constant Field Values
  - MAP_SCALE_STEP
```
private static final float MAP_SCALE_STEP
```
    See Also:
    
    Constant Field Values
  - UNIT_OFFSET
```
private static final int UNIT_OFFSET
```
    See Also:
    
    Constant Field Values
  - OTHER_UNITS_OFFSET_X
```
private static final int OTHER_UNITS_OFFSET_X
```
    See Also:
    
    Constant Field Values
  - OTHER_UNITS_OFFSET_Y
```
private static final int OTHER_UNITS_OFFSET_Y
```
    See Also:
    
    Constant Field Values
  - OTHER_UNITS_WIDTH
```
private static final int OTHER_UNITS_WIDTH
```
    See Also:
    
    Constant Field Values
  - MAX_OTHER_UNITS
```
private static final int MAX_OTHER_UNITS
```
    See Also:
    
    Constant Field Values
  - unitsOutForAnimation
```
private final java.util.Map<Unit,java.lang.Integer> unitsOutForAnimation
```
  - unitsOutForAnimationLabels
```
private final java.util.Map<Unit,javax.swing.JLabel> unitsOutForAnimationLabels
```
  - borderPoints
```
private final java.util.EnumMap<Direction,java.awt.geom.Point2D.Float> borderPoints
```
  - controlPoints
```
private final java.util.EnumMap<Direction,java.awt.geom.Point2D.Float> controlPoints
```
  - borderStroke
```
private java.awt.Stroke borderStroke
```
  - gridStroke
```
private java.awt.Stroke gridStroke
```
- Constructor Detail
  - MapViewer
```
MapViewer(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;
  - getViewMode
```
int getViewMode()
```
    Get the view mode.
    
    Returns:
    
    The view mode.
  - toggleViewMode
```
void toggleViewMode()
```
    Toggle the current view mode.
  - changeViewMode
```
void changeViewMode(int newViewMode)
```
    Change the view mode to a new one.
    
    Parameters:
    
    newViewMode - The new view mode.
  - centerActiveUnit
```
void centerActiveUnit()
```
    Centers the map on the selected unit.
  - convertToMapTile
```
Tile convertToMapTile(int x,
                      int y)
```
    Converts the given screen coordinates to Map coordinates. It checks to see to which Tile the given pixel 'belongs'.
    
    Parameters:
    
    x - The x-coordinate in pixels.
    
    y - The y-coordinate in pixels.
    
    Returns:
    
    The Tile that is located at the given position on the screen.
  - executeWithUnitOutForAnimation
```
void executeWithUnitOutForAnimation(Unit unit,
                                    Tile sourceTile,
                                    OutForAnimationCallback r)
```
    Run some code with the given unit made invisible. You can nest several of these method calls in order to hide multiple units. There are no problems related to nested calls with the same unit.
    
    Parameters:
    
    unit - The Unit to be hidden.
    
    sourceTile - The source Tile.
    
    r - The code to be executed.
  - enterUnitOutForAnimation
```
private javax.swing.JLabel enterUnitOutForAnimation(Unit unit,
                                                    Tile sourceTile)
```
  - releaseUnitOutForAnimation
```
private void releaseUnitOutForAnimation(Unit unit)
```
  - isOutForAnimation
```
private boolean isOutForAnimation(Unit unit)
```
    Returns true if the given Unit is being animated.
    
    Parameters:
    
    unit - an Unit
    
    Returns:
    
    a boolean
  - createUnitLabel
```
private javax.swing.JLabel createUnitLabel(Unit unit)
```
    Draw the unit's image and occupation indicator in one JLabel object.
    
    Parameters:
    
    unit - The unit to be drawn
    
    Returns:
    
    A JLabel object with the unit's image.
  - calculateTileBounds
```
java.awt.Rectangle calculateTileBounds(Tile tile)
```
    Calculate the bounds of the rectangle containing a Tile on the screen, and return it. If the Tile is not on-screen a maximal rectangle is returned. The bounds includes a one-tile padding area above the Tile, to include the space needed by any units in the Tile.
    
    Parameters:
    
    tile - The Tile on the screen.
    
    Returns:
    
    The bounds Rectangle.
  - calculateTilePosition
```
java.awt.Point calculateTilePosition(Tile t)
```
    Gets the position of the given Tile on the drawn map.
    
    Parameters:
    
    t - The Tile to check.
    
    Returns:
    
    The position of the given Tile, or null if the Tile is not drawn on the mapboard.
  - getTileWidth
```
int getTileWidth()
```
  - calculateUnitLabelPositionInTile
```
java.awt.Point calculateUnitLabelPositionInTile(int labelWidth,
                                                int labelHeight,
                                                java.awt.Point tileP)
```
    Gets the position where a unitLabel located at tile should be drawn.
    
    Parameters:
    
    labelWidth - The width of the unit label.
    
    labelHeight - The width of the unit label.
    
    tileP - The position of the Tile on the screen.
    
    Returns:
    
    The position where to put the label, null if tileP is null.
  - onScreen
```
boolean onScreen(Tile tileToCheck)
```
    Checks if the Tile/Units at the given coordinates are displayed on the screen (or, if the map is already displayed and the focus has been changed, whether they will be displayed on the screen the next time it'll be redrawn).
    
    Parameters:
    
    tileToCheck - The position of the Tile in question.
    
    Returns:
    
    true if the Tile will be drawn on the screen, false otherwise.
  - startCursorBlinking
```
void startCursorBlinking()
```
    Starts the unit-selection-cursor blinking animation.
  - stopBlinking
```
void stopBlinking()
```
  - restartBlinking
```
void restartBlinking()
```
  - getFocus
```
Tile getFocus()
```
    Gets the focus of the map. That is the center tile of the displayed map.
    
    Returns:
    
    The center tile of the displayed map
    
    See Also:
    
    setFocus(Tile)
  - setFocus
```
void setFocus(Tile focus)
```
    Sets the focus of the map.
    
    Parameters:
    
    focus - The Position of the center tile of the displayed map.
    
    See Also:
    
    getFocus()
  - setOffsetFocus
```
int setOffsetFocus(Tile tile)
```
    Sets the focus of the map but offset to the left or right so that the focus position can still be visible when a popup is raised. If successful, the supplied position will either be at the center of the left or right half of the map.
    
    Parameters:
    
    tile - The Tile to display.
    
    Returns:
    
    Positive if the focus is on the right hand side, negative if on the left, zero on failure.
    
    See Also:
    
    getFocus()
  - forceReposition
```
void forceReposition()
```
    Force the next screen repaint to reposition the tiles on the window.
  - repositionMapIfNeeded
```
private void repositionMapIfNeeded()
```
  - positionMap
```
private void positionMap(Tile pos)
```
    Position the map so that the supplied tile is displayed at the center.
    
    Parameters:
    
    pos - The Tile to center at.
  - scrollMap
```
boolean scrollMap(Direction direction)
```
    Scroll the map in the given direction.
    
    Parameters:
    
    direction - The Direction to scroll in.
    
    Returns:
    
    True if scrolling occurred.
  - isMapNearBottom
```
private boolean isMapNearBottom(int y)
```
    Is a y-coordinate near the bottom?
    
    Parameters:
    
    y - The y-coordinate.
    
    Returns:
    
    True if near the bottom.
  - isMapNearLeft
```
private boolean isMapNearLeft(int x,
                              int y)
```
    Is an x,y coordinate near the left?
    
    Parameters:
    
    x - The x-coordinate.
    
    y - The y-coordinate.
    
    Returns:
    
    True if near the left.
  - isMapNearRight
```
private boolean isMapNearRight(int x,
                               int y)
```
    Is an x,y coordinate near the right?
    
    Parameters:
    
    x - The x-coordinate.
    
    y - The y-coordinate.
    
    Returns:
    
    True if near the right.
  - getLeftColumns
```
private int getLeftColumns()
```
    Returns the amount of columns that are to the left of the Tile that is displayed in the center of the Map.
    
    Returns:
    
    The amount of columns that are to the left of the Tile that is displayed in the center of the Map.
  - getLeftColumns
```
private int getLeftColumns(int y)
```
    Returns the amount of columns that are to the left of the Tile with the given y-coordinate.
    
    Parameters:
    
    y - The y-coordinate of the Tile in question.
    
    Returns:
    
    The amount of columns that are to the left of the Tile with the given y-coordinate.
  - getRightColumns
```
private int getRightColumns()
```
    Returns the amount of columns that are to the right of the Tile that is displayed in the center of the Map.
    
    Returns:
    
    The amount of columns that are to the right of the Tile that is displayed in the center of the Map.
  - getRightColumns
```
private int getRightColumns(int y)
```
    Returns the amount of columns that are to the right of the Tile with the given y-coordinate.
    
    Parameters:
    
    y - The y-coordinate of the Tile in question.
    
    Returns:
    
    The amount of columns that are to the right of the Tile with the given y-coordinate.
  - isMapNearTop
```
private boolean isMapNearTop(int y)
```
    Is a y-coordinate near the top?
    
    Parameters:
    
    y - The y-coordinate.
    
    Returns:
    
    True if near the top.
  - isTileVisible
```
private boolean isTileVisible(Tile tile)
```
  - getSelectedTile
```
Tile getSelectedTile()
```
    Gets the selected tile.
    
    Returns:
    
    The Tile selected.
  - setSelectedTile
```
boolean setSelectedTile(Tile newTile)
```
    Selects the tile at the specified position. There are two possible cases:
    1. If the tile contains a unit that can become active, then that unit will be set as the active unit.
    2. If not, the selectedTile will become the map focus.
    If a unit is active and is located on the selected tile, then nothing (except perhaps a map reposition) will happen.
    Parameters:
    
    newTile - The Tile, the tile to be selected
    
    Returns:
    
    True if the focus was set.
    
    See Also:
    
    getSelectedTile(), setActiveUnit(net.sf.freecol.common.model.Unit), setFocus(Tile)
  - findUnitInFront
```
private Unit findUnitInFront(Tile unitTile)
```
    Gets the unit that should be displayed on the given tile.
    
    Parameters:
    
    unitTile - The Tile to check.
    
    Returns:
    
    The Unit to display or null if none found.
  - getActiveUnit
```
Unit getActiveUnit()
```
    Gets the active unit.
    
    Returns:
    
    The Unit.
    
    See Also:
    
    setActiveUnit(net.sf.freecol.common.model.Unit)
  - setActiveUnit
```
boolean setActiveUnit(Unit activeUnit)
```
    Sets the active unit.
    
    Parameters:
    
    activeUnit - The new active Unit.
    
    Returns:
    
    True if the focus was set.
  - isGotoStarted
```
boolean isGotoStarted()
```
    Checks if there is currently a goto operation on the mapboard.
    
    Returns:
    
    True if a goto operation is in progress.
  - startGoto
```
void startGoto()
```
    Starts a goto operation on the mapboard. Dont use this directly, call the method in canvas!
  - stopGoto
```
void stopGoto()
```
    Stops any ongoing goto operation on the mapboard. Dont use this directly, call the method in canvas!
  - getGotoPath
```
PathNode getGotoPath()
```
    Gets the path to be drawn on the map.
    
    Returns:
    
    The path that should be drawn on the map or null if no path should be drawn.
  - setGotoPath
```
void setGotoPath(PathNode gotoPath)
```
    Sets the path to be drawn on the map. Dont use this directly, call the method in canvas!
    
    Parameters:
    
    gotoPath - The path that should be drawn on the map or null if no path should be drawn.
  - updateCurrentPathForActiveUnit
```
void updateCurrentPathForActiveUnit()
```
    Sets the path of the active unit to display it.
  - setCurrentPath
```
void setCurrentPath(PathNode path)
```
    Set the current active unit path.
    
    Parameters:
    
    path - The current PathNode.
  - setSize
```
void setSize(java.awt.Dimension size)
```
  - resetMapScale
```
void resetMapScale()
```
    Reset the scale of the map to the default.
  - isAtMaxMapScale
```
boolean isAtMaxMapScale()
```
  - isAtMinMapScale
```
boolean isAtMinMapScale()
```
  - increaseMapScale
```
void increaseMapScale()
```
  - decreaseMapScale
```
void decreaseMapScale()
```
  - updateMapDisplayVariables
```
private void updateMapDisplayVariables()
```
  - setImageLibraryAndUpdateData
```
private void setImageLibraryAndUpdateData(ImageLibrary lib)
```
    Sets the ImageLibrary and calculates various items that depend on tile size.
    
    Parameters:
    
    lib - an ImageLibrary value
  - displayMap
```
void displayMap(java.awt.Graphics2D g)
```
    Displays the Map.
    
    Parameters:
    
    g - The Graphics2D object on which to draw the Map.
  - displaySettlementLabels
```
private void displaySettlementLabels(java.awt.Graphics2D g,
                                     Settlement settlement,
                                     Player player,
                                     int colonyLabels,
                                     java.awt.Font font,
                                     java.awt.Font italicFont,
                                     java.awt.Font productionFont)
```
  - createCapitalLabel
```
private static java.awt.image.BufferedImage createCapitalLabel(int extent,
                                                               int padding,
                                                               java.awt.Color backgroundColor)
```
    Draws the pentagram indicating a native capital.
  - createLabel
```
private static java.awt.image.BufferedImage createLabel(java.awt.Graphics2D g,
                                                        java.lang.String text,
                                                        java.awt.Font font,
                                                        java.awt.Color backgroundColor)
```
    Creates an BufferedImage that shows the given text centred on a translucent rounded rectangle with the given color.
    
    Parameters:
    
    g - a Graphics2D
    
    text - a String
    
    font - a Font
    
    backgroundColor - a Color
    
    Returns:
    
    an BufferedImage
  - createLabel
```
private static java.awt.image.BufferedImage createLabel(java.awt.Graphics2D g,
                                                        MapViewer.TextSpecification[] textSpecs,
                                                        java.awt.Color backgroundColor)
```
    Creates an BufferedImage that shows the given text centred on a translucent rounded rectangle with the given color.
    
    Parameters:
    
    g - a Graphics2D
    
    textSpecs - a TextSpecification array
    
    backgroundColor - a Color
    
    Returns:
    
    a BufferedImage
  - createReligiousMissionLabel
```
private static java.awt.image.BufferedImage createReligiousMissionLabel(int extent,
                                                                        int padding,
                                                                        java.awt.Color backgroundColor,
                                                                        boolean expertMissionary)
```
    Draws a cross indicating a religious mission is present in the native village.
  - displayPath
```
private void displayPath(java.awt.Graphics2D g,
                         PathNode path)
```
    Display a path.
    
    Parameters:
    
    g - The Graphics2D to display on.
    
    path - The PathNode to display.
  - displayUnit
```
private void displayUnit(java.awt.Graphics2D g,
                         Unit unit)
```
    Displays the given Unit onto the given Graphics2D object at the location specified by the coordinates.
    
    Parameters:
    
    g - The Graphics2D object on which to draw the Unit.
    
    unit - The Unit to draw.
  - calculateUnitImagePositionInTile
```
private java.awt.Point calculateUnitImagePositionInTile(java.awt.image.BufferedImage unitImage)
```
    Gets the coordinates to draw a unit in a given tile.
    
    Parameters:
    
    unitImage - The unit's image
    
    Returns:
    
    The coordinates where the unit should be drawn onscreen
  - displayCursor
```
private void displayCursor(java.awt.Graphics2D g)
```
  - displayTerritorialBorders
```
private void displayTerritorialBorders(java.awt.Graphics2D g,
                                       Tile tile,
                                       MapViewer.BorderType type,
                                       boolean opaque)
```
    Draws the borders of a territory on the given Tile. The territory is either a country or a region.
    
    Parameters:
    
    g - a Graphics2D
    
    tile - a Tile
    
    type - a BorderType
    
    opaque - a boolean

Class MapViewer

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

logger

freeColClient

gui

size

lib

tv

cursor

selectedTile

focus

activeUnit

viewMode

currentPath

gotoPath

gotoStarted

tileHeight

tileWidth

halfHeight

halfWidth

topSpace

topRows

bottomRows

leftSpace

rightSpace

bottomRow

topRow

bottomRowY

topRowY

leftColumn

rightColumn

leftColumnX

alignedTop

alignedBottom

alignedLeft

alignedRight

MAP_SCALE_MIN

MAP_SCALE_MAX

MAP_SCALE_STEP

UNIT_OFFSET

OTHER_UNITS_OFFSET_X

OTHER_UNITS_OFFSET_Y

OTHER_UNITS_WIDTH

MAX_OTHER_UNITS

unitsOutForAnimation

unitsOutForAnimationLabels

borderPoints

controlPoints

borderStroke

gridStroke

Constructor Detail

MapViewer

Method Detail

getImageLibrary

getViewMode

toggleViewMode

changeViewMode

centerActiveUnit

convertToMapTile

executeWithUnitOutForAnimation

enterUnitOutForAnimation

releaseUnitOutForAnimation

isOutForAnimation

createUnitLabel

calculateTileBounds

calculateTilePosition

getTileWidth

calculateUnitLabelPositionInTile

onScreen

startCursorBlinking

stopBlinking

restartBlinking

getFocus

setFocus

setOffsetFocus