Class HexGrid

java.lang.Object

VASSAL.search.AbstractImageFinder

VASSAL.build.AbstractBuildable

VASSAL.build.AbstractConfigurable

VASSAL.build.module.map.boardPicker.board.HexGrid

All Implemented Interfaces:

AutoConfigurable, Buildable, Configurable, GeometricGrid, GridEditor.EditableGrid, MapGrid, PropertyNameSource, ValidityChecker, Translatable, Auditable, ImageSearchTarget, SearchTarget

public class HexGrid
extends AbstractConfigurable
implements GeometricGrid, GridEditor.EditableGrid

A Hexgrid is a map grid composed of hexes.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HexGrid.HexGridEditor

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 boolean	alternate
protected Color	color
static final String	COLOR
protected GridContainer	container
static final String	CORNERS
protected boolean	cornersLegal
static final String	DOTS_VISIBLE
protected boolean	dotsVisible
protected double	dx
static final String	DX
protected double	dy
static final String	DY
static final String	EDGES
protected boolean	edgesLegal
protected HexGrid.HexGridEditor	gridEditor
protected GridNumbering	numbering
protected Point	origin
protected Map<Integer,Area>	shapeCache
protected boolean	sideways
static final String	SIDEWAYS
static final String	SNAP_SCALE
static final String	SNAP_TO
protected int	snapScale
protected boolean	snapTo
protected static final double	sqrt3_2
protected boolean	visible
static final String	VISIBLE
static final String	X0
static final String	Y0

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
HexGrid()
HexGrid(double size, boolean alt)
HexGrid(double height, double width, boolean alt)

Method Summary

Modifier and Type	Method	Description
void	addTo(Buildable b)	Adds this component to its parent.
protected Point	checkCenter(Point center, Point target)
void	draw(Graphics g, Rectangle bounds, Rectangle visibleRect, double zoom, boolean reversed)	Draw the grid, if visible, and the accompanying numbering
void	editGrid()
void	forceDraw(Graphics g, Rectangle bounds, Rectangle visibleRect, double zoom, boolean reversed)	Draw the grid even if set to be not visible
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
VisibilityCondition	getAttributeVisibility(String name)	By default, all attributes are visible
String	getConfigureName()	ConfigureName is used, in particular, by the Editor to track the names of components, and is preferred by UniqueIdManager.
Configurer	getConfigurer()	The default Configurer of an AbstractConfigurable class is an instance of AutoConfigurer
static String	getConfigureTypeName()
GridContainer	getContainer()
double	getDx()
double	getDy()
String	getGridName()
GridNumbering	getGridNumbering()
Area	getGridShape(Point center, int range)	Return the Area representing a set of tiles on the grid
HelpFile	getHelpFile()
double	getHexSize()
double	getHexWidth()
Point	getLocation(String location)
int	getMaxPixelsPerRangeUnit(Point p)	Return the largest number of pixels that a range unit can have NOTE this is just an estimate and is used as a heuristic in the GKC fast match process, so it MUST encompass all units that could be in range, but may be larger.
Point	getOrigin()
int	getRawColumn(Point p)
int	getRawRow(Point p)
protected Area	getSingleHexShape(int centerX, int centerY, boolean reversed)
int	getSnapScale()
protected int	hexX(int x, int y)	Deprecated, for removal: This API element is subject to removal in a future version.
protected int	hexY(int x, int y)	Deprecated, for removal: This API element is subject to removal in a future version.
boolean	isCornersLegal()
boolean	isEdgesLegal()
boolean	isLocationRestricted(Point p)
boolean	isSideways()
boolean	isVisible()	Whether this grid should be drawn on the map
String	localizedLocationName(Point p)
String	locationName(Point p)
int	range(Point p1, Point p2)	Calculate the correct Manhattan range in hexes between 2 points.
void	removeFrom(Buildable b)	Remove this component from its parent
void	rotate(Point p)
void	rotateIfSideways(Point p)
void	setAttribute(String key, Object val)	Sets a buildFile (XML) attribute value for this component.
void	setCornersLegal(boolean legal)
void	setDx(double d)
void	setDy(double d)
void	setEdgesLegal(boolean legal)
void	setGridNumbering(GridNumbering numbering)
void	setHexSize(double size)
void	setHexWidth(double w)
void	setOrigin(Point p)
void	setSideways(boolean b)
void	setSnapScale(int snapScale)
void	setVisible(boolean legal)
protected int	sideX(int x, int y)
protected int	sideY(int x, int y)
Point	snapTo(Point p)
Point	snapTo(Point p, boolean force)
Point	snapTo(Point p, boolean force, boolean centerOnly)
Point	snapToHex(Point p)
Point	snapToHexSide(Point p)
Point	snapToHexVertex(Point p)
protected int	vertexX(int x, int y)
protected int	vertexY(int x, int y)

