Class: TCanvasPolylineMulticlickInteractor

Declaration: CanvasInteraction.h

Taxonomy Categories:

Member Functions:


Interface Category:

API.

Inherits From:

TCanvasMulticlickInteractor

Inherited By:

TCanvasPolygonCreationInteractor TCanvasPolylineCreationInteractor

Purpose:

A base class for multiclick interactors that draw a polyline through all of the multiclick points during interaction.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Abstract base class; must be derived. Typically a derived class overrides EndInteraction to implement the execution of a command at the end of the drag.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TCanvasPolylineMulticlickInteractor::TCanvasPolylineMulticlickInteractor

TCanvasPolylineMulticlickInteractor (MToolHandler *)

Interface Category:

API.

Purpose:

Constructor.

Calling Context:

Called by constructors of derived classes.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCanvasPolylineMulticlickInteractor::~TCanvasPolylineMulticlickInteractor

virtual ~ TCanvasPolylineMulticlickInteractor ()

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: TCanvasPolylineMulticlickInteractor::MouseMoved

virtual bool MouseMoved (TMouseMovedEvent &)

Interface Category:

API.

Purpose:

Handles the mouse-moved event in the context of polyline multiclick interaction.

Calling Context:

Called by the Mouse Input framework. Clients do not call this function. Derived classes must call the base class implementation.

Parameters:

Return Value:

Returns true because the mouse-moved event is always handled.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCanvasPolylineMulticlickInteractor::DrawFeedback

virtual void DrawFeedback ()

Interface Category:

API.

Purpose:

Draws feedback of a polyline consisting of all multiclick points thus far and ending with the current mouse location that has not been recorded.

Calling Context:

Called by TCanvasMulticlickInteractor mouse event handling functions.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCanvasPolylineMulticlickInteractor::MouseDown

virtual bool MouseDown (TMouseDownEvent &)

Interface Category:

API.

Purpose:

Handles the mouse-down event in the context of polyline multiclick interaction.

Calling Context:

Called by the Mouse Input framework. Clients do not call this function. Derived classes must call the base class implementation.

Parameters:

Return Value:

Returns true because the mouse-down event is always handled.

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.