ITrapStyle Class Reference

#include <ITrapStyle.h>

Inheritance diagram for ITrapStyle:

Public Types
enum	{ kDefaultIID = IID_ITRAPSTYLE }
enum	{ kImg2Obj_Off = 0, kImg2Obj_On = 1 }
enum	{ kImg2Img_Off = 0, kImg2Img_On = 1 }
enum	{ kInternalImg_Off = 0, kInternalImg_On = 1 }
enum	{ kImgPlacement_Center = 0, kImgPlacement_Choke = 1, kImgPlacement_NeutralDensity = 2, kImgPlacement_Spread = 3 }
enum	{ kImagemasks_Off = 0, kImagemasks_On = 1 }
enum	{ kMiterTrapJoin = 0, kRoundTrapJoin = 1, kBevelTrapJoin = 2 }
enum	{ kMiterTrapEnd = 0, kOverlapTrapEnd = 1 }
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) }

Public Member Functions
virtual void	SetName (const PMString &inName)=0
virtual PMString	GetName () const =0
virtual void	SetImg2Obj (int32 inImg2Obj)=0
virtual int32	GetImg2Obj () const =0
virtual void	SetImg2Img (int32 inImg2Img)=0
virtual int32	GetImg2Img () const =0
virtual void	SetInternalImg (int32 inInternalImg)=0
virtual int32	GetInternalImg () const =0
virtual void	SetDfltWidth (const PMReal &inDfltWidth)=0
virtual PMReal	GetDfltWidth () const =0
virtual void	SetBlkWidth (const PMReal &inBlkWidth)=0
virtual PMReal	GetBlkWidth () const =0
virtual void	SetClrScaling (const PMReal &inClrScaling)=0
virtual PMReal	GetClrScaling () const =0
virtual void	SetStepTH (const PMReal &inStepTH)=0
virtual PMReal	GetStepTH () const =0
virtual void	SetBlkColorTH (const PMReal &inBlkColorTH)=0
virtual PMReal	GetBlkColorTH () const =0
virtual void	SetBlkDnstyTH (const PMReal &inBlkDnstyTH)=0
virtual PMReal	GetBlkDnstyTH () const =0
virtual void	SetSlidingTH (const PMReal &inSlidingTH)=0
virtual PMReal	GetSlidingTH () const =0
virtual void	SetImgPlacement (int32 inImgPlacement)=0
virtual int32	GetImgPlacement () const =0
virtual void	SetImagemasks (int32 inImagemasks)=0
virtual int32	GetImagemasks () const =0
virtual void	SetTrapJoinStyle (int32 inTrapJoinStyle)=0
virtual int32	GetTrapJoinStyle () const =0
virtual void	SetTrapEndStyle (int32 inTrapEndStyle)=0
virtual int32	GetTrapEndStyle () const =0
virtual void	CopyData (const ITrapStyle *inTrapStyle)=0
virtual void	Reset2DefaultValue ()=0
virtual bool16	GetFlag (int32 inFlag) const =0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Detailed Description

A data interface for the trap style.

Member Enumeration Documentation

anonymous enum

Enumerator
kImg2Obj_Off	kImg2Obj_Off indicates image to object trapping is turned off.
kImg2Obj_On	kImg2Obj_Off indicates image to object trapping is turned on.

anonymous enum

Enumerator
kImg2Img_Off	kImg2Img_Off indicates image to image trapping is turned off
kImg2Img_On	kImg2Img_On indicates image to image trapping is turned on

anonymous enum

Enumerator
kInternalImg_Off	kInternalImg_Off indicates trapping within individual images is turned off.
kInternalImg_On	kInternalImg_On indicates trapping within individual images is turned on.

anonymous enum

Trap settings for determining where trap falls when trapping vector graphics to images.

