Class: TCanvasTopSelectionHitDetectionFilter

Declaration: CanvasConvenienceFilters.h

Taxonomy Categories:

Member Functions:


Interface Category:

API.

Inherits From:

TCanvasSelectionFilter

Inherited By:

None.

Purpose:

Enumerates all graphics from front to back, including selection graphics. All selection graphics are TSRTBoxFeedbacker graphics. These are on top of all other graphics and are enumerated first.

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:

TSRTFeedbacker graphics are not part of the representation. They are created during enumeration by the filter. As each is created, the prior one is destructed. Therefore, each is valid until the next call to Next or until the filter is destructed. This corresponds to the scope of a call to the associated funnel's ProcessGraphic member function in TCanvasView::EnumerateGraphics or MCanvasSelection::EnumerateGraphics.

Member Function: TCanvasTopSelectionHitDetectionFilter::TCanvasTopSelectionHitDetectionFilter

TCanvasTopSelectionHitDetectionFilter (const MCanvasSelection * referenceSelection)

Interface Category:

API.

Purpose:

Constructor.

Calling Context:

Called to create a new object.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCanvasTopSelectionHitDetectionFilter::~TCanvasTopSelectionHitDetectionFilter

virtual ~ TCanvasTopSelectionHitDetectionFilter ()

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: TCanvasTopSelectionHitDetectionFilter::First

virtual const MCanvasGraphic * First ()

Interface Category:

API.

Purpose:

Returns the first graphic.

Calling Context:

Typically called from an implementation of EnumerateGraphics.

Parameters:

Return Value:

const MCanvasGraphic * -The first graphic.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCanvasTopSelectionHitDetectionFilter::Next

virtual const MCanvasGraphic * Next ()

Interface Category:

API.

Purpose:

Returns the next graphic.

Calling Context:

Typically called from an implementation of EnumerateGraphics.

Parameters:

Return Value:

const MCanvasGraphic * -The next graphic.

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.