LayerPD_Layer
ObjectPDPath

A PDPath is a graphic object (a subclass of PDGraphic) representing a path in a page description. Paths are arbitrary shapes made of straight lines, rectangles, and cubic curves. Path objects may be filled or stroked, and they can serve as a clipping path. For details, see the following sections in the PDF Reference:


Typedef Summary
 Typedef
 PDPath
 PDPathEnumMonitor
 PDPathEnumMonitorRec
Enumeration Summary
 Enumeration
  PDPathPaintOp
A path object consists of a sequence of segment operators (moveto, lineto, an so on), as well as a set of operations to be performed with the path. Note that the operations include doing nothing, closing, stroking, filling and using the path as a clip.
  PDPathSegmentOp
A path object consists of a sequence of segment operators (moveto, lineto, and so on), as well as a set of operations to be performed with the path. Note that the operations include doing nothing, closing, stroking, filling and using the path as a clip.
Structure Summary
 Structure
 _t_PDPathEnumMonitor
A data structure containing callbacks used by PDPathEnum(). One callback is called for each path operator encountered; the callback to call depends on the operator.
Callback Summary
 Callback
 PDPathClosePathProc
A callback for PDPathEnumMonitor. It is called for every path closing operator.
 PDPathCurveToProc
A callback for PDPathEnumMonitor. It is called for every c operator.
 PDPathLineToProc
A callback for PDPathEnumMonitor. It is called for every l operator.
 PDPathMoveToProc
A callback for PDPathEnumMonitor. It is called for every m operator.
 PDPathRectProc
A callback for PDPathEnumMonitor. It is called for every re operator.
 PDPathVCurveToProc
A callback for PDPathEnumMonitor. It is called for every v operator.
 PDPathYCurveToProc
A callback for PDPathEnumMonitor. It is called for every y operator.
Method Summary
 Method
 
void PDPathEnum(PDPath obj, PDPathEnumMonitor mon, void* clientData)
Enumerates the specified path's operators, calling one of several user-supplied callbacks for each operator. The callback that is called depends on which operator is encountered.
 
ASInt32 PDPathGetPaintOp(PDPath obj)
Gets flags that indicate which paint/close/clip operators are used for the specified path. For a description of the path painting operators, see Section 4.4.2 in the PDF Reference.

Typedefs Detail
PDPath 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef struct _t_PDGraphic* PDPath;

File: PDExpT.h
Line: 2413
PDPathEnumMonitor 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PDPathEnumMonitor PDPathEnumMonitor;

File: PDExpT.h
Line: 2945
PDPathEnumMonitorRec 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PDPathEnumMonitor PDPathEnumMonitorRec;

File: PDExpT.h
Line: 2970

Enumeration Detail
PDPathPaintOp
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

enum PDPathPaintOp {
 pdPathNoPaint = 0,
 
 pdPathOpClose = 1,
 
 pdPathStroke = 2,
 
 pdPathFill = 4,
 
 pdPathEOFill = 8,
 
 pdPathClip = 16,
 
 pdPathEOClip = 32
}

See Also

PDPathSegmentOp
PDPathGetPaintOp

File: PDExpT.h
Line: 2459

Elements
pdPathNoPaint  

The path is not painted.

 
pdPathOpClose  

The path contains a closepath operator.

 
pdPathStroke  

The path contains a stroke operator.

 
pdPathFill  

The path contains a fill operator.

 
pdPathEOFill  

The path contains an eofill operator.

 
pdPathClip  

The path contains a clip operator.

 
pdPathEOClip  

The path contains an eoclip operator.

PDPathSegmentOp 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

enum PDPathSegmentOp {
 pdSegMoveTo,
 
 pdSegLineTo,
 
 pdSegCurveTo,
 
 pdSegVCurveTo,
 
 pdSegYCurveTo,
 
 pdSegRect,
 
 pdSegClosePath
}

See Also

PDPathPaintOp

File: PDExpT.h
Line: 2433


Structure Detail
_t_PDPathEnumMonitor
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_PDPathEnumMonitor {
 ASSize_t size; 
 
 PDPathMoveToProc MoveTo; 
 
 PDPathLineToProc LineTo; 
 
 PDPathCurveToProc CurveTo; 
 
 PDPathVCurveToProc VCurveTo; 
 
 PDPathYCurveToProc YCurveTo; 
 
 PDPathRectProc Rect; 
 
 PDPathClosePathProc ClosePath; 
}

