DVAGMAcquireClip Class Reference

#include <DVAGMAcquireClip.h>

Public Member Functions
	DVAGMAcquireClip (IViewPort *vp, IControlView *view, SysRgn clipRgn=nil)
	DVAGMAcquireClip (IViewPort *vp, SysRgn clipRgn)
	~DVAGMAcquireClip ()
SysRgn	GetClip () const
SysRgn	GetOriginAdjustedClip () const
void	SetupPlatformClip ()
void	TearDownPlatformClip ()

Detailed Description

An object that sets up the clip for a view or viewport. To be used when you want to draw using AGM. This is usually not used standalone but as a template parameter to AGMGraphicsContextWith.

See Also

AGMGraphicsContext.h

Constructor & Destructor Documentation

DVAGMAcquireClip::DVAGMAcquireClip	(	IViewPort *	vp,
		IControlView *	view,
		SysRgn	clipRgn = nil
	)

Constructs a clipping acquisition object based on a viewport, a control view, and an optional sys region.

Parameters

vp	The viewport to base the clipping on
view	The control view to base the clipping on
clipRgn	The clipping region to use

DVAGMAcquireClip::DVAGMAcquireClip	(	IViewPort *	vp,
		SysRgn	clipRgn
	)

Constructs a clipping acquisition object based on a viewport and an optional sys region.

Parameters

vp	The viewport to base the clipping on
clipRgn	The clipping region to use

DVAGMAcquireClip::~DVAGMAcquireClip

(

)

Destructor

Member Function Documentation

SysRgn DVAGMAcquireClip::GetClip

(

)

const

Gets the clipping region for this context

Returns

The clip region

SysRgn DVAGMAcquireClip::GetOriginAdjustedClip

(

)

const

Gets the clipping region for this context, adjusted for the origin

Returns

The origin-adjusted clip region

void DVAGMAcquireClip::SetupPlatformClip

(

)

Sets up the platform clipping

void DVAGMAcquireClip::TearDownPlatformClip

(

)

Tears down the platform clipping