Class: TRootAttribute3DState

Declaration: Attribute3DState.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TAttribute3DState

Inherited By:

None.

Purpose:

TRootAttribute3DState is a concrete class, derived from TAttribute3DState, that is ideal for the root 3-D attribute state of a graphic hierarchy. The class supplies the default 3-D attributes. The TRootGrafState class uses a TRootAttribute3DState to represent the default 3-D attribute state. To create a hierarchy, link TLocalAttribute3DState objects to a TRootAttribute3DState 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: TRootAttribute3DState::TRootAttribute3DState

  1. TRootAttribute3DState ()
  2. TRootAttribute3DState (const TRootAttribute3DState &)

Interface Category:

API.

Purpose:

  1. Default constructor.
  2. Copy constructor.

Calling Context:

  1. Called by the stream-in operators and directly.
  2. Called to copy an object.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRootAttribute3DState::~TRootAttribute3DState

virtual ~ TRootAttribute3DState ()

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: TRootAttribute3DState::GetBackfaceCulling

virtual EBackfaceCulling GetBackfaceCulling () const

Interface Category:

API.

Purpose:

Returns the default backface culling.

Calling Context:

Call this function directly.

Parameters:

Return Value:

Returns the default value of the backface culling mode.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRootAttribute3DState::GetOutsideShader

virtual const TShader * GetOutsideShader () const

Interface Category:

API.

Purpose:

Returns the default outside shader.

Calling Context:

Call this function directly.

Parameters:

Return Value:

A constant pointer to the default outside shader object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRootAttribute3DState::GetInsideShader

virtual const TShader * GetInsideShader () const

Interface Category:

API.

Purpose:

Returns the default inside shader.

Calling Context:

Call this function directly.

Parameters:

Return Value:

A constant pointer to the default inside shader.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRootAttribute3DState::GetOutsideColor

virtual const TColor * GetOutsideColor () const

Interface Category:

API.

Purpose:

Returns the default outside color.

Calling Context:

Call this function directly.

Parameters:

Return Value:

A constant pointer to the default outside color.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRootAttribute3DState::GetInsideColor

virtual const TColor * GetInsideColor () const

Interface Category:

API.

Purpose:

Returns the default inside color.

Calling Context:

Call this function directly.

Parameters:

Return Value:

A constant pointer to the default inside color.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRootAttribute3DState::GetShadingInterpolation

virtual EShadingInterpolationMode GetShadingInterpolation () const

Interface Category:

API.

Purpose:

Returns the default shading interpolation.

Calling Context:

Call this function directly.

Parameters:

Return Value:

Returns the default shading interpolation value.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRootAttribute3DState::GetTextureMappingMatrix

virtual const TGrafMatrix * GetTextureMappingMatrix () const

Interface Category:

API.

Purpose:

Returns the default texture mapping matrix.

Calling Context:

Call this function directly.

Parameters:

Return Value:

A constant pointer to the default texture mapping matrix.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRootAttribute3DState::GetFramePen

virtual const TPen * GetFramePen () const

Interface Category:

API.

Purpose:

Returns the default frame pen.

Calling Context:

Call this function directly.

Parameters:

Return Value:

A constant pointer to the default frame pen.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRootAttribute3DState::GetGrafAttribute

virtual const TGrafAttribute * GetGrafAttribute (const TToken & key) const

Interface Category:

API.

Purpose:

Returns the custom attribute associated with the specified name. Returns NIL if there is no such attribute.

Calling Context:

Call this function directly.

Parameters:

Return Value:

A constant pointer to the custom attribute object, or NIL if it doesn't exist.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRootAttribute3DState::operator<<=

virtual TStream & operator <<= (TStream &)

Interface Category:

API.

Purpose:

Stream-in operator.

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

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

Interface Category:

API.

Purpose:

Stream-out operator.

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: TRootAttribute3DState::GetDrawingOperation

virtual TAttributeState :: EDrawOperation GetDrawingOperation () const

Interface Category:

API.

Purpose:

Returns the default drawing operation.

Calling Context:

Call this function directly.

Parameters:

Return Value:

Returns a value that specifies the drawing operation to be used in the rendering process. The possible return values are kFill, kFrame, kFillAndFrame, and kUnset.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRootAttribute3DState::GetShadingQuality

virtual EShadingQuality GetShadingQuality () const

Interface Category:

API.

Purpose:

Returns the default shading quality.

Calling Context:

Call this function directly.

Parameters:

Return Value:

Returns a value that specifies the shading quality to be used in the rendering process. The possible return values are kFast, kMedium, kBest, and kShadingQualityUnset.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRootAttribute3DState::GetPrimaryDitherHint

virtual const TDitherHint * GetPrimaryDitherHint () const

Interface Category:

API.

Purpose:

Returns the default dither hint.

Calling Context:

Call this function directly.

Parameters:

Return Value:

Returns a pointer to the dither hint object to be used when dithering is performed.

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.