Class: TCanvasLineCreationInteractor

Declaration: CanvasLine.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TCanvasLineDragInteractor

Inherited By:

None.

Purpose:

A tool interactor that manages a drag interaction and uses the start and end points of the drag as end points to create a new canvas line. Finally, the interactor adopts the new line into a canvas representation by executing a TAdoptCanvasGraphicCmd.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Intended to be used as is but can be derived.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TCanvasLineCreationInteractor::TCanvasLineCreationInteractor

TCanvasLineCreationInteractor (MCanvasSelection * adoptTarget, MToolHandler *)

Interface Category:

API.

Purpose:

Creates a new object.

Calling Context:

Created by a TCanvasLineCreationTool.

Parameters:

MCanvasSelection * adoptTarget -A canvas selection for the TAdoptCanvasGraphicCmd to be bound to in order to adopt the line into the representation.
MToolHandler * -The tool handler to be called to execute the TAdoptCanvasGraphicCmd.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCanvasLineCreationInteractor::~TCanvasLineCreationInteractor

virtual ~ TCanvasLineCreationInteractor ()

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: TCanvasLineCreationInteractor::EndInteraction

virtual void EndInteraction ()

Interface Category:

API.

Purpose:

Processes the end points and creates a new canvas line when the drag interaction is complete.

Calling Context:

Called by the Graphics Editing framework.

Parameters:

Takes no parameters.

Return Value:

None.

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.