ilog.tgo.grprim

Class IltColorModifier

java.lang.Object

ilog.tgo.grprim.IltColorModifier

Direct Known Subclasses:

IltColorModifier.MultiColor, IltColorModifier.Shade

public abstract class IltColorModifier
extends Object

An instance of this class can dynamically modify the color of a gauge or chart. The method modify is invoked for each animated pixel of the gauge or chart.

This class also contains some utility methods to write color modifiers. Especially, the methods Red, Green, Blue & Color allow to easily code or decode colors in the default RGB color model.

See Also:

IltGaugeMapping.setColorModifier(ilog.tgo.grprim.IltColorModifier), IltChartMapping.setColorModifier(ilog.tgo.grprim.IltColorModifier), modify(int, int, ilog.tgo.grprim.IltColorModifierContext), IltColorModifierContext

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IltColorModifier.MultiColor This class is a color modifier that produces a green representation, when the value is below 0.5, a yellow representation when the value is below 0.75, and a red representation when the value is above 0.75.
static class	IltColorModifier.Shade This class is a color modifier that produces a transparent color shade effect.

Field Summary

Fields

Modifier and Type	Field and Description
static IltColorModifier	Standard This color modifier returns foregroundColor or backgroundColor according to the value returned by UseForegroundColor.

Constructor Summary

Constructors

Constructor and Description
IltColorModifier()

Method Summary

Modifier and Type	Method and Description
static int	Blue(int color) Returns the blue component of the given color.
static int	Color(int red, int green, int blue) Returns the blue component of the given color.
IltColorModifier	compose(IltColorModifier cm) Returns a color modifier that composes this color modifier with the given one.
static int	Green(int color) Returns the green component of the given color.
abstract int	modify(int backgroundColor, int foregroundColor, IltColorModifierContext context) This method is invoked for each animated pixel of the gauge or chart.
static int	Red(int color) Returns the red component of the given color.
static boolean	UseForegroundColor(IltColorModifierContext context) Returns true when the foreground color should be used, otherwise it returns false.

Methods inherited from class java.lang.Object

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

Field Detail

Standard

public static final IltColorModifier Standard

This color modifier returns foregroundColor or backgroundColor according to the value returned by UseForegroundColor.
Note: This is the default behavior of a gauge or chart. The graphic representation is the same when using this color modifier, as when the color modifier of the gauge or chart is null or unspecified.

Constructor Detail

IltColorModifier

public IltColorModifier()

Method Detail

modify

public abstract int modify(int backgroundColor,
                           int foregroundColor,
                           IltColorModifierContext context)

This method is invoked for each animated pixel of the gauge or chart. Any color can be returned. The color format is the default RGB color model. The format for the RGB values is an integer with 8 bits each of alpha, red, green, and blue color components ordered correspondingly from the most significant byte to the least significant byte, as in: 0xAARRGGBB. Color components are not premultiplied by the alpha component. This format does not necessarily represent the native nor the most efficient ColorModel for a particular device or for all images. It is merely used as a common color model format.

This method is supposed to be overridden to implement the appropriate color modification.

Parameters:

backgroundColor - The background color of the chart for this pixel.

foregroundColor - The foreground color of the chart for this pixel.

context - The context for this pixel.

See Also:

ColorModel.getRGBdefault(), IltColorModifierContext

UseForegroundColor

public static final boolean UseForegroundColor(IltColorModifierContext context)

Returns true when the foreground color should be used, otherwise it returns false. This method returns true when pixelValue is lower than barValue, and false when pixelValue is greater than barValue.

See Also:

IltColorModifierContext.getPixelValue(), IltColorModifierContext.getBarValue()

Red

public static final int Red(int color)

Returns the red component of the given color.

Parameters:

color - A color in the default RGB color model.

Green

public static final int Green(int color)

Returns the green component of the given color.

Parameters:

color - A color in the default RGB color model.

Blue

public static final int Blue(int color)

Returns the blue component of the given color.

Parameters:

color - A color in the default RGB color model.

Color

public static final int Color(int red,
                              int green,
                              int blue)

Returns the blue component of the given color.

Parameters:

red - The red component of this color in the range 0..255.

green - The green component of this color in the range 0..255.

blue - The blue component of this color in the range 0..255.

compose

public IltColorModifier compose(IltColorModifier cm)

Returns a color modifier that composes this color modifier with the given one. The color is first modified by this color modifier, then by the given color modifier.