Class: TRootGrafState

Declaration: GrafState.h

Taxonomy Categories:

Member Functions:


Interface Category:

API.

Inherits From:

TGrafState

Inherited By:

None.

Purpose:

TRootGrafState is a concrete class derived from TGrafState. TRootGrafState provides access to the default graphic state. The default graphic state includes identity matrices and infinite clip boundaries; default attributes as specified by the TRootAttributeState, TRootAttribute3DState and TRootSceneState classes; and a 3-D model matrix that is linked to the default scene state's camera. Unlike TRootGrafPort, TRootGrafState has no knowledge of devices.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TRootGrafState::TRootGrafState

TRootGrafState ()

Interface Category:

API.

Purpose:

Default constructor. The default values for the various state objects (attribute state, 3-D attribute state, view matrix state, clip state, model matrix state, scene state, and 3-D matrix state) are defined by their respective default constructors.

Calling Context:

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: TRootGrafState::~TRootGrafState

virtual ~ TRootGrafState ()

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: TRootGrafState::GetAttributeState

virtual const TAttributeState * GetAttributeState () const

Interface Category:

API.

Purpose:

Returns a constant pointer to a TAttributeState containing default 2-D attributes.

Calling Context:

Call this function directly.

Parameters:

Return Value:

Returns a constant pointer to a TAttributeState containing default 2-D attributes.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRootGrafState::GetAttribute3DState

virtual const TAttribute3DState * GetAttribute3DState () const

Interface Category:

API.

Purpose:

Returns a constant pointer to a TAttribute3DState containing default 3-D attributes.

Calling Context:

Call this function directly.

Parameters:

Return Value:

Returns a constant pointer to a TAttribute3DState containing default 3-D attributes.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRootGrafState::GetViewMatrixState

virtual const TMatrixState * GetViewMatrixState () const

Interface Category:

API.

Purpose:

Returns a constant pointer to an identity TMatrixState that defines the default 2-D view coordinate system.

Calling Context:

Call this function directly.

Parameters:

Return Value:

Returns a constant pointer to an identity TMatrixState that defines the default 2-D view coordinate system.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRootGrafState::GetModelMatrixState

virtual const TMatrixState * GetModelMatrixState () const

Interface Category:

API.

Purpose:

Returns a constant pointer to an identity TMatrixState that defines the default 2-D model coordinate system.

Calling Context:

Call this function directly.

Parameters:

Return Value:

Returns a constant pointer to an identity TMatrixState that defines the default 2-D model coordinate system.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRootGrafState::GetClipState

virtual const TClipState * GetClipState () const

Interface Category:

API.

Purpose:

Returns a constant pointer to a TClipState that defines an infinite 2-D clipping area.

Calling Context:

Call this function directly.

Parameters:

Return Value:

Returns a constant pointer to a TClipState that defines an infinite 2-D clipping area.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRootGrafState::GetSceneState

virtual const TSceneState * GetSceneState () const

Interface Category:

API.

Purpose:

Returns a constant pointer to a TSceneState containing default global 3-D features, such as the camera and lights.

Calling Context:

Call this function directly.

Parameters:

Return Value:

Returns a constant pointer to a TSceneState containing default global 3-D features.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRootGrafState::GetModelMatrix3DState

virtual const TMatrix3DState * GetModelMatrix3DState () const

Interface Category:

API.

Purpose:

Returns a constant pointer to a TMatrix3DState that is linked to the default scene state's camera.

Calling Context:

Call this function directly.

Parameters:

Return Value:

Returns a constant pointer to a TMatrix3DState that is linked to the default scene state's camera.

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.