Alphabetical Class Index   Class Hierarchy   Compound Members   File Members   File List  

TK_Conditions Class Reference

Handles the TKE_Conditions opcode. More...

#include <BOpcodeHandler.h>

Inheritance diagram for TK_Conditions:

BBaseOpcodeHandler BControlledMemoryObject

List of all members.

Public Member Functions

TK_Status Clone (BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const
char alter * GetConditions () alter
char const * GetConditions () const
int GetLength () alter
TK_Status Read (BStreamFileToolkit &tk) alter
TK_Status ReadAscii (BStreamFileToolkit &tk) alter
 Deprecated.
void Reset () alter
void SetConditions (int length) alter
void SetConditions (char const *options) alter
 TK_Conditions ()
TK_Status Write (BStreamFileToolkit &tk) alter
TK_Status WriteAscii (BStreamFileToolkit &tk) alter
 Deprecated.

Protected Attributes

int m_length
char * m_string


Detailed Description

Handles the TKE_Conditions opcode.

TK_Conditions provides support for writing/reading the TKE_Conditions opcode object to/from an HSF file.

The HOOPS/3dGS scene-graph supports conditional use of style & include segments. A condition is simply a string containing a comma-separated list of condition flags being turned on or off


Constructor & Destructor Documentation

TK_Conditions::TK_Conditions (  )  [inline]

constructor


Member Function Documentation

TK_Status TK_Conditions::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 BBaseOpcodeHandler.

char alter* TK_Conditions::GetConditions (  )  [inline]

Returns the conditions string buffer, which may be modified directly

char const* TK_Conditions::GetConditions (  )  const [inline]

Returns the conditions string.

int TK_Conditions::GetLength (  )  [inline]

Returns the size of the string buffer (number of chars, not including any space for trailing null)

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

Implements BBaseOpcodeHandler.

void TK_Conditions::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_Conditions::SetConditions ( int  length  ) 

Sets the conditions string buffer. Allocates a buffer which can hold a srting of 'length' characters

void TK_Conditions::SetConditions ( char const *  options  ) 

Sets the conditions string. Allocates the buffer and copies the string

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

Implements BBaseOpcodeHandler.


Member Data Documentation

int TK_Conditions::m_length [protected]

Length of text string

char* TK_Conditions::m_string [protected]

Text string


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