VASSAL.build.module.map.MapShader

All Implemented Interfaces:: AutoConfigurable, Buildable, Configurable, GameComponent, Drawable, PropertyNameSource, ValidityChecker, Translatable, UniqueIdManager.Identifyable

public class MapShader
extends AbstractConfigurable
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`
`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 interface VASSAL.build.AutoConfigurable

AutoConfigurable.Util

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`ALL_BOARDS`
`static String`	`ALWAYS_ON`
`protected boolean`	`alwaysOn`
`static String`	`BG_TYPE`
`static String`	`BOARD_LIST`
`protected Area`	`boardClip`
`protected String[]`	`boardList`
`static String`	`BOARDS`
`protected String`	`boardSelection`
`protected boolean`	`border`
`static String`	`BORDER`
`static String`	`BORDER_COLOR`
`static String`	`BORDER_OPACITY`
`static String`	`BORDER_WIDTH`
`protected Color`	`borderColor`
`protected AlphaComposite`	`borderComposite`
`protected int`	`borderOpacity`
`protected int`	`borderWidth`
`static String`	`BUTTON_TEXT`
`protected Color`	`color`
`static String`	`COLOR`
`protected AlphaComposite`	`composite`
`static String`	`DRAW_OVER`
`protected boolean`	`drawOver`
`static String`	`EXC_BOARDS`
`static String`	`FG_TYPE`
`static String`	`HOT_KEY`
`static String`	`ICON`
`protected String`	`id`
`protected static UniqueIdManager`	`idMgr`
`static String`	`IMAGE`
`protected String`	`imageName`
`static String`	`INC_BOARDS`
`protected LaunchButton`	`launch`
`protected Map`	`map`
`static String`	`NAME`
`protected int`	`opacity`
`static String`	`OPACITY`
`protected String`	`pattern`
`static String`	`PATTERN`
`protected Rectangle`	`patternRect`
`static String`	`SCALE_IMAGE`
`protected boolean`	`scaleImage`
`protected boolean`	`shadingVisible`
`protected Area`	`shape`
`protected ImageOp`	`srcOp`
`static String`	`STARTS_ON`
`protected boolean`	`startsOn`
`protected BasicStroke`	`stroke`
`protected TexturePaint`	`texture`
`protected Map<Double,TexturePaint>`	`textures`
`static String`	`TOOLTIP`
`protected String`	`type`
`static String`	`TYPE`
`static String`	`TYPE_25_PERCENT`
`static String`	`TYPE_50_PERCENT`
`static String`	`TYPE_75_PERCENT`
`static String`	`TYPE_IMAGE`
`static String`	`TYPE_SOLID`

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`	`addTo(Buildable parent)`	Adds this component to its parent.
`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()`	Deprecated, for removal: This API element is subject to removal in a future version. Use `buildTexture(double)` instead.
`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()`	Return a list of valid sub-component Classes.
`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 buildFile (XML) attributes of this component.
`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
`Area`	`getBoardClip()`
`Color`	`getBorderColor()`
`protected AlphaComposite`	`getBorderComposite()`
`Color`	`getColor()`
`protected AlphaComposite`	`getComposite()`	Get/Build the AlphaComposite used to draw the semi-transparent shade/
`static String`	`getConfigureTypeName()`
`HelpFile`	`getHelpFile()`
`String`	`getId()`
`protected Map`	`getMap()`
`protected Rectangle`	`getPatternRect()`	Deprecated, for removal: This API element is subject to removal in a future version. Use `getPatternRect(double)` instead.
`protected Rectangle`	`getPatternRect(double zoom)`
`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()`	Deprecated, for removal: This API element is subject to removal in a future version. Use `getShadePattern(double)` instead.
`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()`	Deprecated, for removal: This API element is subject to removal in a future version. Use `getTexture(double)` instead.
`protected TexturePaint`	`getTexture(double zoom)`
`protected boolean`	`isAlwaysOn()`
`protected boolean`	`isStartsOn()`
`protected TexturePaint`	`makeTexture(double zoom)`
`void`	`removeFrom(Buildable parent)`	Remove this component from its parent
`void`	`reset()`
`void`	`setAttribute(String key, Object value)`	Sets a buildFile (XML) attribute value for this component.
`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.AbstractConfigurable

add, addPropertyChangeListener, getConfigureComponents, getConfigureName, getConfigurer, getI18nData, getI18nPrefix, getLocalizedConfigureName, remove, removePropertyChangeListener, setAllAttributesUntranslatable, setAttributeTranslatable, setConfigureName

Methods inherited from class VASSAL.build.AbstractBuildable

build, getAllDescendantComponents, getAllDescendantComponentsOf, getBuildables, getBuildComponents, getBuildElement, getComponents, getComponentsOf, getPropertyNames, validate

