Class: TCanvasHitDetectionFunnel

Declaration: GrafEditUtilities.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TCanvasGraphicFunnel

Inherited By:

None.

Purpose:

Funnel used to identify the first graphic that a specified point hits.

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.

Member Function: TCanvasHitDetectionFunnel::TCanvasHitDetectionFunnel

TCanvasHitDetectionFunnel (const TGPoint &)

Interface Category:

API.

Purpose:

Constructor.

Calling Context:

Called to create a new object.

Parameters:

const TGPoint & -The point for hit detection.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCanvasHitDetectionFunnel::~TCanvasHitDetectionFunnel

virtual ~ TCanvasHitDetectionFunnel ()

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: TCanvasHitDetectionFunnel::ProcessGraphic

virtual bool ProcessGraphic (const MCanvasGraphic &)

Interface Category:

API.

Purpose:

Determines if a point hits the graphic to process.

Calling Context:

Typically called in an implementation of EnumerateGraphics.

Parameters:

const MCanvasGraphic & -The graphic to process.

Return Value:

Returns true if the point hits the graphic to process.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCanvasHitDetectionFunnel::GetHitGraphicID

TCanvasGraphicID GetHitGraphicID () const

Interface Category:

API.

Purpose:

Identifies the hit graphic, if any.

Calling Context:

Typically called after graphic enumeration with either TCanvasView::EnumerateGraphics or MCanvasSelection::EnumerateGraphics.

Parameters:

Takes no parameters.

Return Value:

TCanvasGraphicID -The ID of the hit graphic, or TCanvasGraphicID::kInvalidID if no graphic was hit.

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.