Handles the TKE_Line_Style opcode. More...
#include <BOpcodeHandler.h>
Public Member Functions | |
TK_Status | Clone (BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const |
char const * | GetDefinition () const |
char * | GetDefinition () |
char const * | GetName () const |
char * | GetName () |
TK_Status | Read (BStreamFileToolkit &tk) |
TK_Status | ReadAscii (BStreamFileToolkit &tk) |
Deprecated. | |
void | Reset () |
void | SetDefinition (char const *def) |
void | SetDefinition (int length) |
void | SetName (char const *name) |
void | SetName (int length) |
TK_Line_Style () | |
TK_Status | Write (BStreamFileToolkit &tk) |
TK_Status | WriteAscii (BStreamFileToolkit &tk) |
Deprecated. | |
Protected Attributes | |
char * | m_definition |
int | m_definition_length |
char * | m_name |
int | m_name_length |
Handles the TKE_Line_Style opcode.
TK_Line_Style provides support for writing/reading the TKE_Line_Style opcode object to/from an HSF file.
The HOOPS/3dGS scene-graph supports 'line pattern definitions', which define how to draw lines.
TK_Line_Style::TK_Line_Style | ( | ) | [inline] |
constructor
TK_Status TK_Line_Style::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.
char const* TK_Line_Style::GetDefinition | ( | ) | const [inline] |
Returns the definition buffer
char* TK_Line_Style::GetDefinition | ( | ) | [inline] |
Returns the definition buffer, which can be modified directly
char const* TK_Line_Style::GetName | ( | ) | const [inline] |
Returns the pattern name
char* TK_Line_Style::GetName | ( | ) | [inline] |
Returns the pattern name buffer, which can be modified directly
TK_Status TK_Line_Style::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_Line_Style::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_Line_Style::SetDefinition | ( | char const * | def | ) |
Sets the definition. Allocates the buffer and copies the definition
void TK_Line_Style::SetDefinition | ( | int | length | ) |
Sets the definition buffer. Allocates a buffer large enough to hold a string of 'length' characters
void TK_Line_Style::SetName | ( | char const * | name | ) |
Sets the pattern name. Allocates the buffer and copies the name string
void TK_Line_Style::SetName | ( | int | length | ) |
Sets the pattern name buffer. Allocates a buffer large enough to hold a string of 'length' characters
TK_Status TK_Line_Style::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.
char* TK_Line_Style::m_definition [protected] |
internal use; definition
int TK_Line_Style::m_definition_length [protected] |
internal use; definition length
char* TK_Line_Style::m_name [protected] |
internal use; Line Pattern name
int TK_Line_Style::m_name_length [protected] |
internal use; Pattern name length