The class that extends PdfShading class and is in charge of Shading Dictionary with function-based type, that defines color at every point in the domain by a specified mathematical function. More...

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

Public Member Functions
	FunctionBased (PdfColorSpace colorSpace, IPdfFunction function)
	Creates the new instance of the class. More...

	FunctionBased (PdfObject colorSpace, IPdfFunction function)
	Creates the new instance of the class. More...

virtual PdfArray	GetDomain ()
	Gets the iText.Kernel.Pdf.PdfArray domain rectangle object that establishes an internal coordinate space for the shading that is independent of the target coordinate space in which it shall be painted. More...

virtual void	SetDomain (float xmin, float xmax, float ymin, float ymax)
	Sets the iText.Kernel.Pdf.PdfArray domain rectangle object that establishes an internal coordinate space for the shading that is independent of the target coordinate space in which it shall be painted. More...

virtual void	SetDomain (PdfArray domain)
	Sets the iText.Kernel.Pdf.PdfArray domain rectangle object that establishes an internal coordinate space for the shading that is independent of the target coordinate space in which it shall be painted. More...

virtual PdfArray	GetMatrix ()
	Gets the iText.Kernel.Pdf.PdfArray of floats that represents the transformation matrix that maps the domain rectangle into a corresponding figure in the target coordinate space. More...

virtual void	SetMatrix (float[] matrix)
	Sets the array of floats that represents the transformation matrix that maps the domain rectangle into a corresponding figure in the target coordinate space. More...

virtual void	SetMatrix (PdfArray matrix)
	Sets the array of floats that represents the transformation matrix that maps the domain rectangle into a corresponding figure in the target coordinate space. 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 ()

Package Functions
	FunctionBased (PdfDictionary pdfDictionary)
	Creates the new instance of the class from the existing iText.Kernel.Pdf.PdfDictionary. More...

Package Functions inherited from iText.Kernel.Pdf.Colorspace.PdfShading
	PdfShading (PdfDictionary pdfObject)
	Creates the PdfShading object from the existing iText.Kernel.Pdf.PdfDictionary. More...

	PdfShading (PdfDictionary pdfObject, int type, PdfColorSpace colorSpace)
	Creates the PdfShading object from the existing iText.Kernel.Pdf.PdfDictionary , using provided type and colorspace. More...

override bool	IsWrappedObjectMustBeIndirect ()
	Defines if the object behind this wrapper must be an indirect object in the resultant document. More...

Package Functions inherited from iText.Kernel.Pdf.PdfObjectWrapper< PdfDictionary >
	PdfObjectWrapper (T pdfObject)

virtual void	SetPdfObject (T pdfObject)

virtual void	SetForbidRelease ()

virtual void	UnsetForbidRelease ()

virtual void	EnsureUnderlyingObjectHasIndirectReference ()

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

Static Package Functions inherited from iText.Kernel.Pdf.PdfObjectWrapper< PdfDictionary >
static void	MarkObjectAsIndirect (PdfObject pdfObject)

static void	EnsureObjectIsAddedToDocument (PdfObject @object)
	Some wrappers use object's indirect reference to obtain the `PdfDocument` to which the object belongs to. More...

Detailed Description

The class that extends PdfShading class and is in charge of Shading Dictionary with function-based type, that defines color at every point in the domain by a specified mathematical function.

Constructor & Destructor Documentation

◆ FunctionBased() [1/3]

iText.Kernel.Pdf.Colorspace.PdfShading.FunctionBased.FunctionBased ( PdfDictionary pdfDictionary )

inlinepackage

Creates the new instance of the class from the existing iText.Kernel.Pdf.PdfDictionary.

Parameters

pdfDictionary from which this FunctionBased will be created

◆ FunctionBased() [2/3]

iText.Kernel.Pdf.Colorspace.PdfShading.FunctionBased.FunctionBased	(	PdfColorSpace	colorSpace,
		IPdfFunction	function
	)

inline

Creates the new instance of the class.

Parameters

colorSpace	the PdfColorSpace object in which colour values shall be expressed.
function	the iText.Kernel.Pdf.Function.IPdfFunction , that is used to calculate color transitions.

◆ FunctionBased() [3/3]

iText.Kernel.Pdf.Colorspace.PdfShading.FunctionBased.FunctionBased	(	PdfObject	colorSpace,
		IPdfFunction	function
	)

inline

Creates the new instance of the class.

Parameters

colorSpace	the iText.Kernel.Pdf.PdfObject , that represents color space in which colour values shall be expressed.
function	the iText.Kernel.Pdf.Function.IPdfFunction , that is used to calculate color transitions.

Member Function Documentation

◆ GetDomain()

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

inlinevirtual

Gets the iText.Kernel.Pdf.PdfArray domain rectangle object that establishes an internal coordinate space for the shading that is independent of the target coordinate space in which it shall be painted.

Returns

iText.Kernel.Pdf.PdfArray domain rectangle.

◆ GetMatrix()

virtual PdfArray iText.Kernel.Pdf.Colorspace.PdfShading.FunctionBased.GetMatrix ( )

inlinevirtual

Gets the iText.Kernel.Pdf.PdfArray of floats that represents the transformation matrix that maps the domain rectangle into a corresponding figure in the target coordinate space.

Returns: the iText.Kernel.Pdf.PdfArray of transformation matrix (identical matrix by default).

◆ SetDomain() [1/2]

virtual void iText.Kernel.Pdf.Colorspace.PdfShading.FunctionBased.SetDomain	(	float	xmin,
		float	xmax,
		float	ymin,
		float	ymax
	)

inlinevirtual

Sets the iText.Kernel.Pdf.PdfArray domain rectangle object that establishes an internal coordinate space for the shading that is independent of the target coordinate space in which it shall be painted.

Parameters

xmin	the Xmin coordinate of rectangle.
xmax	the Xmax coordinate of rectangle.
ymin	the Ymin coordinate of rectangle.
ymax	the Ymax coordinate of rectangle.

◆ SetDomain() [2/2]

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

inlinevirtual

Sets the iText.Kernel.Pdf.PdfArray domain rectangle object that establishes an internal coordinate space for the shading that is independent of the target coordinate space in which it shall be painted.

Parameters

domain the iText.Kernel.Pdf.PdfArray domain rectangle object to be set.

◆ SetMatrix() [1/2]

virtual void iText.Kernel.Pdf.Colorspace.PdfShading.FunctionBased.SetMatrix ( float[] matrix )

inlinevirtual

Sets the array of floats that represents the transformation matrix that maps the domain rectangle into a corresponding figure in the target coordinate space.

Parameters

matrix the float[] of transformation matrix to be set.

◆ SetMatrix() [2/2]

virtual void iText.Kernel.Pdf.Colorspace.PdfShading.FunctionBased.SetMatrix ( PdfArray matrix )

inlinevirtual

Sets the array of floats that represents the transformation matrix that maps the domain rectangle into a corresponding figure in the target coordinate space.

Parameters

matrix the iText.Kernel.Pdf.PdfArray transformation matrix object to be set.

Public Member Functions

Package Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FunctionBased() [1/3]

◆ FunctionBased() [2/3]

◆ FunctionBased() [3/3]

Member Function Documentation

◆ GetDomain()

◆ GetMatrix()

◆ SetDomain() [1/2]

◆ SetDomain() [2/2]

◆ SetMatrix() [1/2]

◆ SetMatrix() [2/2]