public static class PdfShading.Axial extends PdfShading
PdfShading
class and is in charge of Shading Dictionary with axial type, that define a colour blend that varies along a linear axis between two endpoints and extends indefinitely perpendicular to that axis.
PdfShading.Axial, PdfShading.CoonsPatchMesh, PdfShading.FreeFormGouraudShadedTriangleMesh, PdfShading.FunctionBased, PdfShading.LatticeFormGouraudShadedTriangleMesh, PdfShading.Radial, PdfShading.TensorProductPatchMesh
Constructor and Description |
---|
Axial(PdfColorSpace cs, float x0, float y0, float[] color0, float x1, float y1, float[] color1)
Creates the new instance of the class.
|
Axial(PdfColorSpace cs, float x0, float y0, float[] color0, float x1, float y1, float[] color1, boolean[] extend)
Creates the new instance of the class.
|
Axial(PdfColorSpace cs, PdfArray coords, PdfFunction function)
Creates the new instance of the class.
|
Axial(PdfDictionary pdfDictionary)
Deprecated.
Intended only for private use. You should use
PdfShading.makeShading(PdfDictionary) instead.
|
Modifier and Type | Method and Description |
---|---|
PdfArray |
getCoords()
Gets the Coords object - a PdfArray of four numbers [x0 y0 x1 y1] that specified the starting and the endings coordinates of thew axis, expressed in the shading's target coordinate space.
|
float[] |
getDomain()
Gets the array of two float [t0, t1] that represent the limiting values of a parametric variable t, that becomes an input of color function(s).
|
boolean[] |
getExtend()
Gets the array of two boolean that specified whether to extend the shading beyond the starting and ending points of the axis, respectively.
|
void |
setCoords(float x0, float y0, float x1, float y1)
Sets the Choords object with the four params expressed in the shading's target coordinate space.
|
void |
setCoords(PdfArray coords)
Sets the Choords object with the PdfArray of four numbers [x0 y0 x1 y1], that specified the starting and the endings coordinates of thew axis, expressed in the shading's target coordinate space.
|
void |
setDomain(float t0, float t1)
Sets the Domain with the array of two float [t0, t1] that represent the limiting values of a parametric variable t, that becomes an input of color function(s).
|
void |
setExtend(boolean extendStart, boolean extendEnd)
Sets the Extend object with the two boolean value.
|
flush, getColorSpace, getFunction, getShadingType, isWrappedObjectMustBeIndirect, makeShading, setFunction, setFunction
ensureObjectIsAddedToDocument, getPdfObject, isFlushed, makeIndirect, makeIndirect, markObjectAsIndirect, setForbidRelease, setModified, setPdfObject, unsetForbidRelease
@Deprecated public Axial(PdfDictionary pdfDictionary)
PdfShading.makeShading(PdfDictionary)
instead.
PdfDictionary
object.
pdfDictionary
- PdfDictionary
from which the instance is created.
public Axial(PdfColorSpace cs, float x0, float y0, float[] color0, float x1, float y1, float[] color1)
cs
- the PdfColorSpace
object in which colour values shall be expressed. The special Pattern space isn't excepted.
x0
- the start coordinate of X axis expressed in the shading's target coordinate space.
y0
- the start coordinate of Y axis expressed in the shading's target coordinate space.
color0
- the float[]
that represents the color in the start point.
x1
- the end coordinate of X axis expressed in the shading's target coordinate space.
y1
- the end coordinate of Y axis expressed in the shading's target coordinate space.
color1
- the float[]
that represents the color in the end point.
public Axial(PdfColorSpace cs, float x0, float y0, float[] color0, float x1, float y1, float[] color1, boolean[] extend)
cs
- the PdfColorSpace
object in which colour values shall be expressed. The special Pattern space isn't excepted.
x0
- the start coordinate of X axis expressed in the shading's target coordinate space.
y0
- the start coordinate of Y axis expressed in the shading's target coordinate space.
color0
- the float[]
that represents the color in the start point.
x1
- the end coordinate of X axis expressed in the shading's target coordinate space.
y1
- the end coordinate of Y axis expressed in the shading's target coordinate space.
color1
- the float[]
that represents the color in the end point.
extend
- the array of two booleans that specified whether to extend the shading beyond the starting and ending points of the axis, respectively.
public Axial(PdfColorSpace cs, PdfArray coords, PdfFunction function)
cs
- the PdfColorSpace
object in which colour values shall be expressed. The special Pattern space isn't excepted.
coords
- the PdfArray
of four number four numbers [x0 y0 x1 y1] that specified the starting and the endings coordinates of thew axis, expressed in the shading's target coordinate space.
function
- the PdfFunction
object, that is used to calculate color transitions.
public PdfArray getCoords()
PdfArray
of four numbers [x0 y0 x1 y1] that specified the starting and the endings coordinates of thew axis, expressed in the shading's target coordinate space.
PdfArray
Coords object.
public void setCoords(float x0, float y0, float x1, float y1)
x0
- the start coordinate of X axis to be set.
y0
- the start coordinate of Y axis to be set.
x1
- the end coordinate of X axis to be set.
y1
- the end coordinate of Y axis to be set.
public void setCoords(PdfArray coords)
PdfArray
of four numbers [x0 y0 x1 y1], that specified the starting and the endings coordinates of thew axis, expressed in the shading's target coordinate space.
coords
- the Chords PdfArray
to be set.
public float[] getDomain()
float
[t0, t1] that represent the limiting values of a parametric variable t, that becomes an input of color function(s).
float[]
of Domain object ([0.0 1.0] by default)
public void setDomain(float t0, float t1)
float
[t0, t1] that represent the limiting values of a parametric variable t, that becomes an input of color function(s).
t0
- first limit of variable t
t1
- second limit of variable t
public boolean[] getExtend()
boolean
that specified whether to extend the shading beyond the starting and ending points of the axis, respectively.
boolean[]
of Extended object ([false false] by default)
public void setExtend(boolean extendStart, boolean extendEnd)
boolean
value.
extendStart
- if true will extend shading beyond the starting point of Coords
extendEnd
- if true will extend shading beyond the ending point of Coords
Copyright © 1998–2016 iText Group NV. All rights reserved.