IGraphicChannelInfo.h

//========================================================================================
// 
// $File$
// 
// Owner: David Berggren
// 
// $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:
// Stores info about channels read in from a placed graphic (i.e. PSD or AI file)
// Assumes channel names are unique
// 
//========================================================================================

#ifndef __IGraphicChannelInfo__
#define __IGraphicChannelInfo__

#include "IPMUnknown.h"
#include "IColorData.h"
#include "ImageID.h"
#include "PMString.h"

class IGraphicChannelInfo : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IGRAPHICCHANNELINFO };

 typedef enum
 {
 kPMChannelTypeUnknown = 0,

 kPMAlphaAssociated = 1,

 kPMAlphaUnassociated = 2,

 kPMSpotChannel = 3, 

 kPMAlphaUnassociatedBackground = 4 
 } GraphicChannelType;

 // ***********************
 // Add/Remove methods
 // ***********************

 virtual void AddChannel ( const PMString& channelName, 
 const int32 channelID,
 const GraphicChannelType channelType,
 const int32 channelOpacity,
 const int32 colorSpace,
 const ColorArray& colorData
 ) = 0;

 virtual void RemoveChannel ( const int32 channelIndex ) = 0;

 virtual void Clear() = 0;

 // ***********************
 // Set methods
 // ***********************

 virtual void SetChannelName (const int32 channelIndex, const PMString& newName) = 0;

 virtual void SetChannelID (const int32 channelIndex, const int32 newID) = 0;

 virtual void SetChannelType (const int32 channelIndex, const GraphicChannelType newType) = 0;

 virtual void SetChannelOpacity (const int32 channelIndex, const int32 newOpacity) = 0;

 virtual void SetChannelColor (const int32 channelIndex, const int32 colorSpace, const ColorArray& colorData) = 0;

 // ***********************
 // Get methods
 // ***********************

 virtual int32 GetNumberChannels () const = 0;

 virtual PMString GetNthChannelName (const int32 channelIndex) const = 0;
 virtual int32 GetNthChannelID (const int32 channelIndex) const = 0;
 virtual GraphicChannelType GetNthChannelType (const int32 channelIndex) const = 0;
 virtual int32 GetNthChannelOpacity (const int32 channelIndex) const = 0;
 virtual int32 GetNthChannelColorSpace (const int32 channelIndex) const = 0;
 virtual ColorArray GetNthChannelColorData (const int32 channelIndex) const = 0;

};

#endif