Class: TImageTextureMap

Declaration: MapUtilities.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TImageMap

Inherited By:

None.

Purpose:

TImageTextureMap is a concrete derived class of TImageMap that accepts a TImage object to put into the map. The TImage to be used is specified with a constructor argument. Behind the scenes, TImageTextureMap creates a TTextureMap object. When TImageTextureMap::GetValue is invoked (usually by a shader), the TImageTextureMap passes the current shading sample's texture coordinates and filter length to the TTextureMap to obtain the color for a given point.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TImageTextureMap::TImageTextureMap

TImageTextureMap ()
TImageTextureMap (const TImage & image)
TImageTextureMap (const TImageTextureMap & imageTextureMap)

Interface Category:

API.

Purpose:

Default constructor. Sets the map to NIL and the map size to zero by zero pixels.
Constructor for setting the stored image to the given value.
Copy constructor.

Calling Context:

Called by the stream-in operators. You can also call this function directly.
Call this function directly.
Called to copy an object.

Parameters:

Takes no parameters.
const TImage & image -The image to be used as the texture map.
const TImageTextureMap & imageTextureMap -The object to be copied.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TImageTextureMap::~TImageTextureMap

virtual ~ TImageTextureMap ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TImageTextureMap::GetValue

virtual void GetValue (const TShadingSample & info, TColor & returnColor) const

Interface Category:

API.

Purpose:

Returns, in its TColor argument, the color that has been mapped to the specified TShadingSample from the internal image map.

Calling Context:

Call this function directly.

Parameters:

const TShadingSample & info -The information about the surface needed by the shader.
TColor & returnColor -The resulting color is returned here.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TImageTextureMap::operator=

TImageTextureMap & operator =(const TImageTextureMap & source)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Call this function by using the operator in an assignment statement.

Parameters:

const TImageTextureMap & source -The object to be copied.

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

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

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

TStream & -The stream that the object streams itself out to.

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

virtual TStream & operator <<= (TStream &)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & -The stream that the object streams itself in from.

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.

Click the icon to mail questions or corrections about this material to Taligent personnel.