org.cell2d

Class ColorMultiplyFilter

java.lang.Object

org.cell2d.ColorMultiplyFilter

All Implemented Interfaces:

Filter

public class ColorMultiplyFilter
extends java.lang.Object
implements Filter

A ColorMultiplyFilter is a Filter that multiplies the red, green, blue, and alpha values of each pixel in the original image with those of a single Color that it uses. For the purposes of this multiplication, the RGBA values are all treated as floating-point values between 0 and 1. Thus, a ColorMultiplyFilter can tint or darken an image, but not brighten it.

See Also:

Color

Constructor Summary

Constructors

Constructor and Description
ColorMultiplyFilter(Color color) Constructs a ColorMultiplyFilter 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 ColorMultiplyFilter that is equal to this ColorMultiplyFilter.
Color	getColor() Returns the Color that this ColorMultiplyFilter 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

ColorMultiplyFilter

public ColorMultiplyFilter(Color color)

Constructs a ColorMultiplyFilter 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 ColorMultiplyFilter that is equal to this ColorMultiplyFilter. Two ColorMultiplyFilters 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 ColorMultiplyFilter

Returns:

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

getColor

public final Color getColor()

Returns the Color that this ColorMultiplyFilter uses.

Returns:

The Color that this ColorMultiplyFilter 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