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.
 
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: 2410
PDPathEnumMonitor 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PDPathEnumMonitor PDPathEnumMonitor;

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

Syntax

typedef _t_PDPathEnumMonitor PDPathEnumMonitorRec;

File: PDExpT.h
Line: 2967

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


File: PDExpT.h
Line: 2456

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


File: PDExpT.h
Line: 2430


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


File: PDExpT.h
Line: 2950

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


File: PDExpT.h
Line: 2940
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


File: PDExpT.h
Line: 2890
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


File: PDExpT.h
Line: 2876
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


File: PDExpT.h
Line: 2863
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


File: PDExpT.h
Line: 2929
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


File: PDExpT.h
Line: 2903
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


File: PDExpT.h
Line: 2916

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: 3636
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: 3649