Class ZonedGrid

java.lang.Object

VASSAL.search.AbstractImageFinder

VASSAL.build.AbstractBuildable

VASSAL.build.AbstractConfigurable

VASSAL.build.module.map.boardPicker.board.ZonedGrid

All Implemented Interfaces:

AutoConfigurable, Buildable, Configurable, GeometricGrid, MapGrid, GridContainer, PropertyNameSource, ValidityChecker, Translatable, Auditable, ImageSearchTarget, SearchTarget

public class ZonedGrid
extends AbstractConfigurable
implements GeometricGrid, GridContainer

Map Grid that contains any number of Zones against a background MapGrid

Nested Class Summary

Nested classes/interfaces inherited from interface VASSAL.build.AutoConfigurable

AutoConfigurable.Util

Nested classes/interfaces inherited from interface VASSAL.build.module.map.boardPicker.board.MapGrid

MapGrid.BadCoords

Field Summary

Fields

Modifier and Type	Field	Description
protected MapGrid	background
protected final Map<org.apache.commons.lang3.tuple.Pair<Point,Double>,Area>	clipCache
protected GridContainer	container
protected ZonedGridHighlighter	zoneHighlighters
protected List<Zone>	zones

Fields inherited from class VASSAL.build.AbstractConfigurable

changeSupport, config, localizedName, myI18nData, name

Fields inherited from class VASSAL.build.AbstractBuildable

buildComponents, validator

Fields inherited from interface VASSAL.build.Configurable

NAME_PROPERTY

Constructor Summary

Constructors

Constructor	Description
ZonedGrid()

Method Summary

Modifier and Type	Method	Description
void	addTo(Buildable parent)	Adds this component to its parent.
void	addZone(Zone z)
void	build(Element e)	Build this component by getting all XML attributes of the XML element and calling AbstractBuildable.setAttribute(java.lang.String, java.lang.Object) with the String value of the attribute
boolean	contains(Point p)
void	draw(Graphics g, Rectangle bounds, Rectangle visibleRect, double scale, boolean reversed)	Draw the grid
Zone	findZone(Point p)
Zone	findZone(String name)
Class<?>[]	getAllowableConfigureComponents()
String[]	getAttributeDescriptions()	Return an array of Strings describing the attributes of this object.
String[]	getAttributeNames()	Lists all the buildFile (XML) attribute names for this component.
Class<?>[]	getAttributeTypes()	Return the Class for the attributes of this object.
String	getAttributeValueString(String key)	Called by the Buildable.getBuildElement(org.w3c.dom.Document) method to write the attributes into an XML element
MapGrid	getBackgroundGrid()
Board	getBoard()
Configurer	getConfigurer()	The default Configurer of an AbstractConfigurable class is an instance of AutoConfigurer
static String	getConfigureTypeName()
GridContainer	getContainer()
GridNumbering	getGridNumbering()
Area	getGridShape(Point center, int range)	Return the Area representing a set of tiles on the grid
HelpFile	getHelpFile()
Point	getLocation(String location)
Map	getMap()
int	getMaxPixelsPerRangeUnit(Point p)	Return an estimation of the maximum number of pixels per range unit for the grid that applies at the specified point.
Point	getRegionLocation(String location)
Dimension	getSize()
ZoneHighlight	getZoneHighlight(String name)
Iterator<Zone>	getZones()
List<Zone>	getZonesList()
boolean	isLocationRestricted(Point p)
boolean	isVisible()	Whether this grid should be drawn on the map
String	localizedLocationName(Point p)
String	locationName(Point p)
protected Area	makeClipArea(org.apache.commons.lang3.tuple.Pair<Point,Double> k)
protected Area	makeUnscaledUntranslatedClipArea()
int	range(Point p1, Point p2)
void	removeFrom(Buildable parent)	Remove this component from its parent
void	removeGrid(MapGrid grid)
void	removeZone(Zone z)
void	setAttribute(String key, Object value)	Sets a buildFile (XML) attribute value for this component.
void	setBackgroundGrid(MapGrid background)
void	setGrid(MapGrid grid)
void	setZoneHighlighter(ZonedGridHighlighter zh)
Point	snapTo(Point p)
Point	snapTo(Point p, boolean force)
Point	snapTo(Point p, boolean force, boolean centerOnly)

