IColorSystemUtils.h

//========================================================================================
// 
// $File$
// 
// Owner: Bernd Paradies
// 
// $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 __IColorSystemUtils__
#define __IColorSystemUtils__

#include "AppFrameworkID.h"
#include "IPMUnknown.h"
#include "Utils.h"
#include "BravoForwardDecl.h"

#include "IColorData.h"

#include "ColorSystemID.h"
#include "ShuksanID.h"

#include "GraphicTypes.h"
#include "PMString.h"
#include "K2Vector.h"

class IGraphicsPort;
class IDocument;
class IInkData;
class IColorOverrides;
class IColorSpaceMgr;
class IDataBase;
class IInkList;
class IViewPortAttributes;


class IColorSystemUtils : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_ICOLORSYSTEMUTILS };


 virtual PMString GetColorInfoString( const int32& colorSpace, 
 const ColorArray& colorValueArray, 
 bool16 doUseComma ) = 0;



 virtual IPMUnknown* QueryBaseRenderObject(IDataBase* iDataBase, UID renderObjectUID, PMIID iidToQuery = IID_IUNKNOWN) = 0;

 virtual IPMUnknown* QueryBaseRenderObject(IPMUnknown* object, PMIID iidToQuery = IID_IUNKNOWN) = 0;

 virtual PMReal GetTintValueFromSwatch(const UIDRef& swatchRef) = 0;

 virtual PMReal GetTintValueFromColorObject(IPMUnknown* colorObject) = 0;

 virtual PMReal GetCurrentActiveTintValue( IDataBase* iDataBase ) = 0;

 //___________________________________________________________________________________

 virtual AGMColorSpace* NewAGMColorSpace (int32 colorFamily, const ColorArray& colorArray, const UIDList* pInkUIDList, IInkList* iInkList = nil) = 0;

 virtual AGMColorSpace* NewAGMColorSpaceFromColorSwatch (const UIDRef& swatchRef) = 0;

 virtual void GetColorSpaceAndColorValue(bool16 doPrint, const UIDRef& swatchRef, const PMReal& tint,
 AGMColorSpace **colorSpace, float *colorValue, IGraphicsPort* gPort = nil) = 0;


 virtual void ReleaseColorSpace(AGMColorSpace *colorSpace) = 0;

 virtual void SetColorSpaceAndColorValue (IGraphicsPort *gPort, int32 colorFamily, const ColorArray& colorArray, const PMReal& tint, const UIDList* pInkUIDList = nil) = 0;

 virtual void SetColorSpaceAndColorValue( IGraphicsPort *gPort, IColorData* iColorData, IColorData* iAltColorData, 
 IInkData* iInkData, IColorOverrides* iCORides, 
 IColorSpaceMgr* iCSMgr, const PMReal& tint ) = 0;

 virtual ColorArray ColorTransform( IDocument* iDoc, ColorArray srcArray, int32 srcColorSpace, int32 dstColorSpace, const UIDList* pInkUIDList = nil, IInkList* iInkList = nil) = 0;

 virtual ColorArray GetTintedColorComponents(int32 colorSpace, ColorArray colorArray, PMReal tint) = 0;
 
 virtual void GetColorSwatchColorSpaceAndValue (const UIDRef& colorRef, int32& colorspace, ColorArray& colorArray, PMReal& tint) = 0;

 virtual bool32 IsWhite(const UIDRef& swatchRef, PMReal tint = kDefaultTintPercent, bool32 useAltspaceOnly = kFalse) = 0;
 
 virtual bool32 ShouldIgnorePaperColor(IViewPortAttributes* iAttr) = 0;
 
 virtual void RGBToHSB( PMReal r, PMReal g, PMReal b, PMReal &h, PMReal &s, PMReal &v ) = 0;
 
 virtual void HSBToRGB( PMReal h, PMReal s, PMReal v, PMReal &r, PMReal &g, PMReal &b ) = 0;
};


#endif // __IColorSystemUtils__