Class DefaultPieceCollection

java.lang.Object

VASSAL.build.module.map.CompoundPieceCollection

VASSAL.build.module.map.DefaultPieceCollection

All Implemented Interfaces:

PieceCollection

public class DefaultPieceCollection
extends CompoundPieceCollection

Maps now start with a Game Piece Layers component (i.e. LayeredPieceCollection) by default, and so will use that more complex implementation of visual layers. However, the LayeredPieceCollection can be deleted, in which case this simpler implementation is used. This fallback implementation of PieceCollection separates pieces into two visual layers: stacking pieces always drawn above non-stacking pieces

Field Summary

Fields inherited from class CompoundPieceCollection

bottomLayer, enabled, layers

Modifier and Type	Field	Description
protected int	bottomLayer
protected boolean[]	enabled
protected SimplePieceCollection[]	layers

Constructor Summary

Constructors

Constructor	Description
DefaultPieceCollection()

Method Summary

Modifier and Type	Method	Description
int	getLayerForPiece(GamePiece p)	Default implementation is "degenerate", having only a single layer -- when extending this class, this method takes a piece and determines which of several layers it belongs in, returning an index.

Methods inherited from class CompoundPieceCollection

add, canMerge, canPiecesMerge, canStackAndPieceMerge, canStacksMerge, clear, getAllPieces, getBottomLayer, getCollectionForPiece, getLayerCount, getLayerForName, getLayerNameForPiece, getPieces, getPieces, getTopLayer, indexOf, initLayers, moveToBack, moveToFront, remove, reset, rotate, rotate, setBottomLayer, setLayerEnabled, setLayerEnabled, toggleLayerEnabled, toggleLayerEnabled

Modifier and Type	Method	Description
void	add(GamePiece p)	Adds a piece to the overall collection, by adding it to the simple collection for the layer it belongs in.
boolean	canMerge(GamePiece p1, GamePiece p2)	Used when moving a piece on top of another piece to determine whether they can be merged together (e.g. can this Piece be added to that Stack, can this Stack be added to that Deck, can these two Stacks be combined together into one).
protected boolean	canPiecesMerge(GamePiece p1, GamePiece p2)	Two pieces can merge in the default case as long as neither is presently invisible and neither has a Does Not Stack (Hideable) trait.
protected boolean	canStackAndPieceMerge(Stack s, GamePiece p)	A piece can be merged into a stack if it is merge-compatible with the first piece in the stack.
protected boolean	canStacksMerge(Stack s1, Stack s2)	Stacks can merge if their component pieces can merge
void	clear()	Clears the whole collection.
GamePiece[]	getAllPieces()	Return all pieces in the collection, regardless of visibility
int	getBottomLayer()
protected PieceCollection	getCollectionForPiece(GamePiece p)	Given a game piece, returns the simple piece collection for the layer that it belongs in
int	getLayerCount()
int	getLayerForName(String layerName)	Default implementation is "degenerate", having only a single layer -- when extending this class, this method takes layer name and returns the index for that layer, or -1 if the string does not name a valid layer.
String	getLayerNameForPiece(GamePiece p)	Default implementation is "degenerate", having only a single layer -- when extending this class, this method takes a piece and determines which of several layers it belongs in, returning the layer name.
GamePiece[]	getPieces()	Return all currently-visible pieces in the collection as a read-only array
protected GamePiece[]	getPieces(boolean includeDisabled)
int	getTopLayer()
int	indexOf(GamePiece p)	Returns the index of a piece.
protected void	initLayers(int layerCount)
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	reset()
void	rotate(boolean rotateUp)
void	rotate(boolean rotateUp, boolean skipNullLayers)
void	setBottomLayer(int layer)
void	setLayerEnabled(int layer, boolean b)	Enable/Disable layers
void	setLayerEnabled(String layer, boolean b)	Enable/Disable layers
void	toggleLayerEnabled(int layer)	Toggle for Enable/Disable of layers
void	toggleLayerEnabled(String layer)	Toggle for Enable/Disable of layers

Methods inherited from class Object

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

Constructor Details

DefaultPieceCollection

public DefaultPieceCollection()

Method Details

getLayerForPiece

public int getLayerForPiece(GamePiece p)

Description copied from class: CompoundPieceCollection

Default implementation is "degenerate", having only a single layer -- when extending this class, this method takes a piece and determines which of several layers it belongs in, returning an index.

Overrides:

getLayerForPiece in class CompoundPieceCollection

Parameters:

p - A game piece

Returns:

Index for the visual layer the piece should be drawn with.