Alphabetical Class Index   Class Hierarchy   Compound Members   File Members   File List  

HTK_Color_By_FIndex Class Reference

Provides HOOPS/3dGS-specific handling of the TKE_Color_By_FIndex opcode. More...

#include <HOpcodeHandler.h>

Inheritance diagram for HTK_Color_By_FIndex:

TK_Color_By_FIndex BBaseOpcodeHandler BControlledMemoryObject

List of all members.

Public Member Functions

TK_Status Clone (BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const
TK_Status Execute (BStreamFileToolkit &tk)
 HTK_Color_By_FIndex (int mask=0, float index=0.0f)
TK_Status Interpret (BStreamFileToolkit &tk, ID_Key key, char const *special)
TK_Status Interpret (BStreamFileToolkit &tk, ID_Key key, int variant=0)


Detailed Description

Provides HOOPS/3dGS-specific handling of the TKE_Color_By_FIndex opcode.

This class complements the read/write functionality implemented in the base class by overloading the Interpret and Execute methods to provide HOOPS/3dGS-specific opcode handling.

Writing: The HOOPS/3dGS database is queried in the Interpret method, and this data is then written to the HSF file by the Write method Reading: The data is read from the HSF file by the Read method, and is mapped to the HOOPS/3dGS scene-graph within the Execute method.

Export/import of additional user-data (which is associated with this HSF object) would typically be done by overloading the Write and Read methods.


Constructor & Destructor Documentation

HTK_Color_By_FIndex::HTK_Color_By_FIndex ( int  mask = 0,
float  index = 0.0f 
) [inline]

constructor


Member Function Documentation

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

Copies the opcode handler

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

Reimplemented from TK_Color_By_FIndex.

TK_Status HTK_Color_By_FIndex::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:
tk A reference to the BStreamFileToolkit object.
Returns:
The result of the function call.

Reimplemented from BBaseOpcodeHandler.

TK_Status HTK_Color_By_FIndex::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:
tk A reference to the BStreamFileToolkit object.
key An identifier to the object (for example, the HOOPS key of a geometry item)
special A string value of particular data
Returns:
The result of the function call.

Reimplemented from BBaseOpcodeHandler.

References BBaseOpcodeHandler::Interpret().

TK_Status HTK_Color_By_FIndex::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:
tk A reference to the BStreamFileToolkit object.
key An identifier to the object (for example, the HOOPS key of a geometry item)
variant optional specification of an alternate form, such as a Level-of-Detail representation
Returns:
The result of the function call.

Reimplemented from BBaseOpcodeHandler.


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