Inheritance diagram for INewGuideCmdData:

Public Types
enum	{ kDefaultIID = IID_INEWGUIDECMDDATA }

Public Member Functions
virtual void	Set (const UIDRef &parent, bool16 isHoriz, const PMReal &distance, const UID &ownerUID, bool16 isShort=kTrue, const PMReal &threshold=kDefaultViewThreshold, const int32 colorIndex=IUIColorUtils::kStockRulerGuide, const IGuideData::GuideType guideType=IGuideData::kRulerGuide)=0

virtual void	SetMultiple (bool16 isMultiple)=0

virtual void	SetType (const IGuideData::GuideType guideType)=0

virtual IGuideData::GuideType	GetType () const =0

virtual void	SetLiquidGrowZoneSize (const PMReal &size)=0

virtual PMReal	GetLiquidGrowZoneSize () const =0

virtual void	SetLocation (const PMReal &location)=0

virtual PMReal	GetLocation () const =0

virtual const UIDRef &	GetParent ()=0

virtual bool16	GetIsHoriz () const =0

virtual bool16	GetIsMultiple () const =0

virtual const PMReal &	GetDistance () const =0

virtual const UID &	GetOwnerUID () const =0

virtual const PMReal &	GetThreshold () const =0

virtual const int32	GetColorIndex () const =0

virtual bool16	GetIsShort () 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

Member Function Documentation

virtual PMReal INewGuideCmdData::GetLiquidGrowZoneSize ( ) const

pure virtual

Returns: Gets the size of the zone (width for vertical, height for horizontal).

virtual IGuideData::GuideType INewGuideCmdData::GetType ( ) const

pure virtual

virtual void INewGuideCmdData::Set	(	const UIDRef &	parent,
		bool16	isHoriz,
		const PMReal &	distance,
		const UID &	ownerUID,
		bool16	isShort = `kTrue`,
		const PMReal &	threshold = `kDefaultViewThreshold`,
		const int32	colorIndex = `IUIColorUtils::kStockRulerGuide`,
		const IGuideData::GuideType	guideType = `IGuideData::kRulerGuide`
	)

pure virtual

Catch all setter for specifying how a guide should be created.

Parameters

guideType [IN] specifies which type of guide to create (e.g. ruler, liquid, magnetic, etc. )

virtual void INewGuideCmdData::SetLiquidGrowZoneSize ( const PMReal & size )

pure virtual

Sets the size of the zone (width for vertical, height for horizontal).

Parameters

size	[IN] specifies the size of the zone (width for vertical, height for horizontal).

virtual void INewGuideCmdData::SetType ( const IGuideData::GuideType guideType )

pure virtual

Sets the type of guide. Default is kSnapping.

Parameters

guideType [IN] One of snapping, slicing, magnetic, etc.

Public Types