Package VASSAL.build.module.map

Class SimplePieceCollection

java.lang.Object

VASSAL.build.module.map.SimplePieceCollection

All Implemented Interfaces:

PieceCollection

public class SimplePieceCollection
extends Object
implements PieceCollection

A SimplePieceCollection is used within a CompoundPieceCollection to maintain an array of the pieces/stacks/decks (GamePiece) within a single visual layer. Even within a single "layer", the individual pieces can be rearranged, which will change their relative draw order within that layer.

Constructor Summary

Constructors

Constructor	Description
SimplePieceCollection()

Method Summary

Modifier and Type	Method	Description
void	add(GamePiece p)	Adds a piece
boolean	canMerge(GamePiece p1, GamePiece p2)	Return true if the two pieces can be merged into a single stack
void	clear()	Remove all pieces
GamePiece[]	getAllPieces()	Return all pieces in the collection, regardless of visibility
GamePiece[]	getPieces()	Return all currently-visible pieces in the collection as a read-only array
int	indexOf(GamePiece p)	Returns the index of a piece.
void	moveToBack(GamePiece p)	Reposition a piece to the back of all others in the same visual layer
void	moveToFront(GamePiece p)	Reposition a piece to the front of all others in the same visual layer
void	remove(GamePiece p)	Removes the piece
void	reposition(GamePiece p, int pos)

Methods inherited from class java.lang.Object

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

Constructor Details

SimplePieceCollection

public SimplePieceCollection()

Method Details

indexOf

public int indexOf(GamePiece p)

Returns the index of a piece. When painting the map, pieces are drawn in order of index, so lowest index is drawn first and therefore appears at the "bottom", as later pieces are then drawn "on top of" it.

Specified by:

indexOf in interface PieceCollection

canMerge

public boolean canMerge(GamePiece p1,
 GamePiece p2)

Description copied from interface: PieceCollection

Return true if the two pieces can be merged into a single stack

Specified by:

canMerge in interface PieceCollection

add

public void add(GamePiece p)

Description copied from interface: PieceCollection

Adds a piece

Specified by:

add in interface PieceCollection

clear

public void clear()

Description copied from interface: PieceCollection

Remove all pieces

Specified by:

clear in interface PieceCollection

remove

public void remove(GamePiece p)

Description copied from interface: PieceCollection

Removes the piece

Specified by:

remove in interface PieceCollection

getPieces

public GamePiece[] getPieces()

Description copied from interface: PieceCollection

Return all currently-visible pieces in the collection as a read-only array

Specified by:

getPieces in interface PieceCollection

getAllPieces

public GamePiece[] getAllPieces()

Description copied from interface: PieceCollection

Return all pieces in the collection, regardless of visibility

Specified by:

getAllPieces in interface PieceCollection

reposition

public void reposition(GamePiece p,
 int pos)

moveToBack

public void moveToBack(GamePiece p)

Description copied from interface: PieceCollection

Reposition a piece to the back of all others in the same visual layer

Specified by:

moveToBack in interface PieceCollection

moveToFront

public void moveToFront(GamePiece p)

Description copied from interface: PieceCollection

Reposition a piece to the front of all others in the same visual layer

Specified by:

moveToFront in interface PieceCollection