Methods inherited from class VASSAL.build.AbstractConfigurable

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

Methods inherited from class VASSAL.build.AbstractBuildable

addImageNamesRecursively, build, 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

build, getBuildElement, isMandatory, isMovable, isUnique

Field Details

origin

protected Point origin

dx

protected double dx

dy

protected double dy

snapScale

protected int snapScale

container

protected GridContainer container

numbering

protected GridNumbering numbering

visible

protected boolean visible

dotsVisible

protected boolean dotsVisible

edgesLegal

protected boolean edgesLegal

cornersLegal

protected boolean cornersLegal

color

protected Color color

sideways

protected boolean sideways

snapTo

protected boolean snapTo

shapeCache

protected Map<Integer,Area> shapeCache

gridEditor

protected HexGrid.HexGridEditor gridEditor

X0

public static final String X0

See Also:

• Constant Field Values

Y0

public static final String Y0

See Also:

• Constant Field Values

DY

public static final String DY

See Also:

• Constant Field Values

DX

public static final String DX

See Also:

• Constant Field Values

VISIBLE

public static final String VISIBLE

See Also:

• Constant Field Values

DOTS_VISIBLE

public static final String DOTS_VISIBLE

See Also:

• Constant Field Values

CORNERS

public static final String CORNERS

See Also:

• Constant Field Values

EDGES

public static final String EDGES

See Also:

• Constant Field Values

SIDEWAYS

public static final String SIDEWAYS

See Also:

• Constant Field Values

COLOR

public static final String COLOR

See Also:

• Constant Field Values

SNAP_SCALE

public static final String SNAP_SCALE

See Also:

• Constant Field Values

SNAP_TO

public static final String SNAP_TO

See Also:

• Constant Field Values

sqrt3_2

protected static final double sqrt3_2

alternate

protected boolean alternate

Constructor Details

HexGrid

public HexGrid(double height,
 double width,
 boolean alt)

HexGrid

public HexGrid(double size,
 boolean alt)

HexGrid

public HexGrid()

Method Details

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

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()

getAttributeVisibility

public VisibilityCondition getAttributeVisibility(String name)

Description copied from class: AbstractConfigurable

By default, all attributes are visible

Specified by:

getAttributeVisibility in interface AutoConfigurable

Overrides:

getAttributeVisibility in class AbstractConfigurable

Parameters:

name - Name (key) of one of this component's attributes

Returns:

a VisibilityCondition for this attribute, or null if attribute should always be visible.

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

isVisible

public boolean isVisible()

Description copied from interface: MapGrid

Whether this grid should be drawn on the map

Specified by:

isVisible in interface GridEditor.EditableGrid

Specified by:

isVisible in interface MapGrid

isEdgesLegal

public boolean isEdgesLegal()

isCornersLegal

public boolean isCornersLegal()

setVisible

public void setVisible(boolean legal)

Specified by:

setVisible in interface GridEditor.EditableGrid

setEdgesLegal

public void setEdgesLegal(boolean legal)

isSideways

public boolean isSideways()

Specified by:

isSideways in interface GridEditor.EditableGrid

setSideways

public void setSideways(boolean b)

Specified by:

setSideways in interface GridEditor.EditableGrid

setCornersLegal

public void setCornersLegal(boolean legal)

setHexSize

public void setHexSize(double size)

getHexSize

public double getHexSize()

getHexWidth

public double getHexWidth()

setHexWidth

public void setHexWidth(double w)

getDx

public double getDx()

Specified by:

