Alphabetical Class Index   Class Hierarchy   Compound Members   File Members   File List  

HTK_Enumerated Class Reference

Provides HOOPS/3dGS-specific handling of various opcodes. More...

#include <HOpcodeHandler.h>

Inheritance diagram for HTK_Enumerated:

TK_Enumerated BBaseOpcodeHandler BControlledMemoryObject

List of all members.

Public Member Functions

TK_Status Clone (BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const
TK_Status Execute (BStreamFileToolkit &tk)
 HTK_Enumerated (unsigned char opcode)
TK_Status Interpret (BStreamFileToolkit &tk, ID_Key key, char const *special)
TK_Status Interpret (BStreamFileToolkit &tk, ID_Key key=-1, int variant=0)


Detailed Description

Provides HOOPS/3dGS-specific handling of various opcodes.

This class provides provides support for writing/reading opcode objects which represent a simple choice from an enumerated set (TKO_Enumerations). This currently includes the opcodes: TKE_Face_Pattern, TKE_Window_Pattern, TKE_Marker_Symbol, TKE_Text_Alignment, TKE_Window_Frame, TKE_Handedness


Constructor & Destructor Documentation

HTK_Enumerated::HTK_Enumerated ( unsigned char  opcode  )  [inline]

constructor


Member Function Documentation

TK_Status HTK_Enumerated::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_Enumerated.

TK_Status HTK_Enumerated::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_Enumerated::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_Enumerated::Interpret ( BStreamFileToolkit tk,
ID_Key  key = -1,
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: