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 AbstractOpImpl

cache, size

Modifier and Type	Field	Description
protected static final OpCache	cache	The cache which contains calculated Images.
protected Dimension	size	The cached size of this operation's resulting Image.

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 AbstractTileOpImpl

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

Modifier and Type	Method	Description
Future<BufferedImage>	getFutureTile(int tileX, int tileY, ImageOpObserver obs)	Submits a request for tile (tileX,tileY), and returns a reference to that request.
int	getNumXTiles()	Returns the number of tiles along the x-axis.
int	getNumYTiles()	Returns the number of tiles along the y-axis.
BufferedImage	getTile(int tileX, int tileY, ImageOpObserver obs)	Calculates tile (tileX,tileY), and reports completion or failure to the specified ImageOpObserver.
int	getTileHeight()	Returns the standard height of the BufferedImage tiles which are returned by ImageOp.getTile(Point, ImageOpObserver).
Point[]	getTileIndices(Rectangle rect)	Returns an array of Points representing the tiles intersecting the given Rectangle.
ImageOp	getTileOp(int tileX, int tileY)	Returns an ImageOp which can produce the requested tile.
Dimension	getTileSize()	Returns the standard size of the BufferedImage tiles which are returned by ImageOp.getTile(Point, ImageOpObserver).
int	getTileWidth()	Returns the standard width of the BufferedImage tiles which are returned by ImageOp.getTile(Point, ImageOpObserver).

Methods inherited from class AbstractOpImpl

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

Modifier and Type	Method	Description
static void	clearCache()
Future<BufferedImage>	getFutureImage(ImageOpObserver obs)	Submits a request for the BufferedImage produced by this operation, and returns a reference to that request.
Future<BufferedImage>	getFutureTile(Point p, ImageOpObserver obs)	Submits a request for tile (tileX,tileY), and returns a reference to that request.
int	getHeight()	Returns the height of the BufferedImage which would be returned by ImageOp.getImage().
BufferedImage	getImage()	Calculates the BufferedImage produced by this operation.
BufferedImage	getImage(ImageOpObserver obs)	Calculates the BufferedImage produced by this operation, and reports completion or failure to the specified ImageOpObserver.
Dimension	getSize()	Returns the size of the BufferedImage which would be returned by ImageOp.getImage().
protected Dimension	getSizeFromCache()	A utility method for retrieving the size of the computed Image from the cache if the Image is cached.
BufferedImage	getTile(Point p, ImageOpObserver obs)	Calculates tile (p.x,p.y), and reports completion or failure to the specified ImageOpObserver.
ImageOp	getTileOp(Point p)	Returns an ImageOp which can produce the requested tile.
int	getWidth()	Returns the width of the BufferedImage which would be returned by ImageOp.getImage().

Methods inherited from class AbstractOpImpl

get, newKey, update

Modifier and Type	Method	Description
BufferedImage	get()
OpCache.Key<BufferedImage>	newKey()	Returns the current cache key for this Op.
void	update()	Invalidates the current cache key for this Op.

Methods inherited from class Object

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

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