Package com.orsonpdf.shading
Class AxialShading
- java.lang.Object
-
- com.orsonpdf.PDFObject
-
- com.orsonpdf.shading.Shading
-
- com.orsonpdf.shading.AxialShading
-
public final class AxialShading extends Shading
An axial shading.
-
-
Field Summary
Fields Modifier and Type Field Description private double[]
coords
Coordinates (x0, y0, x1, y1) defining the axis.private double[]
domain
The domain.private boolean[]
extend
The extend flags (two of them).private Function
function
The shading function.-
Fields inherited from class com.orsonpdf.shading.Shading
dictionary
-
-
Constructor Summary
Constructors Constructor Description AxialShading(int number, double[] coords, Function function)
Creates a new axial shading.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description double[]
getCoords()
Returns a copy of the axis coordinates array(x1, y1, x2, y2)
.double[]
getDomain()
Returns the function domain.boolean[]
getExtend()
Returns the extend array.Function
getFunction()
Returns the function for this shading.void
setCoords(double[] coords)
Sets the axis coordinates array(x1, y1, x2, y2)
.void
setDomain(double[] domain)
Sets the domain.void
setExtend(boolean[] extend)
Sets the extend array.void
setFunction(Function function)
Sets the function for this shading.-
Methods inherited from class com.orsonpdf.shading.Shading
getObjectBytes, getShadingType
-
Methods inherited from class com.orsonpdf.PDFObject
getGeneration, getNumber, getReference, toPDFBytes
-
-
-
-
Field Detail
-
coords
private double[] coords
Coordinates (x0, y0, x1, y1) defining the axis.
-
function
private Function function
The shading function.
-
domain
private double[] domain
The domain.
-
extend
private boolean[] extend
The extend flags (two of them).
-
-
Constructor Detail
-
AxialShading
public AxialShading(int number, double[] coords, Function function)
Creates a new axial shading.- Parameters:
number
- the object number.coords
- the coordinates of the axis (x1, y1, x2, y2).function
- the function object for the shading (null
not permitted).
-
-
Method Detail
-
getCoords
public double[] getCoords()
Returns a copy of the axis coordinates array(x1, y1, x2, y2)
.- Returns:
- A copy of the axis coordinates array (never
null
).
-
setCoords
public void setCoords(double[] coords)
Sets the axis coordinates array(x1, y1, x2, y2)
.- Parameters:
coords
- the axis coordinates (null
not permitted).
-
getFunction
public Function getFunction()
Returns the function for this shading.- Returns:
- The function (never
null
).
-
setFunction
public void setFunction(Function function)
Sets the function for this shading.- Parameters:
function
- the function (null
not permitted).
-
getDomain
public double[] getDomain()
Returns the function domain. The default value is[0.0, 1.0]
.- Returns:
- The function domain.
-
setDomain
public void setDomain(double[] domain)
Sets the domain.- Parameters:
domain
- the domain (array must have length 2).
-
getExtend
public boolean[] getExtend()
Returns the extend array.- Returns:
- The extend array.
-
setExtend
public void setExtend(boolean[] extend)
Sets the extend array.- Parameters:
extend
- the extend array (must have length 2).
-
-