#include <AGMGraphicsContextWith.h>

Inheritance diagram for AGMGraphicsContextWith< AcquireCoordSys, AcquireClip >:

Public Member Functions
	AGMGraphicsContextWith (IViewPort viewPort, IControlView controlView, SysRgn clipRgn=nil)

	AGMGraphicsContextWith (IViewPort viewPort, ITransform xform=nil, SysRgn clipRgn=nil)

	AGMGraphicsContextWith (IViewPort *viewPort, const PMMatrix &theMatrix, SysRgn clipRgn=nil)

	AGMGraphicsContextWith (IViewPort viewPort, const PMMatrix &theMatrix, IControlView controlView, SysRgn clipRgn=nil)

	AGMGraphicsContextWith (IViewPort viewPort, ITransform xform, IControlView *controlView, SysRgn clipRgn=nil)

virtual	~AGMGraphicsContextWith ()

virtual SysRgn	GetClip () const

virtual SysRgn	GetOriginAdjustedClip () const

virtual SysPort	GetSysPort () const

virtual IViewPort *	GetViewPort () const

virtual const PMMatrix &	GetContentToViewTransform () const

virtual const PMMatrix &	GetViewToContentTransform () const

virtual IControlView *	GetView () const

bool16	IsCurrent () const

virtual dvaui::drawbot::Drawbot *	GetDrawbot () const

Detailed Description

template<class AcquireCoordSys, class AcquireClip>
class AGMGraphicsContextWith< AcquireCoordSys, AcquireClip >

A class template that sets up the coordinate system and clip for a given view or view port. The template requires two parameters, a class that sets up the coordinate system and a class that sets up the clip. By using different implementations for these you can build a graphic context for AGM on Mac, AGM on Win, Quickdraw on Mac, or GDI on Win.

The various constructor overrides allow flexibility in how the graphics context is to be set up. Each installs this context as the current context in the graphics context arbitrator's stack of graphics contexts. The destructor then restores the prior context.

See Also: IGraphicsContext; IGraphicsContextArbitrator

Constructor & Destructor Documentation

template<class AcquireCoordSys, class AcquireClip>

AGMGraphicsContextWith< AcquireCoordSys, AcquireClip >::AGMGraphicsContextWith	(	IViewPort *	viewPort,
		IControlView *	controlView,
		SysRgn	clipRgn = `nil`
	)

Constructs a graphics context based on a viewport, a control view, and an optional clip region

Parameters

viewPort	IN The view port to base the context on
controlView	IN The control view to base the context on
clipRgn	IN The clipping region to use

See Also: IViewPort; IControlView

template<class AcquireCoordSys, class AcquireClip>

AGMGraphicsContextWith< AcquireCoordSys, AcquireClip >::AGMGraphicsContextWith	(	IViewPort *	viewPort,
		ITransform *	xform = `nil`,
		SysRgn	clipRgn = `nil`
	)

Constructs a graphics context based on a viewport, a control view, and an optional clip region

Parameters

viewPort	IN The view port to base the context on
xform	IN The optional transform to use
clipRgn	IN The clipping region to use

See Also: IViewPort; ITransform

template<class AcquireCoordSys, class AcquireClip>

AGMGraphicsContextWith< AcquireCoordSys, AcquireClip >::AGMGraphicsContextWith	(	IViewPort *	viewPort,
		const PMMatrix &	theMatrix,
		SysRgn	clipRgn = `nil`
	)

Constructs a graphics context based on a viewport, a matrix, and an optional clip region

Parameters

viewPort	IN The view port to base the context on
theMatrix	IN The matrix to apply
clipRgn	IN The clipping region to use

See Also: IViewPort

template<class AcquireCoordSys, class AcquireClip>

AGMGraphicsContextWith< AcquireCoordSys, AcquireClip >::AGMGraphicsContextWith	(	IViewPort *	viewPort,
		const PMMatrix &	theMatrix,
		IControlView *	controlView,
		SysRgn	clipRgn = `nil`
	)

Constructs a graphics context based on a viewport, a matrix, a control view, and an optional clip region

Parameters

viewPort	IN The view port to base the context on
theMatrix	IN The matrix to apply
controlView	IN The control view to base the context on
clipRgn	IN The clipping region to use

