Alphabetical Class Index   Class Hierarchy   Compound Members   File Members   File List  

TK_Comment Class Reference

Handles the TKE_Comment opcode. More...

#include <BOpcodeHandler.h>

List of all members.

Public Member Functions

TK_Status Execute (BStreamFileToolkit &tk)
TK_Status ExecuteAscii (BStreamFileToolkit &tk)
char const * GetComment () const
char * GetComment ()
TK_Status Interpret (BStreamFileToolkit &tk, ID_Key key, int variant)
TK_Status Interpret (BStreamFileToolkit &tk, ID_Key key, char const *special)
TK_Status Read (BStreamFileToolkit &tk)
TK_Status ReadAscii (BStreamFileToolkit &tk)
 Deprecated.
void Reset ()
void SetComment (char const *comment)
void SetComment (int length)
 TK_Comment (char const *comment=0)
TK_Status Write (BStreamFileToolkit &tk)
TK_Status WriteAscii (BStreamFileToolkit &tk)
 Deprecated.

Protected Member Functions

void set_comment (char const *comment)
 internal use
void set_comment (int length)
 internal use

Protected Attributes

int m_allocated
 internal use
char * m_comment
 internal use
int m_length
 internal use

Detailed Description

Handles the TKE_Comment opcode.

TK_Comment provides support for writing/reading the TK_Comment opcode object to/from an HSF file. Take care when overloading this one, since the first comment in the file contains important information about the file (such file version and the flags that were used at the time of file write).

The TKE_Comment opcode object contains a comment for the file.


Constructor & Destructor Documentation

TK_Comment::TK_Comment ( char const *  comment = 0)

constructor


Member Function Documentation

TK_Status TK_Comment::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.

char const* TK_Comment::GetComment ( ) const [inline]

Get the comment string. Returns a pointer to the current comment

char* TK_Comment::GetComment ( ) [inline]

Get the comment string buffer. Returns a pointer to the current comment buffer, which may then be modified directly

TK_Status TK_Comment::Interpret ( BStreamFileToolkit tk,
ID_Key  key,
int  variant 
) [inline, virtual]

The only real reason we need an Interpret function here is so that we can register this class as a PreWalk or PostWalk handler

Reimplemented from BBaseOpcodeHandler.

References TK_Normal.

TK_Status TK_Comment::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 TK_Comment::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.

void TK_Comment::Reset ( ) [virtual]

Resets the current opcode handler. This is called by the toolkit when it is done processing an opcode. This method reinitializes any opcode handler variables and frees up temporary data.

Reimplemented from BBaseOpcodeHandler.

void TK_Comment::SetComment ( char const *  comment) [inline]

Set the comment string. Makes sure the buffer is big enough to hold the string, and copies it in

void TK_Comment::SetComment ( int  length) [inline]

Set the comment. Makes sure the buffer is big enough to hold a string of 'length' characters

TK_Status TK_Comment::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: