Class ImageItem.BaseOp

java.lang.Object

VASSAL.tools.opcache.AbstractOpImpl<BufferedImage>

VASSAL.tools.imageop.AbstractOpImpl

VASSAL.tools.imageop.AbstractTileOpImpl

VASSAL.build.module.gamepieceimage.ImageItem.BaseOp

All Implemented Interfaces:

ImageOp, Op<BufferedImage>

Enclosing class:

ImageItem

protected static final class ImageItem.BaseOp
extends AbstractTileOpImpl

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.

Method Summary

Modifier and Type	Method	Description
BufferedImage	eval()	Runs the Op.
protected void	fixSize()	Sets the size which is used by AbstractOpImpl.getSize(), AbstractOpImpl.getHeight(), and AbstractOpImpl.getWidth().
int	getHeight()	Returns the height of the BufferedImage which would be returned by ImageOp.getImage().
Dimension	getSize()	Returns the size of the BufferedImage which would be returned by ImageOp.getImage().
List<Op<?>>	getSources()	Returns a list of Ops on which this Op depends.
int	getWidth()	Returns the width of the BufferedImage which would be returned by ImageOp.getImage().

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, getImage, getImage, getSizeFromCache, getTile, getTileOp

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

Methods inherited from class AbstractOpImpl

get, get, getFuture, newKey, update

Modifier and Type	Method	Description
BufferedImage	get()
BufferedImage	get(OpObserver<BufferedImage> obs)
Future<BufferedImage>	getFuture(OpObserver<BufferedImage> obs)
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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

eval

public BufferedImage eval()

Description copied from class: AbstractOpImpl

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()

Description copied from class: AbstractOpImpl

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

Specified by:

fixSize in class AbstractOpImpl

getSize

public Dimension getSize()

Description copied from class: AbstractOpImpl

Returns the size of the BufferedImage which would be returned by ImageOp.getImage(). The size is cached so that it need not be recalculated on each call.

Specified by:

getSize in interface ImageOp

Overrides:

getSize in class AbstractOpImpl

Returns:

the size of the resulting BufferedImage in pixels

See Also:

• ImageOp.getHeight()
• ImageOp.getWidth()

getWidth

public int getWidth()

Description copied from class: AbstractOpImpl

Returns the width of the BufferedImage which would be returned by ImageOp.getImage(). The width is cached so that it need not be recalculated on each call.

Specified by:

getWidth in interface ImageOp

Overrides:

getWidth in class AbstractOpImpl

Returns:

the width of the resulting BufferedImage in pixels

See Also:

• ImageOp.getHeight()
• ImageOp.getSize()

getHeight

public int getHeight()

Description copied from class: AbstractOpImpl

Returns the height of the BufferedImage which would be returned by ImageOp.getImage(). The height is cached so that it need not be recalculated on each call.

Specified by:

getHeight in interface ImageOp

Overrides:

getHeight in class AbstractOpImpl

Returns:

the height of the resulting BufferedImage in pixels

See Also:

• ImageOp.getWidth()
• ImageOp.getSize()

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