Class GamePieceOpImpl

java.lang.Object

VASSAL.tools.opcache.AbstractOpImpl<BufferedImage>

VASSAL.tools.imageop.AbstractOpImpl

VASSAL.tools.imageop.AbstractTileOpImpl

VASSAL.tools.imageop.GamePieceOpImpl

All Implemented Interfaces:

GamePieceOp, ImageOp, Op<BufferedImage>

public class GamePieceOpImpl
extends AbstractTileOpImpl
implements GamePieceOp

An ImageOp which uses a GamePiece as its source.

Since:

3.1.0

Author:

Joel Uckelman

Field Summary

Fields inherited from class VASSAL.tools.imageop.AbstractOpImpl

cache, size

Constructor Summary

Constructors

Constructor	Description
GamePieceOpImpl(GamePiece gp)	Constructs an ImageOp which will produce an image from the given GamePiece.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
BufferedImage	eval()	Runs the Op.
protected void	fixSize()	Sets the size which is used by AbstractOpImpl.getSize(), AbstractOpImpl.getHeight(), and AbstractOpImpl.getWidth().
BufferedImage	get(OpObserver<BufferedImage> obs)
Future<BufferedImage>	getFuture(OpObserver<BufferedImage> obs)
GamePiece	getPiece()	Returns the source GamePiece.
List<Op<?>>	getSources()	Returns a list of Ops on which this Op depends.
String	getState()
int	hashCode()
boolean	isChanged()	Returns true iff the source GamePiece has changed state.

Methods inherited from class VASSAL.tools.imageop.AbstractTileOpImpl

getFutureTile, getNumXTiles, getNumYTiles, getTile, getTileHeight, getTileIndices, getTileOp, getTileSize, getTileWidth

Methods inherited from class VASSAL.tools.imageop.AbstractOpImpl

clearCache, getFutureImage, getFutureTile, getHeight, getImage, getImage, getSize, getSizeFromCache, getTile, getTileOp, getWidth

Methods inherited from class VASSAL.tools.opcache.AbstractOpImpl

get, newKey, update

Methods inherited from class java.lang.Object

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

Methods inherited from interface VASSAL.tools.imageop.ImageOp

getFutureImage, getFutureTile, getFutureTile, getHeight, getImage, getImage, getNumXTiles, getNumYTiles, getSize, getTile, getTile, getTileHeight, getTileIndices, getTileOp, getTileOp, getTileSize, getTileWidth, getWidth

Methods inherited from interface VASSAL.tools.opcache.Op

newKey, update

Constructor Details

GamePieceOpImpl

public GamePieceOpImpl(GamePiece gp)

Constructs an ImageOp which will produce an image from the given GamePiece.

Parameters:

gp - the source

Throws:

IllegalArgumentException - if gp == null.

Method Details

get

public BufferedImage get(OpObserver<BufferedImage> obs)
                  throws CancellationException,
InterruptedException,
ExecutionException

Overrides:

get in class AbstractOpImpl<BufferedImage>

Throws:

CancellationException - if the operation was cancelled

InterruptedException - if the operation was interrupted

ExecutionException - if the operation failed

getFuture

public Future<BufferedImage> getFuture(OpObserver<BufferedImage> obs)
                                throws ExecutionException

Overrides:

getFuture in class AbstractOpImpl<BufferedImage>

Throws:

ExecutionException - if the operation failed

getSources

public List<Op<?>> getSources()

Description copied from class: AbstractOpImpl

Returns a list of Ops on which this Op depends.

Specified by:

getSources in interface Op<BufferedImage>

Specified by:

getSources in class AbstractOpImpl<BufferedImage>

Returns:

the Ops on which this Op depends

eval

public BufferedImage eval()

Runs the Op. This method should be called only by the caching framework.

Specified by:

eval in interface ImageOp

Specified by:

eval in interface Op<BufferedImage>

Specified by:

eval in class AbstractOpImpl

Returns:

the result of running this Op

fixSize

protected void fixSize()

Sets the size which is used by AbstractOpImpl.getSize(), AbstractOpImpl.getHeight(), and AbstractOpImpl.getWidth().

Specified by:

fixSize in class AbstractOpImpl

getPiece

public GamePiece getPiece()

Returns the source GamePiece.

Specified by:

getPiece in interface GamePieceOp

Returns:

the source

getState

public String getState()

Specified by:

getState in interface GamePieceOp

isChanged

public boolean isChanged()

Returns true iff the source GamePiece has changed state.

Specified by:

isChanged in interface GamePieceOp

Returns:

true iff the source has changed.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object