Class: TCanvasPolyline

Declaration: CanvasPolyline.h

Taxonomy Categories:

Member Functions:

TCanvasPolyline
~TCanvasPolyline
operator=
operator>>=
operator<<=
HandleDraw
HandleGetBounds
HandleHit

Interface Category:

API.

Inherits From:

MCanvasGraphic

Inherited By:

None.

Purpose:

A line canvas graphic.

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: TCanvasPolyline::TCanvasPolyline

TCanvasPolyline (const TGPolyline &)
TCanvasPolyline (const TCanvasPolyline &)
TCanvasPolyline ()

Interface Category:

API.

Purpose:

Constructor for creating new canvas polylines.
Copy constructor.
Default constructor.

Calling Context:

Called to create a new canvas polyline.
Called to copy an object.
Called by the stream-in operators and constructors of derived classes.

Parameters:

const TGPolyline & -A polyline geometry.
const TCanvasPolyline & -Another canvas polyline.
Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCanvasPolyline::~TCanvasPolyline

virtual ~ TCanvasPolyline ()

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

TCanvasPolyline & operator =(const TCanvasPolyline &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TCanvasPolyline & -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: TCanvasPolyline::operator>>=

virtual TStream & operator >>=(TStream &) 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: TCanvasPolyline::operator<<=

virtual TStream & operator <<= (TStream &)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

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

Return Value:

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

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCanvasPolyline::HandleDraw

virtual void HandleDraw (TGrafPort &) const

Interface Category:

API.

Purpose:

Draws the graphic'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 & -The port to draw into.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCanvasPolyline::HandleGetBounds

virtual TGRect HandleGetBounds () const

Interface Category:

API.

Purpose:

Returns the bounding rectangle of the untransformed geometry.

Calling Context:

Called by MCanvasGraphic::GetGeometricBounds and MCanvasGraphic::GetLooseFitBounds, which apply the graphic's transform to the returned bounds and expand it as required by the graphic's bundle.

Parameters:

Takes no parameters.

Return Value:

TGRect -The graphic's untransformed geometric bounds.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCanvasPolyline::HandleHit

virtual bool HandleHit (const TGPoint &) const

Interface Category:

API.

Purpose:

Detects the intersection of the point with the graphic's untransformed geometry.

Calling Context:

Called by MCanvasGraphic::Hit, which provides a point that has been untransformed by the graphic's transform.

Parameters:

const TGPoint & -The point to detect a hit against.

Return Value:

Returns true if the point intersects ( hits ) the graphic's untransformed geometry.

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.