Contains information relating to painting current path. More...

Inheritance diagram for iText.Kernel.Pdf.Canvas.Parser.Data.PathRenderInfo:

Public Member Functions
	PathRenderInfo (Stack< CanvasTag > canvasTagHierarchy, CanvasGraphicsState gs, Path path, int operation, int rule, bool isClip, int clipRule)
	Creates the new PathRenderInfo instance. More...

	PathRenderInfo (Stack< CanvasTag > canvasTagHierarchy, CanvasGraphicsState gs, Path path, int operation)
	If the operation is NO_OP then the rule is ignored, otherwise iText.Kernel.Pdf.Canvas.PdfCanvasConstants.FillingRule.NONZERO_WINDING is used by default. More...

virtual Path	GetPath ()
	Gets the iText.Kernel.Geom.Path to be rendered More...

virtual int	GetOperation ()
	Gets the `int` value which is either NO_OP or one of possible combinations of STROKE and FILL. More...

virtual int	GetRule ()
	Gets either iText.Kernel.Pdf.Canvas.PdfCanvasConstants.FillingRule.NONZERO_WINDING or iText.Kernel.Pdf.Canvas.PdfCanvasConstants.FillingRule.EVEN_ODD. More...

virtual bool	IsPathModifiesClippingPath ()
	Gets the clipping path flag. More...

virtual int	GetClippingRule ()
	Gets either iText.Kernel.Pdf.Canvas.PdfCanvasConstants.FillingRule.NONZERO_WINDING or iText.Kernel.Pdf.Canvas.PdfCanvasConstants.FillingRule.EVEN_ODD. More...

virtual Matrix	GetCtm ()
	Gets the current transformation matrix. More...

virtual float	GetLineWidth ()
	Gets the path's line width. More...

virtual int	GetLineCapStyle ()
	Gets the line cap style. More...

virtual int	GetLineJoinStyle ()
	Gets the line join style. More...

virtual float	GetMiterLimit ()
	Gets the miter limit. More...

virtual PdfArray	GetLineDashPattern ()
	Gets the path's dash pattern. More...

virtual Color	GetStrokeColor ()
	Gets the path's stroke color. More...

virtual Color	GetFillColor ()
	Gets the path's fill color. More...

virtual IList< CanvasTag >	GetCanvasTagHierarchy ()
	Gets hierarchy of the canvas tags that wraps given text. More...

virtual int	GetMcid ()
	Gets the marked-content identifier associated with this PathRenderInfo instance More...

virtual bool	HasMcid (int mcid)
	Checks if the text belongs to a marked content sequence with a given mcid. More...

virtual bool	HasMcid (int mcid, bool checkTheTopmostLevelOnly)
	Checks if the text belongs to a marked content sequence with a given mcid. More...

Public Member Functions inherited from iText.Kernel.Pdf.Canvas.Parser.Data.AbstractRenderInfo
	AbstractRenderInfo (CanvasGraphicsState gs)

virtual CanvasGraphicsState	GetGraphicsState ()

virtual bool	IsGraphicsStatePreserved ()

virtual void	PreserveGraphicsState ()

virtual void	ReleaseGraphicsState ()

Static Public Attributes
const int	NO_OP = 0
	End the path object without filling or stroking it. More...

const int	STROKE = 1
	Value specifying stroke operation to perform on the current path. More...

const int	FILL = 2
	Value specifying fill operation to perform on the current path. More...

Detailed Description

Contains information relating to painting current path.

Constructor & Destructor Documentation

◆ PathRenderInfo() [1/2]

iText.Kernel.Pdf.Canvas.Parser.Data.PathRenderInfo.PathRenderInfo	(	Stack< CanvasTag >	canvasTagHierarchy,
		CanvasGraphicsState	gs,
		Path	path,
		int	operation,
		int	rule,
		bool	isClip,
		int	clipRule
	)

inline

Creates the new PathRenderInfo instance.

Parameters

canvasTagHierarchy	the canvas tag hierarchy
gs	the graphics state
path	the path to be rendered
operation	one of the possible combinations of STROKE and FILL values or NO_OP
rule	either iText.Kernel.Pdf.Canvas.PdfCanvasConstants.FillingRule.NONZERO_WINDING or iText.Kernel.Pdf.Canvas.PdfCanvasConstants.FillingRule.EVEN_ODD
isClip

