Package com.github.tadukoo.view.paint.gradient

Class LinearGradient

java.lang.Object

com.github.tadukoo.view.paint.gradient.LinearGradient

All Implemented Interfaces:

Gradient, SizablePaint

public class LinearGradient
extends Object
implements Gradient

Linear Gradient is used to build a Gradient object to use for LinearGradientPaint.

Since:

Alpha v.0.2

Version:

Alpha v.0.2.1

Author:

Logan Ferree (Tadukoo)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	LinearGradient.GradientDirection	The direction for a LinearGradient to go.
static class	LinearGradient.LinearGradientBuilder	Linear Gradient Builder is a builder for LinearGradient.

Field Summary

Fields

Modifier and Type	Field	Description
protected final Color[]	colors	The Colors involved in this LinearGradient
protected final MultipleGradientPaint.ColorSpaceType	colorSpace	The color space involved in this LinearGradient
protected final MultipleGradientPaint.CycleMethod	cycleMethod	The cycle method involved in this LinearGradient
protected final LinearGradient.GradientDirection	direction	The direction for this LinearGradient to go.
protected final float[]	fractions	The fractions involved in this LinearGradient
protected final AffineTransform	gradientTransform	The AffineTransform involved in this LinearGradient
protected final BiFunction<Dimension,LinearGradient.GradientDirection,com.github.tadukoo.util.tuple.Pair<Point2D,Point2D>>	startAndEndPointsFunc	A function taking in the dimensions of the space and the chosen LinearGradient.GradientDirection to return the start and end points in space for this LinearGradient

Constructor Summary

Constructors

Modifier	Constructor	Description
private	LinearGradient(LinearGradient.GradientDirection direction, BiFunction<Dimension,LinearGradient.GradientDirection,com.github.tadukoo.util.tuple.Pair<Point2D,Point2D>> startAndEndPointsFunc, float[] fractions, Color[] colors, MultipleGradientPaint.CycleMethod cycleMethod, MultipleGradientPaint.ColorSpaceType colorSpace, AffineTransform gradientTransform)	Constructs a new Linear Gradient using the given parameters.

Method Summary

Modifier and Type	Method	Description
static LinearGradient.LinearGradientBuilder	builder()
Color[]	getColors()
MultipleGradientPaint.ColorSpaceType	getColorSpace()
MultipleGradientPaint.CycleMethod	getCycleMethod()
LinearGradient.GradientDirection	getDirection()
float[]	getFractions()
AffineTransform	getGradientTransform()
Paint	getPaint(Dimension size)	Creates a LinearGradientPaint using the startAndEndPointsFunc to determine the start and end points, and sending the other parameters as specified.
BiFunction<Dimension,LinearGradient.GradientDirection,com.github.tadukoo.util.tuple.Pair<Point2D,Point2D>>	getStartAndEndPointsFunc()

Methods inherited from class java.lang.Object

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

Field Details

direction

protected final LinearGradient.GradientDirection direction

The direction for this LinearGradient to go. This may be ignored by the startAndEndPointsFunc

startAndEndPointsFunc

protected final BiFunction<Dimension,LinearGradient.GradientDirection,com.github.tadukoo.util.tuple.Pair<Point2D,Point2D>> startAndEndPointsFunc

A function taking in the dimensions of the space and the chosen LinearGradient.GradientDirection to return the start and end points in space for this LinearGradient

fractions

protected final float[] fractions

The fractions involved in this LinearGradient

colors

protected final Color[] colors

The Colors involved in this LinearGradient

cycleMethod

protected final MultipleGradientPaint.CycleMethod cycleMethod

The cycle method involved in this LinearGradient

colorSpace

protected final MultipleGradientPaint.ColorSpaceType colorSpace

The color space involved in this LinearGradient

gradientTransform

protected final AffineTransform gradientTransform

The AffineTransform involved in this LinearGradient

Constructor Details

LinearGradient

private LinearGradient(LinearGradient.GradientDirection direction,
 BiFunction<Dimension,LinearGradient.GradientDirection,com.github.tadukoo.util.tuple.Pair<Point2D,Point2D>> startAndEndPointsFunc,
 float[] fractions,
 Color[] colors,
 MultipleGradientPaint.CycleMethod cycleMethod,
 MultipleGradientPaint.ColorSpaceType colorSpace,
 AffineTransform gradientTransform)

Constructs a new Linear Gradient using the given parameters.

Parameters:

direction - The direction for this LinearGradient to go. This may be ignored by the startAndEndPointsFunc

startAndEndPointsFunc - A function taking in the dimensions of the space and the chosen LinearGradient.GradientDirection to return the start and end points in space for this LinearGradient

fractions - The fractions involved in this LinearGradient

colors - The Colors involved in this LinearGradient

cycleMethod - The cycle method involved in this LinearGradient

colorSpace - The color space involved in this LinearGradient

gradientTransform - The AffineTransform involved in this LinearGradient

Method Details

builder

public static LinearGradient.LinearGradientBuilder builder()

Returns:

A LinearGradient.LinearGradientBuilder to use in building a LinearGradient

getColors

public Color[] getColors()

Specified by:

getColors in interface Gradient

Returns:

The Colors involved in this Gradient

getFractions

public float[] getFractions()

Specified by:

getFractions in interface Gradient

Returns:

The fractions involved in this Gradient

getCycleMethod

public MultipleGradientPaint.CycleMethod getCycleMethod()

Specified by:

getCycleMethod in interface Gradient

Returns:

The cycle method involved in the Gradient

getColorSpace

public MultipleGradientPaint.ColorSpaceType getColorSpace()

Specified by:

getColorSpace in interface Gradient

Returns:

The color space involved in the Gradient

getGradientTransform

public AffineTransform getGradientTransform()

Specified by:

getGradientTransform in interface Gradient

Returns:

The AffineTransform involved in the Gradient

getDirection

public LinearGradient.GradientDirection getDirection()

Returns:

The direction for this LinearGradient to go. This may be ignored by the startAndEndPointsFunc

getStartAndEndPointsFunc

public BiFunction<Dimension,LinearGradient.GradientDirection,com.github.tadukoo.util.tuple.Pair<Point2D,Point2D>> getStartAndEndPointsFunc()

Returns:

A function taking in the dimensions of the space and the chosen LinearGradient.GradientDirection to return the start and end points in space for this LinearGradient

getPaint

public Paint getPaint(Dimension size)

Creates a LinearGradientPaint using the startAndEndPointsFunc to determine the start and end points, and sending the other parameters as specified.

Specified by:

getPaint in interface SizablePaint

Parameters:

size - The dimensions of the object the Gradient will go on

Returns:

A new LinearGradientPaint using the parameters of this LinearGradient