A data structure containing callbacks used by PDPathEnum(). One callback is called for each path operator encountered; the callback to call depends on the operator.

See Also

PDPathEnum

File: PDExpT.h
Line: 2953

Elements
size  

The size of the data structure. It must be set to sizeof(PDPathEnumMonitorRec).

 
Callbacks Detail
PDPathClosePathProc 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool (*PDPathClosePathProc)(void *clientData)

A callback for PDPathEnumMonitor. It is called for every path closing operator.

See Also

PDPathEnum

File: PDExpT.h
Line: 2943
PDPathCurveToProc 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool (*PDPathCurveToProc)(ASFixedPoint *p1, ASFixedPoint *p2, ASFixedPoint *p3, void *clientData)

A callback for PDPathEnumMonitor. It is called for every c operator.

See Also

PDPathEnum

File: PDExpT.h
Line: 2893
PDPathLineToProc 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool (*PDPathLineToProc)(ASFixedPoint *p1, void *clientData)

A callback for PDPathEnumMonitor. It is called for every l operator.

See Also

PDPathEnum

File: PDExpT.h
Line: 2879
PDPathMoveToProc 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool (*PDPathMoveToProc)(ASFixedPoint *p1, void *clientData)

A callback for PDPathEnumMonitor. It is called for every m operator.

See Also

PDPathEnum

File: PDExpT.h
Line: 2866
PDPathRectProc 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool (*PDPathRectProc)(ASFixedPoint *p1, ASFixedPoint *p2, void *clientData)

A callback for PDPathEnumMonitor. It is called for every re operator.

See Also

PDPathEnum

File: PDExpT.h
Line: 2932
PDPathVCurveToProc 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool (*PDPathVCurveToProc)(ASFixedPoint *p1, ASFixedPoint *p2, void *clientData)

A callback for PDPathEnumMonitor. It is called for every v operator.

See Also

PDPathEnum

File: PDExpT.h
Line: 2906
PDPathYCurveToProc 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool (*PDPathYCurveToProc)(ASFixedPoint *p1, ASFixedPoint *p2, void *clientData)

A callback for PDPathEnumMonitor. It is called for every y operator.

See Also

PDPathEnum

File: PDExpT.h
Line: 2919

Method Detail
PDPathEnum()
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PDPathEnum(PDPath obj, PDPathEnumMonitor mon, void* clientData)

Enumerates the specified path's operators, calling one of several user-supplied callbacks for each operator. The callback that is called depends on which operator is encountered.

Parameters

obj — 

IN/OUT The path whose operators are enumerated.

 
mon — 

IN/OUT A pointer to a structure that contains callbacks. One of the callbacks will be called for each path segment operator in the path. Enumeration ends if any of the monitor's callbacks returns false.

 
clientData — 

IN/OUT A pointer to user-supplied data to pass to the monitor's callbacks each time one is called.

Since

PI_PDMODEL_VERSION >= 0x00020000

File: PDProcs.h
Line: 3637
PDPathGetPaintOp() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

ASInt32 PDPathGetPaintOp(PDPath obj)

Gets flags that indicate which paint/close/clip operators are used for the specified path. For a description of the path painting operators, see Section 4.4.2 in the PDF Reference.

Parameters

obj — 

IN/OUT The path whose painting operators are obtained.

Returns

A bit-wise OR of the PDPathPaintOp flags.

Since

PI_PDMODEL_VERSION >= 0x00020000

File: PDProcs.h
Line: 3650



Copyright 2020 Adobe Systems Incorporated and its licensors. All rights reserved. Adobe and the Adobe logo are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States and/or other countries. This product contains either BSAFE and/or TIPEM software by RSA Security, Inc. Portions utilize Microsoft Windows Media Technologies. Copyright © 2006 Microsoft Corporation. All Rights Reserved. Notices, terms and conditions pertaining to other third party software are located at http://www.adobe.com/go/thirdparty/ and incorporated herein by reference.
Wed Feb 7 2024, 2:16 pm IST