Package VASSAL.build.module.map

Class MapShader

java.lang.Object

VASSAL.search.AbstractImageFinder

VASSAL.build.AbstractBuildable

VASSAL.build.AbstractConfigurable

VASSAL.build.AbstractToolbarItem

VASSAL.build.module.map.MapShader

All Implemented Interfaces:

PropertyChangeListener, EventListener, AutoConfigurable, Buildable, Configurable, GameComponent, Drawable, PropertyNameSource, ValidityChecker, Translatable, Auditable, ImageSearchTarget, SearchTarget, UniqueIdManager.Identifyable

public class MapShader
extends AbstractToolbarItem
implements GameComponent, Drawable, UniqueIdManager.Identifyable

Draw shaded regions on a map.

Author:

Brent Easton

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MapShader.BoardPrompt
static class	MapShader.IconConfig	Deprecated, for removal: This API element is subject to removal in a future version. Use AbstractToolbarItem.IconConfig instead.
static class	MapShader.PatternPrompt
static interface	MapShader.ShadedPiece	Pieces that contribute to shading must implement this interface
static class	MapShader.TypePrompt

Nested classes/interfaces inherited from class VASSAL.build.AbstractToolbarItem

AbstractToolbarItem.FormattedStringConfig

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

AutoConfigurable.Util

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADD_TO_MAP_TOOLBAR
protected boolean	addToMapToolbar	Should the toolbar button for this shader be added to the Map toolbar instead of the Global toolbar? Map Shader buttons SHOULD be added to the Map Toolbar, but have mistakenly been added to the GLobal Toolbar since before the dawn of time.
static final String	ALL_BOARDS
static final String	ALWAYS_ON
protected boolean	alwaysOn
static final String	BG_TYPE
static final String	BOARD_LIST
protected Area	boardClip
protected String[]	boardList
static final String	BOARDS
protected String	boardSelection
protected boolean	border
static final String	BORDER
static final String	BORDER_COLOR
static final String	BORDER_OPACITY
static final String	BORDER_WIDTH
protected Color	borderColor
protected AlphaComposite	borderComposite
protected int	borderOpacity
protected int	borderWidth
static final String	BUTTON_TEXT
protected Color	color
static final String	COLOR
protected AlphaComposite	composite
static final String	DRAW_OVER
protected boolean	drawOver
static final String	EXC_BOARDS
static final String	FG_TYPE
static final String	HOT_KEY
static final String	ICON
protected String	id
protected static final UniqueIdManager	idMgr	Deprecated.
static final String	IMAGE
protected String	imageName
static final String	INC_BOARDS
protected LaunchButton	launch	Deprecated, for removal: This API element is subject to removal in a future version. use launch from the superclass
protected Map	map
static final String	NAME
protected int	opacity
static final String	OPACITY
protected String	pattern
static final String	PATTERN
protected Rectangle	patternRect
static final String	SCALE_IMAGE
protected boolean	scaleImage
protected boolean	shadingVisible
protected Area	shape
protected ImageOp	srcOp
static final String	STARTS_ON
protected boolean	startsOn
protected BasicStroke	stroke
protected TexturePaint	texture
protected Map<Double,TexturePaint>	textures
static final String	TOOLTIP
protected String	type
static final String	TYPE
static final String	TYPE_25_PERCENT
static final String	TYPE_50_PERCENT
static final String	TYPE_75_PERCENT
static final String	TYPE_IMAGE
static final String	TYPE_SOLID
protected String	version

Fields inherited from class VASSAL.build.AbstractToolbarItem

CAN_DISABLE, canDisable, DISABLED_ICON, disabledIconConfig, HIDE_WHEN_DISABLED, hideWhenDisabled, HOTKEY, property, PROPERTY_GATE, propertyGate, showDisabledOptions

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

Method Summary

