InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IOffsetPath Class Referenceabstract

#include <IOffsetPath.h>

Inheritance diagram for IOffsetPath:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IOFFSETPATH }
 
enum  OffsetStyle { kOffsetArea, kOffsetPath }
 

Public Member Functions

virtual ErrorCode OffsetPath (IPathGeometry const *pathData, IOutlineInfo *offsetPath, PMReal const &amount, OffsetStyle style=kOffsetArea, int32 joinType=kPMRoundJoin, int32 lineCap=kPMButtCap, PMReal const &miterLimit=1.0, bool16 unionPaths=kTrue) const =0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

Interface for outsetting (i.e., negative inset) a path

Member Enumeration Documentation

anonymous enum

default IID for this interface

Offset strategy
Enumerator
kOffsetArea 

old functionality: closes path and offsets hull

kOffsetPath 

offsets stroke, without closing path

Member Function Documentation

virtual ErrorCode IOffsetPath::OffsetPath (IPathGeometry const * pathData,
IOutlineInfooffsetPath,
PMReal const & amount,
OffsetStyle style = kOffsetArea,
int32 joinType = kPMRoundJoin,
int32 lineCap = kPMButtCap,
PMReal const & miterLimit = 1.0,
bool16 unionPaths = kTrue 
) const
pure virtual

Offsets the path by nOffset amount. Will union the paths if bUnionPaths is true can specify join type, line cap, and miter limit directly.

Parameters
pathData- IN: source path
offsetPath- OUT: destination path
amount- IN: non-zero amount to offset
style- IN: offset style
joinType- IN: join type
lineCap- IN: linecap
miterLimit- IN: miter limit
unionPaths- IN: Should paths be unioned
Returns
ErrorCode. kSuccess indicates no error.