IClippingPathSuite.h

//========================================================================================
// 
// $File$
// 
// Owner: Dave Stephens
// 
// $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.
// 
// 
// Note:
// 
//========================================================================================

#ifndef __IClippingPathSuite__
#define __IClippingPathSuite__

#include "IPMUnknown.h"

#include "ImageID.h"

class IClipSettings;
class IPathGeometry;

class IClippingPathSuite : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_ICLIPPINGPATHSUITE };

 enum
 {
 kInvertFlag = 1 << 0, // Invert the resulting path by combining with a path equal to the bounds of the image
 kUseHighResFlag = 1 << 1, // Force edge detection to use the high resolution source image (potentially much slower
 // but higher quality. Although the 72 dpi proxy does a pretty good job).
 kAllowHolesFlag = 1 << 2, // For edge detection, do we remove the holes or leave them in.
 kRestrictToFrameFlag = 1 << 3 // For edge detection, do we only detect edges within the visible portions of the image?
 // That is, do we crop the image to its frame before performing edge detection?
 };
 

 virtual bool16 CanHaveClippingPath (void) const = 0;

 virtual bool16 HasAlphaChannels (void) const = 0;

 virtual bool16 HasPhotoshopPaths (void) const = 0;

 virtual bool16 HasHighResRaster (void) const = 0;

 virtual bool16 CanConvertClippingToFrame (void) const = 0;

 virtual IClipSettings* QueryActiveClipSettings(void) const = 0;

 virtual IPathGeometry* QueryActiveClippingPath(void) const = 0;

 virtual ErrorCode ApplyEmbeddedPath(uint16 index, const PMString *pathName, const PMReal& tolerance, const PMReal& minPathSize, 
 const PMReal& inset, uint32 flags) const = 0;


 virtual ErrorCode ApplyAlphaChannel(uint16 index, const PMReal& tolerance, const PMReal& minPathSize, const PMReal& inset,
 uint32 flags, uint8 threshhold) const = 0;


 virtual ErrorCode DoDetectEdges(const PMReal& tolerance, const PMReal& minPathSize, const PMReal& inset,
 uint32 flags, uint8 threshhold) const = 0;


 virtual ErrorCode RemoveClipping(void) const = 0;

 virtual ErrorCode DoConvertClippingToFrame (void) const = 0;

 virtual ErrorCode ApplyUserPathOptions (bool8 bInvert, const PMReal& inset) const = 0;

};

#endif // __IClippingPathSuite__