Class RadialGradientPaint
- java.lang.Object
-
- com.inductiveautomation.ignition.client.util.gui.paints.MultipleGradientPaint
-
- com.inductiveautomation.ignition.client.util.gui.paints.RadialGradientPaint
-
- All Implemented Interfaces:
java.awt.Paint
,java.awt.Transparency
public final class RadialGradientPaint extends MultipleGradientPaint
TheRadialGradientPaint
class provides a way to fill a shape with a circular radial color gradient pattern. The user may specify 2 or more gradient colors, and this paint will provide an interpolation between each color.The user must specify the circle controlling the gradient pattern, which is described by a center point and a radius. The user can also specify a separate focus point within that circle, which controls the location of the first color of the gradient. By default the focus is set to be the center of the circle.
This paint will map the first color of the gradient to the focus point, and the last color to the perimeter of the circle, interpolating smoothly for any in-between colors specified by the user. Any line drawn from the focus point to the circumference will thus span all the gradient colors.
Specifying a focus point outside of the circle's radius will result in the focus being set to the intersection point of the focus-center line and the perimeter of the circle.
The user must provide an array of floats specifying how to distribute the colors along the gradient. These values should range from 0.0 to 1.0 and act like keyframes along the gradient (they mark where the gradient should be exactly a particular color).
In the event that the user does not set the first keyframe value equal to 0 and/or the last keyframe value equal to 1, keyframes will be created at these positions and the first and last colors will be replicated there. So, if a user specifies the following arrays to construct a gradient:
{Color.BLUE, Color.RED}, {.3f, .7f}
this will be converted to a gradient with the following keyframes:
{Color.BLUE, Color.BLUE, Color.RED, Color.RED}, {0f, .3f, .7f, 1f}
The user may also select what action the
RadialGradientPaint
should take when filling color outside the bounds of the circle's radius. If no cycle method is specified,NO_CYCLE
will be chosen by default, which means the the last keyframe color will be used to fill the remaining area.The colorSpace parameter allows the user to specify in which colorspace the interpolation should be performed, default sRGB or linearized RGB.
The following code demonstrates typical usage of
RadialGradientPaint
, where the center and focus points are the same:Point2D center = new Point2D.Float(50, 50); float radius = 25; float[] dist = { 0.0f, 0.2f, 1.0f }; Color[] colors = { Color.RED, Color.WHITE, Color.BLUE }; RadialGradientPaint p = new RadialGradientPaint(center, radius, dist, colors);
This image demonstrates the example code above, with default (centered) focus for each of the three cycle methods:
It is also possible to specify a non-centered focus point, as in the following code:
Point2D center = new Point2D.Float(50, 50); float radius = 25; Point2D focus = new Point2D.Float(40, 40); float[] dist = { 0.0f, 0.2f, 1.0f }; Color[] colors = { Color.RED, Color.WHITE, Color.BLUE }; RadialGradientPaint p = new RadialGradientPaint(center, radius, focus, dist, colors, CycleMethod.NO_CYCLE);
This image demonstrates the previous example code, with non-centered focus for each of the three cycle methods:
- Since:
- 1.6
- See Also:
Paint
,Graphics2D.setPaint(java.awt.Paint)
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.inductiveautomation.ignition.client.util.gui.paints.MultipleGradientPaint
MultipleGradientPaint.ColorSpaceType, MultipleGradientPaint.CycleMethod
-
-
Field Summary
-
Fields inherited from class com.inductiveautomation.ignition.client.util.gui.paints.MultipleGradientPaint
gradientTransform
-
-
Constructor Summary
Constructors Constructor Description RadialGradientPaint(float cx, float cy, float radius, float[] fractions, java.awt.Color[] colors)
Constructs aRadialGradientPaint
with a defaultNO_CYCLE
repeating method andSRGB
color space, using the center as the focus point.RadialGradientPaint(float cx, float cy, float radius, float[] fractions, java.awt.Color[] colors, MultipleGradientPaint.CycleMethod cycleMethod)
Constructs aRadialGradientPaint
with a defaultSRGB
color space, using the center as the focus point.RadialGradientPaint(float cx, float cy, float radius, float fx, float fy, float[] fractions, java.awt.Color[] colors, MultipleGradientPaint.CycleMethod cycleMethod)
Constructs aRadialGradientPaint
with a defaultSRGB
color space.RadialGradientPaint(java.awt.geom.Point2D center, float radius, float[] fractions, java.awt.Color[] colors)
Constructs aRadialGradientPaint
with a defaultNO_CYCLE
repeating method andSRGB
color space, using the center as the focus point.RadialGradientPaint(java.awt.geom.Point2D center, float radius, float[] fractions, java.awt.Color[] colors, MultipleGradientPaint.CycleMethod cycleMethod)
Constructs aRadialGradientPaint
with a defaultSRGB
color space, using the center as the focus point.RadialGradientPaint(java.awt.geom.Point2D center, float radius, java.awt.geom.Point2D focus, float[] fractions, java.awt.Color[] colors, MultipleGradientPaint.CycleMethod cycleMethod)
Constructs aRadialGradientPaint
with a defaultSRGB
color space.RadialGradientPaint(java.awt.geom.Point2D center, float radius, java.awt.geom.Point2D focus, float[] fractions, java.awt.Color[] colors, MultipleGradientPaint.CycleMethod cycleMethod, MultipleGradientPaint.ColorSpaceType colorSpace, java.awt.geom.AffineTransform gradientTransform)
Constructs aRadialGradientPaint
.RadialGradientPaint(java.awt.geom.Rectangle2D gradientBounds, float[] fractions, java.awt.Color[] colors, MultipleGradientPaint.CycleMethod cycleMethod)
Constructs aRadialGradientPaint
with a defaultSRGB
color space.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.awt.PaintContext
createContext(java.awt.image.ColorModel cm, java.awt.Rectangle deviceBounds, java.awt.geom.Rectangle2D userBounds, java.awt.geom.AffineTransform transform, java.awt.RenderingHints hints)
java.awt.geom.Point2D
getCenterPoint()
Returns a copy of the center point of the radial gradient.java.awt.geom.Point2D
getFocusPoint()
Returns a copy of the end point of the gradient axis.float
getRadius()
Returns the radius of the circle defining the radial gradient.-
Methods inherited from class com.inductiveautomation.ignition.client.util.gui.paints.MultipleGradientPaint
copyOf, copyOf, copyOf, getColors, getColorSpace, getCycleMethod, getFractions, getTransform, getTransparency
-
-
-
-
Constructor Detail
-
RadialGradientPaint
public RadialGradientPaint(float cx, float cy, float radius, float[] fractions, java.awt.Color[] colors)
Constructs aRadialGradientPaint
with a defaultNO_CYCLE
repeating method andSRGB
color space, using the center as the focus point.- Parameters:
cx
- the X coordinate in user space of the center point of the circle defining the gradient. The last color of the gradient is mapped to the perimeter of this circle.cy
- the Y coordinate in user space of the center point of the circle defining the gradient. The last color of the gradient is mapped to the perimeter of this circle.radius
- the radius of the circle defining the extents of the color gradientfractions
- numbers ranging from 0.0 to 1.0 specifying the distribution of colors along the gradientcolors
- array of colors to use in the gradient. The first color is used at the focus point, the last color around the perimeter of the circle.- Throws:
java.lang.NullPointerException
- iffractions
array is null, orcolors
array is nulljava.lang.IllegalArgumentException
- ifradius
is non-positive, orfractions.length != colors.length
, orcolors
is less than 2 in size, or afractions
value is less than 0.0 or greater than 1.0, or thefractions
are not provided in strictly increasing order
-
RadialGradientPaint
public RadialGradientPaint(java.awt.geom.Point2D center, float radius, float[] fractions, java.awt.Color[] colors)
Constructs aRadialGradientPaint
with a defaultNO_CYCLE
repeating method andSRGB
color space, using the center as the focus point.- Parameters:
center
- the center point, in user space, of the circle defining the gradientradius
- the radius of the circle defining the extents of the color gradientfractions
- numbers ranging from 0.0 to 1.0 specifying the distribution of colors along the gradientcolors
- array of colors to use in the gradient. The first color is used at the focus point, the last color around the perimeter of the circle.- Throws:
java.lang.NullPointerException
- ifcenter
point is null, orfractions
array is null, orcolors
array is nulljava.lang.IllegalArgumentException
- ifradius
is non-positive, orfractions.length != colors.length
, orcolors
is less than 2 in size, or afractions
value is less than 0.0 or greater than 1.0, or thefractions
are not provided in strictly increasing order
-
RadialGradientPaint
public RadialGradientPaint(float cx, float cy, float radius, float[] fractions, java.awt.Color[] colors, MultipleGradientPaint.CycleMethod cycleMethod)
Constructs aRadialGradientPaint
with a defaultSRGB
color space, using the center as the focus point.- Parameters:
cx
- the X coordinate in user space of the center point of the circle defining the gradient. The last color of the gradient is mapped to the perimeter of this circle.cy
- the Y coordinate in user space of the center point of the circle defining the gradient. The last color of the gradient is mapped to the perimeter of this circle.radius
- the radius of the circle defining the extents of the color gradientfractions
- numbers ranging from 0.0 to 1.0 specifying the distribution of colors along the gradientcolors
- array of colors to use in the gradient. The first color is used at the focus point, the last color around the perimeter of the circle.cycleMethod
- eitherNO_CYCLE
,REFLECT
, orREPEAT
- Throws:
java.lang.NullPointerException
- iffractions
array is null, orcolors
array is null, orcycleMethod
is nulljava.lang.IllegalArgumentException
- ifradius
is non-positive, orfractions.length != colors.length
, orcolors
is less than 2 in size, or afractions
value is less than 0.0 or greater than 1.0, or thefractions
are not provided in strictly increasing order
-
RadialGradientPaint
public RadialGradientPaint(java.awt.geom.Point2D center, float radius, float[] fractions, java.awt.Color[] colors, MultipleGradientPaint.CycleMethod cycleMethod)
Constructs aRadialGradientPaint
with a defaultSRGB
color space, using the center as the focus point.- Parameters:
center
- the center point, in user space, of the circle defining the gradientradius
- the radius of the circle defining the extents of the color gradientfractions
- numbers ranging from 0.0 to 1.0 specifying the distribution of colors along the gradientcolors
- array of colors to use in the gradient. The first color is used at the focus point, the last color around the perimeter of the circle.cycleMethod
- eitherNO_CYCLE
,REFLECT
, orREPEAT
- Throws:
java.lang.NullPointerException
- ifcenter
point is null, orfractions
array is null, orcolors
array is null, orcycleMethod
is nulljava.lang.IllegalArgumentException
- ifradius
is non-positive, orfractions.length != colors.length
, orcolors
is less than 2 in size, or afractions
value is less than 0.0 or greater than 1.0, or thefractions
are not provided in strictly increasing order
-
RadialGradientPaint
public RadialGradientPaint(float cx, float cy, float radius, float fx, float fy, float[] fractions, java.awt.Color[] colors, MultipleGradientPaint.CycleMethod cycleMethod)
Constructs aRadialGradientPaint
with a defaultSRGB
color space.- Parameters:
cx
- the X coordinate in user space of the center point of the circle defining the gradient. The last color of the gradient is mapped to the perimeter of this circle.cy
- the Y coordinate in user space of the center point of the circle defining the gradient. The last color of the gradient is mapped to the perimeter of this circle.radius
- the radius of the circle defining the extents of the color gradientfx
- the X coordinate of the point in user space to which the first color is mappedfy
- the Y coordinate of the point in user space to which the first color is mappedfractions
- numbers ranging from 0.0 to 1.0 specifying the distribution of colors along the gradientcolors
- array of colors to use in the gradient. The first color is used at the focus point, the last color around the perimeter of the circle.cycleMethod
- eitherNO_CYCLE
,REFLECT
, orREPEAT
- Throws:
java.lang.NullPointerException
- iffractions
array is null, orcolors
array is null, orcycleMethod
is nulljava.lang.IllegalArgumentException
- ifradius
is non-positive, orfractions.length != colors.length
, orcolors
is less than 2 in size, or afractions
value is less than 0.0 or greater than 1.0, or thefractions
are not provided in strictly increasing order
-
RadialGradientPaint
public RadialGradientPaint(java.awt.geom.Point2D center, float radius, java.awt.geom.Point2D focus, float[] fractions, java.awt.Color[] colors, MultipleGradientPaint.CycleMethod cycleMethod)
Constructs aRadialGradientPaint
with a defaultSRGB
color space.- Parameters:
center
- the center point, in user space, of the circle defining the gradient. The last color of the gradient is mapped to the perimeter of this circle.radius
- the radius of the circle defining the extents of the color gradientfocus
- the point in user space to which the first color is mappedfractions
- numbers ranging from 0.0 to 1.0 specifying the distribution of colors along the gradientcolors
- array of colors to use in the gradient. The first color is used at the focus point, the last color around the perimeter of the circle.cycleMethod
- eitherNO_CYCLE
,REFLECT
, orREPEAT
- Throws:
java.lang.NullPointerException
- if one of the points is null, orfractions
array is null, orcolors
array is null, orcycleMethod
is nulljava.lang.IllegalArgumentException
- ifradius
is non-positive, orfractions.length != colors.length
, orcolors
is less than 2 in size, or afractions
value is less than 0.0 or greater than 1.0, or thefractions
are not provided in strictly increasing order
-
RadialGradientPaint
public RadialGradientPaint(java.awt.geom.Point2D center, float radius, java.awt.geom.Point2D focus, float[] fractions, java.awt.Color[] colors, MultipleGradientPaint.CycleMethod cycleMethod, MultipleGradientPaint.ColorSpaceType colorSpace, java.awt.geom.AffineTransform gradientTransform)
Constructs aRadialGradientPaint
.- Parameters:
center
- the center point in user space of the circle defining the gradient. The last color of the gradient is mapped to the perimeter of this circle.radius
- the radius of the circle defining the extents of the color gradientfocus
- the point in user space to which the first color is mappedfractions
- numbers ranging from 0.0 to 1.0 specifying the distribution of colors along the gradientcolors
- array of colors to use in the gradient. The first color is used at the focus point, the last color around the perimeter of the circle.cycleMethod
- eitherNO_CYCLE
,REFLECT
, orREPEAT
colorSpace
- which color space to use for interpolation, eitherSRGB
orLINEAR_RGB
gradientTransform
- transform to apply to the gradient- Throws:
java.lang.NullPointerException
- if one of the points is null, orfractions
array is null, orcolors
array is null, orcycleMethod
is null, orcolorSpace
is null, orgradientTransform
is nulljava.lang.IllegalArgumentException
- ifradius
is non-positive, orfractions.length != colors.length
, orcolors
is less than 2 in size, or afractions
value is less than 0.0 or greater than 1.0, or thefractions
are not provided in strictly increasing order
-
RadialGradientPaint
public RadialGradientPaint(java.awt.geom.Rectangle2D gradientBounds, float[] fractions, java.awt.Color[] colors, MultipleGradientPaint.CycleMethod cycleMethod)
Constructs aRadialGradientPaint
with a defaultSRGB
color space. The gradient circle of theRadialGradientPaint
is defined by the given bounding box.This constructor is a more convenient way to express the following (equivalent) code:
double gw = gradientBounds.getWidth(); double gh = gradientBounds.getHeight(); double cx = gradientBounds.getCenterX(); double cy = gradientBounds.getCenterY(); Point2D center = new Point2D.Double(cx, cy); AffineTransform gradientTransform = new AffineTransform(); gradientTransform.translate(cx, cy); gradientTransform.scale(gw / 2, gh / 2); gradientTransform.translate(-cx, -cy); RadialGradientPaint gp = new RadialGradientPaint(center, 1.0f, center, fractions, colors, cycleMethod, ColorSpaceType.SRGB, gradientTransform);
- Parameters:
gradientBounds
- the bounding box, in user space, of the circle defining the outermost extent of the gradientfractions
- numbers ranging from 0.0 to 1.0 specifying the distribution of colors along the gradientcolors
- array of colors to use in the gradient. The first color is used at the focus point, the last color around the perimeter of the circle.cycleMethod
- eitherNO_CYCLE
,REFLECT
, orREPEAT
- Throws:
java.lang.NullPointerException
- ifgradientBounds
is null, orfractions
array is null, orcolors
array is null, orcycleMethod
is nulljava.lang.IllegalArgumentException
- ifgradientBounds
is empty, orfractions.length != colors.length
, orcolors
is less than 2 in size, or afractions
value is less than 0.0 or greater than 1.0, or thefractions
are not provided in strictly increasing order
-
-
Method Detail
-
createContext
public java.awt.PaintContext createContext(java.awt.image.ColorModel cm, java.awt.Rectangle deviceBounds, java.awt.geom.Rectangle2D userBounds, java.awt.geom.AffineTransform transform, java.awt.RenderingHints hints)
-
getCenterPoint
public java.awt.geom.Point2D getCenterPoint()
Returns a copy of the center point of the radial gradient.- Returns:
- a
Point2D
object that is a copy of the center point
-
getFocusPoint
public java.awt.geom.Point2D getFocusPoint()
Returns a copy of the end point of the gradient axis.- Returns:
- a
Point2D
object that is a copy of the focus point
-
getRadius
public float getRadius()
Returns the radius of the circle defining the radial gradient.- Returns:
- the radius of the circle defining the radial gradient
-
-