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

Inheritance diagram for iText.Kernel.Pdf.Colorspace.PdfShading.Radial:

Public Member Functions
	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. More...

	Radial (PdfColorSpace cs, float x0, float y0, float r0, float[] color0, float x1, float y1, float r1, float[] color1, bool[] extend)
	Creates the new instance of the class. More...

	Radial (PdfColorSpace cs, PdfArray coords, IPdfFunction function)
	Creates the new instance of the class. More...

virtual PdfArray	GetCoords ()
	Gets the coords iText.Kernel.Pdf.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. More...

virtual void	SetCoords (float x0, float y0, float r0, float x1, float y1, float r1)
	Sets the coords object. More...

virtual void	SetCoords (PdfArray coords)
	Sets the coords iText.Kernel.Pdf.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. More...

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

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

virtual void	SetDomain (PdfArray domain)
	Sets the Domain with the iText.Kernel.Pdf.PdfArray of two `float` [t0, t1] that represent the limiting values of a parametric variable t, that becomes an input of color function(s). More...

virtual PdfArray	GetExtend ()
	Gets the iText.Kernel.Pdf.PdfArray of two `boolean` that specified whether to extend the shading beyond the starting and ending circles of the axis, respectively. More...

virtual void	SetExtend (bool extendStart, bool extendEnd)
	Sets the Extend object with the two `boolean` value. More...

virtual void	SetExtend (PdfArray extend)
	Sets the Extend object with the iText.Kernel.Pdf.PdfArray of two `boolean`. More...

Public Member Functions inherited from iText.Kernel.Pdf.Colorspace.PdfShading
virtual int	GetShadingType ()
	Gets the shading type. More...

virtual PdfObject	GetColorSpace ()
	Gets the color space in which colour values shall be expressed. More...

virtual PdfObject	GetFunction ()
	Gets the function PdfObject that represents color transitions across the shading geometry. More...

virtual void	SetFunction (IPdfFunction function)
	Sets the function that represents color transitions across the shading geometry as one object. More...

virtual void	SetFunction (IPdfFunction[] functions)
	Sets the function object that represents color transitions across the shading geometry as an array of functions. More...

override void	Flush ()
	To manually flush a `PdfObject` behind this wrapper, you have to ensure that this object is added to the document, i.e. it has an indirect reference. More...

Public Member Functions inherited from iText.Kernel.Pdf.PdfObjectWrapper< PdfDictionary >
virtual T	GetPdfObject ()

virtual iText.Kernel.Pdf.PdfObjectWrapper< T >	MakeIndirect (PdfDocument document, PdfIndirectReference reference)
	Marks object behind wrapper to be saved as indirect. More...

virtual iText.Kernel.Pdf.PdfObjectWrapper< T >	MakeIndirect (PdfDocument document)
	Marks object behind wrapper to be saved as indirect. More...

virtual iText.Kernel.Pdf.PdfObjectWrapper< T >	SetModified ()

virtual bool	IsFlushed ()

Additional Inherited Members
Static Public Member Functions inherited from iText.Kernel.Pdf.Colorspace.PdfShading
static PdfShading	MakeShading (PdfDictionary shadingDictionary)
	Creates the PdfShading object from the existing iText.Kernel.Pdf.PdfDictionary with corresponding type. More...

Detailed Description

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.

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

Constructor & Destructor Documentation

◆ Radial() [1/3]

iText.Kernel.Pdf.Colorspace.PdfShading.Radial.Radial	(	PdfColorSpace	cs,
		float	x0,
		float	y0,
		float	r0,
		float[]	color0,
		float	x1,
		float	y1,
		float	r1,
		float[]	color1
	)

inline

Creates the new instance of the class.

Parameters

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.

◆ Radial() [2/3]

iText.Kernel.Pdf.Colorspace.PdfShading.Radial.Radial	(	PdfColorSpace	cs,
		float	x0,
		float	y0,
		float	r0,
		float[]	color0,
		float	x1,
		float	y1,
		float	r1,
		float[]	color1,
		bool[]	extend
	)