See Also: IViewPort; IControlView

template<class AcquireCoordSys, class AcquireClip>

AGMGraphicsContextWith< AcquireCoordSys, AcquireClip >::AGMGraphicsContextWith	(	IViewPort *	viewPort,
		ITransform *	xform,
		IControlView *	controlView,
		SysRgn	clipRgn = `nil`
	)

Constructs a graphics context based on a viewport, a transform, a control view, and an optional clip region

Parameters

viewPort	IN The view port to base the context on
xform	IN The transform to apply
controlView	IN The control view to base the context on
clipRgn	IN The clipping region to use

See Also: IViewPort; IControlView

template<class AcquireCoordSys, class AcquireClip>

virtual AGMGraphicsContextWith< AcquireCoordSys, AcquireClip >::~AGMGraphicsContextWith ( )

virtual

Destructs this graphics context

Member Function Documentation

template<class AcquireCoordSys , class AcquireClip >

SysRgn AGMGraphicsContextWith< AcquireCoordSys, AcquireClip >::GetClip ( ) const

inlinevirtual

Gets the clipping region for this context

Returns: The clip region

Implements IGraphicsContext.

template<class AcquireCoordSys , class AcquireClip >

const PMMatrix & AGMGraphicsContextWith< AcquireCoordSys, AcquireClip >::GetContentToViewTransform ( ) const

inlinevirtual

Gets the transform matrix for this graphics context

Returns: the transform matrix

Implements IGraphicsContext.

template<class AcquireCoordSys, class AcquireClip>

virtual dvaui::drawbot::Drawbot* AGMGraphicsContextWith< AcquireCoordSys, AcquireClip >::GetDrawbot ( ) const

inlinevirtual

Internal use only

Implements IGraphicsContext.

template<class AcquireCoordSys , class AcquireClip >

SysRgn AGMGraphicsContextWith< AcquireCoordSys, AcquireClip >::GetOriginAdjustedClip ( ) const

inlinevirtual

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

Returns: The origin-adjusted clip region

Implements IGraphicsContext.

template<class AcquireCoordSys , class AcquireClip >

SysPort AGMGraphicsContextWith< AcquireCoordSys, AcquireClip >::GetSysPort ( ) const

inlinevirtual

Obsolete don't use

Gets the system port for this graphics context

Returns: The system port

Obsolete don't use

It will cause a assert if called

Implements IGraphicsContext.

template<class AcquireCoordSys , class AcquireClip >

IControlView * AGMGraphicsContextWith< AcquireCoordSys, AcquireClip >::GetView ( ) const

inlinevirtual

Gets the control view for this graphics context, if any

Returns: the control view

See Also: IControlView

Implements IGraphicsContext.

template<class AcquireCoordSys , class AcquireClip >

IViewPort * AGMGraphicsContextWith< AcquireCoordSys, AcquireClip >::GetViewPort ( ) const

inlinevirtual

Gets the view port interface for this graphics context

Returns: the view port

See Also: IViewPort

Implements IGraphicsContext.

template<class AcquireCoordSys , class AcquireClip >

const PMMatrix & AGMGraphicsContextWith< AcquireCoordSys, AcquireClip >::GetViewToContentTransform ( ) const

inlinevirtual

Gets the inverse transform matrix for this graphics context

Returns: the inverse transform matrix

Implements IGraphicsContext.

template<class AcquireCoordSys, class AcquireClip>

bool16 AGMGraphicsContextWith< AcquireCoordSys, AcquireClip >::IsCurrent ( ) const

virtual

Gets the 'is current' flag for this graphics context. The context is current if it matches the current context maintained by the graphics context arbitrator

Returns: kTrue if this graphics context is current

See Also: IGraphicsContextArbitrator

Implements IGraphicsContext.

Public Member Functions

Detailed Description

template<class AcquireCoordSys, class AcquireClip> class AGMGraphicsContextWith< AcquireCoordSys, AcquireClip >

Constructor & Destructor Documentation

Member Function Documentation

template<class AcquireCoordSys, class AcquireClip>
class AGMGraphicsContextWith< AcquireCoordSys, AcquireClip >