Modifier and Type	Method	Description
void	addLocalImageNames(Collection<String> s)	Classes extending AbstractBuildable should override this method in order to add the names of any image files they use to the collection.
void	addTo(Buildable parent)	Default behavior adds the button to the parent component
protected void	buildBoardClip()	Build a clipping region excluding boards that do not needed to be Shaded.
protected AlphaComposite	buildBorderComposite()
protected void	buildComposite()
protected void	buildPatternAndTexture()
protected void	buildShadePattern()
protected void	buildStroke(double zoom)
protected void	buildTexture(double zoom)
protected void	checkPiece(Area area, GamePiece piece)
void	draw(Graphics g, Map map)
boolean	drawAboveCounters()	Is this Shade drawn over or under counters?
Class<?>[]	getAllowableConfigureComponents()
String[]	getAttributeDescriptions()	This getAttributeDescriptions() will return the items specific to the Toolbar Button - classes extending this should add their own items as well.
String[]	getAttributeNames()	This getAttributeNames() will return the items specific to the Toolbar Button - classes extending this should add their own items as well.
Class<?>[]	getAttributeTypes()	This getAttributeTypes() will return the items specific to the Toolbar Button - classes extending this should add their own items as well.
String	getAttributeValueString(String key)	Classes extending AbstractToolbarItem can call this as a super() method after checking for their own keys, to avoid needing to deal with the nitty gritty of the toolbar button.
VisibilityCondition	getAttributeVisibility(String name)	By default, all attributes are visible
Area	getBoardClip()
Color	getBorderColor()
protected AlphaComposite	getBorderComposite()
Color	getColor()
protected AlphaComposite	getComposite()	Get/Build the AlphaComposite used to draw the semi-transparent shade/
Configurer	getConfigurer()	The default Configurer of an AbstractConfigurable class is an instance of AutoConfigurer
static String	getConfigureTypeName()
HelpFile	getHelpFile()
String	getId()
protected Map	getMap()
protected Rectangle	getPatternRect(double zoom)
List<String>	getPropertyList()	SearchTarget
Command	getRestoreCommand()	When saving a game, each GameComponent should return a Command that, when executed, restores the GameComponent to its state when the game was saved If this component has no persistent state, return null
protected BufferedImage	getShadePattern(double zoom)
protected Area	getShadeShape(Map map)	Get/Build the shape of the shade.
protected BasicStroke	getStroke(double zoom)
protected TexturePaint	getTexture(double zoom)
protected boolean	isAlwaysOn()
protected boolean	isStartsOn()
protected TexturePaint	makeTexture(double zoom)
void	removeFrom(Buildable parent)	Remove from our parent
void	reset()
void	setAttribute(String key, Object value)	Classes extending AbstractToolbarItem can call this as a super() method after checking for their own keys, to avoid needing to deal with the nitty gritty of the toolbar button.
void	setId(String id)
void	setLaunchButtonVisibility()
void	setShadingVisibility(boolean b)
void	setup(boolean gameStarting)	Notify the GameComponent that a game has started/ended
protected void	toggleShading()

Methods inherited from class VASSAL.build.AbstractToolbarItem

addPropertyGateListener, addPropertyGateListener, checkDisabled, disableIfTrue, getComponent, getLaunchButton, getMenuTextList, getNamedKeyStrokeList, getNameKey, isShowDisabledOptions, makeLaunchButton, propertyChange, removePropertyGateListener, setButtonTextKey, setHotKeyKey, setIconKey, setLaunchButton, setNameKey, setNamePrompt, setShowDisabledOptions, setTooltipKey

Methods inherited from class VASSAL.build.AbstractConfigurable

add, addPropertyChangeListener, getConfigureComponents, getConfigureName, getExpressionList, getFormattedStringList, getI18nData, getI18nPrefix, getLocalizedConfigureName, 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

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

Methods inherited from interface VASSAL.tools.UniqueIdManager.Identifyable

getConfigureName

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

HOT_KEY

public static final String HOT_KEY

See Also:

• Constant Field Values

BUTTON_TEXT

public static final String BUTTON_TEXT

See Also:

• Constant Field Values

ICON

public static final String ICON

See Also:

• Constant Field Values

TOOLTIP

public static final String TOOLTIP

See Also:

• Constant Field Values

ALWAYS_ON

public static final String ALWAYS_ON

See Also:

• Constant Field Values

STARTS_ON

public static final String STARTS_ON

See Also:

• Constant Field Values

BOARDS

public static final String BOARDS

See Also:

• Constant Field Values

BOARD_LIST

public static final String BOARD_LIST

See Also:

• Constant Field Values

ALL_BOARDS

public static final String ALL_BOARDS

See Also:

• Constant Field Values

EXC_BOARDS

public static final String EXC_BOARDS

See Also:

• Constant Field Values

INC_BOARDS

public static final String INC_BOARDS

See Also:

• Constant Field Values

ADD_TO_MAP_TOOLBAR

public static final String ADD_TO_MAP_TOOLBAR

See Also:

• Constant Field Values

idMgr

@Deprecated(since="2023-08-13")
protected static final UniqueIdManager idMgr

Deprecated.

launch

@Deprecated(since="2021-04-03",
            forRemoval=true)
protected LaunchButton launch

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

use launch from the superclass

alwaysOn

protected boolean alwaysOn

startsOn

protected boolean startsOn

boardSelection

protected String boardSelection

boardList

protected String[] boardList

shadingVisible

protected boolean shadingVisible

scaleImage

protected boolean scaleImage

map

protected Map map

id

protected String id

boardClip

protected Area boardClip

TYPE

public static final String TYPE

See Also:

• Constant Field Values

DRAW_OVER

public static final String DRAW_OVER

See Also:

• Constant Field Values

PATTERN

public static final String PATTERN

