Class: TSRTHandleFeedbacker

Declaration: CanvasGraphicManipulation.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TSRTFeedbacker

Inherited By:

None.

Purpose:

A standard selection feedback graphic that supports direct manipulation, scaling,, and translating of the graphic it represents. In this case, the graphic is a handle interactor.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TSRTHandleFeedbacker::TSRTHandleFeedbacker

TSRTHandleFeedbacker ()
TSRTHandleFeedbacker (const MCanvasGraphic & forThis)
TSRTHandleFeedbacker (const TSRTHandleFeedbacker &)

Interface Category:

API.

Purpose:

Default constructor.
Used for creating a feedbacker region for a given canvas graphic.
Copy constructor.

Calling Context:

Called by the stream-in operators and can be called directly.
Call this function directly.
Called to copy an object.

Parameters:

Takes no parameters.
const MCanvasGraphic & forThis -The canvas graphic this new feedbacker is to be associated with.
const TSRTHandleFeedbacker & -The object to be copied.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSRTHandleFeedbacker::~TSRTHandleFeedbacker

virtual ~ TSRTHandleFeedbacker ()

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: TSRTHandleFeedbacker::operator=

TSRTHandleFeedbacker & operator =( const TSRTHandleFeedbacker & source)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TSRTHandleFeedbacker & source -The object to be copied.

Return Value:

A non-const reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSRTHandleFeedbacker::operator>>=

virtual TStream & operator >>=(TStream & toWhere) const

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

TStream & toWhere -The stream the object is streamed out to.

Return Value:

Returns a reference to the stream the object streams itself out to.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSRTHandleFeedbacker::operator<<=

virtual TStream & operator <<= (TStream & fromWhere)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & fromWhere -The stream the object is streamed in from.

Return Value:

Returns a reference to the stream the object streams itself in from.

Exceptions:

Throws TStandardException (kStreamBadVersion,0) if streaming in aversion other than kOriginalVersion. Passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSRTHandleFeedbacker::HandleDraw

virtual void HandleDraw (TGrafPort & port) const

Interface Category:

API.

Purpose:

Draws the feedbacker's untransformed geometry.

Calling Context:

Called by MCanvasGraphic::Draw, which links the graphic's transform and bundle to the port before calling HandleDraw.

Parameters:

TGrafPort & port -The graphics port to draw into.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSRTHandleFeedbacker::HandleCreateInteractor

virtual TCanvasInteractor * HandleCreateInteractor (MCanvasSelection * adoptTarget, MToolHandler *, const TGPoint &) const

Interface Category:

API.

Purpose:

Creates a handle-type interactor corresponding to the location of the point. The TSRTHandleFeedbacker consists of a rectangle connected by four corners. If the mouse click is in any of the four corners, then a scaling interactor is created and returned. If the mouse click is in the center, then a translating interactor is created and returned. If the point is not in the box feedbacker, then NIL is returned. Note that this type of feedbacker does not supply a rotation interactor.

Calling Context:

Call this function directly.

Parameters:

MCanvasSelection * adoptTarget -The target.
MToolHandler * -The tool handler.
const TGPoint & -The point that determines the type of interactor.

Return Value:

An interactor for the appropriate type of interaction.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSRTHandleFeedbacker::SetGraphic

virtual void SetGraphic (const MCanvasGraphic * forThis)

Interface Category:

API.

Purpose:

Associates this feedbacker with a given graphic. This is necessary in order for a particular instance of a feedbacker to be reused with different graphics (of different sizes)..

Calling Context:

Call this function directly. Typically called by a filter.

Parameters:

const MCanvasGraphic * forThis -The graphic for the feedbacker to become associated with.

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.