Class: THairlineFrameBundle3D

Declaration: Bundles3D.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TLocalAttribute3DState

Inherited By:

None.

Purpose:

THairlineFrameBundle3D is a bundle class that is used for hairline polygon frames. In particular, the hairline frame is quite useful when a wire frame representation for a 3-D model is needed. This bundle contains a collection of attributes that contain imaging information for the rendering device. The MGraphic3D class associates a TFrameBundle3D with a 3-D geometry, in order to define the attributes needed for rendering the outer edge of the geometry. In the case of the hairline frame, the only attribute that is of consequence is the frame color.

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

THairlineFrameBundle3D ()
THairlineFrameBundle3D (const THairlineFrameBundle3D &)
THairlineFrameBundle3D (const TColor & frameColor)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.
A constructor used when the user wants to specify the frame color.

Calling Context:

Called by the stream-in operators and can be called directly.
Called to copy an object.
Called when a hairline frame of a certain color is desired.

Parameters:

Takes no parameters.
const THairlineFrameBundle3D & -The object to be copied.
const TColor & frameColor -The color to use for the new frame.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: THairlineFrameBundle3D::~THairlineFrameBundle3D

virtual ~ THairlineFrameBundle3D ()

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

THairlineFrameBundle3D & operator =(const THairlineFrameBundle3D &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const THairlineFrameBundle3D & -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: THairlineFrameBundle3D::SetFrameColor

void SetFrameColor (const TColor & frameColor)

Interface Category:

API.

Purpose:

Sets the color to be used when rendering the frame.

Calling Context:

Call this function directly.

Parameters:

const TColor & frameColor -The color to be used for the frame.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: THairlineFrameBundle3D::GetOutsideColor

virtual const TColor * GetOutsideColor () const

Interface Category:

API.

Purpose:

Returns the outside color being used for this frame.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Pointer to the outside color object being used.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: THairlineFrameBundle3D::GetFramePen

virtual const TPen * GetFramePen () const

Interface Category:

API.

Purpose:

Gets the TPen object that is used for the rendering of the frame.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

A pointer to this frame's TPen.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: THairlineFrameBundle3D::GetDrawingOperation

virtual TAttributeState :: EDrawOperation GetDrawingOperation () const

Interface Category:

API.

Purpose:

Returns the EDrawOperation that contains the rendering information.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

The EDrawingOperation value of the frame bundle.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: THairlineFrameBundle3D::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: THairlineFrameBundle3D::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.

Click the icon to mail questions or corrections about this material to Taligent personnel.