Handles the TKE_Conditional_Action opcode. More...
#include <BOpcodeHandler.h>
Public Member Functions | |
TK_Status | Clone (BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const |
int | GetAction () const |
char const * | GetCondition () const |
char * | GetCondition () |
int | GetLength () |
int | GetOptions () const |
TK_Status | Read (BStreamFileToolkit &tk) |
TK_Status | ReadAscii (BStreamFileToolkit &tk) |
Deprecated. | |
void | Reset () |
void | SetAction (int at) |
void | SetCondition (char const *options) |
void | SetCondition (int length) |
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 |
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
TK_Conditional_Action::TK_Conditional_Action | ( | ) | [inline] |
constructor
TK_Status TK_Conditional_Action::Clone | ( | BStreamFileToolkit & | tk, |
BBaseOpcodeHandler ** | handler | ||
) | const [virtual] |
Copies the opcode handler
tk | A reference to the BStreamFileToolkit object. |
handler | A pointer to the opcode handler object. Passed by reference. |
Reimplemented from BBaseOpcodeHandler.
Reimplemented in HTK_Conditional_Action.
int TK_Conditional_Action::GetAction | ( | ) | const [inline] |
Returns the action type.
char const* TK_Conditional_Action::GetCondition | ( | ) | const [inline] |
Returns the conditions string.
char* TK_Conditional_Action::GetCondition | ( | ) | [inline] |
Returns the conditions string buffer, which may be modified directly
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.
tk | A reference to the BStreamFileToolkit object. |
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 | ( | char const * | options | ) |
Sets the condition string. Allocates the buffer and copies the string
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::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.
tk | A reference to the BStreamFileToolkit object. |
Implements BBaseOpcodeHandler.
int TK_Conditional_Action::m_length [protected] |
Length of text string
short TK_Conditional_Action::m_options [protected] |
Option flags
char* TK_Conditional_Action::m_string [protected] |
Text string
short TK_Conditional_Action::m_type [protected] |
Action type