See Also:

• Constant Field Values

COLOR

public static final String COLOR

See Also:

• Constant Field Values

IMAGE

public static final String IMAGE

See Also:

• Constant Field Values

SCALE_IMAGE

public static final String SCALE_IMAGE

See Also:

• Constant Field Values

OPACITY

public static final String OPACITY

See Also:

• Constant Field Values

BORDER

public static final String BORDER

See Also:

• Constant Field Values

BORDER_COLOR

public static final String BORDER_COLOR

See Also:

• Constant Field Values

BORDER_WIDTH

public static final String BORDER_WIDTH

See Also:

• Constant Field Values

BORDER_OPACITY

public static final String BORDER_OPACITY

See Also:

• Constant Field Values

BG_TYPE

public static final String BG_TYPE

See Also:

• Constant Field Values

FG_TYPE

public static final String FG_TYPE

See Also:

• Constant Field Values

TYPE_25_PERCENT

public static final String TYPE_25_PERCENT

See Also:

• Constant Field Values

TYPE_50_PERCENT

public static final String TYPE_50_PERCENT

See Also:

• Constant Field Values

TYPE_75_PERCENT

public static final String TYPE_75_PERCENT

See Also:

• Constant Field Values

TYPE_SOLID

public static final String TYPE_SOLID

See Also:

• Constant Field Values

TYPE_IMAGE

public static final String TYPE_IMAGE

See Also:

• Constant Field Values

imageName

protected String imageName

color

protected Color color

type

protected String type

drawOver

protected boolean drawOver

pattern

protected String pattern

opacity

protected int opacity

border

protected boolean border

borderColor

protected Color borderColor

borderWidth

protected int borderWidth

borderOpacity

protected int borderOpacity

shape

protected Area shape

patternRect

protected Rectangle patternRect

srcOp

protected ImageOp srcOp

texture

protected TexturePaint texture

textures

protected Map<Double,TexturePaint> textures

composite

protected AlphaComposite composite

borderComposite

protected AlphaComposite borderComposite

stroke

protected BasicStroke stroke

version

protected String version

addToMapToolbar

protected boolean addToMapToolbar

Should the toolbar button for this shader be added to the Map toolbar instead of the Global toolbar? Map Shader buttons SHOULD be added to the Map Toolbar, but have mistakenly been added to the GLobal Toolbar since before the dawn of time. Changing this will break existing module that have already added Shader buttons to global toolbar menus. Existing Map Shaders will have addToMapToolbar default to false to maintain compatibility New Map Shaders will have addToMapToolbar set to True

Constructor Details

MapShader

public MapShader()

Method Details

draw

public void draw(Graphics g,
 Map map)

Specified by:

draw in interface Drawable

getComposite

protected AlphaComposite getComposite()

Get/Build the AlphaComposite used to draw the semi-transparent shade/

buildComposite

protected void buildComposite()

getBorderComposite

protected AlphaComposite getBorderComposite()

buildBorderComposite

protected AlphaComposite buildBorderComposite()

getShadeShape

protected Area getShadeShape(Map map)

Get/Build the shape of the shade.

checkPiece

protected void checkPiece(Area area,
 GamePiece piece)

getShadePattern

protected BufferedImage getShadePattern(double zoom)

getPatternRect

protected Rectangle getPatternRect(double zoom)

buildShadePattern

protected void buildShadePattern()

getStroke

protected BasicStroke getStroke(double zoom)

buildStroke

protected void buildStroke(double zoom)

getBorderColor

public Color getBorderColor()

getTexture

protected TexturePaint getTexture(double zoom)

buildTexture

protected void buildTexture(double zoom)

makeTexture

protected TexturePaint makeTexture(double zoom)

getColor

public Color getColor()

drawAboveCounters

public boolean drawAboveCounters()

Is this Shade drawn over or under counters?

Specified by:

drawAboveCounters in interface Drawable

getAttributeNames

public String[] getAttributeNames()

Description copied from class: AbstractToolbarItem

This getAttributeNames() will return the items specific to the Toolbar Button - classes extending this should add their own items as well. If the "nameKey" is blank, then no "name" configure entry will be generated. Extending classes can use ArrayUtils.addAll(super.getAttributeNames(), key1, ..., keyN), or supply their own order from scratch.

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

Overrides:

getAttributeNames in class AbstractToolbarItem

Returns:

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

getAttributeTypes

public Class<?>[] getAttributeTypes()

Description copied from class: AbstractToolbarItem

This getAttributeTypes() will return the items specific to the Toolbar Button - classes extending this should add their own items as well. If the "nameKey" is blank, then no "name" configure entry will be generated. Extending classes can use ArrayUtils.addAll(super.getAttributeTypes(), key1, ..., keyN), or supply their own order from scratch.

Specified by:

getAttributeTypes in interface AutoConfigurable

