Class: TBasicCanvasGraphicCreationInteractor

Declaration: BasicCanvasGraphic.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TCanvasRectDragInteractor

Inherited By:

None.

Purpose:

A tool interactor that manages a drag interaction and uses the start and end points of the drag as opposite corners of a bounding rectangle to create a basic canvas graphic. Finally, the interactor adopts the new basic canvas graphic into a canvas representation before executing a TAdoptCanvasGraphicCmd.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Intended to be used as is, not likely to be derived but can be derived.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TBasicCanvasGraphicCreationInteractor::TBasicCanvasGraphicCreationInteractor

TBasicCanvasGraphicCreationInteractor (MCanvasSelection * adoptTarget, MToolHandler * toolHandler, const MGraphic & thePrototype)

Interface Category:

API.

Purpose:

Constructs from a target selection, tool handler, and unit MGraphic.

Calling Context:

Called to create a new interactor.

Parameters:

MCanvasSelection * adoptTarget -A canvas selection for the TAdoptCanvasGraphicCmd to be bound to in order to adopt the basic canvas graphic into the representation.
MToolHandler * toolHandler -The tool handler to be called to execute the TAdoptCanvasGraphicCmd.
const MGraphic & thePrototype -A unit MGraphic, for example, an MGraphic with a bounds from TGPoint(0,0) to TGPoint(1,1).

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

At the end of interaction, the unit MGraphic is scaled and translated to fit in the bounds defined by the start and end points of the drag interaction.

Member Function: TBasicCanvasGraphicCreationInteractor::~TBasicCanvasGraphicCreationInteractor

virtual ~ TBasicCanvasGraphicCreationInteractor ()

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

virtual void EndInteraction ()

Interface Category:

API.

Purpose:

Processes the start and end points of the drag interaction to create a bounding rectangle, transforms the unit MGraphic to fit in the resulting bounds, and creates a new basic canvas graphic 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.