getDx in interface GridEditor.EditableGrid

setDx

public void setDx(double d)

Specified by:

setDx in interface GridEditor.EditableGrid

getDy

public double getDy()

Specified by:

getDy in interface GridEditor.EditableGrid

setDy

public void setDy(double d)

Specified by:

setDy in interface GridEditor.EditableGrid

getContainer

public GridContainer getContainer()

Specified by:

getContainer in interface GridEditor.EditableGrid

addTo

public void addTo(Buildable b)

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:

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

removeFrom

public void removeFrom(Buildable b)

Description copied from interface: Configurable

Remove this component from its parent

Specified by:

removeFrom in interface Configurable

getConfigureTypeName

public static String getConfigureTypeName()

getGridName

public String getGridName()

Specified by:

getGridName in interface GridEditor.EditableGrid

getConfigureName

public String getConfigureName()

Description copied from class: AbstractConfigurable

ConfigureName is used, in particular, by the Editor to track the names of components, and is preferred by UniqueIdManager.

Specified by:

getConfigureName in interface Configurable

Overrides:

getConfigureName in class AbstractConfigurable

Returns:

The language-independent name of this component used for programmatic identification (including within Modules by e.g. Traits and module components)

getHelpFile

public HelpFile getHelpFile()

Specified by:

getHelpFile in interface Configurable

Returns:

a HelpFile describing how to use and configure * 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 val)

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()

val - 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()

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.

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

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.

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)

checkCenter

protected Point checkCenter(Point center,
 Point target)

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

snapToHex

public Point snapToHex(Point p)

Returns:

the nearest hex center

snapToHexSide

public Point snapToHexSide(Point p)

Returns:

the nearest hex center or hexside

snapToHexVertex

public Point snapToHexVertex(Point p)

Returns:

the nearest hex center or vertex

rotate

public void rotate(Point p)

rotateIfSideways

public void rotateIfSideways(Point p)

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:

getSingleHexShape

protected Area getSingleHexShape(int centerX,
 int centerY,
 boolean reversed)

See Also:

• getSingleHexShape(int, int, boolean, boolean, double, double)

getRawColumn

public int getRawColumn(Point p)

getRawRow

public int getRawRow(Point p)

range

public int range(Point p1,
 Point p2)

Calculate the correct Manhattan range in hexes between 2 points.

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)

Return the largest number of pixels that a range unit can have NOTE this is just an estimate and is used as a heuristic in the GKC fast match process, so it MUST encompass all units that could be in range, but may be larger. The range of selected pieces will be accurately checked.

Specified by:

getMaxPixelsPerRangeUnit in interface MapGrid

Returns:

max pixels per range

hexX

@Deprecated(since="2023-06-03",
            forRemoval=true)
protected int hexX(int x,
 int y)

Deprecated, for removal: This API element is subject to removal in a future version.

hexY

@Deprecated(since="2023-06-03",
            forRemoval=true)
protected int hexY(int x,
 int y)

Deprecated, for removal: This API element is subject to removal in a future version.

sideX

protected int sideX(int x,
 int y)

sideY

protected int sideY(int x,
 int y)

vertexX

protected int vertexX(int x,
 int y)

vertexY

protected int vertexY(int x,
 int y)

draw

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

Draw the grid, if visible, and the accompanying numbering

Specified by:

draw in interface MapGrid

Parameters:

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

zoom - the magnification factor

forceDraw

public void forceDraw(Graphics g,
 Rectangle bounds,
 Rectangle visibleRect,
 double zoom,
 boolean reversed)

Draw the grid even if set to be not visible

setGridNumbering

public void setGridNumbering(GridNumbering numbering)

getGridNumbering

public GridNumbering getGridNumbering()

Specified by:

getGridNumbering in interface GridEditor.EditableGrid

Specified by:

getGridNumbering in interface MapGrid

getOrigin

public Point getOrigin()

Specified by:

getOrigin in interface GridEditor.EditableGrid

setOrigin

public void setOrigin(Point p)

Specified by:

setOrigin in interface GridEditor.EditableGrid

editGrid

public void editGrid()

getSnapScale

public int getSnapScale()

setSnapScale

public void setSnapScale(int snapScale)