Alphabetical Class Index   Class Hierarchy   Compound Members   File Members   File List  

TK_Conditional_Action Class Reference

Handles the TKE_Conditional_Action opcode. More...

#include <BOpcodeHandler.h>

Inheritance diagram for TK_Conditional_Action:

BBaseOpcodeHandler BControlledMemoryObject

List of all members.

Public Member Functions

TK_Status Clone (BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const
int GetAction () const
char * GetCondition ()
char const * GetCondition () const
int GetLength ()
int GetOptions () const
TK_Status Read (BStreamFileToolkit &tk)
TK_Status ReadAscii (BStreamFileToolkit &tk)
 Deprecated.
void Reset ()
void SetAction (int at)
void SetCondition (int length)
void SetCondition (char const *options)
void SetOptions (int at)
 TK_Conditional_Action ()
TK_Status Write (BStreamFileToolkit &tk)
TK_Status WriteAscii (BStreamFileToolkit &tk)
 Deprecated.

Protected Attributes

int m_length
short m_options
char * m_string
short m_type


Detailed Description

Handles the TKE_Conditional_Action opcode.

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

The HOOPS/3dGS scene-graph supports specific actions which can be triggered when specified conditions are present


Constructor & Destructor Documentation

TK_Conditional_Action::TK_Conditional_Action (  )  [inline]

constructor


Member Function Documentation

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

int TK_Conditional_Action::GetAction (  )  const [inline]

Returns the action type.

char* TK_Conditional_Action::GetCondition (  )  [inline]

Returns the conditions string buffer, which may be modified directly

char const* TK_Conditional_Action::GetCondition (  )  const [inline]

Returns the conditions string.

int TK_Conditional_Action::GetLength (  )  [inline]

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

int TK_Conditional_Action::GetOptions (  )  const [inline]

Returns the options flags.

TK_Status TK_Conditional_Action::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_Conditional_Action::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_Conditional_Action::SetAction ( int  at  )  [inline]

Sets the action type.

void TK_Conditional_Action::SetCondition ( int  length  ) 

Sets the condition string buffer. Allocates a buffer which can hold a steing of 'length' characters

void TK_Conditional_Action::SetCondition ( char const *  options  ) 

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

void TK_Conditional_Action::SetOptions ( int  at  )  [inline]

Sets the options flags.

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

Length of text string

Option flags

Text string

short TK_Conditional_Action::m_type [protected]

Action type


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