Alphabetical Class Index   Class Hierarchy   Compound Members   File Members   File List  

HTK_Texture_Definitions Class Reference

#include <HOpcodeHandler.h>

List of all members.

Public Member Functions

TK_Status Clone (BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const
TK_Status Execute (BStreamFileToolkit &tk) alter
 HTK_Texture_Definitions (bool shader=false)
TK_Status Interpret (BStreamFileToolkit &tk, ID_Key key, int variant=0) alter
TK_Status Interpret (BStreamFileToolkit &tk, ID_Key key, char const *special) alter
TK_Status Read (BStreamFileToolkit &tk) alter
TK_Status Write (BStreamFileToolkit &tk) alter

Protected Attributes

bool m_is_shader
 search for shaders, not textures
int m_num_parts
 number of handlers
BBaseOpcodeHandler ** m_parts
 Array of texture handlers.

Detailed Description

Finds textures defined in a segment, and writes out individual opcodes for each one.


Member Function Documentation

TK_Status HTK_Texture_Definitions::Clone ( BStreamFileToolkit tk,
BBaseOpcodeHandler **  handler 
) const [virtual]

Copies the opcode handler

Parameters:
tkA reference to the BStreamFileToolkit object.
handlerA pointer to the opcode handler object. Passed by reference.
Returns:
The result of the function call.

Reimplemented from BBaseOpcodeHandler.

TK_Status HTK_Texture_Definitions::Execute ( BStreamFileToolkit tk) [virtual]

Processes the binary data that has been read for the current object, which involves passing the data to application-specific data structures.

Parameters:
tkA reference to the BStreamFileToolkit object.
Returns:
The result of the function call.

Reimplemented from BBaseOpcodeHandler.

TK_Status HTK_Texture_Definitions::Interpret ( BStreamFileToolkit tk,
ID_Key  key,
int  variant = 0 
) [virtual]

Extracts graphics data (typically from the application's scene-graph) and maps it to the opcode handler's data members in preparation for writing out an object to the file.

Parameters:
tkA reference to the BStreamFileToolkit object.
keyAn identifier to the object (for example, the HOOPS key of a geometry item)
variantoptional specification of an alternate form, such as a Level-of-Detail representation
Returns:
The result of the function call.

Reimplemented from BBaseOpcodeHandler.

TK_Status HTK_Texture_Definitions::Interpret ( BStreamFileToolkit tk,
ID_Key  key,
char const *  special 
) [inline, virtual]

Extracts graphics data (typically from the application's scene-graph) and maps it to the opcode handler's data members in preparation for writing out an object to the file.

Parameters:
tkA reference to the BStreamFileToolkit object.
keyAn identifier to the object (for example, the HOOPS key of a geometry item)
specialA string value of particular data
Returns:
The result of the function call.

Reimplemented from BBaseOpcodeHandler.

References BBaseOpcodeHandler::Interpret().

TK_Status HTK_Texture_Definitions::Read ( BStreamFileToolkit tk) [virtual]

Reads data from the toolkit buffer, decodes/decompresses it, and maps it to the opcode handlers data members. User-defined classes which need to write out custom data should utilize one of the available GetData() methods.

Parameters:
tkA reference to the BStreamFileToolkit object.
Returns:
The result of the function call.

Implements BBaseOpcodeHandler.

TK_Status HTK_Texture_Definitions::Write ( BStreamFileToolkit tk) [virtual]

Encodes/compresses data and writes data to the toolkit buffer. User-defined classes which need to write out custom data should utilize one of the available PutData() methods, and first write out the opcode associated with the group of binary data followed by the data itself.

Parameters:
tkA reference to the BStreamFileToolkit object.
Returns:
The result of the function call.

Implements BBaseOpcodeHandler.


The documentation for this class was generated from the following file: