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

#include <IPathStorage.h>

Inheritance diagram for IPathStorage:
IPMUnknown

Public Member Functions

virtual void ReplayPath (IViewPort *dstPort)=0
 
virtual void CapturePath (IViewPort *srcPort)=0
 
virtual void ClearPath ()=0
 
virtual void GetPathInfo (IOutlineInfo *callBack)=0
 
virtual int32 GetNumPathSegs ()=0
 
virtual void moveto (const PMReal &x, const PMReal &y)=0
 
virtual void lineto (const PMReal &x, const PMReal &y)=0
 
virtual void curveto (const PMReal &x1, const PMReal &y1, const PMReal &x2, const PMReal &y2, const PMReal &x3, const PMReal &y3)=0
 
virtual void closepath ()=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 to be used to store an Adobe imaging model path in an in-memory data structure. The basic path API is similar to that exposed by IOutlineInfo.

See Also
IOutlineInfo

Member Function Documentation

virtual void IPathStorage::CapturePath (IViewPortsrcPort)
pure virtual

Captures the path currently stored in the specified viewport. Assumes that the viewport has an aggregated IRasterPort.

Parameters
srcPortIN The port from which the path is captured
See Also
IRasterPort
virtual void IPathStorage::ClearPath ()
pure virtual

Clears the path stored by this object.

virtual void IPathStorage::closepath ()
pure virtual

Closes the current subpath. If the first point in the subpath (defined by a prior call to moveto) does not correspond to the current point, this call will implicitly add a line segment from the current point to the first point in the subpath.

The current point is undefined after a call to closepath. The caller must call moveto to start a new subpath and establish the current point before calling either lineto, curveto, or closepath.

virtual void IPathStorage::curveto (const PMRealx1,
const PMRealy1,
const PMRealx2,
const PMRealy2,
const PMRealx3,
const PMRealy3 
)
pure virtual

Adds a new bezier curve segment to the current subpath, using four control points. The current point in user space at the time the call is made is used as the starting point for the curve. (x1, y1) and (x2, y2) are used as control points defining the degree of curvature and magnitude of the curve, and (x3, y3) defines the end point. The current point is implicitly set to (x3, y3).

Parameters
x1IN The x-component for the first control point of the new bezier segment
y1IN The y-component for the first control point of the new bezier segment
x2IN The x-component for the second control point of the new bezier segment
y2IN The y-component for the second control point of the new bezier segment
x3IN The x-component for the end point of the new bezier segment
y3IN The y-component for the end point of the new bezier segment
virtual int32 IPathStorage::GetNumPathSegs ()
pure virtual

Returns the number of segments in the path stored by this object

Returns
The number of segments in the stored path
virtual void IPathStorage::GetPathInfo (IOutlineInfocallBack)
pure virtual

Gets the path stored by this object using an IOutlineInfo glue object to capture the path.

Parameters
callBackIN The outline info called back on as the path is gotten
virtual void IPathStorage::lineto (const PMRealx,
const PMRealy 
)
pure virtual

Adds a line segment to the current subpath. The beginning of the segment is the current point in user space at the time the call is made. The end is (x, y). Implicitly sets the current point to (x, y).

Parameters
xIN The x-component for the end point of the new line segment
yIN The y-component for the end point of the new line segment
virtual void IPathStorage::moveto (const PMRealx,
const PMRealy 
)
pure virtual

Starts a new subpath. The current point in user space is set to (x, y).

Parameters
xIN The x-component of the new current point
yIN The y-component of the new current point
virtual void IPathStorage::ReplayPath (IViewPortdstPort)
pure virtual

Replays the path stored by this object into the specified viewport. Assumes that the viewport has an aggregated IGraphicsPort.

Parameters
dstPortIN The port into which the path is played
See Also
IGraphicsPort