VASSAL.counters.Footprint

All Implemented Interfaces:: PropertyNameSource, PropertySource, EditablePiece, GamePiece, PropertyExporter, StateMergeable, TranslatablePiece, PersistentPropertyContainer

public class Footprint
extends MovementMarkable

Displays a movement trail indicating where a piece has been moved

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`protected static class`	`Footprint.Ed`	Key Command Global Visibility Circle Radius Fill Color Line Color Selected Transparency Unselected Transparency Edge Buffer Display Limit Edge Buffer Point Limit

Field Summary

Fields
Modifier and Type	Field	Description
`protected int`	`circleRadius`
`protected static int`	`DEFAULT_CIRCLE_RADIUS`
`protected static int`	`DEFAULT_EDGE_DISPLAY_BUFFER`
`protected static int`	`DEFAULT_EDGE_POINT_BUFFER`
`protected static Color`	`DEFAULT_FILL_COLOR`
`protected static Boolean`	`DEFAULT_GLOBALLY_VISIBLE`
`protected static Boolean`	`DEFAULT_INITIALLY_VISIBLE`
`protected static Color`	`DEFAULT_LINE_COLOR`
`protected static String`	`DEFAULT_MENU_COMMAND`
`protected static int`	`DEFAULT_SELECTED_TRANSPARENCY`
`protected static char`	`DEFAULT_TRAIL_KEY`
`protected static int`	`DEFULT_UNSELECTED_TRANSPARENCY`
`protected int`	`edgeDisplayBuffer`
`protected int`	`edgePointBuffer`
`protected Color`	`fillColor`
`protected Font`	`font`
`protected boolean`	`globallyVisible`
`protected boolean`	`globalVisibility`
`static String`	`ID`
`protected boolean`	`initialized`
`protected boolean`	`initiallyVisible`
`protected double`	`lastZoom`
`protected static float`	`LINE_WIDTH`
`protected Color`	`lineColor`
`protected double`	`lineWidth`
`protected boolean`	`localVisibility`
`protected String`	`menuCommand`
`protected Rectangle`	`myBoundingBox`
`protected List<Point>`	`pointList`
`protected int`	`selectedTransparency`
`protected String`	`startMapId`
`protected NamedKeyStroke`	`trailKey`
`protected NamedKeyStroke`	`trailKeyClear`
`protected NamedKeyStroke`	`trailKeyOff`
`protected NamedKeyStroke`	`trailKeyOn`
`protected int`	`unSelectedTransparency`

Fields inherited from class VASSAL.counters.Decorator

piece

Fields inherited from interface VASSAL.counters.PropertyExporter

LOCALIZED_NAME

Fields inherited from interface VASSAL.i18n.TranslatablePiece

PREFIX

Constructor Summary

Constructors

Constructor Description

Footprint()

Footprint(String type, GamePiece p)

Method Summary

Modifier and Type	Method	Description
`protected void`	`addPoint(Point p)`	Add Point to list and adjust the overall boundingBox to encompass the trail.
`Rectangle`	`boundingBox()`	Return a bounding box covering the whole trail if it is visible, otherwise just return the standard piece bounding box
`protected void`	`clearTrail()`
`void`	`draw(Graphics g, int x, int y, Component obs, double zoom)`	Draw this GamePiece
`protected void`	`drawPoint(Graphics g, Point p, double zoom, int elementCount)`	Draw a Circle at the given point.
`protected void`	`drawTrack(Graphics g, int x1, int y1, int x2, int y2, double zoom)`	Draw a track from one Point to another.
`String`	`getDescription()`	A plain-English description of this type of piece
`PieceEditor`	`getEditor()`	Get the configurer for this trait
`HelpFile`	`getHelpFile()`
`PieceI18nData`	`getI18nData()`	Return I18n data for this piece
`Object`	`getLocalizedProperty(Object key)`
`Rectangle`	`getMyBoundingBox()`	Return the boundingBox including the trail
`String`	`getName()`	The plain English name for this piece
`protected Enumeration<Point>`	`getPointList()`	Deprecated, for removal: This API element is subject to removal in a future version. Use `pointList` directly.
`Object`	`getProperty(Object key)`
`Shape`	`getShape()`	The shape of the piece from the user's viewpoint.
`protected Image`	`getTrailImage(int elementCount)`	Override this method to return an Image to display within each trail circle
`protected String`	`getTrailText(int elementCount)`	Override this method to return text to display within each trail circle.
`protected boolean`	`isTrailVisible()`	Global Visibility means all players see the same trail Local Visibility means each player controls their own trail visibility
`KeyCommand[]`	`myGetKeyCommands()`
`String`	`myGetState()`
`String`	`myGetType()`
`Command`	`myKeyEvent(KeyStroke stroke)`	The response of this trait alone to the given KeyStroke
`void`	`mySetState(String newState)`	Set just the state of this trait
`void`	`mySetType(String type)`	Type is the character command that toggles footprint visiblity
`protected void`	`recordCurrentPosition()`
`void`	`redraw()`
`void`	`setMoved(boolean justMoved)`	setMoved is called with an argument of true each time the piece is moved.
`void`	`setProperty(Object key, Object val)`	Other properties, possibly game-specific, can be associated with a piece.

