ilog.tgo.grprim

Interface IltColorModifierContext

public interface IltColorModifierContext

An instance of IltColorModifierContext is given as argument when IltColorModifier.modify is invoked. This instance contains information regarding the pixels to be modified, or the values of the gauge or chart to be modified.

See Also:

IltColorModifier, IltColorModifier.modify(int, int, ilog.tgo.grprim.IltColorModifierContext)

Method Summary

Modifier and Type	Method and Description
float	getBarValue() Returns the value of the bar to be modified, in the range 0..1.
float	getLastValue() Returns the last value of the chart.
float	getMaxValue() Returns the maximum value of the chart.
float	getPixelValue() Returns the value of the pixel to be modified, in the range 0..1.

Method Detail

getPixelValue

float getPixelValue()

Returns the value of the pixel to be modified, in the range 0..1.
When this value is lower than the value returned by getBarValue, the pixel is supposed to be in foregroundColor, so that the color modifier returns the foregroundColor. When this value is greater than the value returned by getBarValue, the pixel is supposed to be in backgroundColor, so that the color modifier returns the backgroundColor.

See Also:

getBarValue(), IltColorModifier.UseForegroundColor(ilog.tgo.grprim.IltColorModifierContext)

getBarValue

float getBarValue()

Returns the value of the bar to be modified, in the range 0..1.
When a gauge is being modified, this value corresponds to the gauge value, and is therefore the same for each pixel of the gauge.
When a chart is being modified, this value corresponds to the value of the bar being modified, and is therefore the same for each pixel in the same bar.

See Also:

getPixelValue(), IltColorModifier.UseForegroundColor(ilog.tgo.grprim.IltColorModifierContext)

getLastValue

float getLastValue()

Returns the last value of the chart.

Note: When a gauge is being modified, this method returns the current value of the gauge.

getMaxValue

float getMaxValue()

Returns the maximum value of the chart.

Note: When a gauge is being modified, this method returns the current value of the gauge.