Package VASSAL.tools.imageop

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 VASSAL.tools.imageop.AbstractTiledOpImpl

numXTiles, numYTiles, tiles, tileSize

Fields inherited from class VASSAL.tools.imageop.AbstractOpImpl

cache, size

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 VASSAL.tools.imageop.AbstractTiledOpImpl

fixTileSize, 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, get, getFuture, 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

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