TranFxMatteFactory.h

//========================================================================================
// 
// $File$
// 
// Owner: Adobe Developer Technologies
// 
// $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 __TranFxHelper_H_DEFINED__
#define __TranFxHelper_H_DEFINED__

class IShape;
class AGMImageAccessor;
class IGraphicStyleDescriptor;
class IHierarchy;

class TranFxMatteFactory
{

public:
 TranFxMatteFactory();

 virtual ~TranFxMatteFactory();

public:
 // Effect image methods:

 const AGMImageAccessor* MakeMatte(IShape* iShape, const PMReal& resolution, const DrawOptionsSet& drawOptionsSet, const bool16 enableCaching);

 PBPMRect GetBoundingBox(IShape* iShape) const;

 bool16 GetPaintedBBoxWithoutMatte(IShape* iShape, PBPMRect& bounds) const;

public:
 // Cache management methods:

 void PurgeImageCache(const UIDList& itemList);

 void PurgeWholeCache(const UIDRef& documentUIDRef);

private:
 void AddToCache(const AGMImageAccessor* image, uint32 startTime, const UIDRef& itemUIDRef, const PMReal& resolution, uint32 checksum);

 const AGMImageAccessor* FindInCache(const UIDRef& currentShapeRef, const PMReal& resolution, uint32 checksum);

 bool16 InkingIsSafeToCache(IShape* iShape);

 bool16 InkingIsSafeToCacheRecursive(IHierarchy* iPageItem, int32& childCount);

 bool16 ObjectHasNoColor(IGraphicStyleDescriptor* gsDesc);

 void SetMaskImage(const AGMImageAccessor* image);

private:
 AGMImageAccessor* fMaskImage;
};

#endif // __TranFxHelper_H_DEFINED__