Class PdfShading.Radial

Namespace

iText.Kernel.Pdf.Colorspace

Assembly

itext.kernel.dll

The class that extends PdfShading class and is in charge of Shading Dictionary with radial type, that define a colour blend that varies between two circles.

public class PdfShading.Radial : PdfShading

Inheritance

object

PdfObjectWrapper<PdfDictionary>

PdfShading

PdfShading.Radial

Inherited Members

PdfShading.MakeShading(PdfDictionary)

PdfShading.GetShadingType()

PdfShading.GetColorSpace()

PdfShading.GetFunction()

PdfShading.SetFunction(IPdfFunction)

PdfShading.SetFunction(IPdfFunction[])

PdfShading.Flush()

PdfShading.IsWrappedObjectMustBeIndirect()

PdfObjectWrapper<PdfDictionary>.GetPdfObject()

PdfObjectWrapper<PdfDictionary>.MakeIndirect(PdfDocument, PdfIndirectReference)

PdfObjectWrapper<PdfDictionary>.MakeIndirect(PdfDocument)

PdfObjectWrapper<PdfDictionary>.SetModified()

PdfObjectWrapper<PdfDictionary>.IsFlushed()

PdfObjectWrapper<PdfDictionary>.SetPdfObject(PdfDictionary)

PdfObjectWrapper<PdfDictionary>.SetForbidRelease()

PdfObjectWrapper<PdfDictionary>.UnsetForbidRelease()

PdfObjectWrapper<PdfDictionary>.EnsureUnderlyingObjectHasIndirectReference()

PdfObjectWrapper<PdfDictionary>.MarkObjectAsIndirect(PdfObject)

PdfObjectWrapper<PdfDictionary>.EnsureObjectIsAddedToDocument(PdfObject)

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Remarks

The class that extends 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

Constructors

Radial(PdfColorSpace, float, float, float, float[], float, float, float, float[])

Creates the new instance of the class.

public Radial(PdfColorSpace cs, float x0, float y0, float r0, float[] color0, float x1, float y1, float r1, float[] color1)

Parameters

cs PdfColorSpace

the PdfColorSpace object in which colour values shall be expressed. The Indexed color space isn't excepted.

x0 float

the X coordinate of starting circle's centre, expressed in in the shading’s target coordinate space.

y0 float

the Y coordinate of starting circle's centre, expressed in in the shading’s target coordinate space.

r0 float

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 float[]

the float[] that represents the color in the start circle.

x1 float

the X coordinate of ending circle's centre, expressed in in the shading’s target coordinate space.

y1 float

the Y coordinate of ending circle's centre, expressed in in the shading’s target coordinate space.

r1 float

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 float[]

the float[] that represents the color in the end circle.

Radial(PdfColorSpace, float, float, float, float[], float, float, float, float[], bool[])

Creates the new instance of the class.

public Radial(PdfColorSpace cs, float x0, float y0, float r0, float[] color0, float x1, float y1, float r1, float[] color1, bool[] extend)

Parameters

cs PdfColorSpace

the PdfColorSpace object in which colour values shall be expressed. The Indexed color space isn't excepted.

x0 float

the X coordinate of starting circle's centre, expressed in in the shading’s target coordinate space.

y0 float

the Y coordinate of starting circle's centre, expressed in in the shading’s target coordinate space.

r0 float

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 float[]

the float[] that represents the color in the start circle.

x1 float

the X coordinate of ending circle's centre, expressed in in the shading’s target coordinate space.

y1 float

the Y coordinate of ending circle's centre, expressed in in the shading’s target coordinate space.

r1 float

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 float[]

the float[] that represents the color in the end circle.

extend bool[]

the array of two boolean that specified whether to extend the shading beyond the starting and ending points of the axis, respectively.

Radial(PdfColorSpace, PdfArray, IPdfFunction)

Creates the new instance of the class.

public Radial(PdfColorSpace cs, PdfArray coords, IPdfFunction function)

Parameters

cs PdfColorSpace

the PdfColorSpace object in which colour values shall be expressed. The Indexed color space isn't excepted.

coords PdfArray

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 IPdfFunction

the IPdfFunction object, that is used to calculate color transitions.

Radial(PdfDictionary)

Creates the new instance of the class from the existing PdfDictionary.

protected Radial(PdfDictionary pdfDictionary)

Parameters

pdfDictionary PdfDictionary

from which this PdfShading.Radial will be created

Methods

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.

public virtual PdfArray GetCoords()

Returns

PdfArray

the PdfArray coords object.

Remarks

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. 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.

GetDomain()

Gets the PdfArray of two float [t0, t1] that represent the limiting values of a parametric variable t, that becomes an input of color function(s).

public virtual PdfArray GetDomain()

Returns

PdfArray

the PdfArray of Domain object ([0.0 1.0] by default)

GetExtend()

Gets the PdfArray of two boolean that specified whether to extend the shading beyond the starting and ending circles of the axis, respectively.

public virtual PdfArray GetExtend()

Returns

PdfArray

the PdfArray of Extended object ([false false] by default)

SetCoords(float, float, float, float, float, float)

Sets the coords object.

public virtual void SetCoords(float x0, float y0, float r0, float x1, float y1, float r1)

Parameters

x0 float

the X coordinate of starting circle's centre, expressed in in the shading’s target coordinate space.

y0 float

the Y coordinate of starting circle's centre, expressed in in the shading’s target coordinate space.

r0 float

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 float

the X coordinate of ending circle's centre, expressed in in the shading’s target coordinate space.

y1 float

the Y coordinate of ending circle's centre, expressed in in the shading’s target coordinate space.

r1 float

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.

SetCoords(PdfArray)

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.

public virtual void SetCoords(PdfArray coords)

Parameters

coords PdfArray

PdfArray choords object to be set.

Remarks

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. 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.

SetDomain(float, float)

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).

public virtual void SetDomain(float t0, float t1)

Parameters

t0 float

first limit of variable t

t1 float

second limit of variable t

SetDomain(PdfArray)

Sets the Domain with the PdfArray of two float [t0, t1] that represent the limiting values of a parametric variable t, that becomes an input of color function(s).

public virtual void SetDomain(PdfArray domain)

Parameters

domain PdfArray

the PdfArray that represents domain

SetExtend(bool, bool)

Sets the Extend object with the two boolean value.

public virtual void SetExtend(bool extendStart, bool extendEnd)

Parameters

extendStart bool

if true will extend shading beyond the starting circle of Coords.

extendEnd bool

if true will extend shading beyond the ending circle of Coords.

SetExtend(PdfArray)

Sets the Extend object with the PdfArray of two boolean.

public virtual void SetExtend(PdfArray extend)

Parameters

extend PdfArray

the PdfArray representing Extend object

Remarks

Sets the Extend object with the PdfArray of two boolean. If first is true shading will extend beyond the starting circle of Coords. If second is true shading will extend beyond the ending circle of Coords.