Methods inherited from class VASSAL.counters.MovementMarkable

getPropertyNames, isMoved

Methods inherited from class VASSAL.counters.Decorator

getCommandDescription, getDecorator, getI18nData, getI18nData, getId, getInner, getInnermost, getKeyCommands, getLocalizedName, getMap, getOuter, getOutermost, getParent, getPersistentProperty, getPosition, getState, getTranslation, getType, isSelected, keyEvent, mergeState, putOldProperties, repack, reportDataError, reportDataError, reportDataError, setId, setInner, setMap, setOldProperties, setOldProperties, setParent, setPersistentProperty, setPosition, setSelected, setState, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface VASSAL.counters.GamePiece

getId, getLocalizedName, getMap, getParent, getPosition, getState, getType, keyEvent, setId, setMap, setParent, setPosition, setState

Methods inherited from interface VASSAL.counters.PropertyExporter

getProperties

Field Details
- ID
  
  public static final String ID
  
  See Also:
  
  Constant Field Values
- globalVisibility
  
  protected boolean globalVisibility
- startMapId
  
  protected String startMapId
- pointList
  
  protected List<Point> pointList
- trailKey
  
  protected NamedKeyStroke trailKey
- trailKeyOn
  
  protected NamedKeyStroke trailKeyOn
- trailKeyOff
  
  protected NamedKeyStroke trailKeyOff
- trailKeyClear
  
  protected NamedKeyStroke trailKeyClear
- menuCommand
  
  protected String menuCommand
- initiallyVisible
  
  protected boolean initiallyVisible
- globallyVisible
  
  protected boolean globallyVisible
- circleRadius
  
  protected int circleRadius
- selectedTransparency
  
  protected int selectedTransparency
- unSelectedTransparency
  
  protected int unSelectedTransparency
- lineColor
  
  protected Color lineColor
- fillColor
  
  protected Color fillColor
- edgePointBuffer
  
  protected int edgePointBuffer
- edgeDisplayBuffer
  
  protected int edgeDisplayBuffer
- DEFAULT_TRAIL_KEY
  
  protected static final char DEFAULT_TRAIL_KEY
  
  See Also:
  
  Constant Field Values
- DEFAULT_MENU_COMMAND
  
  protected static final String DEFAULT_MENU_COMMAND
  
  See Also:
  
  Constant Field Values
- DEFAULT_INITIALLY_VISIBLE
  
  protected static final Boolean DEFAULT_INITIALLY_VISIBLE
- DEFAULT_GLOBALLY_VISIBLE
  
  protected static final Boolean DEFAULT_GLOBALLY_VISIBLE
- DEFAULT_CIRCLE_RADIUS
  
  protected static final int DEFAULT_CIRCLE_RADIUS
  
  See Also:
  
  Constant Field Values
- DEFAULT_FILL_COLOR
  
  protected static final Color DEFAULT_FILL_COLOR
- DEFAULT_LINE_COLOR
  
  protected static final Color DEFAULT_LINE_COLOR
- DEFAULT_SELECTED_TRANSPARENCY
  
  protected static final int DEFAULT_SELECTED_TRANSPARENCY
  
  See Also:
  
  Constant Field Values
- DEFULT_UNSELECTED_TRANSPARENCY
  
  protected static final int DEFULT_UNSELECTED_TRANSPARENCY
  
  See Also:
  
  Constant Field Values
- DEFAULT_EDGE_POINT_BUFFER
  
  protected static final int DEFAULT_EDGE_POINT_BUFFER
  
  See Also:
  
  Constant Field Values
- DEFAULT_EDGE_DISPLAY_BUFFER
  
  protected static final int DEFAULT_EDGE_DISPLAY_BUFFER
  
  See Also:
  
  Constant Field Values
- LINE_WIDTH
  
  protected static final float LINE_WIDTH
  
  See Also:
  
  Constant Field Values
- myBoundingBox
  
  protected Rectangle myBoundingBox
- font
  
  protected Font font
- lastZoom
  
  protected double lastZoom
- localVisibility
  
  protected boolean localVisibility
- initialized
  
  protected boolean initialized
- lineWidth
  
  protected double lineWidth
Constructor Details
- Footprint
  
  public Footprint()
- Footprint
  
  public Footprint(String type, GamePiece p)
Method Details
- getPointList
  
  @Deprecated(since="2020-08-06", forRemoval=true) protected Enumeration<Point> getPointList()
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  Use pointList directly.
- mySetState
  
  public void mySetState(String newState)
  
  Description copied from class: Decorator
  
  Set just the state of this trait
  
  Overrides:
  
  mySetState in class MovementMarkable
  
  See Also:
  
  Decorator.myGetState()
- myGetState
  
  public String myGetState()
  
  Overrides:
  
  myGetState in class MovementMarkable
  
  Returns:
  
  the state of this trait alone
  
  See Also:
  
  Decorator.getState()
- mySetType
  
  public void mySetType(String type)
  
  Type is the character command that toggles footprint visiblity
  
  Specified by:
  
  mySetType in interface EditablePiece
  
  Overrides:
  
  mySetType in class MovementMarkable
- myGetType
  
  public String myGetType()
  
  Overrides:
  
  myGetType in class MovementMarkable
  
  Returns:
  
  the type of this trait alone
  
  See Also:
  
  Decorator.getType()
- setProperty
  
  public void setProperty(Object key, Object val)
  
  Description copied from interface: GamePiece
  
  Other properties, possibly game-specific, can be associated with a piece. The properties may or may not need to be encoded in the piece's GamePiece.getState() method.
  
  Specified by:
  
  setProperty in interface GamePiece
  
  Overrides:
  
  setProperty in class MovementMarkable
- getLocalizedProperty
  
  public Object getLocalizedProperty(Object key)
  
  Specified by:
  
  getLocalizedProperty in interface PropertySource
  
  Overrides:
  
  getLocalizedProperty in class MovementMarkable
- getProperty
  
  public Object getProperty(Object key)
  
  Specified by:
  
  getProperty in interface GamePiece
  
  Specified by:
  
  getProperty in interface PropertySource
  
  Overrides:
  
  getProperty in class MovementMarkable
- setMoved
  
  public void setMoved(boolean justMoved)
  
  setMoved is called with an argument of true each time the piece is moved. The argument is false when the unit is marked as not moved.
  
  Overrides:
  
  setMoved in class MovementMarkable
- recordCurrentPosition
  
  protected void recordCurrentPosition()
- clearTrail
  
  protected void clearTrail()
- getHelpFile
  
  public HelpFile getHelpFile()
  
  Specified by:
  
  getHelpFile in interface EditablePiece
  
  Overrides:
  
  getHelpFile in class MovementMarkable
- addPoint
  
  protected void addPoint(Point p)
  
  Add Point to list and adjust the overall boundingBox to encompass the trail.
- redraw
  
  public void redraw()
