Class CounterDetailViewer.Visitor

java.lang.Object

VASSAL.counters.PieceFinder.Movable

VASSAL.build.module.map.CounterDetailViewer.Visitor

All Implemented Interfaces:

DeckVisitor, PieceFinder, PieceVisitor

Enclosing class:

CounterDetailViewer

protected static class CounterDetailViewer.Visitor
extends PieceFinder.Movable

Version:

1.0

Author:

David Sullivan

Nested Class Summary

Nested classes/interfaces inherited from interface PieceFinder

PieceFinder.DeckOrPieceInStack, PieceFinder.MatOnly, PieceFinder.Movable, PieceFinder.PieceInStack, PieceFinder.StackOnly

Modifier and Type	Interface	Description
static class	PieceFinder.DeckOrPieceInStack
static class	PieceFinder.MatOnly	Returns a Mat that overlaps this piece
static class	PieceFinder.Movable
static class	PieceFinder.PieceInStack
static class	PieceFinder.StackOnly

Field Summary

Fields

Modifier and Type	Field	Description
protected CompoundPieceCollection	collection
protected CounterDetailViewer.Filter	filter
protected Point	foundPieceAt
protected int	insertPos
protected int	lastLayer
protected List<GamePiece>	pieces
protected final boolean	showDeckMasked
protected boolean	showingOverlap
protected final int	showNumberFromDeck
protected final boolean	showOnlyTopOfStack

Fields inherited from class PieceFinder.Movable

dispatcher, map, pt, shapes

Modifier and Type	Field	Description
protected DeckVisitorDispatcher	dispatcher
protected Map	map
protected Point	pt
protected Shape[]	shapes

Fields inherited from interface PieceFinder

DECK_OR_PIECE_IN_STACK, MAT_ONLY, MOVABLE, PIECE_IN_STACK, STACK_ONLY

Modifier and Type	Field	Description
static final PieceFinder	DECK_OR_PIECE_IN_STACK	If a Stack overlaps the given point, return the piece containing that point if expanded, or the top piece if not expanded.
static final PieceFinder	MAT_ONLY
static final PieceFinder	MOVABLE	Returns a Stack if unexpanded and overlapping the given point, or a piece within that stack if expanded and overlapping the given point
static final PieceFinder	PIECE_IN_STACK	If a Stack overlaps the given point, return the piece containing that point if expanded, or the top piece if not expanded.
static final PieceFinder	STACK_ONLY	Return a Stack overlapping the given point

Constructor Summary

Constructors

Constructor	Description
Visitor(CounterDetailViewer.Filter filter, Map map, Point pt, boolean showOverlap)	Deprecated, for removal: This API element is subject to removal in a future version.
Visitor(CounterDetailViewer.Filter filter, Map map, Point pt, boolean showOverlap, int showNumberFromDeck, boolean showDeckMasked)
Visitor(CounterDetailViewer.Filter filter, Map map, Point pt, boolean showOverlap, int showNumberFromDeck, boolean showDeckMasked, boolean showOnlyTopOfStack)

Method Summary

Modifier and Type	Method	Description
protected void	apply(GamePiece p)
List<GamePiece>	getPieces()
Object	visitDeck(Deck d)	Perform the operation on a Deck
Object	visitDefault(GamePiece p)	GamePieces that are not handled by one of the type-specific methods (e.g.
Object	visitStack(Stack s)	Perform the operation on a Stack

Methods inherited from class PieceFinder.Movable

select

Modifier and Type	Method	Description
GamePiece	select(Map map, GamePiece piece, Point pt)	Return the argument GamePiece (or one of its children if a Stack) found at the given point on the given Map

Methods inherited from class Object

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

Field Details

pieces

protected List<GamePiece> pieces

filter

protected CounterDetailViewer.Filter filter

collection

protected CompoundPieceCollection collection

lastLayer

protected int lastLayer

insertPos

protected int insertPos

foundPieceAt

protected Point foundPieceAt

showingOverlap

protected boolean showingOverlap

showNumberFromDeck

protected final int showNumberFromDeck

showDeckMasked

protected final boolean showDeckMasked

showOnlyTopOfStack

protected final boolean showOnlyTopOfStack

Constructor Details

Visitor

@Deprecated(since="2021-12-01",
            forRemoval=true)
public Visitor(CounterDetailViewer.Filter filter,
 Map map,
 Point pt,
 boolean showOverlap)

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

Visitor

public Visitor(CounterDetailViewer.Filter filter,
 Map map,
 Point pt,
 boolean showOverlap,
 int showNumberFromDeck,
 boolean showDeckMasked)

Visitor

public Visitor(CounterDetailViewer.Filter filter,
 Map map,
 Point pt,
 boolean showOverlap,
 int showNumberFromDeck,
 boolean showDeckMasked,
 boolean showOnlyTopOfStack)

Method Details

visitDeck

public Object visitDeck(Deck d)

Description copied from interface: DeckVisitor

Perform the operation on a Deck

Specified by:

visitDeck in interface DeckVisitor

Overrides:

visitDeck in class PieceFinder.Movable

visitStack

public Object visitStack(Stack s)

Description copied from interface: PieceVisitor

Perform the operation on a Stack

Specified by:

visitStack in interface PieceVisitor

Overrides:

visitStack in class PieceFinder.Movable

visitDefault

public Object visitDefault(GamePiece p)

Description copied from interface: PieceVisitor

GamePieces that are not handled by one of the type-specific methods (e.g. PieceVisitor.visitStack(Stack)) are handled here

Specified by:

visitDefault in interface PieceVisitor

Overrides:

visitDefault in class PieceFinder.Movable

apply

protected void apply(GamePiece p)

getPieces

public List<GamePiece> getPieces()