Methods inherited from class VASSAL.build.AbstractConfigurable

add, addPropertyChangeListener, getAttributeVisibility, getConfigureComponents, getConfigureName, getExpressionList, getFormattedStringList, getI18nData, getI18nPrefix, getLocalizedConfigureName, getMenuTextList, getNamedKeyStrokeList, getPropertyList, getTypeName, remove, removePropertyChangeListener, setAllAttributesUntranslatable, setAttributeTranslatable, setConfigureName

Methods inherited from class VASSAL.build.AbstractBuildable

addImageNamesRecursively, buildString, getAllDescendantComponentsOf, getAncestor, getBuildables, getBuildComponents, getBuildElement, getComponents, getComponentsOf, getNonFolderAncestor, getPropertyNames, setAncestor, validate

Methods inherited from class VASSAL.search.AbstractImageFinder

addLocalImageNames, getAllImageNames, getLocalImageNames

Methods inherited from class java.lang.Object

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

Methods inherited from interface VASSAL.script.expression.Auditable

getComponentName, getComponentTypeName

Methods inherited from interface VASSAL.build.Buildable

getBuildElement, isMandatory, isMovable, isUnique

Field Details

zones

protected List<Zone> zones

background

protected MapGrid background

container

protected GridContainer container

zoneHighlighters

protected ZonedGridHighlighter zoneHighlighters

clipCache

protected final Map<org.apache.commons.lang3.tuple.Pair<Point,Double>,Area> clipCache

Constructor Details

ZonedGrid

public ZonedGrid()

Method Details

getAttributeDescriptions

public String[] getAttributeDescriptions()

Description copied from interface: AutoConfigurable

Return an array of Strings describing the attributes of this object. These strings are used as prompts in the Properties window for this object.

Specified by:

getAttributeDescriptions in interface AutoConfigurable

Specified by:

getAttributeDescriptions in class AbstractConfigurable

Returns:

an array of Strings describing the buildFile (XML) attributes of this component. These strings are used as prompts in the Properties window for this object, when the component is configured in the Editor. The order of descriptions should be the same as the order of names in AbstractBuildable.getAttributeNames()

getAttributeTypes

public Class<?>[] getAttributeTypes()

Description copied from interface: AutoConfigurable

Return the Class for the attributes of this object. Valid classes are: String, Integer, Double, Boolean, Image, File, Color, and KeyStroke

Specified by:

getAttributeTypes in interface AutoConfigurable

Specified by:

getAttributeTypes in class AbstractConfigurable

Returns:

the Class for the buildFile (XML) attributes of this component. Valid classes include: String, Integer, Double, Boolean, Image, Color, and KeyStroke, along with any class for which a Configurer exists in VASSAL.configure. The class determines, among other things, which type of AutoConfigurer will be used to configure the attribute when the object is configured in the Editor. The order of classes should be the same as the order of names in AbstractBuildable.getAttributeNames()

getAttributeNames

public String[] getAttributeNames()

Description copied from class: AbstractBuildable

Lists all the buildFile (XML) attribute names for this component. If this component is ALSO an AbstractConfigurable, then this list of attributes determines the appropriate attribute order for AbstractConfigurable.getAttributeDescriptions() and AbstractConfigurable.getAttributeTypes().

Specified by:

getAttributeNames in interface AutoConfigurable

Specified by:

getAttributeNames in class AbstractBuildable

Returns:

a list of all buildFile (XML) attribute names for this component

getAttributeValueString

public String getAttributeValueString(String key)

Description copied from interface: AutoConfigurable

