org.cell2d

Class ColorFilter

java.lang.Object

org.cell2d.ColorFilter

All Implemented Interfaces:

Filter

public class ColorFilter
extends java.lang.Object
implements Filter

A ColorFilter is a Filter that blends the RGB value of each pixel in the original image with that of a single Color that it uses. The alpha value of the ColorFilter's Color is proportional to the strength of its influence on the filtered image's RGB values. An alpha value of 0 has no effect, and an alpha value of 1 completely replaces the original image's RGB values, thus turning the filtered image into a colored silhouette. The alpha values of the original image's pixels are left unchanged in the filtered image.

See Also:

Color

Constructor Summary

Constructors

Constructor and Description
ColorFilter(Color color) Constructs a ColorFilter that uses the specified Color.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Returns whether the specified object is a ColorFilter that is equal to this ColorFilter.
Color	getColor() Returns the Color that this ColorFilter uses.
Image	getFilteredImage(Image image) Returns the transformation through this Filter of the specified Celick image.
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Detail

ColorFilter

public ColorFilter(Color color)

Constructs a ColorFilter that uses the specified Color.

Parameters:

color - The used Color

Method Detail

hashCode

public final int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public final boolean equals(java.lang.Object obj)

Returns whether the specified object is a ColorFilter that is equal to this ColorFilter. Two ColorFilters are equal if and only if the Colors they use are equal.

Overrides:

equals in class java.lang.Object

Parameters:

obj - The object to be compared with this ColorFilter

Returns:

Whether the specified object is a ColorFilter that is equal to this ColorFilter

getColor

public final Color getColor()

Returns the Color that this ColorFilter uses.

Returns:

The Color that this ColorFilter uses

getFilteredImage

public final Image getFilteredImage(Image image)

Description copied from interface: Filter

Returns the transformation through this Filter of the specified Celick image.

Specified by:

getFilteredImage in interface Filter

Parameters:

image - The Image to be transformed

Returns:

The transformation of the specified Image