org.apache.batik.gvt.filter

Interface Mask

public interface Mask extends Filter

Implements a masking operation. This masks the source by the result of converting the GraphicsNode to a mask image.

Method Summary
Rectangle2D	getFilterRegion() The region to which this mask applies
GraphicsNode	getMaskNode() Returns the Graphics node that the mask operation will use to define the masking image.
Filter	getSource() This returns the current image being masked by the mask node.
void	setFilterRegion(Rectangle2D filterRegion) Returns the filter region to which this mask applies
void	setMaskNode(GraphicsNode gn) Set the masking image to that described by gn.
void	setSource(Filter src) The source to be masked by the mask node.

Method Detail

getFilterRegion

public Rectangle2D getFilterRegion()

The region to which this mask applies

getMaskNode

public GraphicsNode getMaskNode()

Returns the Graphics node that the mask operation will use to define the masking image.

Returns: The graphics node that defines the mask image.

getSource

public Filter getSource()

This returns the current image being masked by the mask node.

Returns: The image to mask

setFilterRegion

public void setFilterRegion(Rectangle2D filterRegion)

Returns the filter region to which this mask applies

setMaskNode

public void setMaskNode(GraphicsNode gn)

Set the masking image to that described by gn. If gn is an rgba image then the alpha is premultiplied and then the rgb is converted to alpha via the standard feColorMatrix rgb to luminance conversion. In the case of an rgb only image, just the rgb to luminance conversion is performed.

Parameters: gn The graphics node that defines the mask image.

setSource

public void setSource(Filter src)

The source to be masked by the mask node.

Parameters: src The Image to be masked.