Class CropOpBitmapImpl

java.lang.Object

VASSAL.tools.opcache.AbstractOpImpl<BufferedImage>

VASSAL.tools.imageop.AbstractOpImpl

VASSAL.tools.imageop.AbstractTiledOpImpl

VASSAL.tools.imageop.CropOpBitmapImpl

All Implemented Interfaces:

CropOp, ImageOp, Op<BufferedImage>

public class CropOpBitmapImpl
extends AbstractTiledOpImpl
implements CropOp

An ImageOp which crops its source.

Since:

3.1.0

Author:

Joel Uckelman

Field Summary

Fields inherited from class AbstractTiledOpImpl

numXTiles, numYTiles, tiles, tileSize

Modifier and Type	Field	Description
protected int	numXTiles	The number of tiles along the x-axis.
protected int	numYTiles	The number of tiles along the y-axis.
protected ImageOp[]	tiles	The tiles already created, stored as y*numXTiles + x.
protected Dimension	tileSize	The standard size of this ImageOps tiles.

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
CropOpBitmapImpl(ImageOp sop, int x0, int y0, int x1, int y1)	Constructs an ImageOp which will crop the image produced by its source ImageOp.

Method Summary

Modifier and Type	Method	Description
protected ImageOp	createTileOp(int tileX, int tileY)
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().
Rectangle	getRect()	Returns the crop rectangle.
List<Op<?>>	getSources()	Returns a list of Ops on which this Op depends.
int	getX0()
int	getX1()
int	getY0()
int	getY1()
int	hashCode()

Methods inherited from class AbstractTiledOpImpl

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

Modifier and Type	Method	Description
protected void	fixTileSize()	Sets the tileSize which is used by AbstractTiledOpImpl.getTileSize(), AbstractTiledOpImpl.getTileHeight(), AbstractTiledOpImpl.getTileWidth(), AbstractTiledOpImpl.getNumXTiles(), AbstractTiledOpImpl.getNumYTiles(), and all other tile methods.
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 the ImageOp which produces tile (tileX,tileY), creating it if necessary.
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, 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, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CropOpBitmapImpl

public CropOpBitmapImpl(ImageOp sop,
 int x0,
 int y0,
 int x1,
 int y1)

Constructs an ImageOp which will crop the image produced by its source ImageOp.

Parameters:

sop - the source operation

x0 - the x coordinate of the upper-left corner

y0 - the y coordinate of the upper-left corner

x1 - the x coordinate of the lower-right corner

y1 - the y coordinate of the lower-right corner

Method Details

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

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

Throws:

Exception - passed up from the source ImageOp.

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

createTileOp

protected ImageOp createTileOp(int tileX,
 int tileY)

Specified by:

createTileOp in class AbstractTiledOpImpl

getRect

public Rectangle getRect()

Returns the crop rectangle.

Specified by:

getRect in interface CropOp

Returns:

the rectangle to be cropped.

getX0

public int getX0()

Specified by:

getX0 in interface CropOp

getY0

public int getY0()

Specified by:

getY0 in interface CropOp

getX1

public int getX1()

Specified by:

getX1 in interface CropOp

getY1

public int getY1()

Specified by:

getY1 in interface CropOp

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object