Class: TCanvasPolygonCreationInteractor

Declaration: CanvasPolygon.h

Taxonomy Categories:

Member Functions:


Interface Category:

API.

Inherits From:

TCanvasPolylineMulticlickInteractor

Inherited By:

None.

Purpose:

A tool interactor that manages a multiclick interaction and uses the resulting points as vertices to create a new canvas polygon. Finally, the interactor adopts the new polygon into a canvas representation before executing a TAdoptCanvasGraphicCmd.

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.

Other Considerations:

The interaction must result in at least three points to create a new canvas polyline. The polygon is automatically closed, for example, the last multiclick point is connected to the first to produce a closed polygon. If the last multiclick point is within five pixels of the first point, it is dropped and the prior point is connected to the first point.

Member Function: TCanvasPolygonCreationInteractor::TCanvasPolygonCreationInteractor

TCanvasPolygonCreationInteractor (MCanvasSelection * adoptTarget, MToolHandler *)

Interface Category:

API.

Purpose:

Creates a new object.

Calling Context:

Created by a TCanvasLineCreationTool.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCanvasPolygonCreationInteractor::~TCanvasPolygonCreationInteractor

virtual ~ TCanvasPolygonCreationInteractor ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCanvasPolygonCreationInteractor::EndInteraction

virtual void EndInteraction ()

Interface Category:

API.

Purpose:

Processes vertices and creates a new canvas polyline when the multiclick interaction is complete.

Calling Context:

Called by the Graphics Editing framework.

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.
Copyright©1995 Taligent,Inc. All rights reserved.