Facade::IGuideFacade Class Reference

#include <IGuideFacade.h>

Inheritance diagram for Facade::IGuideFacade:

Public Types
enum	{ kDefaultIID = IID_IGUIDEFACADE }

Public Member Functions
virtual ErrorCode	SetGuideOrientation (const UIDList &guideList, const bool16 &orientation)=0
virtual ErrorCode	SetGuideColor (const UIDList &guideList, const UID &colorUID)=0
virtual ErrorCode	SetGuideViewThreshold (const UIDList &guideList, const PMReal &threshold)=0
virtual ErrorCode	SetGuideType (const UIDList &guideList, const IGuideData::GuideType guideType)=0
virtual ErrorCode	SetGuideGrowZone (const UIDList &guideList, const PMReal &zone)=0
virtual bool16	GetGuideOrientation (const UIDRef &guideRef) const =0
virtual UID	GetGuideColor (const UIDRef &guideRef) const =0
virtual PMReal	GetGuideViewThreshold (const UIDRef &guideRef) const =0
virtual IGuideData::GuideType	GetGuideType (const UIDRef &guideRef) const =0
virtual PMReal	GetGuideGrowZone (const UIDRef &guideRef) 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

Static Public Attributes
static const bool16	kVerticalGuide = kFalse
static const bool16	kHorizontalGuide = kTrue

Detailed Description

A high level API for dealing with Guide. To use this Facade, include this header file and use the following example syntax: result = Utils<Facade::IGuideFacade>()->SetGuideColor( ... );

Author

Paul Sorrick

Member Function Documentation

virtual UID Facade::IGuideFacade::GetGuideColor ( const UIDRef &  guideRef ) const

pure virtual

Gets the guide color for a given guide.

Parameters

guideRef

- UIDRef for the guide (kGuideItemBoss)

Returns

UID - UID of the UI Color that is set.

virtual PMReal Facade::IGuideFacade::GetGuideGrowZone ( const UIDRef &  guideRef ) const

pure virtual

Gets the guide grow zone for a given guide.

Parameters

guideRef

- UIDRef for the guide (kGuideItemBoss)

Returns

PMReal - The grow zone of the guide.

virtual bool16 Facade::IGuideFacade::GetGuideOrientation ( const UIDRef &  guideRef ) const

pure virtual

Gets the guide orientation for a given guide–Vertical (kFalse) or Horizontal (kTrue)

Parameters

guideRef

- UIDRef for the guide (kGuideItemBoss)

Returns

orientation - Vertical (kFalse) or Horizontal (kTrue).

ErrorCode - result of the operation.

virtual IGuideData::GuideType Facade::IGuideFacade::GetGuideType ( const UIDRef &  guideRef ) const

pure virtual

Gets the guide type for a given guide.

Parameters

guideRef

- UIDRef for the guide (kGuideItemBoss)

Returns

IGuideData::GuideType - The type of the guide.

virtual PMReal Facade::IGuideFacade::GetGuideViewThreshold ( const UIDRef &  guideRef ) const

pure virtual

Gets the guide threshold for a given guide.

Parameters

guideRef

- UIDRef for the guide (kGuideItemBoss)

Returns

PMReal - The view threshold for the guide.

virtual ErrorCode Facade::IGuideFacade::SetGuideColor ( const UIDList &  guideList, const UID &  colorUID  )

pure virtual

Sets the guide color for one or more guides.

Parameters

guides	- a list of guides to change the color on.
color	- The UID of the UI color to change the color.

Returns

ErrorCode - result of the operation.

virtual ErrorCode Facade::IGuideFacade::SetGuideGrowZone ( const UIDList &  guideList, const PMReal &  zone  )

pure virtual

Sets the guide grow zone for one or more guides.

Parameters

guides	- a list of guides to change the zone for.
zone	- The grow zone to change the guides to.

Returns

ErrorCode - result of the operation.

virtual ErrorCode Facade::IGuideFacade::SetGuideOrientation ( const UIDList &  guideList, const bool16 &  orientation  )

pure virtual

Sets the guide orientation for one or more guides.

Parameters

guides	- a list of guides to change the orientation of.
orientation	- Vertical (kFalse) or Horizontal (kTrue).

Returns

ErrorCode - result of the operation.

virtual ErrorCode Facade::IGuideFacade::SetGuideType ( const UIDList &  guideList, const IGuideData::GuideType  guideType  )

pure virtual

Sets the guide color for one or more guides.

Parameters

guides	- a list of guides to change the type of.
guideType	- The type to change the guides to.

Returns

ErrorCode - result of the operation.

virtual ErrorCode Facade::IGuideFacade::SetGuideViewThreshold ( const UIDList &  guideList, const PMReal &  threshold  )

pure virtual

Sets the guide color for one or more guides. Default value is kDefaultViewThreshold, or 0.05 (i.e. guides always visible since 0.05% is min zoom) 1.0 would set the threshold to 100%

Parameters

guides	- a list of guides to change the view threshold for.
threshold	- the view threshold to set.

Returns

ErrorCode - result of the operation.