Class: TLocalAttribute3DState

Declaration: Attribute3DState.h

Taxonomy Categories:

Member Functions:


Interface Category:

API.

Inherits From:

TAttribute3DState

Inherited By:

TFillBundle3D TFrameBundle3D THairlineFrameBundle3D

Purpose:

Derived from TAttribute3DState, TLocalAttribute3DState provides implementations for all the functions, each of which returns the value that represents the unset value of the attribute. The purpose of this class is to define a convenient starting point for making derived classes that define a subset of the attributes, all others being unset.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Provided classes: TFillBundle3D, TFrameBundle3D, THairlineFrameBundle3D.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TLocalAttribute3DState::TLocalAttribute3DState

  1. TLocalAttribute3DState ()
  2. TLocalAttribute3DState (const TLocalAttribute3DState &)

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

virtual ~ TLocalAttribute3DState ()

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

TLocalAttribute3DState & operator =( const TLocalAttribute3DState &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

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

virtual EBackfaceCulling GetBackfaceCulling () const

Interface Category:

API.

Purpose:

Returns the unset value of backface culling.

Calling Context:

Call this function directly.

Parameters:

Return Value:

Returns kUnset, meaning that the backface culling mode is not specified.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TLocalAttribute3DState::GetOutsideShader

virtual const TShader * GetOutsideShader () const

Interface Category:

API.

Purpose:

Returns the unset value for the outside shader.

Calling Context:

Call this function directly.

Parameters:

Return Value:

Returns NIL, meaning that an outside shader is not specified.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TLocalAttribute3DState::GetInsideShader

virtual const TShader * GetInsideShader () const

Interface Category:

API.

Purpose:

Returns the unset value for the inside shader.

Calling Context:

Call this function directly.

Parameters:

Return Value:

Returns NIL, meaning that an inside shader is not specified.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TLocalAttribute3DState::GetOutsideColor

virtual const TColor * GetOutsideColor () const

Interface Category:

API.

Purpose:

Returns the unset value for the outside color.

Calling Context:

Call this function directly.

Parameters:

Return Value:

Returns NIL, meaning that an outside color is not specified.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TLocalAttribute3DState::GetInsideColor

virtual const TColor * GetInsideColor () const

Interface Category:

API.

Purpose:

Returns the unset value for the inside color.

Calling Context:

Call this function directly.

Parameters:

Return Value:

Returns NIL, meaning that an inside color is not specified.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TLocalAttribute3DState::GetShadingInterpolation

virtual EShadingInterpolationMode GetShadingInterpolation () const

Interface Category:

API.

Purpose:

Returns the unset value for the shading interpolation mode.

Calling Context:

Call this function directly.

Parameters:

Return Value:

Returns kNoShading, meaning that shading interpolation is not specified.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TLocalAttribute3DState::GetShadingQuality

virtual EShadingQuality GetShadingQuality () const

Interface Category:

API.

Purpose:

Returns the unset value for the shading quality.

Calling Context:

Call this function directly.

Parameters:

Return Value:

Returns kShadingQualityUnset, meaning that shading quality is not specified.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TLocalAttribute3DState::GetTextureMappingMatrix

virtual const TGrafMatrix * GetTextureMappingMatrix () const

Interface Category:

API.

Purpose:

Returns the unset value for the texture mapping matrix.

Calling Context:

Call this function directly.

Parameters:

Return Value:

Returns NIL, meaning that a texture mapping matrix is not specified.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TLocalAttribute3DState::GetFramePen

virtual const TPen * GetFramePen () const

Interface Category:

API.

Purpose:

Returns the unset value for the frame pen.

Calling Context:

Call this function directly.

Parameters:

Return Value:

Returns NIL, meaning that a frame pen is not specified.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TLocalAttribute3DState::GetDrawingOperation

virtual TAttributeState :: EDrawOperation GetDrawingOperation () const

Interface Category:

API.

Purpose:

Returns the unset value for the drawing operation.

Calling Context:

Call this function directly.

Parameters:

Return Value:

Returns kUnset, meaning that a drawing operation is not specified.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TLocalAttribute3DState::GetGrafAttribute

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

Interface Category:

API.

Purpose:

Returns the unset value for all extensible attributes.

Calling Context:

Call this function directly.

Parameters:

Return Value:

Returns NIL, meaning that no extensible attributes are specified.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TLocalAttribute3DState::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: TLocalAttribute3DState::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: TLocalAttribute3DState::GetPrimaryDitherHint

virtual const TDitherHint * GetPrimaryDitherHint () const

Interface Category:

API.

Purpose:

Returns the unset value for the primary dither hint.

Calling Context:

Call this function directly.

Parameters:

Return Value:

Returns NIL, meaning that a primary dither hint is not specified.

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.