IImageCacheMgr.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.
// 
// 
// Purpose of Interface:
// The IImageCacheMgr is a centralized list of image caches which lives off of
// kDocWorkspaceBoss. It can be accessed by anyone at any time allowing image
// caches to be purged separately from the IShape instance which generated it.
// Moreover, it will allow clients to purge a cache based on when it was last
// used, its size and amount of time required to regenerate it.
// 
//========================================================================================

#ifndef __IImageCacheMgr__
#define __IImageCacheMgr__

#include "IPMUnknown.h"
#include "IImageStreamManager.h"
#include "ImageID.h"

class IImageCache;

class IImageCacheMgr : public IPMUnknown
{
public: 
 enum { kDefaultIID = IID_IIMAGECACHEMGR };
 
 enum {
 kWildCard = 0, // matches anything
 kRasterImage = 1,
 kAlphaMask = 2,
 kLinkThumbnail = 4,
 kUncalibratedRasterImage = 5,

 // Transparency effect masks (yes, in theory, there really could be this many on a page item)
 kXP_DSH_PI = 10,
 kXP_DSH_ST = 11,
 kXP_DSH_FI = 12,
 kXP_DSH_CT = 13,
 kXP_ISH_PI = 14,
 kXP_ISH_ST = 15,
 kXP_ISH_FI = 16,
 kXP_ISH_CT = 17,
 kXP_OGL_PI = 18,
 kXP_OGL_ST = 19,
 kXP_OGL_FI = 20,
 kXP_OGL_CT = 21,
 kXP_IGL_PI = 22,
 kXP_IGL_ST = 23,
 kXP_IGL_FI = 24,
 kXP_IGL_CT = 25,
 kXP_BE1_PI = 26,
 kXP_BE1_ST = 27,
 kXP_BE1_FI = 28,
 kXP_BE1_CT = 29,
 kXP_BE2_PI = 30,
 kXP_BE2_ST = 31,
 kXP_BE2_FI = 32,
 kXP_BE2_CT = 33,
 kXP_BE3_PI = 34,
 kXP_BE3_ST = 35,
 kXP_BE3_FI = 36,
 kXP_BE3_CT = 37,
 kXP_BE4_PI = 38,
 kXP_BE4_ST = 39,
 kXP_BE4_FI = 40,
 kXP_BE4_CT = 41,
 kXP_SAT_PI = 42,
 kXP_SAT_ST = 43,
 kXP_SAT_FI = 44,
 kXP_SAT_CT = 45,
 kXP_FTH_PI = 46,
 kXP_FTH_ST = 47,
 kXP_FTH_FI = 48,
 kXP_FTH_CT = 49,
 kXP_DRF_PI = 50,
 kXP_DRF_ST = 51,
 kXP_DRF_FI = 52,
 kXP_DRF_CT = 53,
 kXP_GRF_PI = 54,
 kXP_GRF_ST = 55,
 kXP_GRF_FI = 56,
 kXP_GRF_CT = 57
 };
 
 virtual ErrorCode Add(const UIDRef& imageRef, IImageCache* cache, bool8 purgeFirst = kFalse, uint32 selector = kRasterImage) = 0;
 
 virtual uint32 Purge(const UIDRef& imageRef, IImageCache* cache) = 0;
 
 virtual uint32 Purge(const UIDRef& imageRef, const PMReal& resolution, uint32 selector = kWildCard) = 0;

 virtual uint32 Purge(const UIDRef& imageRef, uint32 selector = kWildCard) = 0;

 virtual uint32 Purge(const IDataBase *db, uint32 selector = kWildCard) = 0;
 
 virtual uint32 GetSize(void) const = 0;
 
 virtual bool16 GetClosestMatchResolution(const UIDRef& imageRef, PMReal& resolution, uint32 selector = kRasterImage,
 uint32* selectorFound = nil) const = 0;

 virtual IImageCache* QueryClosestResolution(const UIDRef& imageRef, const PMReal& resolution, uint32 selector = kRasterImage,
 uint32* selectorFound = nil) = 0;

 virtual IImageCache* QueryPreviousResolution(const UIDRef& imageRef, const IImageCache& currentCache, uint32 selector = kRasterImage,
 uint32* selectorFound = nil) = 0;
 
 virtual IImageCache* QueryNextResolution(const UIDRef& imageRef, const IImageCache& currentCache, uint32 selector = kRasterImage,
 uint32* selectorFound = nil) = 0;

 virtual IImageCache* Resample(const UIDRef& imageRef, uint32 srcSelector, uint32 dstSelector, const PMReal &resToResampleFrom,
 const PMReal &resToResampleTo, IImageStreamManager::ResamplingType &sampleType,
 bool32 bForceNonVirtual = kFalse) = 0;

 virtual void SetMaxSize(uint32 kiloBytes) = 0;

 virtual void PurgeMemory(int32 level, bool16 inGrowZone) = 0; // levels from MemUtils.h 
};

#endif