TK_Conditions Class Reference

#include <BOpcodeHandler.h>

Inheritance diagram for TK_Conditions:

Inheritance graph
[legend]
Collaboration diagram for TK_Conditions:

Collaboration graph
[legend]
List of all members.

Detailed Description

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 stye & include segments. A condition is simply a string containing a comma-separated list of condition flags being turned on or off

Definition at line 4742 of file BOpcodeHandler.h.

Public Member Functions

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

Protected Attributes

int m_length
char * m_string


Constructor & Destructor Documentation

TK_Conditions::TK_Conditions  )  [inline]
 

constructor

Definition at line 4752 of file BOpcodeHandler.h.


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 void   )  [inline]
 

Returns the conditions string buffer, which may be modified directly

Definition at line 4771 of file BOpcodeHandler.h.

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

Returns the conditions string.

Definition at line 4769 of file BOpcodeHandler.h.

int TK_Conditions::GetLength void   )  [inline]
 

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

Definition at line 4773 of file BOpcodeHandler.h.

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 void   )  [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

Definition at line 4747 of file BOpcodeHandler.h.

char* TK_Conditions::m_string [protected]
 

Text string

Definition at line 4748 of file BOpcodeHandler.h.


The documentation for this class was generated from the following file:
Generated on Tue Jan 6 22:41:42 2009 for Autodesk DWF 3D Toolkit by  doxygen 1.4.5