Overrides:

getAttributeTypes in class AbstractToolbarItem

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

getAttributeDescriptions

public String[] getAttributeDescriptions()

Description copied from class: AbstractToolbarItem

This getAttributeDescriptions() will return the items specific to the Toolbar Button - classes extending this should add their own items as well. If the "nameKey" is blank, then no "name" configure entry will be generated. Extending classes can use ArrayUtils.addAll(super.getAttributeDescriptions(), key1, ..., keyN), or supply their own order from scratch.

Specified by:

getAttributeDescriptions in interface AutoConfigurable

Overrides:

getAttributeDescriptions in class AbstractToolbarItem

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

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.

reset

public void reset()

toggleShading

protected void toggleShading()

setShadingVisibility

public void setShadingVisibility(boolean b)

isAlwaysOn

protected boolean isAlwaysOn()

isStartsOn

protected boolean isStartsOn()

getMap

protected Map getMap()

getBoardClip

public Area getBoardClip()

buildBoardClip

protected void buildBoardClip()

Build a clipping region excluding boards that do not needed to be Shaded.

setLaunchButtonVisibility

public void setLaunchButtonVisibility()

setup

public void setup(boolean gameStarting)

Description copied from interface: GameComponent

Notify the GameComponent that a game has started/ended

Specified by:

setup in interface GameComponent

Overrides:

setup in class AbstractToolbarItem

Parameters:

gameStarting - if true, a game is starting. If false, then a game is ending

getRestoreCommand

public Command getRestoreCommand()

Description copied from interface: GameComponent

When saving a game, each GameComponent should return a Command that, when executed, restores the GameComponent to its state when the game was saved If this component has no persistent state, return null

Specified by:

getRestoreCommand in interface GameComponent

Overrides:

getRestoreCommand in class AbstractToolbarItem

buildPatternAndTexture

protected void buildPatternAndTexture()

setAttribute

public void setAttribute(String key,
 Object value)

Description copied from class: AbstractToolbarItem

Classes extending AbstractToolbarItem can call this as a super() method after checking for their own keys, to avoid needing to deal with the nitty gritty of the toolbar button. Sets a buildFile (XML) attribute value for this component. The key parameter will be one of those listed in AbstractToolbarItem.getAttributeNames(). If the value parameter is a String, it will be the value returned by AbstractToolbarItem.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

Overrides:

setAttribute in class AbstractToolbarItem

Parameters:

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

value - If the value parameter is a String, it will be the value returned by AbstractToolbarItem.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()

getAttributeValueString

public String getAttributeValueString(String key)

Description copied from class: AbstractToolbarItem

Classes extending AbstractToolbarItem can call this as a super() method after checking for their own keys, to avoid needing to deal with the nitty gritty of the toolbar button.

Specified by:

getAttributeValueString in interface AutoConfigurable

Specified by:

getAttributeValueString in interface Translatable

Overrides:

getAttributeValueString in class AbstractToolbarItem

Parameters:

key - the name of the attribute. Will be one of those listed in AbstractToolbarItem.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 AbstractToolbarItem.setAttribute(java.lang.String, java.lang.Object). It is also frequently used for checking the current value of an attribute.

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 AbstractToolbarItem

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.

addLocalImageNames

public void addLocalImageNames(Collection<String> s)

Description copied from class: AbstractToolbarItem

Classes extending AbstractBuildable should override this method in order to add the names of any image files they use to the collection. For "find unused images" and "search".

Specified by:

addLocalImageNames in interface ImageSearchTarget

Overrides:

addLocalImageNames in class AbstractToolbarItem

Parameters:

s - Collection to add image names to

getConfigureTypeName

public static String getConfigureTypeName()

removeFrom

public void removeFrom(Buildable parent)

Description copied from class: AbstractToolbarItem

Remove from our parent

Specified by:

removeFrom in interface Configurable

Overrides:

removeFrom in class AbstractToolbarItem

Parameters:

parent - parent

getHelpFile

public HelpFile getHelpFile()

Specified by:

getHelpFile in interface Configurable

Returns:

a HelpFile describing how to use and configure * this component

addTo

public void addTo(Buildable parent)

Description copied from class: AbstractToolbarItem

Default behavior adds the button to the parent component

Specified by:

addTo in interface Buildable

Overrides:

addTo in class AbstractToolbarItem

Parameters:

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

getId

public String getId()

Specified by:

getId in interface UniqueIdManager.Identifyable

setId

public void setId(String id)

Specified by:

setId in interface UniqueIdManager.Identifyable

getPropertyList

public List<String> getPropertyList()

SearchTarget

Specified by:

getPropertyList in interface SearchTarget

Overrides:

getPropertyList in class AbstractToolbarItem

Returns:

a list of any Property Names referenced in the Configurable, if any (for search)

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