Class: TRootClipState

Declaration: ClipState.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TClipState

Inherited By:

None.

Purpose:

TRootClipState is a concrete class, derived from TClipState, that is ideal for the root clip state of a graphic hierarchy. The class supplies an infinite clip area and its own shared time stamp. The TRootGrafState class uses a TRootClipState to represent the default clip state. To create a hierarchy, link TLinkableClipState or TLinkableTransformedClipState objects to a TRootClipState object by passing it as an argument to their LinkTo member functions.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TRootClipState::TRootClipState

TRootClipState ()
TRootClipState (const TRootClipState &)

Interface Category:

API.

Purpose:

Default constructor. Sets the clipping area to an infinite area.
Copy constructor.

Calling Context:

Called by the stream-in operators. You can also call this function directly.
Called to copy an object.

Parameters:

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

virtual ~ TRootClipState ()

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

virtual const TGArea * GetClipArea () const

Interface Category:

API.

Purpose:

Returns a constant pointer to an infinite TGArea. The clipping area for a TRootClipState object can not be changed.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns a constant pointer to an infinite TGArea.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRootClipState::GetSharedTimeStampState

virtual TTimeStampState * GetSharedTimeStampState () const

Interface Category:

API.

Purpose:

Returns a pointer to a TSharedTimeStampState whose time stamp is updated whenever any clip state in the hierarchy changes.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns a pointer to a TSharedTimeStampState object that represents the time of the last modification of any of the clip states in the hierarchy.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRootClipState::GetInfiniteClipState

static const TRootClipState & GetInfiniteClipState ()

Interface Category:

API.

Purpose:

Returns a constant reference to a TRootClipState in the default state (that is, a state that has a zero time stamp). The zero time stamp value identifies the size of the clipping window as an infinite rectangle.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns a constant reference to a TRootClipState in the default state.

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.