- getDescription
  
  public String getDescription()
  
  Description copied from interface: EditablePiece
  
  A plain-English description of this type of piece
  
  Specified by:
  
  getDescription in interface EditablePiece
  
  Overrides:
  
  getDescription in class MovementMarkable
- draw
  
  public void draw(Graphics g, int x, int y, Component obs, double zoom)
  
  Description copied from interface: GamePiece
  
  Draw this GamePiece
  
  Specified by:
  
  draw in interface GamePiece
  
  Overrides:
  
  draw in class MovementMarkable
  
  x - x-location of the center of the piece
  
  y - y-location of the center of the piece
  
  obs - the Component on which this piece is being drawn
  
  zoom - the scaling factor.
- drawPoint
  
  protected void drawPoint(Graphics g, Point p, double zoom, int elementCount)
  
  Draw a Circle at the given point. Override this method to do something different (eg. display an Icon)
- drawTrack
  
  protected void drawTrack(Graphics g, int x1, int y1, int x2, int y2, double zoom)
  
  Draw a track from one Point to another. Don't draw under the circle as it shows through with transparency turned on.
- getTrailImage
  
  protected Image getTrailImage(int elementCount)
  
  Override this method to return an Image to display within each trail circle
- getTrailText
  
  protected String getTrailText(int elementCount)
  
  Override this method to return text to display within each trail circle. Note, there will normally be only room for 1 character.
- isTrailVisible
  
  protected boolean isTrailVisible()
  
  Global Visibility means all players see the same trail Local Visibility means each player controls their own trail visibility
- boundingBox
  
  public Rectangle boundingBox()
  
  Return a bounding box covering the whole trail if it is visible, otherwise just return the standard piece bounding box
  
  Specified by:
  
  boundingBox in interface GamePiece
  
  Overrides:
  
  boundingBox in class MovementMarkable
- getMyBoundingBox
  
  public Rectangle getMyBoundingBox()
  
  Return the boundingBox including the trail
- getShape
  
  public Shape getShape()
  
  Description copied from interface: GamePiece
  
  The shape of the piece from the user's viewpoint. This defines the area in which the user must click to select or move the piece, for example. Like GamePiece.boundingBox(), it assumes the position is (0,0) and must be translated to the actual location where the piece is being drawn.
  
  Specified by:
  
  getShape in interface GamePiece
  
  Overrides:
  
  getShape in class MovementMarkable
- getName
  
  public String getName()
  
  Description copied from interface: GamePiece
  
  The plain English name for this piece
  
  Specified by:
  
  getName in interface GamePiece
  
  Overrides:
  
  getName in class MovementMarkable
- myGetKeyCommands
  
  public KeyCommand[] myGetKeyCommands()
  
  Overrides:
  
  myGetKeyCommands in class MovementMarkable
  
  Returns:
  
  the commands for this trait alone
  
  See Also:
  
  Decorator.getKeyCommands()
- myKeyEvent
  
  public Command myKeyEvent(KeyStroke stroke)
  
  Description copied from class: Decorator
  
  The response of this trait alone to the given KeyStroke
  
  Overrides:
  
  myKeyEvent in class MovementMarkable
  
  Parameters:
  
  stroke - Stroke to apply
  
  Returns:
  
  Generated Command or null if no effect
  
  See Also:
  
  Decorator.keyEvent(javax.swing.KeyStroke)
- getEditor
  
  public PieceEditor getEditor()
  
  Description copied from interface: EditablePiece
  
  Get the configurer for this trait
  
  Specified by:
  
  getEditor in interface EditablePiece
  
  Overrides:
  
  getEditor in class MovementMarkable
- getI18nData
  
  public PieceI18nData getI18nData()
  
  Description copied from class: Decorator
  
  Return I18n data for this piece
  
  Specified by:
  
  getI18nData in interface TranslatablePiece
  
  Overrides:
  
  getI18nData in class MovementMarkable
  
  Returns:
  
  I18n data

Constructors
Constructor	Description
`Footprint()`
`Footprint(String type, GamePiece p)`

Class Footprint