Class: TRoundJoint

Declaration: GrafJoints.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TJoint

Inherited By:

None.

Purpose:

Derived from TJoint, TRoundJoint implements joints that fill the gap at a corner of the frame with a circular section. In other words, a circular arc connects the endpoints of the two outer edges of the frame. The radius of the circle is predetermined; it is equal to half of the pen width.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TRoundJoint::TRoundJoint

TRoundJoint();
TRoundJoint (const TRoundJoint &)

Interface Category:

API.

Purpose:

Default constructor -radius of the round joint =0.5 pen thickness.
Copy constructor.

Calling Context:

Used by the streaming operators. You can call this function directly.
Called to copy an object. You can call this function directly.

Parameters:

Takes no parameters.
const TRoundJoint & -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: TRoundJoint::~TRoundJoint

virtual ~ TRoundJoint ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object. You can call this function directly.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRoundJoint::operator>>=

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

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

TStream & -The stream that the object streams itself 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: TRoundJoint::operator<<=

virtual TStream & operator <<= (TStream &)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & -The stream that the object streams itself 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: TRoundJoint::operator=

TRoundJoint & operator =(const TRoundJoint & source)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Call this function by using the operator in an assignment statement.

Parameters:

const TRoundJoint & 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: TRoundJoint::AdjustBounds

virtual TGRect AdjustBounds (const TGRect & currentBounds, const TPen * pen =NIL) const

Interface Category:

API.

Purpose:

Adjusts the size of the bounding rectangle to account for the thickness of the pen used. If a NIL TPen argument is passed in, the bounding rectangle is inset by a thickness of 1.0 world units. If a valid TPen argument is passed in, the bounding rectangle is inset by the appropriate amount, depending on the balance of the pen (centered or inset).

Calling Context:

Call this function directly.

Parameters:

const TGRect & currentBounds -The bounding rectangle before adjustments.
const TPen * pen =NIL -The pen used to draw the joint.

Return Value:

The modified bounding rectangle.

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.