Enumerator
kImgPlacement_Center	kImgPlacement_Center indicates the trap straddles the edges between objects and images.
kImgPlacement_Choke	kImgPlacement_Choke indicates the objects is to overlap the abutting images.
kImgPlacement_NeutralDensity	kImgPlacement_NeutralDensity indicates same trapping rules are applied as used elsewhere in the document.
kImgPlacement_Spread	kImgPlacement_Spread indicates the images is to overlap the abutting objects.

anonymous enum

Enumerator
kImagemasks_Off	kImagemasks_Off indicate if 1-bit image should not be trapped to abutting objects.
kImagemasks_On	kImagemasks_On indicate if 1-bit image is trapped to abutting objects.

anonymous enum

Trap settings for controling the shape of the outside join of two trap segments.

Enumerator
kMiterTrapJoin	kMiterTrapJoin indicates the join is mitered.
kRoundTrapJoin	kRoundTrapJoin indicates the join is rounded.
kBevelTrapJoin	kBevelTrapJoin indicates the join is beveled.

anonymous enum

Trap settings for controling the intersection of three-way traps.

Enumerator
kMiterTrapEnd	kMiterTrapEnd shapes the end of the trap to keep it away from the intersecting object.
kOverlapTrapEnd	kOverlapTrapEnd shapes the end of the lightest trap by wrapping around the point where the three objects intersect.

anonymous enum

Enumerator
kNameFlag	kNameFlag indicate style name is set.
kImg2ObjFlag	kImg2ObjFlag indicate image to object trap setting is set.
kInternalImgFlag	kInternalImgFlag indicate internal image trap setting is set.
kDfltWidthFlag	kDfltWidthFlag indicate default width is set.
kBlkWidthFlag	kBlkWidthFlag indicate black width is set.
kClrScalingFlag	kClrScalingFlag indicate color scaling factor is set.
kStepTHFlag	kStepTHFlag indicate trap step threshhold is set.
kBlkColorTHFlag	kBlkColorTHFlag indicate black color threshhold is set.
kBlkDnstyTHFlag	kBlkDnstyTHFlag indicate black density threshhold is set.
kSlidingTHFlag	kSlidingTHFlag indicate slinding threshhold is set.
kImgPlacementFlag	kImgPlacementFlag indicate image placement trap setting is set.
kImagemasksFlag	kImagemasksFlag indicate 1-bit image trap setting is set.
kJoinStyleFlag	kJoinStyleFlag indicate trap join is set.
kEndStyleFlag	kEndStyleFlag indicate trap end is set.
kImg2ImgFlag	kImg2ImgFlag indicate image to image trap setting is set.

Member Function Documentation

virtual void ITrapStyle::CopyData ( const ITrapStyle *  inTrapStyle )

pure virtual

Copy the trap style from inTrapStyle.

Parameters

inTrapStyle

is the source trap style to copy from

virtual PMReal ITrapStyle::GetBlkColorTH ( ) const

pure virtual

Returns the black color threshhold

virtual PMReal ITrapStyle::GetBlkDnstyTH ( ) const

pure virtual

Returns the black density threshhold

virtual PMReal ITrapStyle::GetBlkWidth ( ) const

pure virtual

Returns the black trap width

virtual PMReal ITrapStyle::GetClrScaling ( ) const

pure virtual

Returns the color scaling factor

virtual PMReal ITrapStyle::GetDfltWidth ( ) const

pure virtual

Returns the default trap width

virtual bool16 ITrapStyle::GetFlag ( int32  inFlag ) const

pure virtual

Returns whether or not the specifies property is set.

Parameters

inFlag

is one of the enum described immediately above.

Returns

true if the specified inFlag is set.

virtual int32 ITrapStyle::GetImagemasks ( ) const

pure virtual

Returns the 1-bit image trap setting.

virtual int32 ITrapStyle::GetImg2Img ( ) const

pure virtual

Returns the image-to-image trap setting

virtual int32 ITrapStyle::GetImg2Obj ( ) const

pure virtual

Returns the image-to-object trap setting.