Methods inherited from class java.lang.Object

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

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
- 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
- HOT_KEY
  
  public static final String HOT_KEY
  
  See Also:
  
  Constant Field Values
- ICON
  
  public static final String ICON
  
  See Also:
  
  Constant Field Values
- BUTTON_TEXT
  
  public static final String BUTTON_TEXT
  
  See Also:
  
  Constant Field Values
- TOOLTIP
  
  public static final String TOOLTIP
  
  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
- idMgr
  
  protected static final UniqueIdManager idMgr
- launch
  
  protected LaunchButton launch
- 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
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
  
  @Deprecated(since="2020-08-06", forRemoval=true) protected BufferedImage getShadePattern()
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  Use getShadePattern(double) instead.
  
  Get/Build the repeating rectangle used to generate the shade texture pattern.
- getShadePattern
  
  protected BufferedImage getShadePattern(double zoom)
- getPatternRect
  
  @Deprecated(since="2020-08-06", forRemoval=true) protected Rectangle getPatternRect()
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  Use getPatternRect(double) instead.
- 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
  
  @Deprecated(since="2020-08-06", forRemoval=true) protected TexturePaint getTexture()
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  Use getTexture(double) instead.
  
  Get/Build the textured paint used to fill in the Shade
- getTexture
  
  protected TexturePaint getTexture(double zoom)
- buildTexture
  
  @Deprecated(since="2020-08-06", forRemoval=true) protected void buildTexture()
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  Use buildTexture(double) instead.
- 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: 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
- getAttributeTypes
  
  public Class<?>[] getAttributeTypes()
  
  Description copied from class: AbstractConfigurable
  
  Return 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()
  
  Specified by:
  
  getAttributeTypes in interface AutoConfigurable
  
  Specified by:
  
  getAttributeTypes in class AbstractConfigurable
- 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()
- getAllowableConfigureComponents
  
  public Class<?>[] getAllowableConfigureComponents()
  
  Description copied from interface: Configurable
  
  Return 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 Configuration Window.
  
  Specified by:
  
  getAllowableConfigureComponents in interface Configurable
- 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
  
  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
- buildPatternAndTexture
  
  protected void buildPatternAndTexture()
- 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()
- 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 attribute with the given name. When initializing a module, this String value will be passed to AbstractBuildable.setAttribute(java.lang.String, java.lang.Object).
- 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.
- getConfigureTypeName
  
  public static String getConfigureTypeName()
- removeFrom
  
  public void removeFrom(Buildable parent)
  
  Description copied from interface: Configurable
  
  Remove this component from its parent
  
  Specified by:
  
  removeFrom in interface Configurable
- getHelpFile
  
  public HelpFile getHelpFile()
  
  Specified by:
  
  getHelpFile in interface Configurable
  
  Returns:
  
  a HelpFilte describing how to use and configure 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 reponsible 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
- getId
  
  public String getId()
  
  Specified by:
  
  getId in interface UniqueIdManager.Identifyable
- setId
  
  public void setId(String id)
  
  Specified by:
  
  setId in interface UniqueIdManager.Identifyable

Class MapShader

Nested Class Summary

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

Field Summary

Fields inherited from class VASSAL.build.AbstractConfigurable

Fields inherited from class VASSAL.build.AbstractBuildable

Fields inherited from interface VASSAL.build.Configurable

Constructor Summary

Method Summary

Methods inherited from class VASSAL.build.AbstractConfigurable

Methods inherited from class VASSAL.build.AbstractBuildable

Methods inherited from class java.lang.Object

Methods inherited from interface VASSAL.build.Buildable

Methods inherited from interface VASSAL.tools.UniqueIdManager.Identifyable

Field Details

NAME

ALWAYS_ON

STARTS_ON

HOT_KEY

ICON

BUTTON_TEXT

TOOLTIP

BOARDS

BOARD_LIST

ALL_BOARDS

EXC_BOARDS

INC_BOARDS

idMgr

launch

alwaysOn

startsOn

boardSelection

boardList

shadingVisible

scaleImage

map

id

boardClip

TYPE

DRAW_OVER

PATTERN

COLOR

IMAGE

SCALE_IMAGE

OPACITY

BORDER

BORDER_COLOR

BORDER_WIDTH

BORDER_OPACITY

BG_TYPE

FG_TYPE

TYPE_25_PERCENT

TYPE_50_PERCENT

TYPE_75_PERCENT

TYPE_SOLID

TYPE_IMAGE

imageName

color

type

drawOver

pattern

opacity

border

borderColor

borderWidth

borderOpacity

shape

patternRect

srcOp

texture

textures

composite

borderComposite

stroke

Constructor Details

MapShader

Method Details

draw

getComposite

buildComposite