ilog.views.chart.java2d

Class IlvValueGradientPaint

java.lang.Object

ilog.views.chart.java2d.Ilv3DPaint

ilog.views.chart.java2d.IlvValueGradientPaint

All Implemented Interfaces:

IlvMultipleGradientPaintConstants, Paint, Transparency, Serializable

public class IlvValueGradientPaint
extends Ilv3DPaint
implements Paint, Serializable, IlvMultipleGradientPaintConstants

Implements a gradient Paint whose definition is based on data values. An IlvValueGradientPaint can be specified as the stroke or fill paint of an IlvStyle, and thus be used with chart renderers. The gradient is defined by values that act as key-frames with specific colors.

The following code illustrates two examples:

 double[] xVals = new double[] {0., 100.};
 Color[] colors = new Color[] {Color.white, Color.red};
 IlvValueGradientPaint grad1 = new IlvValueGradientPaint(chart, xVals, colors);
 double[] yVals = new double[] {0., 80., 80., 100.};
 Color[] colors = new Color[] {Color.white, Color.white, Color.red, Color.red};
 IlvValueGradientPaint grad2 = new IlvValueGradientPaint(chart, 0, yVals, colors);
 

grad1 defines a gradient along the X axis that will produce the following colors:

• white for x <= 0,
• between white and red for 0 < x < 100,
• red for x >= 100.

grad2 defines a gradient along the Y axis that will produce the following colors:

• white for y <= 80,
• red for y > 80.

Note that a gradient can only be used for renderers displayed by the chart for which they were created.

Limitation: These gradients can be used in 3D mode for bar, area, and pie charts, but not for line charts.

Since:

JViews 5.0

See Also:

Serialized Form

Field Summary

Fields inherited from class ilog.views.chart.java2d.Ilv3DPaint

LinearARGBColorModel

Fields inherited from interface java.awt.Transparency

BITMASK, OPAQUE, TRANSLUCENT

Fields inherited from interface ilog.views.util.java2d.IlvMultipleGradientPaintConstants

LINEAR_RGB, SPREAD_PAD, SPREAD_REFLECT, SPREAD_REPEAT, SRGB

Constructor Summary

Constructors

Constructor and Description
IlvValueGradientPaint(IlvChart chart, double[] xValues, Color[] colors) Creates a gradient based on the specified x-values.
IlvValueGradientPaint(IlvChart chart, double[] xValues, Color[] colors, boolean clipValues) Creates a gradient based on the specified x-values.
IlvValueGradientPaint(IlvChart chart, double[] xValues, Color[] colors, short colorSpace, boolean clipValues) Creates a gradient based on the specified x-values.
IlvValueGradientPaint(IlvChart chart, int yAxisIdx, double[] yValues, Color[] colors) Creates a gradient based on the specified y-values.
IlvValueGradientPaint(IlvChart chart, int yAxisIdx, double[] yValues, Color[] colors, boolean clipValues) Creates a gradient based on the specified y-values.
IlvValueGradientPaint(IlvChart chart, int yAxisIdx, double[] yValues, Color[] colors, short colorSpace, boolean clipValues) Creates a gradient based on the specified y-values.

Method Summary

Modifier and Type	Method and Description
PaintContext	createContext(ColorModel cm, Rectangle deviceBounds, Rectangle2D userBounds, AffineTransform transform, RenderingHints hints) Creates and returns a context used to generate the gradient.
Paint	createPlaneRestrictedPaint(ilog.views.chart.view3d.Ilv3DTransform transform3D, ilog.views.chart.view3d.Ilv3DVector planeNormal, double planeConstant) Creates and returns a Paint that can be used to generate the color pattern for a piece of the scene that lies on a given plane.
void	dispose() Releases the resources allocated for this gradient.
IlvAxis	getAxis() Returns the axis along which this gradient is defined.
Color[]	getColors() Returns a copy of the array of colors used by this gradient.
int	getPixelARGB(int xd, int yd, double xu, double yu, double zu, double x3d, double y3d, double z3d) Returns the color, as an ARGB-encoded integer, of the given pixel.
int	getTransparency() Returns the transparency mode for this GradientPaint.
double[]	getValues() Returns a copy of the array of values used by this gradient.
protected void	setColors(Color[] colors) Modifies the colors defining this gradient.
protected void	setValues(double[] values) Modifies the values defining this gradient.
protected void	update() Called when the gradient needs to be recomputed.

Methods inherited from class ilog.views.chart.java2d.Ilv3DPaint

createContext

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvValueGradientPaint

public IlvValueGradientPaint(IlvChart chart,
                             int yAxisIdx,
                             double[] yValues,
                             Color[] colors)

Creates a gradient based on the specified y-values.

Parameters:

chart - The chart on which this gradient is based.

yAxisIdx - The index of the considered y-axis.

yValues - The y-values that will define the key-frames of the gradient. This array must be sorted.

colors - The colors for the gradient.

IlvValueGradientPaint

public IlvValueGradientPaint(IlvChart chart,
                             int yAxisIdx,
                             double[] yValues,
                             Color[] colors,
                             boolean clipValues)

Creates a gradient based on the specified y-values.

Parameters:

chart - The chart on which this gradient is based.

yAxisIdx - The index of the considered y-axis.

yValues - The y-values that will define the key-frames of the gradient. This array must be sorted.

colors - The colors for the gradient.

clipValues - Whether the values should be clipped to the axis data range.

Since:

JViews 6.0

IlvValueGradientPaint

public IlvValueGradientPaint(IlvChart chart,
                             int yAxisIdx,
                             double[] yValues,
                             Color[] colors,
                             short colorSpace,
                             boolean clipValues)

Creates a gradient based on the specified y-values.

Parameters:

chart - The chart on which this gradient is based.

yAxisIdx - The index of the considered y-axis.

yValues - The y-values that will define the key-frames of the gradient. This array must be sorted.

colors - The colors for the gradient.

colorSpace - The color space in which the color interpolation shall occur. Either IlvMultipleGradientPaintConstants.SRGB or IlvMultipleGradientPaintConstants.LINEAR_RGB.

clipValues - Whether the values should be clipped to the axis data range.

Since:

JViews 8.6

IlvValueGradientPaint

public IlvValueGradientPaint(IlvChart chart,
                             double[] xValues,
                             Color[] colors)

Creates a gradient based on the specified x-values.

Parameters:

chart - The chart on which this gradient is based.

xValues - The x-values that will define the key-frames of the gradient. This array must be sorted.

colors - The colors for the gradient.

IlvValueGradientPaint

public IlvValueGradientPaint(IlvChart chart,
                             double[] xValues,
                             Color[] colors,
                             boolean clipValues)

Creates a gradient based on the specified x-values.

Parameters:

chart - The chart on which this gradient is based.

xValues - The x-values that will define the key-frames of the gradient. This array must be sorted.

colors - The colors for the gradient.

clipValues - Whether the values should be clipped to the axis data range.

Since:

JViews 6.0

IlvValueGradientPaint

public IlvValueGradientPaint(IlvChart chart,
                             double[] xValues,
                             Color[] colors,
                             short colorSpace,
                             boolean clipValues)

Creates a gradient based on the specified x-values.

Parameters:

chart - The chart on which this gradient is based.

xValues - The x-values that will define the key-frames of the gradient. This array must be sorted.

colors - The colors for the gradient.

colorSpace - The color space in which the color interpolation shall occur. Either IlvMultipleGradientPaintConstants.SRGB or IlvMultipleGradientPaintConstants.LINEAR_RGB.

clipValues - Whether the values should be clipped to the axis data range.

Since:

JViews 8.6

Method Detail

dispose

public void dispose()

Releases the resources allocated for this gradient.

Note: This method must be called when the gradient is no more used by a chart.

getColors

public Color[] getColors()

Returns a copy of the array of colors used by this gradient.

Returns:

A copy of the array of colors used by this gradient.

setColors

protected void setColors(Color[] colors)

Modifies the colors defining this gradient.

Note: This method should only be called from this object, because a Paint is conceptually an immutable object.

Parameters:

colors - The colors for the gradient.

getValues

public double[] getValues()

Returns a copy of the array of values used by this gradient.

Returns:

A copy of the array of values used by this gradient.

setValues

protected void setValues(double[] values)

Modifies the values defining this gradient.

Note: This method should only be called from this object, because a Paint is conceptually an immutable object.

Parameters:

values - The values that will define the key-frames of the gradient.

getAxis

public final IlvAxis getAxis()

Returns the axis along which this gradient is defined.

update

protected void update()

Called when the gradient needs to be recomputed. The default implementation does nothing.

createContext

public PaintContext createContext(ColorModel cm,
                                  Rectangle deviceBounds,
                                  Rectangle2D userBounds,
                                  AffineTransform transform,
                                  RenderingHints hints)

Creates and returns a context used to generate the gradient.

Specified by:

createContext in interface Paint

getTransparency

public int getTransparency()

Returns the transparency mode for this GradientPaint.

Specified by:

getTransparency in interface Transparency

getPixelARGB

public int getPixelARGB(int xd,
                        int yd,
                        double xu,
                        double yu,
                        double zu,
                        double x3d,
                        double y3d,
                        double z3d)

Returns the color, as an ARGB-encoded integer, of the given pixel. xd, yd are the device coordinates (transformed by the chart's projection then by the Graphics2D transform). xu, yu, zu are the user coordinates (transformed by the chart's projection). x3d, y3d, z3d are the 3-d coordinates (untransformed).

Specified by:

getPixelARGB in class Ilv3DPaint

Returns:

A 24-bit integer denoting a color, usually combined with an alpha mask of 0xFF000000.

Since:

JViews 8.6

createPlaneRestrictedPaint

public Paint createPlaneRestrictedPaint(ilog.views.chart.view3d.Ilv3DTransform transform3D,
                                        ilog.views.chart.view3d.Ilv3DVector planeNormal,
                                        double planeConstant)

Creates and returns a Paint that can be used to generate the color pattern for a piece of the scene that lies on a given plane.

Overrides:

createPlaneRestrictedPaint in class Ilv3DPaint

Parameters:

transform3D - The 3D transformation of the view.

planeNormal - The normal vector of the given plane.

planeConstant - The constant part of the plane's equation.

Returns:

A Paint object that can be used for the points in the given plane.

Since:

JViews 8.6