games.strategy.triplea.ui
Class MapData

java.lang.Object
  extended by games.strategy.triplea.ui.MapData

public class MapData
extends java.lang.Object

contains data about the territories useful for drawing


Constructor Summary
MapData(ResourceLoader loader)
          Constructor TerritoryData(java.lang.String) Sets the map directory for this instance of TerritoryData
MapData(java.lang.String mapNameDir)
           
 
Method Summary
 void close()
           
 boolean drawCapitolMarkers()
           
 boolean drawTerritoryNames()
           
 boolean getBooleanProperty(java.lang.String propertiesKey)
           
 java.awt.Rectangle getBoundingRect(java.lang.String name)
           
 java.awt.Rectangle getBoundingRect(Territory terr)
           
 java.awt.Point getCapitolMarkerLocation(Territory terr)
           
 java.awt.Point getCenter(java.lang.String terr)
           
 java.awt.Point getCenter(Territory terr)
           
 java.awt.Color getColorProperty(java.lang.String propertiesKey)
           
 java.util.List getContainedTerritory(java.lang.String territoryName)
          returns the name of the territory contained in the given territory.
 java.util.Map<java.awt.Image,java.util.List<java.awt.Point>> getDecorations()
           
 double getDefaultUnitScale()
           
 java.awt.Image getErrorImage()
           
 boolean getHasMapBlends()
           
 boolean getHasRelief()
           
 java.awt.Image getHelpImage()
           
 java.awt.Image getInfoImage()
           
 java.awt.Point getKamikazeMarkerLocation(Territory terr)
           
 float getMapBlendAlpha()
           
 java.lang.String getMapBlendMode()
           
 java.awt.Dimension getMapDimensions()
           
 java.awt.Point getNamePlacementPoint(Territory terr)
           
 java.util.List<java.awt.Point> getPlacementPoints(Territory terr)
           
 java.awt.Color getPlayerColor(java.lang.String playerName)
           
 java.util.List<java.awt.Polygon> getPolygons(java.lang.String terr)
           
 java.util.List<java.awt.Polygon> getPolygons(Territory terr)
           
 java.lang.String getProperty(java.lang.String propertiesKey)
          returns the named property, or null
 java.awt.Point getPUPlacementPoint(Territory terr)
           
 java.util.Set<java.lang.String> getTerritories()
           
 java.lang.String getTerritoryAt(double x, double y)
          Get the territory at the x,y co-ordinates could be null.
 java.awt.Image getVCImage()
           
 java.awt.Point getVCPlacementPoint(Territory terr)
           
 java.awt.Image getWarningImage()
           
 boolean hasContainedTerritory(java.lang.String territoryName)
          Does this territory have any territories contained within it
 java.awt.Color impassibleColor()
          returns the color for impassible territories
 boolean scrollWrapX()
           
 boolean shouldDrawTerritoryName(java.lang.String territoryName)
           
 java.util.List<java.lang.String> territoriesThatOverlap(java.awt.geom.Rectangle2D bounds)
          Get the territories that intersect or are bound by this shapes bounding rect.
 void verify(GameData data)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MapData

public MapData(java.lang.String mapNameDir)

MapData

public MapData(ResourceLoader loader)
Constructor TerritoryData(java.lang.String) Sets the map directory for this instance of TerritoryData

Parameters:
java.lang.String - mapNameDir the given map directory
Method Detail

scrollWrapX

public boolean scrollWrapX()

close

public void close()

getDefaultUnitScale

public double getDefaultUnitScale()

shouldDrawTerritoryName

public boolean shouldDrawTerritoryName(java.lang.String territoryName)

getHasRelief

public boolean getHasRelief()

getHasMapBlends

public boolean getHasMapBlends()

getMapBlendMode

public java.lang.String getMapBlendMode()

getMapBlendAlpha

public float getMapBlendAlpha()

drawCapitolMarkers

public boolean drawCapitolMarkers()

drawTerritoryNames

public boolean drawTerritoryNames()

getBooleanProperty

public boolean getBooleanProperty(java.lang.String propertiesKey)

getColorProperty

public java.awt.Color getColorProperty(java.lang.String propertiesKey)
                                throws java.lang.IllegalStateException
Throws:
java.lang.IllegalStateException

getPlayerColor

public java.awt.Color getPlayerColor(java.lang.String playerName)

getProperty

public java.lang.String getProperty(java.lang.String propertiesKey)
returns the named property, or null


impassibleColor

public java.awt.Color impassibleColor()
returns the color for impassible territories


getTerritories

public java.util.Set<java.lang.String> getTerritories()
Returns:
a Set of territory names as Strings. generally this shouldnt be used, instead you should use aGameData.getMap().getTerritories()

hasContainedTerritory

public boolean hasContainedTerritory(java.lang.String territoryName)
Does this territory have any territories contained within it


getContainedTerritory

public java.util.List getContainedTerritory(java.lang.String territoryName)
returns the name of the territory contained in the given territory. This applies to islands within sea zones.

Returns:
possiblly null

verify

public void verify(GameData data)

getPlacementPoints

public java.util.List<java.awt.Point> getPlacementPoints(Territory terr)

getPolygons

public java.util.List<java.awt.Polygon> getPolygons(java.lang.String terr)

getPolygons

public java.util.List<java.awt.Polygon> getPolygons(Territory terr)

getCenter

public java.awt.Point getCenter(java.lang.String terr)

getCenter

public java.awt.Point getCenter(Territory terr)

getCapitolMarkerLocation

public java.awt.Point getCapitolMarkerLocation(Territory terr)

getKamikazeMarkerLocation

public java.awt.Point getKamikazeMarkerLocation(Territory terr)

getVCPlacementPoint

public java.awt.Point getVCPlacementPoint(Territory terr)

getPUPlacementPoint

public java.awt.Point getPUPlacementPoint(Territory terr)

getNamePlacementPoint

public java.awt.Point getNamePlacementPoint(Territory terr)

getTerritoryAt

public java.lang.String getTerritoryAt(double x,
                                       double y)
Get the territory at the x,y co-ordinates could be null.


getMapDimensions

public java.awt.Dimension getMapDimensions()

getBoundingRect

public java.awt.Rectangle getBoundingRect(Territory terr)

getBoundingRect

public java.awt.Rectangle getBoundingRect(java.lang.String name)

territoriesThatOverlap

public java.util.List<java.lang.String> territoriesThatOverlap(java.awt.geom.Rectangle2D bounds)
Get the territories that intersect or are bound by this shapes bounding rect.

Returns:
List of territory names as Strings

getVCImage

public java.awt.Image getVCImage()

getErrorImage

public java.awt.Image getErrorImage()

getWarningImage

public java.awt.Image getWarningImage()

getInfoImage

public java.awt.Image getInfoImage()

getHelpImage

public java.awt.Image getHelpImage()

getDecorations

public java.util.Map<java.awt.Image,java.util.List<java.awt.Point>> getDecorations()