Class: TTextureMap

Declaration: TextureMaps.h

Taxonomy Categories:

Member Functions:


Interface Category:

API.

Inherits From:

MCollectible

Inherited By:

TMipMapA8R8G8B8

Purpose:

TTextureMap is an abstract base class for texture maps that use an image (such as an instance of TImage).

Instantiation:

Abstract class; do not allocate.

Deriving Classes:

Note that TBumpTextureMap has a, not is a, TTextureMap. The same is true of TImageTextureMap.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TTextureMap::~TTextureMap

virtual ~ TTextureMap ()

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: TTextureMap::GetItemValue

  1. virtual void GetItemValue (const TGPoint & index, double filterRange, TColor & returnColor) const
  2. virtual void GetItemValue (const TGPoint & index, const TGPoint & filterRange, TColor & returnColor)
  3. virtual void GetItemValue (const TGPoint & index, const TGPointArray & filterRange, TColor & returnColor)

Interface Category:

API.

Purpose:

  1. Returns the color from the texture-map image that corresponds to the index point. The filter range argument allows the image to be filtered to provide less detail than is available in the actual image array. Filter range values greater than 1.0 causes the image to become more fuzzy. This is a pure virtual function which must be overridden by derived classes.
  2. Returns the color from the texture-map image that corresponds to the index point. The filter range argument allows the image to be filtered to provide less detail than is available in the actual image array. This is a virtual function designed to be overridden by a derived class. However, a default value of kBlack is returned for classes that choose not to implement the function.
  3. Returns the color from the texture-map image that corresponds to the index point. The filter range argument allows the image to be filtered to provide less detail than is available in the actual image array. This is a virtual function designed to be overridden by a derived class. However, a default value of kBlack is returned for classes that choose not to implement the function.

Calling Context:

  1. Do not call this function directly.
  2. Do not call this function directly, except from within a derived class.
  3. Do not call this function directly, except from within a derived class.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTextureMap::GetImageSize

virtual TGPoint GetImageSize () const

Interface Category:

API.

Purpose:

Returns a TGPoint specifying the height and width of the image in pixels. This is a pure virtual function which must be overridden by derived classes.

Calling Context:

Do not call this function directly.

Parameters:

Return Value:

Returns a TGPoint representing the height and width of the image in pixels.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTextureMap::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: TTextureMap::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: TTextureMap::TTextureMap

  1. TTextureMap ()
  2. TTextureMap (const TTextureMap & source)

Interface Category:

API.

Purpose:

  1. Default constructor. This is a protected constructor which must be overridden by derived classes.
  2. Copy constructor. This is a protected constructor designed to be overridden by derived classes.

Calling Context:

  1. Called by the stream-in operators. Do not call this function directly.
  2. Called to copy an object. Do not call this function directly, except from a derived class' copy constructor.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTextureMap::operator=

TTextureMap & operator =(const TTextureMap & source)

Interface Category:

API.

Purpose:

Assignment operator. This is a protected member function designed to be overridden by derived classes.

Calling Context:

Do not call this function directly, except from a derived class' operator

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.
Click the icon to mail questions or corrections about this material to Taligent personnel.
Copyright©1995 Taligent,Inc. All rights reserved.