public static class PdfShading.Radial extends PdfShading
PdfShading
class and is in charge of Shading Dictionary with radial type, that define a colour blend that varies between two circles. This type of shading shall not be used with an Indexed colour space
PdfShading.Axial, PdfShading.CoonsPatchMesh, PdfShading.FreeFormGouraudShadedTriangleMesh, PdfShading.FunctionBased, PdfShading.LatticeFormGouraudShadedTriangleMesh, PdfShading.Radial, PdfShading.TensorProductPatchMesh
Constructor and Description |
---|
Radial(PdfColorSpace cs, float x0, float y0, float r0, float[] color0, float x1, float y1, float r1, float[] color1)
Creates the new instance of the class.
|
Radial(PdfColorSpace cs, float x0, float y0, float r0, float[] color0, float x1, float y1, float r1, float[] color1, boolean[] extend)
Creates the new instance of the class.
|
Radial(PdfColorSpace cs, PdfArray coords, PdfFunction function)
Creates the new instance of the class.
|
Radial(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 PdfArray object - an array of six numbers [x0 y0 r0 x1 y1 r1], specifying the centres and radii of the starting and ending circles, 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 circles of the axis, respectively.
|
void |
setCoords(float x0, float y0, float r0, float x1, float y1, float r1)
Sets the coords object.
|
void |
setCoords(PdfArray coords)
Sets the coords PdfArray object - an array of six numbers [x0 y0 r0 x1 y1 r1], specifying the centres and radii of the starting and ending circles, 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
public Radial(PdfDictionary pdfDictionary)
PdfShading.makeShading(PdfDictionary)
instead.
PdfDictionary
object.
pdfDictionary
- - PdfDictionary
from which the instance is created.
public Radial(PdfColorSpace cs, float x0, float y0, float r0, float[] color0, float x1, float y1, float r1, float[] color1)
cs
- the PdfColorSpace
object in which colour values shall be expressed. The Indexed color space isn't excepted.
x0
- the X coordinate of starting circle's centre, expressed in in the shading’s target coordinate space.
y0
- the Y coordinate of starting circle's centre, expressed in in the shading’s target coordinate space.
r0
- the radius of starting circle's centre, should be greater or equal to 0. If 0 then starting circle is treated as point. If both radii are 0, nothing shall be painted.
color0
- the float[]
that represents the color in the start circle.
x1
- the X coordinate of ending circle's centre, expressed in in the shading’s target coordinate space.
y1
- the Y coordinate of ending circle's centre, expressed in in the shading’s target coordinate space.
r1
- the radius of ending circle's centre, should be greater or equal to 0. If 0 then ending circle is treated as point. If both radii are 0, nothing shall be painted.
color1
- the float[]
that represents the color in the end circle.
public Radial(PdfColorSpace cs, float x0, float y0, float r0, float[] color0, float x1, float y1, float r1, float[] color1, boolean[] extend)
cs
- the PdfColorSpace
object in which colour values shall be expressed. The Indexed color space isn't excepted.
x0
- the X coordinate of starting circle's centre, expressed in in the shading’s target coordinate space.
y0
- the Y coordinate of starting circle's centre, expressed in in the shading’s target coordinate space.
r0
- the radius of starting circle's centre, should be greater or equal to 0. If 0 then starting circle is treated as point. If both radii are 0, nothing shall be painted.
color0
- the float[]
that represents the color in the start circle.
x1
- the X coordinate of ending circle's centre, expressed in in the shading’s target coordinate space.
y1
- the Y coordinate of ending circle's centre, expressed in in the shading’s target coordinate space.
r1
- the radius of ending circle's centre, should be greater or equal to 0. If 0 then ending circle is treated as point. If both radii are 0, nothing shall be painted.
color1
- the float[]
that represents the color in the end circle.
extend
- the array of two boolean
that specified whether to extend the shading beyond the starting and ending points of the axis, respectively.
public Radial(PdfColorSpace cs, PdfArray coords, PdfFunction function)
cs
- the PdfColorSpace
object in which colour values shall be expressed. The Indexed color space isn't excepted.
coords
- the PdfArray
of of six numbers [x0 y0 r0 x1 y1 r1], specifying the centres and radii of the starting and ending circles, expressed in the shading’s target coordinate space. The radii r0 and r1 shall both be greater than or equal to 0. If one radius is 0, the corresponding circle shall be treated as a point; if both are 0, nothing shall be painted.
function
- the PdfFunction
object, that is used to calculate color transitions.
public PdfArray getCoords()
PdfArray
object - an array of six numbers [x0 y0 r0 x1 y1 r1], specifying the centres and radii of the starting and ending circles, expressed in the shading’s target coordinate space. The radii r0 and r1 shall both be greater than or equal to 0. If one radius is 0, the corresponding circle shall be treated as a point; if both are 0, nothing shall be painted.
PdfArray
coords object.
public void setCoords(float x0, float y0, float r0, float x1, float y1, float r1)
x0
- the X coordinate of starting circle's centre, expressed in in the shading’s target coordinate space.
y0
- the Y coordinate of starting circle's centre, expressed in in the shading’s target coordinate space.
r0
- the radius of starting circle's centre, should be greater or equal to 0. If 0 then starting circle is treated as point. If both radii are 0, nothing shall be painted.
x1
- the X coordinate of ending circle's centre, expressed in in the shading’s target coordinate space.
y1
- the Y coordinate of ending circle's centre, expressed in in the shading’s target coordinate space.
r1
- the radius of ending circle's centre, should be greater or equal to 0. If 0 then ending circle is treated as point. If both radii are 0, nothing shall be painted.
public void setCoords(PdfArray coords)
PdfArray
object - an array of six numbers [x0 y0 r0 x1 y1 r1], specifying the centres and radii of the starting and ending circles, expressed in the shading’s target coordinate space. The radii r0 and r1 shall both be greater than or equal to 0. If one radius is 0, the corresponding circle shall be treated as a point; if both are 0, nothing shall be painted.
coords
- - PdfArray
choords object 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 circles 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 circle of Coords.
extendEnd
- if true will extend shading beyond the ending circle of Coords.
Copyright © 1998–2016 iText Group NV. All rights reserved.