Called by the Buildable.getBuildElement(org.w3c.dom.Document) method to write the attributes into an XML element

Specified by:

getAttributeValueString in interface AutoConfigurable

Specified by:

getAttributeValueString in interface Translatable

Specified by:

getAttributeValueString in class AbstractBuildable

Parameters:

key - the name of the attribute. Will be one of those listed in AbstractBuildable.getAttributeNames()

Returns:

a String representation of the XML buildFile attribute with the given name. When initializing a module, this String value will loaded from the XML and passed to AbstractBuildable.setAttribute(java.lang.String, java.lang.Object). It is also frequently used for checking the current value of an attribute.

setAttribute

public void setAttribute(String key,
 Object value)

Description copied from class: AbstractBuildable

Sets a buildFile (XML) attribute value for this component. The key parameter will be one of those listed in AbstractBuildable.getAttributeNames(). If the value parameter is a String, it will be the value returned by AbstractBuildable.getAttributeValueString(java.lang.String) for the same key. If the implementing class extends AbstractConfigurable, then value will be an instance of the corresponding Class listed in AbstractConfigurable.getAttributeTypes()

Specified by:

setAttribute in interface AutoConfigurable

Specified by:

setAttribute in interface Translatable

Specified by:

setAttribute in class AbstractBuildable

Parameters:

key - the name of the attribute. Will be one of those listed in AbstractBuildable.getAttributeNames()

value - If the value parameter is a String, it will be the value returned by AbstractBuildable.getAttributeValueString(java.lang.String) for the same key. If the implementing class extends AbstractConfigurable, then value can also be an instance of the corresponding Class listed in AbstractConfigurable.getAttributeTypes()

getConfigurer

public Configurer getConfigurer()

Description copied from class: AbstractConfigurable

The default Configurer of an AbstractConfigurable class is an instance of AutoConfigurer

Specified by:

getConfigurer in interface Configurable

Overrides:

getConfigurer in class AbstractConfigurable

Returns:

Configurer for this component

addTo

public void addTo(Buildable parent)

Description copied from interface: Buildable

Adds this component to its parent. In order to make Buildable objects extensible, the child is responsible for adding itself to the parent. That way, Buildable subcomponents can be defined in an extension package without needing to modify the containing class.

Specified by:

addTo in interface Buildable

Parameters:

parent - parent Buildable to add this component to as a subcomponent.

getContainer

public GridContainer getContainer()

getSize

public Dimension getSize()

Specified by:

getSize in interface GridContainer

contains

public boolean contains(Point p)

Specified by:

contains in interface GridContainer

removeGrid

public void removeGrid(MapGrid grid)

Specified by:

removeGrid in interface GridContainer

getBoard

public Board getBoard()

Specified by:

getBoard in interface GridContainer

getMap

public Map getMap()

setGrid

public void setGrid(MapGrid grid)

Specified by:

setGrid in interface GridContainer

getAllowableConfigureComponents

public Class<?>[] getAllowableConfigureComponents()

Specified by:

getAllowableConfigureComponents in interface Configurable

Returns:

a list of valid sub-component Classes. If a Class appears in this list, then instances of that class may be added to this component from the Editor's ConfigureTree window by right-clicking on the component and selecting the appropriate "Add" option.

getConfigureTypeName

public static String getConfigureTypeName()

getHelpFile

public HelpFile getHelpFile()

Specified by:

getHelpFile in interface Configurable

Returns:

a HelpFile describing how to use and configure * this component

removeFrom

public void removeFrom(Buildable parent)

Description copied from interface: Configurable

Remove this component from its parent

Specified by:

removeFrom in interface Configurable

makeUnscaledUntranslatedClipArea

protected Area makeUnscaledUntranslatedClipArea()

makeClipArea

protected Area makeClipArea(org.apache.commons.lang3.tuple.Pair<Point,Double> k)

draw

public void draw(Graphics g,
 Rectangle bounds,
 Rectangle visibleRect,
 double scale,
 boolean reversed)