true indicates that current path modifies the clipping path

Parameters

clipRule either iText.Kernel.Pdf.Canvas.PdfCanvasConstants.FillingRule.NONZERO_WINDING or iText.Kernel.Pdf.Canvas.PdfCanvasConstants.FillingRule.EVEN_ODD

◆ PathRenderInfo() [2/2]

iText.Kernel.Pdf.Canvas.Parser.Data.PathRenderInfo.PathRenderInfo	(	Stack< CanvasTag >	canvasTagHierarchy,
		CanvasGraphicsState	gs,
		Path	path,
		int	operation
	)

inline

If the operation is NO_OP then the rule is ignored, otherwise iText.Kernel.Pdf.Canvas.PdfCanvasConstants.FillingRule.NONZERO_WINDING is used by default.

If the operation is NO_OP then the rule is ignored, otherwise iText.Kernel.Pdf.Canvas.PdfCanvasConstants.FillingRule.NONZERO_WINDING is used by default. With this constructor path is considered as not modifying clipping path.

See PathRenderInfo(System.Collections.Generic.Stack, iText.Kernel.Pdf.Canvas.CanvasGraphicsState, iText.Kernel.Geom.Path, int, int, bool, int)

Parameters

canvasTagHierarchy	the canvas tag hierarchy
gs	the graphics state
path	the path to be rendered
operation	one of the possible combinations of STROKE and FILL values or NO_OP

Member Function Documentation

◆ GetCanvasTagHierarchy()

virtual IList<CanvasTag> iText.Kernel.Pdf.Canvas.Parser.Data.PathRenderInfo.GetCanvasTagHierarchy ( )

inlinevirtual

Gets hierarchy of the canvas tags that wraps given text.

Returns: list of the wrapping canvas tags. The first tag is the innermost (nearest to the text)

◆ GetClippingRule()

virtual int iText.Kernel.Pdf.Canvas.Parser.Data.PathRenderInfo.GetClippingRule ( )

inlinevirtual

Gets either iText.Kernel.Pdf.Canvas.PdfCanvasConstants.FillingRule.NONZERO_WINDING or iText.Kernel.Pdf.Canvas.PdfCanvasConstants.FillingRule.EVEN_ODD.

Returns: the clipping rule value

◆ GetCtm()

virtual Matrix iText.Kernel.Pdf.Canvas.Parser.Data.PathRenderInfo.GetCtm ( )

inlinevirtual

Gets the current transformation matrix.

Returns: the current transformation matrix

◆ GetFillColor()

virtual Color iText.Kernel.Pdf.Canvas.Parser.Data.PathRenderInfo.GetFillColor ( )

inlinevirtual

Gets the path's fill color.

Returns: the path's fill color

◆ GetLineCapStyle()

virtual int iText.Kernel.Pdf.Canvas.Parser.Data.PathRenderInfo.GetLineCapStyle ( )

inlinevirtual

Gets the line cap style.

Gets the line cap style. See iText.Kernel.Pdf.Canvas.PdfCanvasConstants.LineCapStyle.

Returns: the line cap style value

◆ GetLineDashPattern()

virtual PdfArray iText.Kernel.Pdf.Canvas.Parser.Data.PathRenderInfo.GetLineDashPattern ( )

inlinevirtual

Gets the path's dash pattern.

Returns: the path's dash pattern as a iText.Kernel.Pdf.PdfArray

◆ GetLineJoinStyle()

virtual int iText.Kernel.Pdf.Canvas.Parser.Data.PathRenderInfo.GetLineJoinStyle ( )

inlinevirtual

Gets the line join style.

Gets the line join style. See iText.Kernel.Pdf.Canvas.PdfCanvasConstants.LineJoinStyle.

Returns: the line join style value

◆ GetLineWidth()

virtual float iText.Kernel.Pdf.Canvas.Parser.Data.PathRenderInfo.GetLineWidth ( )

inlinevirtual

Gets the path's line width.

Returns: the path's line width

◆ GetMcid()

virtual int iText.Kernel.Pdf.Canvas.Parser.Data.PathRenderInfo.GetMcid ( )

