IPathUtils.h

//========================================================================================
// 
// $File$
// 
// Owner: Bernd Paradies
// 
// $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.
// 
//========================================================================================

#ifndef __IPathUtils__
#define __IPathUtils__

#include "GenericID.h"
#include "IPMUnknown.h"
#include "Utils.h"

#include "INewPageItemCmdData.h"
#include "TransformTypes.h" // CoordinateSpace
#include "PMPathPoint.h"
#include "PMRect.h"
#include "UIDList.h"

enum PMPageItemType {
 kIsPoint, 
 kIsLine, 
 kIsSquare, 
 kIsRectangle,
 kIsCircle,
 kIsOval,
 kIsEllipse = kIsOval,
 kIsPoly,
 kIsPath,
 kIsCompoundPath,
 kPMUnknownType
};

class IPathGeometry;
class IHandleShape;
class IPathSelectionList;
class IPathSelectionSuite;
class PathSelectionList;
class ITransform;
class IHierarchy;


class IPathUtils : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IPATHUTILS };


 virtual UIDRef CreateRectangleSpline
 (
 const UIDRef& parent,
 PMRect& boundsRect,
 INewPageItemCmdData::GraphicAttrType attrType,
 ClassID itemClass,
 bool16 bAllowDefaultStandOff = kTrue,
 const Transform::CoordinateSpace &boundsSpace = Transform::PasteboardCoordinates(),
 INewPageItemCmdData::ObjectStyleApplication howToApplyObjStyle = INewPageItemCmdData::kCommandAppliesObjectStyle
 ) const = 0;

 virtual UIDRef CreateRectangleSpline
 (
 const UIDRef& parent,
 PMRect& boundsRect,
 INewPageItemCmdData::GraphicAttrType attrType,
 bool16 bAllowDefaultStandOff = kTrue,
 const Transform::CoordinateSpace &boundsSpace = Transform::PasteboardCoordinates()
 ) const = 0;
 
 virtual UIDRef CreateOvalSpline
 (
 const UIDRef& parent,
 PMRect& boundsRect,
 INewPageItemCmdData::GraphicAttrType attrType,
 bool16 bAllowDefaultStandOff = kTrue,
 const Transform::CoordinateSpace &boundsSpace = Transform::PasteboardCoordinates()
 ) const = 0;

 virtual UIDRef CreateLineSpline
 (
 const UIDRef& parent,
 const PMPointList& pathPoints,
 INewPageItemCmdData::GraphicAttrType attrType,
 bool16 bAllowDefaultStandOff = kTrue,
 const Transform::CoordinateSpace &boundsSpace = Transform::PasteboardCoordinates()
 ) const = 0;
 
 virtual UIDRef CreateSpline
 (
 const UIDRef& parent,
 const PMPathPointList& pathPointList,
 INewPageItemCmdData::GraphicAttrType attrType,
 bool16 bAllowDefaultStandOff = kTrue,
 bool16 bClosedPath = kTrue,
 const Transform::CoordinateSpace &boundsSpace = Transform::PasteboardCoordinates()
 ) const = 0;
 
 virtual UIDRef CreateRegPolySpline
 (
 const UIDRef& parent,
 PMRect& boundsRect,
 int32 numSides,
 int32 starInset,
 INewPageItemCmdData::GraphicAttrType attrType,
 bool16 bAllowDefaultStandOff = kTrue,
 const Transform::CoordinateSpace &boundsSpace = Transform::PasteboardCoordinates()
 ) const = 0;

 virtual void MakeLinePath
 (
 IPathGeometry* iPathGeometry,
 const PMPointList& pathPoints
 ) const = 0;


 virtual void MakeRectanglePath
 (
 IPathGeometry* iPathGeometry,
 const PMRect& boundsRect
 ) const = 0;
 
 virtual void MakeOvalPath
 (
 IPathGeometry* iPathGeometry,
 const PMRect& boundsRect
 ) const = 0;
 
 virtual void MakeRegPolyPath
 (
 IPathGeometry* iPathGeometry,
 const PMRect& boundsRect,
 int32 numSides,
 int32 starInset
 ) const = 0;
 
 virtual void MakeSplinePath
 (
 IPathGeometry* iPathGeometry,
 const PMPathPointList& pathPointList,
 bool16 bClosePath = kTrue
 ) const = 0;

 virtual void MakeUnitCirclePolygon
 (
 PMPointList& polyPts,
 int32 numSides,
 int32 starInset
 ) const = 0;
 

 virtual bool16 CalculateDirectionPoints(const IPathGeometry* iPathGeometry, const PMPathPoint& thePoint, const int32 pathIndex, const int32 pointIndex, PMPoint& leftDirPt, PMPoint& rightDirPt) const = 0;


 virtual bool16 IsSquare( const IPathGeometry* iPathGeometry ) const = 0;

 virtual bool16 IsRectangle( const IPathGeometry* iPathGeometry ) const = 0;

 virtual bool16 IsPoint( const IPathGeometry* iPathGeometry ) const = 0;

 virtual bool16 IsLine( const IPathGeometry* iPathGeometry ) const = 0;

 virtual bool16 IsOval( const IPathGeometry* iPathGeometry ) const = 0;

 virtual bool16 IsCircle( const IPathGeometry* iPathGeometry ) const = 0;

 virtual bool16 IsPolygon( const IPathGeometry* iPathGeometry ) const = 0;

 virtual bool16 IsCompoundPath( const IPathGeometry* iPathGeometry ) const = 0;

 virtual PMPageItemType WhichKindOfPageItem( const IPathGeometry* iPathGeometry ) const = 0;


 virtual void AppendPathPointSelectors( IPathGeometry* pathGeom, int32 pathIndex, PointSelectorList& pts ) const = 0;

 virtual void AppendAllPathPointSelectors( IPathGeometry* pathGeom, PointSelectorList& pts ) const = 0;

 virtual bool16 IsPathSelectable( const IPMUnknown* pageItem ) const = 0;

 virtual bool16 IsPathSelectable( const UIDRef& pageItem ) const = 0;

 virtual void AppendNonPathSelectables( const UIDList& selectionList, UIDList& itemList ) const = 0;

 virtual void FilterUnselectedPathObjects( const IPathSelectionSuite* pathSelectionSuite, UIDList& itemList ) const = 0;

 virtual void FilterNonPathSelectables( UIDList& itemList ) const = 0;

 virtual bool16 AllPointsOnObjectSelected( IPathSelectionList* pathSelectionList, IPathGeometry* pathGeom ) const = 0;

 //virtual bool16 AllPointsOnPathSelected( IPathSelectionList* pathSelectionList, IPathGeometry* pathGeom, int32 pathIndex ) const = 0;

 virtual bool16 AllPointsOnObjectSelected( IPathGeometry* pathGeom, const PointSelectorList& pts ) const = 0;
 virtual bool16 AllPointsOnPathSelected( IPathGeometry* pathGeom, int32 pathIndex, const PointSelectorList& pts ) const = 0;



 virtual PMRect GetPolyPathBBox
 (
 const PMPointList& polyPts
 ) const = 0;

 virtual IHandleShape* QueryHandleShape
 (
 bool16 tryPathHandleShape,
 const UIDRef& item
 ) const = 0;

 virtual IHandleShape* QueryHandleShape
 (
 bool16 tryPathHandleShape,
 IPMUnknown* iUnknown
 ) const = 0;

 virtual bool16 IsAnyPathOpen( const IPathGeometry* iPathGeometry ) const = 0;

 virtual bool16 IsValidSelector( const IPathGeometry* pathGeom, const PointSelector& handle ) const = 0;

 virtual PMRect::PointIndex GetVisualPointIndex(const PointSelector& controlPtIndex, ITransform* itemTransform) const = 0;

 virtual void GetPathSelectableUIDList(UIDList* resultList, IHierarchy* hierarchy) = 0;
};


#endif // __IPathUtils__