Class: TCanvasInteractionFunnel

Declaration: GrafEditUtilities.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TCanvasGraphicFunnel

Inherited By:

None.

Purpose:

Funnel used to create a graphic-specific interactor. It identifies the first hit graphic and then asks it to create an interactor by calling its CreateInteractor member function.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Intended to be used as is but can also be derived.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TCanvasInteractionFunnel::TCanvasInteractionFunnel

TCanvasInteractionFunnel (MCanvasSelection * adopt, MToolHandler *, const TGPoint &)

Interface Category:

API.

Purpose:

Constructor.

Calling Context:

Called to create a new object.

Parameters:

MCanvasSelection * adopt -The selection adopted for the interactor creation.
MToolHandler * -The application's tool handler for interaction creation.
const TGPoint & -The point for hit detection.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCanvasInteractionFunnel::~TCanvasInteractionFunnel

virtual ~ TCanvasInteractionFunnel ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCanvasInteractionFunnel::ProcessGraphic

virtual bool ProcessGraphic (const MCanvasGraphic &)

Interface Category:

API.

Purpose:

First determines if a point hits the graphic to process. If so, then asks the graphic to create an interactor.

Calling Context:

Typically called in an implementation of EnumerateGraphics.

Parameters:

const MCanvasGraphic & -The graphic to process.

Return Value:

Returns true if the point hits the graphic to process.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCanvasInteractionFunnel::AdoptInteractor

void AdoptInteractor (TCanvasInteractor *)

Interface Category:

API.

Purpose:

Adopts an interactor for later access.

Calling Context:

Called from ProcessGraphic to retain the interactor that a hit graphic creates.

Parameters:

TCanvasInteractor * -The interactor to adopt.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCanvasInteractionFunnel::OrphanInteractor

TCanvasInteractor * OrphanInteractor ()

Interface Category:

API.

Purpose:

Orphans the currently saved interactor, if any.

Calling Context:

Called after EnumerateGraphics to extract the interactor that was created.

Parameters:

Takes no parameters.

Return Value:

TCanvasInteractor * -The interactor, if one exists; otherwise NIL.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Click the icon to mail questions or corrections about this material to Taligent personnel.