IImageFacade.h

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

#ifndef __IImageFacade__
#define __IImageFacade__

// ----- Interfaces -----

#include "IPMUnknown.h"

// ----- Includes -----

#include "ImageTypes.h"
#include "ImageID.h"
#include "BravoForwardDecl.h"

class IPMStream;

namespace Facade
{
// Please use the IImageFacade directly via the UtilsBoss if possible, see Utils.h:
// i.e. Utils<Facade::IImageFacade>()->GetImageInfo( ... );
// Or, you can simply include ImageFacade.h (instead of IImageFacade.h) and then use
// ImageFacade::GetImageInfo( ... );

 class IImageFacade : public IPMUnknown
 {
 public:
 enum { kDefaultIID = IID_IIMAGEFACADE };

 // ***********************
 // Image Info Routines
 // ***********************

 virtual ErrorCode GetImageInfo(const IPMUnknown* imageOrProxyBoss, PMRect* bounds,
 int32* colorSpace, Fixed *xRes, Fixed *yRes) const = 0;

 virtual ErrorCode GetImageInfo(const UIDRef& imageOrProxyRef, PMRect* bounds,
 int32* colorSpace, Fixed *xRes, Fixed *yRes) const = 0;

 virtual ErrorCode GetChannelInfo(
 const UIDRef& imageOrProxyRef,
 uint32& totalChannels, // total number of channels
 uint32& colorChannels, // total number of color channels (not including spot colors)
 uint32& transparencyAlphas, // 0 or 1
 uint32& spotChannels, // total number of spot channels
 uint32& otherChannels // total number of extra alphas which are not spot channels and do not describe transparency
 ) const = 0; 

 virtual ErrorCode GetSpotChannelName (const UIDRef& imageOrProxyRef,uint32 spotIndex, PMString& name) const = 0;

 virtual ErrorCode GetTransparencyAlphaName (const UIDRef& imageOrProxyRef,PMString& name) const = 0;

 virtual ErrorCode GetExtraChannelName( const UIDRef& imageOrProxyRef, uint32 extraChannelIndex, PMString& name ) const = 0;

 virtual bool16 IsTransparencyAlphaPreMultiplied( const UIDRef& imageOrProxyRef ) const = 0;

 // GetProxy

 virtual const UIDRef GetProxyUIDRef(const IPMUnknown* imageBoss) const = 0;

 virtual const UIDRef GetProxyUIDRef(const UIDRef& imageRef) const = 0;


 virtual bool16 IsEmbeddedImage(const IPMUnknown* boss) const = 0;
 virtual bool16 IsEmbeddedImage(const UIDRef& imageRef) const = 0;

 virtual IPMStream *GetImageStream(const UIDRef& imageOrProxyRef) const = 0;

 virtual AGMColorSpace *GetAGMColorProfileFromImage(const UIDRef &imageOrProxyRef) const = 0;

 virtual ClassID GetReadFilterClassID(const UIDRef& imageOrProxyRef) const = 0;


 // virtual IClippingFacade* QueryClippingPathFacade(void) const = 0;
 
 // virtual IImageWrapFacade* QueryImageWrapFacade(void) const = 0;
 };
}

#endif // __IImageFacade__