inline

Creates the new instance of the class.

Parameters

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.

◆ Radial() [3/3]

iText.Kernel.Pdf.Colorspace.PdfShading.Radial.Radial	(	PdfColorSpace	cs,
		PdfArray	coords,
		IPdfFunction	function
	)

inline

Creates the new instance of the class.

Parameters

cs	the PdfColorSpace object in which colour values shall be expressed. The Indexed color space isn't excepted.
coords	the iText.Kernel.Pdf.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 iText.Kernel.Pdf.Function.IPdfFunction object, that is used to calculate color transitions.

Member Function Documentation

◆ GetCoords()

virtual PdfArray iText.Kernel.Pdf.Colorspace.PdfShading.Radial.GetCoords ( )

inlinevirtual

Gets the coords iText.Kernel.Pdf.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.

Gets the coords iText.Kernel.Pdf.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.

Returns: the iText.Kernel.Pdf.PdfArray coords object.

◆ GetDomain()

virtual PdfArray iText.Kernel.Pdf.Colorspace.PdfShading.Radial.GetDomain ( )

inlinevirtual

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

Returns: the iText.Kernel.Pdf.PdfArray of Domain object ([0.0 1.0] by default)

◆ GetExtend()

virtual PdfArray iText.Kernel.Pdf.Colorspace.PdfShading.Radial.GetExtend ( )

inlinevirtual

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

Returns: the iText.Kernel.Pdf.PdfArray of Extended object ([false false] by default)

◆ SetCoords() [1/2]

virtual void iText.Kernel.Pdf.Colorspace.PdfShading.Radial.SetCoords	(	float	x0,
		float	y0,
		float	r0,
		float	x1,
		float	y1,
		float	r1
	)

inlinevirtual

Sets the coords object.

Parameters

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.

◆ SetCoords() [2/2]

virtual void iText.Kernel.Pdf.Colorspace.PdfShading.Radial.SetCoords ( PdfArray coords )

inlinevirtual

Sets the coords iText.Kernel.Pdf.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.

Sets the coords iText.Kernel.Pdf.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.

Parameters

coords

iText.Kernel.Pdf.PdfArray choords object to be set.

◆ SetDomain() [1/2]

virtual void iText.Kernel.Pdf.Colorspace.PdfShading.Radial.SetDomain	(	float	t0,
		float	t1
	)

inlinevirtual

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

Parameters

t0	first limit of variable t
t1	second limit of variable t

◆ SetDomain() [2/2]

virtual void iText.Kernel.Pdf.Colorspace.PdfShading.Radial.SetDomain ( PdfArray domain )

inlinevirtual

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

Parameters

domain the iText.Kernel.Pdf.PdfArray that represents domain

◆ SetExtend() [1/2]

virtual void iText.Kernel.Pdf.Colorspace.PdfShading.Radial.SetExtend	(	bool	extendStart,
		bool	extendEnd
	)

inlinevirtual

Sets the Extend object with the two boolean value.

Parameters

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

◆ SetExtend() [2/2]

virtual void iText.Kernel.Pdf.Colorspace.PdfShading.Radial.SetExtend ( PdfArray extend )

inlinevirtual

Sets the Extend object with the iText.Kernel.Pdf.PdfArray of two boolean.

Sets the Extend object with the iText.Kernel.Pdf.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.

Parameters

extend the iText.Kernel.Pdf.PdfArray representing Extend object

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Radial() [1/3]

◆ Radial() [2/3]

◆ Radial() [3/3]

Member Function Documentation

◆ GetCoords()

◆ GetDomain()

◆ GetExtend()

◆ SetCoords() [1/2]

◆ SetCoords() [2/2]

◆ SetDomain() [1/2]

◆ SetDomain() [2/2]

◆ SetExtend() [1/2]

◆ SetExtend() [2/2]