ITrapStyle.h

//========================================================================================
// 
// $File$
// 
// Owner: James Jardee-Borquist
// 
// $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 __ITrapStyle__
#define __ITrapStyle__

#if PRAGMA_ONCE
#endif

#ifndef __ODFRC__ // when used for core resource compilation, provide just the parameter range constants

#include "IPMUnknown.h"
#include "PrintID.h"

//_______________________________________________________________________________________
// Default value for each of the Trap style properties are defined below.
//_______________________________________________________________________________________

//_______________________________________________________________________________________
// CLASS ITrapStyle
//_______________________________________________________________________________________

class ITrapStyle : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_ITRAPSTYLE };
 
 virtual void SetName(const PMString &inName) = 0;
 virtual PMString GetName() const = 0;
 
 
 enum {
 kImg2Obj_Off = 0,
 kImg2Obj_On = 1
 };
 
 virtual void SetImg2Obj(int32 inImg2Obj) = 0;

 virtual int32 GetImg2Obj() const = 0;
 
 enum {
 kImg2Img_Off = 0,
 kImg2Img_On = 1
 };
 
 virtual void SetImg2Img(int32 inImg2Img) = 0;

 virtual int32 GetImg2Img() const = 0;

 enum {
 kInternalImg_Off = 0,
 kInternalImg_On = 1
 };
 
 virtual void SetInternalImg(int32 inInternalImg) = 0;

 virtual int32 GetInternalImg() const = 0;
 
 virtual void SetDfltWidth(const PMReal &inDfltWidth/*0.0 to 8.0*/) = 0;

 virtual PMReal GetDfltWidth() const = 0;
 
 virtual void SetBlkWidth(const PMReal &inBlkWidth/*0.0 to 8.0*/) = 0;

 virtual PMReal GetBlkWidth() const = 0;
 
 virtual void SetClrScaling(const PMReal &inClrScaling/*0.0 to 100.0*/) = 0;
 
 virtual PMReal GetClrScaling() const = 0;
 
 virtual void SetStepTH(const PMReal &inStepTH/*1.0 to 100.0*/) = 0;
 
 virtual PMReal GetStepTH() const = 0;
 
 virtual void SetBlkColorTH(const PMReal &inBlkColorTH/*0.0 to 100.0*/) = 0;
 
 virtual PMReal GetBlkColorTH() const = 0;
 
 virtual void SetBlkDnstyTH(const PMReal &inBlkDnstyTH/*0.001 to 12.0*/) = 0;
 
 virtual PMReal GetBlkDnstyTH() const = 0;
 
 virtual void SetSlidingTH(const PMReal &inSlidingTH/*0.0 to 100.0*/) = 0;
 
 virtual PMReal GetSlidingTH() const = 0;
 
 enum {
 kImgPlacement_Center = 0,
 kImgPlacement_Choke = 1,
 kImgPlacement_NeutralDensity = 2,
 kImgPlacement_Spread = 3
 };
 
 virtual void SetImgPlacement(int32 inImgPlacement) = 0;

 virtual int32 GetImgPlacement() const = 0;
 
 enum {
 kImagemasks_Off = 0,
 kImagemasks_On = 1
 };
 
 virtual void SetImagemasks(int32 inImagemasks) = 0;

 virtual int32 GetImagemasks() const = 0;

 enum {
 kMiterTrapJoin = 0,
 kRoundTrapJoin = 1, 
 kBevelTrapJoin = 2
 };

 virtual void SetTrapJoinStyle(int32 inTrapJoinStyle) = 0;

 virtual int32 GetTrapJoinStyle() const = 0;
 
 enum {
 kMiterTrapEnd = 0,
 kOverlapTrapEnd = 1
 };

 virtual void SetTrapEndStyle(int32 inTrapEndStyle) = 0;
 virtual int32 GetTrapEndStyle() const = 0;
 
 virtual void CopyData(const ITrapStyle *inTrapStyle) = 0;

 virtual void Reset2DefaultValue() = 0;
 
 enum {
 kNameFlag = (1 << 0),
 kImg2ObjFlag = (1 << 1),
 kInternalImgFlag = (1 << 2),
 kDfltWidthFlag = (1 << 3),
 kBlkWidthFlag = (1 << 4),
 kClrScalingFlag = (1 << 5),
 kStepTHFlag = (1 << 6),
 kBlkColorTHFlag = (1 << 7),
 kBlkDnstyTHFlag = (1 << 8),
 kSlidingTHFlag = (1 << 9),
 kImgPlacementFlag = (1 << 10),
 kImagemasksFlag = (1 << 11),
 kJoinStyleFlag = (1 << 12),
 kEndStyleFlag = (1 << 13),
 kImg2ImgFlag = (1 << 14)
 };
 
 virtual bool16 GetFlag(int32 inFlag) const = 0;
};

#endif //ODFRC

//_______________________________________________________________________________________
// Minimum and maximum values allow for each TrapStyle property.
// Default values
//_______________________________________________________________________________________
const PMReal kTrapStyleMinBlackWidth = 0;
const PMReal kTrapStyleMaxBlackWidth = 8.0;
const PMReal kTrapStyleMinDefaultWidth = 0;
const PMReal kTrapStyleMaxDefaultWidth = 8.0;
const PMReal kTrapStyleMinStep = 1.0;
const PMReal kTrapStyleMaxStep = 100.0;
const PMReal kTrapStyleMinBlackColor = 0.0;
const PMReal kTrapStyleMaxBlackColor = 100.0;
const PMReal kTrapStyleMinBlackDensity = 0.001;
const PMReal kTrapStyleMaxBlackDensity = 10.0;
const PMReal kTrapStyleMinSlidingTrap = 0.0;
const PMReal kTrapStyleMaxSlidingTrap = 100.0;

#ifndef __ODFRC__ // when used for core resource compilation, provide just the parameter range constants

const PMReal kTrapStyleDefaultBlackWidth = 0.5;
const PMReal kTrapStyleDefaultWidth = 0.25;
const int32 kTrapStyleDefaultImagePlacement = ITrapStyle::kImgPlacement_Center;
const bool16 kTrapSytleDefaultObj2Image = ITrapStyle::kImg2Obj_On;
const bool16 kTrapSytleDefaultImage2Image = ITrapStyle::kImg2Img_On;
const bool16 kTrapSytleDefaultInternalImage = ITrapStyle::kInternalImg_Off;
const bool16 kTrapSytleDefaultImageMask = ITrapStyle::kImagemasks_On;
const PMReal kTrapStyleDefaultStep = 10.0;
const PMReal kTrapStyleDefaultBlackColor = 100.0;
const PMReal kTrapStyleDefaultBlackDensity = 1.60;
const PMReal kTrapStyleDefaultSlidingTrap = 70.0;
const PMReal kTrapStyleDefaultColorReduction = 1.0;
const int32 kTrapStyleDefaultJoinStyle = ITrapStyle::kMiterTrapJoin;
const int32 kTrapStyleDefaultEndStyle = ITrapStyle::kMiterTrapEnd;

#endif //ODFRC
#endif // __ITrapStyle__

// End, ITrapStyle.h.