Package VASSAL.counters

Interface PieceFinder

All Known Implementing Classes:

CounterDetailViewer.Visitor, PieceFinder.DeckOrPieceInStack, PieceFinder.Movable, PieceFinder.PieceInStack, PieceFinder.StackOnly

public interface PieceFinder

This interface defines selection criteria for finding a GamePiece in a Map

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	PieceFinder.DeckOrPieceInStack
static class	PieceFinder.Movable
static class	PieceFinder.PieceInStack
static class	PieceFinder.StackOnly

Field Summary

Fields

Modifier and Type	Field	Description
static 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 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 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 PieceFinder	STACK_ONLY	Return a Stack overlapping the given point

Method Summary

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

Field Details

STACK_ONLY

static final PieceFinder STACK_ONLY

Return a Stack overlapping the given point

PIECE_IN_STACK

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.

DECK_OR_PIECE_IN_STACK

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. If a Deck is found instead, return the deck.

MOVABLE

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

Method Details

select

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