CAGMAcquireCoordSys Class Reference

#include <CAGMAcquireCoordSys.h>

Inheritance diagram for CAGMAcquireCoordSys:

Public Member Functions
	CAGMAcquireCoordSys (IViewPort *viewPort, IControlView *controlView)
	CAGMAcquireCoordSys (IViewPort *viewPort, ITransform *xform=nil)
	CAGMAcquireCoordSys (IViewPort *viewPort, const PMMatrix &theMatrix)
	CAGMAcquireCoordSys (IViewPort *viewPort, const PMMatrix &theMatrix, IControlView *controlView)
	CAGMAcquireCoordSys (IViewPort *viewPort, ITransform *xform, IControlView *controlView)
	~CAGMAcquireCoordSys ()
IViewPort *	GetViewPort () const
const PMMatrix &	GetTransform () const
const PMMatrix &	GetInverseTransform () const
IControlView *	GetView () const
Public Member Functions inherited from CAcquireCoordSys
	CAcquireCoordSys ()
	~CAcquireCoordSys ()

Protected Member Functions
void	CommonInit ()
void	CommonTerm ()
virtual void	Resume ()
virtual void	Suspend ()
void	Setup ()
void	TearDown ()
virtual void	SetupSysOrigin ()=0
virtual void	TearDownSysOrigin ()=0

Protected Attributes
IViewPort *	fVP
PMMatrix	fXForm
PMMatrix	fInvXForm
bool16	fInverseValid
IControlView *	fView
PMMatrix	fOrigMatrix
Protected Attributes inherited from CAcquireCoordSys
int16	fDepth
CAcquireCoordSys *	fNextContext

Additional Inherited Members
Static Protected Member Functions inherited from CAcquireCoordSys
static int16	GetStackDepth ()
static void	IncrStackDepth ()
static void	DecrStackDepth ()
static CAcquireCoordSys *	GetFirstContext ()
static void	SetFirstContext (CAcquireCoordSys *)

Detailed Description

An object that sets up the coordinate system for a given view or port. This is usually not used standalone but as a template parameter to AGMGraphicsContextWith.

See Also

AGMGraphicsContextWith

Constructor & Destructor Documentation

CAGMAcquireCoordSys::CAGMAcquireCoordSys	(	IViewPort *	viewPort,
		IControlView *	controlView
	)

Constructs a coordinate system acquisition object based on a viewport and a control view

Parameters

viewPort	The viewport to base the coordinate system on
controlView	The control view to base the coordinate system on

CAGMAcquireCoordSys::CAGMAcquireCoordSys	(	IViewPort *	viewPort,
		ITransform *	xform = nil
	)

Constructs a coordinate system acquisition object based on a viewport and an optional transform

Parameters

viewPort	The viewport to base the coordinate system on
xform	The transform to base the coordinate system on

CAGMAcquireCoordSys::CAGMAcquireCoordSys	(	IViewPort *	viewPort,
		const PMMatrix &	theMatrix
	)

Constructs a coordinate system acquisition object based on a viewport and a matrix

Parameters

viewPort	The viewport to base the coordinate system on
theMatrix	The matrix to base the coordinate system on

CAGMAcquireCoordSys::CAGMAcquireCoordSys	(	IViewPort *	viewPort,
		const PMMatrix &	theMatrix,
		IControlView *	controlView
	)

Constructs a coordinate system acquisition object based on a viewport, a matrix, and a control view

Parameters

viewPort	The viewport to base the coordinate system on
theMatrix	The matrix to base the coordinate system on
controlView	The control view to base the coordinate system on

CAGMAcquireCoordSys::CAGMAcquireCoordSys	(	IViewPort *	viewPort,
		ITransform *	xform,
		IControlView *	controlView
	)

Constructs a coordinate system acquisition object based on a viewport, a transform, and a control view

Parameters

viewPort	The viewport to base the coordinate system on
xform	The transform to base the coordinate system on
controlView	The control view to base the coordinate system on

CAGMAcquireCoordSys::~CAGMAcquireCoordSys

(

)

Destructor

Member Function Documentation

void CAGMAcquireCoordSys::CommonInit ( )

protected

Common initialization routine

void CAGMAcquireCoordSys::CommonTerm ( )

protected

Common termination routine

const PMMatrix& CAGMAcquireCoordSys::GetInverseTransform

(

)

const

Returns the inverse of the matrix used to construct this object

const PMMatrix & CAGMAcquireCoordSys::GetTransform ( ) const

inline

Returns the matrix used to construct this object

IControlView * CAGMAcquireCoordSys::GetView ( ) const

inline

Returns the control view used to construct this object

IViewPort * CAGMAcquireCoordSys::GetViewPort ( ) const

inline

Returns the viewport used to construct this object

virtual void CAGMAcquireCoordSys::Resume ( )

protectedvirtual

Called when this object is made the current coordinate system acquisition object

Implements CAcquireCoordSys.

void CAGMAcquireCoordSys::Setup ( )

protected

Sets port's coordinate system

virtual void CAGMAcquireCoordSys::SetupSysOrigin ( )

protectedpure virtual

Sets up the system coordinate system origin

Implemented in DVAGMAcquireCoordSys.

virtual void CAGMAcquireCoordSys::Suspend ( )

protectedvirtual

Called when another object is made the current coordinate system acquisition object

Implements CAcquireCoordSys.

void CAGMAcquireCoordSys::TearDown ( )

protected

Tears down port's coordinate system

virtual void CAGMAcquireCoordSys::TearDownSysOrigin ( )

protectedpure virtual

Tears down the system coordinate system origin

Implemented in DVAGMAcquireCoordSys.