Class: TLinkedBundle3DState

Declaration: Attribute3DState.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TAttribute3DState

Inherited By:

None.

Purpose:

Derived from TAttribute3DState, TLinkedBundle3DState links a bundle (which contains local attributes) to a parent TAttribute3DState. The linking is used to create bundle hierarchies. The parent is specified as a constructor argument; no member function is provided for unlinking or relinking an existing TLinkedBundle3DState. TLinkedBundle3DState is directly analogous to the 2-D class TLinkedBundleState. TLinkedBundle3DState is typically used in a class (such as TLinkedBundle3DPort) that takes a bundle reference. It concatenates the bundle with a parent attribute state, without modifying the bundle itself.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TLinkedBundle3DState::TLinkedBundle3DState

  1. TLinkedBundle3DState (const TAttribute3DState * parent, const TAttribute3DState * localAttributeState)
  2. TLinkedBundle3DState (const TLinkedBundle3DState &)

Interface Category:

API.

Purpose:

  1. Constructor which takes a parent TAttribute3DState and a reference to a TGrafBundle3D and links them together to form a bundle hierarchy. It concatenates the reference bundle with the parent attribute state, without modifying the bundle itself.
  2. Copy constructor.

Calling Context:

  1. Call this function 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: TLinkedBundle3DState::~TLinkedBundle3DState

virtual ~ TLinkedBundle3DState ()

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

virtual EBackfaceCulling GetBackfaceCulling () const

Interface Category:

API.

Purpose:

Returns a value that specifies whether the shading and rendering operations should ignore any surface that faces away from the camera. If the backface culling is not defined by the reference bundle, the backface culling defined by the parent attribute state is returned.

Calling Context:

Call this function directly.

Parameters:

Return Value:

Returns a value that specifies whether shaders and renderers should ignore any surface which is not visible to the camera.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TLinkedBundle3DState::GetOutsideShader

virtual const TShader * GetOutsideShader () const

Interface Category:

API.

Purpose:

Returns a constant pointer to the TShader used for shading the outside surface. If the outside shader is not defined by the reference bundle, the outside shader defined by the parent attribute state is returned.

Calling Context:

Call this function directly.

Parameters:

Return Value:

Returns a constant pointer to a TShader object that specifies how the outside surface of the graphic will be shaded.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TLinkedBundle3DState::GetInsideShader

virtual const TShader * GetInsideShader () const

Interface Category:

API.

Purpose:

Returns a constant pointer to the TShader used for shading the inside surface. If the inside shader is not defined by the reference bundle, the inside shader defined by the parent attribute state is returned.

Calling Context:

Call this function directly.

Parameters:

Return Value:

Returns a constant pointer to a TShader object that specifies how the inside surface of the graphic will be shaded.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TLinkedBundle3DState::GetOutsideColor

virtual const TColor * GetOutsideColor () const

Interface Category:

API.

Purpose:

Returns a constant pointer to the TColor used as the base color for the outside surface and the frame. If the outside color is not defined by the reference bundle, the outside color defined by the parent attribute state is returned.

Calling Context:

Call this function directly.

Parameters:

Return Value:

A constant pointer to the TColor used as the base color for the outside surface and the frame.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TLinkedBundle3DState::GetInsideColor

virtual const TColor * GetInsideColor () const

Interface Category:

API.

Purpose:

Returns a constant pointer to the TColor used as the base color for the inside surface. If the inside color is not defined by the reference bundle, the inside color defined by the parent attribute state is returned.

Calling Context:

Call this function directly.

Parameters:

Return Value:

A constant pointer to the TColor used as the base color for the inside surface.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TLinkedBundle3DState::GetShadingInterpolation

virtual EShadingInterpolationMode GetShadingInterpolation () const

Interface Category:

API.

Purpose:

Returns the shading interpolation mode used by the shader. Shading interpolation occurs for the pixels that do not have their color explicitly computed by the shader, as defined by the shading resolution. If the shading interpolation is not defined by the reference bundle, the shading interpolation defined by the parent attribute state is returned.

Calling Context:

Call this function directly.

Parameters:

Return Value:

Returns an EShadingInterpolationMode enumerated type. The possible return values are kNoShading, kFlat, kColorSmooth, or kInterpolationUnset.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TLinkedBundle3DState::GetTextureMappingMatrix

virtual const TGrafMatrix * GetTextureMappingMatrix () const

Interface Category:

API.

Purpose:

Returns a constant pointer to the TGrafMatrix used to map a 2-D texture to the surface. If the texture mapping matrix is not defined by the reference bundle, the texture mapping matrix defined by the parent attribute state is returned.

Calling Context:

Call this function directly.

Parameters:

Return Value:

A constant pointer to the TGrafMatrix used to map a 2-D texture to the surface.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TLinkedBundle3DState::GetFramePen

virtual const TPen * GetFramePen () const

Interface Category:

API.

Purpose:

Returns a constant pointer to the TPen that determines the frame's pen style (such as hairline or dashed). If the frame pen is not defined by the reference bundle, the frame pen defined by the parent attribute state is returned.

Calling Context:

Call this function directly.

Parameters:

Return Value:

A constant pointer to the TPen that is used to draw the frame.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TLinkedBundle3DState::GetGrafAttribute

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

Interface Category:

API.

Purpose:

Returns the TGrafAttribute object that is associated with the key. TGrafAttribute objects are custom attributes that you install into the bundle. If the custom attribute is not defined by the reference bundle, the custom attribute (if any) defined by the parent attribute state is returned.

Calling Context:

Call this function directly.

Parameters:

Return Value:

A constant pointer to the TGrafAttribute object associated with the name that is passed in as a key.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TLinkedBundle3DState::GetTimeStamp

virtual TPseudoTimeStamp GetTimeStamp () const

Interface Category:

API.

Purpose:

Returns the time stamp stored by this object.

Calling Context:

Call this function directly.

Parameters:

Return Value:

Returns a TPseudoTimeStamp object that is unique with respect to all other TAttribute3DState objects.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TLinkedBundle3DState::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: TLinkedBundle3DState::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: TLinkedBundle3DState::GetDrawingOperation

virtual TAttributeState :: EDrawOperation GetDrawingOperation () const

Interface Category:

API.

Purpose:

Returns a value that specifies the drawing operation to be used in the rendering process. If the draw operation is not defined by the reference bundle, the draw operation defined by the parent attribute state is returned.

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: TLinkedBundle3DState::GetShadingQuality

virtual EShadingQuality GetShadingQuality () const

Interface Category:

API.

Purpose:

Returns a value that specifies the shading quality to use in the rendering process. If the shading quality is not defined by the reference bundle, the shading quality defined by the parent attribute state is returned.

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

TLinkedBundle3DState & operator =(const TLinkedBundle3DState &)

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: TLinkedBundle3DState::GetPrimaryDitherHint

virtual const TDitherHint * GetPrimaryDitherHint () const

Interface Category:

API.

Purpose:

Returns a pointer to the dither hint object to be used when dithering is performed. If the dither hint is not defined by the reference bundle, the dither hint defined by the parent attribute state is returned.

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.