ISetClipValuesCmdData Class Reference

#include <ISetClipValuesCmdData.h>

Inheritance diagram for ISetClipValuesCmdData:

Public Member Functions
virtual void	SetImageItem (IDataBase *db, UID id)=0
virtual void	SetDocument (UIDRef &document)=0
virtual void	Set (IClipSettings::ClipType clipType, int16 index, PMReal Tolerance, PMReal Inset, uint8 Threshold, bool8 Invert, bool8 UseHighRes, bool8 AllowHoles, bool8 restrict)=0
virtual IDataBase *	GetDataBase () const =0
virtual UID	GetImageUID () const =0
virtual const UIDRef &	GetDocument () const =0
virtual IClipSettings::ClipType	GetClipType () const =0
virtual PMReal	GetTolerance () const =0
virtual PMReal	GetInset () const =0
virtual uint8	GetThreshold () const =0
virtual bool8	GetInvert () const =0
virtual bool8	GetUseHighRes () const =0
virtual bool8	GetAllowHoles () const =0
virtual bool8	GetRestrictToFrame () const =0
virtual int16	GetIndex () 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

ISetClipValuesCmdData Description: Data interface for the kSetClipValuesCmdBoss command, which is used to store the current clipping path settings for a given image or the default clip settings for given document or the default clip settings for all new documents.

Member Function Documentation

virtual bool8 ISetClipValuesCmdData::GetAllowHoles ( ) const

pure virtual

GetAllowHoles

Returns

Returns whether or not holes are allowed in the resulting path. Set via Set.

virtual IClipSettings::ClipType ISetClipValuesCmdData::GetClipType ( ) const

pure virtual

GetClipType

Returns

Returns the ClipType that was set via Set

virtual IDataBase* ISetClipValuesCmdData::GetDataBase ( ) const

pure virtual

GetDataBase

Returns

Returns the IDataBase that was set via SetImageItem or SetDocument

virtual const UIDRef& ISetClipValuesCmdData::GetDocument ( ) const

pure virtual

GetDocument

Returns

Returns the UIDRef of the document that was set via SetDocument

virtual UID ISetClipValuesCmdData::GetImageUID ( ) const

pure virtual

GetImageUID

Returns

Returns the UID of the image that was set via SetImageItem

virtual int16 ISetClipValuesCmdData::GetIndex ( ) const

pure virtual

GetIndex

Returns

Returns the index of the alpha channel or embedded path to use if the clipType is kClipAlpha or kClipEmbeddedPath.

virtual PMReal ISetClipValuesCmdData::GetInset ( ) const

pure virtual

GetInset

Returns

Returns the inset that was set via Set

virtual bool8 ISetClipValuesCmdData::GetInvert ( ) const

pure virtual

GetInvert

Returns

Returns whether or not to invert the result. Set via Set.

virtual bool8 ISetClipValuesCmdData::GetRestrictToFrame ( ) const

pure virtual

GetRestrictToFrame

Returns

Returns whether or not to restrict computations to the currently visible portion of the image. Set via Set.

virtual uint8 ISetClipValuesCmdData::GetThreshold ( ) const

pure virtual

GetThreshold

Returns

Returns the threshold that was set via Set

virtual PMReal ISetClipValuesCmdData::GetTolerance ( ) const

pure virtual

GetTolerance

Returns

Returns the tolerance that was set via Set

virtual bool8 ISetClipValuesCmdData::GetUseHighRes ( ) const

pure virtual

GetUseHighRes

Returns

Returns whether or not to use the High Res image instead of the proxy. Set via Set.

virtual void ISetClipValuesCmdData::Set ( IClipSettings::ClipType  clipType, int16  index, PMReal  Tolerance, PMReal  Inset, uint8  Threshold, bool8  Invert, bool8  UseHighRes, bool8  AllowHoles, bool8  restrict  )

pure virtual

Set This method is used to set the clipping values which will be applied to the target.

Parameters

clipType	- IN: the kind of clipping to apply. IClipSettings
index	- IN: If the clipType is kClipAlpha or kClipEmbeddedPath, then index is the zero based index of the alpha channel or embedded path to use for the clipping. If kDefaultClipIndex is passed, then the default alpha or default embedded path are used. If a default cannot be determined, then the first is used.
Tolerance	- IN: Tolerance is a measure, in points, of how closely the smoothed clipping path must approximate the original. The higher the tolerance, the fewer the total number of points.
Inset	- IN: Inset is a measure in points, of how far to inset the resulting clipping path. Use a negative value to outset.
Threshold	- IN: If the clipType is kClipAlpha or kClipEdgeDetection, then the threshold determines how dark a pixel must be before it can be included in the clipping.
Invert	- IN: Should the resulting path be inverted? That is, should it be treated as a hole in the image?
UseHighRes	- IN: If the clipType is kClipAlpha or kClipEdgeDetection, should the clipping be calculated using the high res data or is the proxy image good enough? Using high res data results in more accurate results but takes longer to compute.
AllowHoles	- IN: Is it okay to have holes in the clipping?
restrict	- IN: Should the clipping path be computed on the currently visible portion of the image?

virtual void ISetClipValuesCmdData::SetDocument ( UIDRef &  document )

pure virtual

SetDocument Sets the given UID as the target of the SetClipValuesCmd. If the target is the application, then do not call this method.

Parameters

document

- IN: the UIDRef of the IDocument for which all newly placed images will have these clip settings by default.

virtual void ISetClipValuesCmdData::SetImageItem ( IDataBase *  db, UID  id  )

pure virtual

SetImageItem Sets the given UID as the target of the SetClipValuesCmd. If the target is the document or the application, then do not call this method.

Parameters

db	- IN: the IDataBase of the document containing the image.
id	- IN: the image.