VASSAL.counters
Interface PieceFinder

All Known Implementing Classes:

PieceFinder.Movable

public interface PieceFinder

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

Inner Class Summary

static class	PieceFinder.Movable
static class	PieceFinder.PieceInStack
static class	PieceFinder.StackOnly

Field Summary

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

GamePiece

select(Map map, GamePiece piece, java.awt.Point pt) Return the argument GamePiece (or one of its children if a Stack) found at the given point on the given Map

Field Detail

STACK_ONLY

public static final PieceFinder STACK_ONLY

Return a Stack overlapping the given point

PIECE_IN_STACK

public 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.

MOVABLE

public 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 Detail

select

public GamePiece select(Map map,
                        GamePiece piece,
                        java.awt.Point pt)

Return the argument GamePiece (or one of its children if a Stack) found at the given point on the given Map