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

#include <IModifyPathPointsCmdData.h>

Inheritance diagram for IModifyPathPointsCmdData:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IMODIFYPATHPOINTSCMDDATA }
 

Public Member Functions

virtual void SetStartingIndex (int32 startingIndex)=0
 
virtual void SetNumPoints (int32 numPoints)=0
 
virtual void SetPathIndex (int32 pathIndex)=0
 
virtual void SetTransformMatrix (const PMMatrix &transformMatrix)=0
 
virtual int32 GetPathIndex () const =0
 
virtual int32 GetStartingIndex () const =0
 
virtual int32 GetNumPoints () const =0
 
virtual PMMatrix GetTransformMatrix () 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

Specifies the points to modify in an existing page item.

For Modify path and Remove path point commands, all arguments are used. For Add point commands, only SetStartingIndex and SetPathIndex are used. In the Add case the starting index indicates the place the cmd should insert before. i.e if index is 4 the add cmd inserts before index 4. If the index is -1 the add command appends the new points. If the pathIndex is equal to the current number of paths the cmd creates a new path. If pathIndex is -1 add points creates a new path, appends the points to the new path, and returns the new index via this interface (it changes pathIndex). If the number of points to add is zero in the path geometry interface of the command, then add points simply creates a new path with no points.

If both startingIndex and pathIndex are equal to -1, then add points appends all of the paths and points from the command to the pageitem.

Member Function Documentation

virtual int32 IModifyPathPointsCmdData::GetNumPoints () const
pure virtual

Returns the number of points to be modified

virtual int32 IModifyPathPointsCmdData::GetPathIndex () const
pure virtual

Returns the path the cmd should modify

virtual int32 IModifyPathPointsCmdData::GetStartingIndex () const
pure virtual

Returns the starting index

virtual PMMatrix IModifyPathPointsCmdData::GetTransformMatrix () const
pure virtual

Return the matrix used for transformations

virtual void IModifyPathPointsCmdData::SetNumPoints (int32 numPoints)
pure virtual

Indicates the number of consecutive points to be modified

virtual void IModifyPathPointsCmdData::SetPathIndex (int32 pathIndex)
pure virtual

Indicates which path the modification should occur. Only one path per modify path points/add points/ remove points

virtual void IModifyPathPointsCmdData::SetStartingIndex (int32 startingIndex)
pure virtual

Indicates the starting index in the pageitem's path geometry

virtual void IModifyPathPointsCmdData::SetTransformMatrix (const PMMatrixtransformMatrix)
pure virtual

Indicates the transformation to use when adding of modifying points