virtual int32 ITrapStyle::GetImgPlacement ( ) const

pure virtual

Returns the image placement trap setting.

virtual int32 ITrapStyle::GetInternalImg ( ) const

pure virtual

Returns true if the trapping within individual images is turned on.

virtual PMString ITrapStyle::GetName ( ) const

pure virtual

Returns the trap style name.

virtual PMReal ITrapStyle::GetSlidingTH ( ) const

pure virtual

Returns the sliding trap threshhold

virtual PMReal ITrapStyle::GetStepTH ( ) const

pure virtual

Returns the trap step threshhold

virtual int32 ITrapStyle::GetTrapEndStyle ( ) const

pure virtual

Returns the trap end setting.

virtual int32 ITrapStyle::GetTrapJoinStyle ( ) const

pure virtual

Returns the trap join setting.

virtual void ITrapStyle::Reset2DefaultValue ( )

pure virtual

Reset all trap style settings to default values.

virtual void ITrapStyle::SetBlkColorTH ( const PMReal &  inBlkColorTH )

pure virtual

Set the black color threshhold

Parameters

inBlkColorTH

specifies the black color threshhold

virtual void ITrapStyle::SetBlkDnstyTH ( const PMReal &  inBlkDnstyTH )

pure virtual

Set the black density threshhold

Parameters

inBlkDnstyTH

specifies the black density threshhold

virtual void ITrapStyle::SetBlkWidth ( const PMReal &  inBlkWidth )

pure virtual

Set the black trap width

Parameters

inBlkWidth

specifies the black trap width

virtual void ITrapStyle::SetClrScaling ( const PMReal &  inClrScaling )

pure virtual

Set the color scaling factor

Parameters

inClrScaling

specifies the color scaling factor

virtual void ITrapStyle::SetDfltWidth ( const PMReal &  inDfltWidth )

pure virtual

Set the default trap width

Parameters

inDfltWidth

specifies the default trap width

virtual void ITrapStyle::SetImagemasks ( int32  inImagemasks )

pure virtual

Set the 1-bit image trap setting.

Parameters

inImagemasks

specifies the 1-bit image trap setting.

virtual void ITrapStyle::SetImg2Img ( int32  inImg2Img )

pure virtual

Set the image-to-image trap setting.

Parameters

inImg2Img

specifies the image-to-image setting

virtual void ITrapStyle::SetImg2Obj ( int32  inImg2Obj )

pure virtual

Set the image-to-object trapping.

Parameters

inImg2Obj

specifies the image-to-object trap setting.

virtual void ITrapStyle::SetImgPlacement ( int32  inImgPlacement )

pure virtual

Sets the image placement trap setting.

Parameters

inImgPlacement

specifies the image placement trap setting

virtual void ITrapStyle::SetInternalImg ( int32  inInternalImg )

pure virtual

Set the trapping within individual images.

Parameters

inInternalImg

specifies whether of not trapping wihtin individual images is on or off.

virtual void ITrapStyle::SetName ( const PMString &  inName )

pure virtual

Set the style name

Parameters

inName

is the new style name to set.

virtual void ITrapStyle::SetSlidingTH ( const PMReal &  inSlidingTH )

pure virtual

Set the sliding trap threshhold

Parameters

inSlidingTH

specifies the sliding trap threshhold

virtual void ITrapStyle::SetStepTH ( const PMReal &  inStepTH )

pure virtual

Set the trap step threshhold

Parameters

inStepTH

specifies the trap step threshhold

virtual void ITrapStyle::SetTrapEndStyle ( int32  inTrapEndStyle )

pure virtual

Sets the trap end appearance setting.

Parameters

inTrapEndStyle

specifies the trap end setting.

virtual void ITrapStyle::SetTrapJoinStyle ( int32  inTrapJoinStyle )

pure virtual

Set the trap join appearance setting.

Parameters

inTrapJoinStyle

specifies the trap join.