inlinevirtual

Gets the marked-content identifier associated with this PathRenderInfo instance

Returns: associated marked-content identifier or -1 in case content is unmarked

◆ GetMiterLimit()

virtual float iText.Kernel.Pdf.Canvas.Parser.Data.PathRenderInfo.GetMiterLimit ( )

inlinevirtual

Gets the miter limit.

Returns: the miter limit

◆ GetOperation()

virtual int iText.Kernel.Pdf.Canvas.Parser.Data.PathRenderInfo.GetOperation ( )

inlinevirtual

Gets the int value which is either NO_OP or one of possible combinations of STROKE and FILL.

Returns: the operation value

◆ GetPath()

virtual Path iText.Kernel.Pdf.Canvas.Parser.Data.PathRenderInfo.GetPath ( )

inlinevirtual

Gets the iText.Kernel.Geom.Path to be rendered

Returns: the iText.Kernel.Geom.Path to be rendered

◆ GetRule()

virtual int iText.Kernel.Pdf.Canvas.Parser.Data.PathRenderInfo.GetRule ( )

inlinevirtual

Gets either iText.Kernel.Pdf.Canvas.PdfCanvasConstants.FillingRule.NONZERO_WINDING or iText.Kernel.Pdf.Canvas.PdfCanvasConstants.FillingRule.EVEN_ODD.

Returns: the rule value

◆ GetStrokeColor()

virtual Color iText.Kernel.Pdf.Canvas.Parser.Data.PathRenderInfo.GetStrokeColor ( )

inlinevirtual

Gets the path's stroke color.

Returns: the path's stroke color

◆ HasMcid() [1/2]

virtual bool iText.Kernel.Pdf.Canvas.Parser.Data.PathRenderInfo.HasMcid ( int mcid )

inlinevirtual

Checks if the text belongs to a marked content sequence with a given mcid.

Parameters

mcid	a marked content id

Returns

true if the text is marked with this id

◆ HasMcid() [2/2]

virtual bool iText.Kernel.Pdf.Canvas.Parser.Data.PathRenderInfo.HasMcid	(	int	mcid,
		bool	checkTheTopmostLevelOnly
	)

inlinevirtual

Checks if the text belongs to a marked content sequence with a given mcid.

Parameters

mcid	a marked content id
checkTheTopmostLevelOnly	indicates whether to check the topmost level of marked content stack only

Returns

true if the text is marked with this id

◆ IsPathModifiesClippingPath()

virtual bool iText.Kernel.Pdf.Canvas.Parser.Data.PathRenderInfo.IsPathModifiesClippingPath ( )

inlinevirtual

Gets the clipping path flag.

Returns

true indicates that current path modifies the clipping path

Member Data Documentation

◆ FILL

const int iText.Kernel.Pdf.Canvas.Parser.Data.PathRenderInfo.FILL = 2

static

Value specifying fill operation to perform on the current path.

Value specifying fill operation to perform on the current path. When the fill operation is performed it should use either nonzero winding or even-odd rule.

◆ NO_OP

const int iText.Kernel.Pdf.Canvas.Parser.Data.PathRenderInfo.NO_OP = 0

static

End the path object without filling or stroking it.

End the path object without filling or stroking it. This operator shall be a path-painting no-op, used primarily for the side effect of changing the current clipping path

◆ STROKE

const int iText.Kernel.Pdf.Canvas.Parser.Data.PathRenderInfo.STROKE = 1

static

Value specifying stroke operation to perform on the current path.

Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PathRenderInfo() [1/2]

◆ PathRenderInfo() [2/2]

Member Function Documentation

◆ GetCanvasTagHierarchy()

◆ GetClippingRule()

◆ GetCtm()

◆ GetFillColor()

◆ GetLineCapStyle()

◆ GetLineDashPattern()

◆ GetLineJoinStyle()

◆ GetLineWidth()

◆ GetMcid()

◆ GetMiterLimit()

◆ GetOperation()

◆ GetPath()

◆ GetRule()

◆ GetStrokeColor()

◆ HasMcid() [1/2]

◆ HasMcid() [2/2]

◆ IsPathModifiesClippingPath()

Member Data Documentation

◆ FILL

◆ NO_OP

◆ STROKE