Description copied from interface: MapGrid

Draw the grid

Specified by:

draw in interface MapGrid

Parameters:

bounds - the boundaries of the grid (in magnified coordinates)

scale - the magnification factor

getGridNumbering

public GridNumbering getGridNumbering()

Specified by:

getGridNumbering in interface MapGrid

getLocation

public Point getLocation(String location)
                  throws MapGrid.BadCoords

Specified by:

getLocation in interface MapGrid

Returns:

A point p such that locationName(p).equals(location).

Throws:

MapGrid.BadCoords - if the location is not valid or formatted incorrectly.

getRegionLocation

public Point getRegionLocation(String location)

isVisible

public boolean isVisible()

Description copied from interface: MapGrid

Whether this grid should be drawn on the map

Specified by:

isVisible in interface MapGrid

locationName

public String locationName(Point p)

Specified by:

locationName in interface MapGrid

Returns:

a string describing the location containing the given point

localizedLocationName

public String localizedLocationName(Point p)

Specified by:

localizedLocationName in interface MapGrid

range

public int range(Point p1,
 Point p2)

Specified by:

range in interface MapGrid

Returns:

the range between two points, in some unit appropriate to the grid (e.g. hexes or squares)

getMaxPixelsPerRangeUnit

public int getMaxPixelsPerRangeUnit(Point p)

Description copied from interface: MapGrid

Return an estimation of the maximum number of pixels per range unit for the grid that applies at the specified point. Does not need to be exact, but must defer on the larger side to ensure fast range-checking by QTree lookup finds all target pieces.

Specified by:

getMaxPixelsPerRangeUnit in interface MapGrid

Returns:

maximum number of pixels per range unit.

getGridShape

public Area getGridShape(Point center,
 int range)

Description copied from interface: GeometricGrid

Return the Area representing a set of tiles on the grid

Specified by:

getGridShape in interface GeometricGrid

Parameters:

center - the center of the tiles

range - the number of tiles outward from the center to include

Returns:

findZone

public Zone findZone(Point p)

findZone

public Zone findZone(String name)

snapTo

public Point snapTo(Point p,
 boolean force,
 boolean centerOnly)

Specified by:

snapTo in interface MapGrid

Parameters:

centerOnly - If true, snaps only to the center, never to the edge or corner.

Returns:

The nearest grid location to the given point. This can for instance snap to center, edge or corner, depending on settings and arguments.

snapTo

public Point snapTo(Point p,
 boolean force)

Specified by:

snapTo in interface MapGrid

See Also:

• MapGrid.snapTo(Point p, boolean force, boolean onlyCenter)

snapTo

public Point snapTo(Point p)

Specified by:

snapTo in interface MapGrid

See Also:

• MapGrid.snapTo(Point p, boolean force, boolean onlyCenter)

isLocationRestricted

public boolean isLocationRestricted(Point p)

Specified by:

isLocationRestricted in interface MapGrid

Returns:

true if the given point may not be a local location. I.e., if this grid will attempt to snap it to the nearest grid location

addZone

public void addZone(Zone z)

removeZone

public void removeZone(Zone z)

getZones

public Iterator<Zone> getZones()

getZonesList

public List<Zone> getZonesList()

getBackgroundGrid

public MapGrid getBackgroundGrid()

setBackgroundGrid

public void setBackgroundGrid(MapGrid background)

build

public void build(Element e)

Description copied from class: AbstractBuildable

Build this component by getting all XML attributes of the XML element and calling AbstractBuildable.setAttribute(java.lang.String, java.lang.Object) with the String value of the attribute

Specified by:

build in interface Buildable

Overrides:

build in class AbstractBuildable

Parameters:

e - the XML element containing the object data

setZoneHighlighter

public void setZoneHighlighter(ZonedGridHighlighter zh)

getZoneHighlight

public ZoneHighlight getZoneHighlight(String name)