Class: TLinkableClipState

Declaration: ClipState.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TClipState

Inherited By:

None.

Purpose:

TLinkableClipState is an abstract class derived from TClipState. The base class provides protocol for accessing the encapsulated clipping area, as well as functionality for maintaining a time stamp. To these functions, TLinkableClipState adds pure virtual member functions for creating a hierarchy of clipping areas. Unlike TLinkableTransformedClipState, however, TLinkableClipState does not make use of any transformation matrix when linking a clip state to its parent. This is because TLinkableClipState is designed for cases where the linking behavior has no need to transform the clipping area into another coordinate system.

Instantiation:

Abstract class; do not allocate.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TLinkableClipState::~TLinkableClipState

virtual ~ TLinkableClipState ()

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: TLinkableClipState::GetClipArea

virtual const TGArea * GetClipArea () const

Interface Category:

API.

Purpose:

Returns a constant pointer to the clipping area. This is a pure virtual function that must be overridden by the derived classes.

Calling Context:

Do not call this function directly.

Parameters:

Return Value:

Returns a constant pointer to the clipping area.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TLinkableClipState::LinkTo

virtual void LinkTo (const TClipState * parentClipState)

Interface Category:

API.

Purpose:

Makes the specified TClipState the parent of this object. This is a pure virtual function that must be overridden by derived classes.

Calling Context:

Do not call this function directly.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TLinkableClipState::Unlink

virtual void Unlink ()

Interface Category:

API.

Purpose:

Severs the link between this object and its parent clip state. This is a pure virtual function that must be overridden by derived classes.

Calling Context:

Do not call this function directly.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TLinkableClipState::TLinkableClipState

  1. TLinkableClipState ()
  2. TLinkableClipState (const TLinkableClipState &)

Interface Category:

API.

Purpose:

  1. Default constructor. This is a protected constructor that must be overridden by derived classes.
  2. Copy constructor. This is a protected constructor that is designed to be overridden by derived classes.

Calling Context:

  1. Do not call this function directly.
  2. Do not call this function directly, except from within the copy constructor of a derived class.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TLinkableClipState::operator=

TLinkableClipState & operator =(const TLinkableClipState &)

Interface Category:

API.

Purpose:

Assignment operator. This is a protected member function that is designed to be overridden by derived classes.

Calling Context:

Do not call this function directly, except from within the operator equals of a derived class.

Parameters:

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

TStream & operator >>=(TStream &) const

Interface Category:

API.

Purpose:

Stream-out operator. This is a protected member function that is designed to be overridden by derived classes.

Calling Context:

Called to stream out data.

Parameters:

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

TStream & operator <<= (TStream &)

Interface Category:

API.

Purpose:

Stream-in operator. This is a protected member function that is designed to be overridden by derived classes.

Calling Context:

Called to stream in data.

Parameters:

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: TLinkableClipState::GetSharedTimeStampState

virtual TTimeStampState * GetSharedTimeStampState () const

Interface Category:

API.

Purpose:

Returns a pointer to the shared time stamp of this object. The shared time stamp changes whenever any clip state within the hierarchy changes. This is a pure virtual function that must to be overridden by derived classes.

Calling Context:

Do not call this function directly.

Parameters:

Return Value:

Returns a pointer to a TTimeStampState object that represents the time of the last modification of any clip state within the hierarchy.

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.