TK_Comment

class TK_Comment

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.

Inherits from: BBaseOpcodeHandler

Methods

void TK_Comment::set_comment(char const *comment)

protected

internal use

void TK_Comment::set_comment(int length)

protected

internal use

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

constructor

TK_Comment::~TK_Comment()
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

tk: A reference to the BStreamFileToolkit object.

Returns

The result of the function call.
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

tk: A reference to the BStreamFileToolkit object.

Returns

The result of the function call.
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

tk: A reference to the BStreamFileToolkit object.

Returns

The result of the function call.
TK_Status TK_Comment::ReadAscii(BStreamFileToolkit &tk)

Deprecated.

TK_Status TK_Comment::WriteAscii(BStreamFileToolkit &tk)

Deprecated.

TK_Status TK_Comment::ExecuteAscii(BStreamFileToolkit &tk)
TK_Status TK_Comment::Interpret(BStreamFileToolkit &tk, ID_Key key, int variant)

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

TK_Status TK_Comment::Interpret(BStreamFileToolkit &tk, ID_Key key, char const *special)

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.
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.

void TK_Comment::SetComment(char const *comment)

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)

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

char const *TK_Comment::GetComment() const

const

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

char *TK_Comment::GetComment()

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

Variables

int TK_Comment::m_length

protected

int

internal use

int TK_Comment::m_allocated

protected

int

internal use

char *TK_Comment::m_comment

protected

char

internal use