IPathGeometry.h

//========================================================================================
// 
// $File$
// 
// Owner: Scott Chai
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
// 
// Purpose:
// IPathGeometry is designed to support geometric data of straight and curved paths.
// 
// Path geometry can contain multiple paths. Each path is either open (the default) or closed.
// The relationship between the paths is only that they exist as part of the same object
// 
// IPathGeometry is a required interface of spline type page items. 
// 
//========================================================================================

#ifndef __IPathGeometry__
#define __IPathGeometry__

#include "IPMUnknown.h"
#include "GraphicsID.h"
#include "PMPathPoint.h"

class PMMatrix;
class PMRect;
class PMPathPoint;
class IOutlineInfo;

class IPathGeometry : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IPATHGEOMETRY } ;

 enum { kDefaultPathSize = 8 };

 virtual int32 GetNumPaths() const = 0;

 virtual int32 GetNumPoints(int32 whichPath) const = 0;

 virtual int32 GetNumSegments(int32 whichPath) const = 0;

 virtual PMPathSegmentType GetNthSegment( int32 whichPath, int32 whichSegment, PMPathPointList& pathPtList ) const = 0 ;

 virtual const PMPathPoint& GetNthPoint(int32 whichPath, int32 n) const = 0;

 virtual void GetNthPath( int32 whichPath, PMPathPointList& pathPtList ) const = 0 ;

 virtual int32 GetTotalPoints() const = 0 ;

 virtual bool16 IsEmpty() const = 0 ;

 virtual bool16 IsSinglePoint( PMPathPoint* pt = nil ) const = 0 ;

 virtual bool16 IsMultiPoint() const = 0 ;

 virtual int32 AddNewPath(int32 preallocatePoints = kDefaultPathSize) = 0;

 virtual void InsertNewPath( int32 before, int32 preallocatePoints = kDefaultPathSize ) = 0 ;

 virtual ErrorCode RemoveNthPath(int32 whichPath) = 0;

 virtual void RemoveAllPaths() = 0;

 virtual void RemoveAllButNthPath( int32 whichPath ) = 0 ;

 virtual ErrorCode AddPoint(int32 whichPath, const PMPathPoint &pt) = 0;

 virtual ErrorCode RemoveNthPoint(int32 whichPath, int32 z) = 0;

 virtual ErrorCode RemoveAllPoints (int32 whichPath) = 0;

 virtual ErrorCode InsertNthPoint(int32 whichPath, int32 before, const PMPathPoint &pt) = 0;

 virtual ErrorCode ModifyNthPoint(int32 whichPath, int32 index, const PMPathPoint& pt) = 0;

 virtual void CopyPath (IPathGeometry* fromPath) = 0;

 virtual void CopyNthPath( int32 copyToPathIndex, IPathGeometry* fromPath, int32 copyFromPathIndex ) = 0 ;

 virtual PMRect GetCtrlPointsBoundingBox(const PMMatrix& theMatrix) const = 0;

 virtual PMRect GetCtrlPointsBoundingBox() const = 0;

 virtual void SetCtrlPointsBoundingBox (const PMRect& newPtBBox) = 0;

 virtual void SetCtrlPointsBoundingBox (const PMMatrix& theMatrix, const PMRect& newPtBBox) = 0;

 virtual PMRect GetPathBoundingBox(const PMMatrix& theMatrix) const = 0;

 virtual PMRect GetPathBoundingBox() const = 0;

 virtual void SetPathBoundingBox(const PMMatrix& theMatrix, const PMRect& newBBox) = 0;

 virtual void SetPathBoundingBox(const PMRect& newBBox) = 0;

 virtual void TransformPath (const PMMatrix& theMatrix) = 0;

 virtual void TransformPathPoints( const PointSelectorList& pts,
 const PMMatrix& mat,
 bool16 ignoreSegments,
 bool16 permitFlips ) = 0;

 virtual void GetOutlineInfo (IOutlineInfo* iOutlineInfo) const = 0;

 virtual ErrorCode OpenPath(int32 whichPath) = 0;

 virtual ErrorCode ClosePath(int32 whichPath) = 0;

 virtual bool16 IsPathOpen(int32 whichPath) const = 0;

 virtual ErrorCode ReversePath( int32 whichPath ) = 0 ;

 virtual void GetOutlineInfo( IOutlineInfo* iOutlineInfo, int32 whichPath ) const = 0 ;

 virtual bool16 IsPathClosed( int32 whichPath ) const = 0 ;
} ;

#endif // __IPathGeometry__