#include <BOpcodeHandler.h>
Public Member Functions | |
TK_Status | Clone (BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const |
char alter * | GetName () alter |
char const * | GetName () const |
char alter * | GetSegment () alter |
char const * | GetSegment () const |
TK_Status | Read (BStreamFileToolkit &tk) alter |
TK_Status | ReadAscii (BStreamFileToolkit &tk) alter |
Deprecated. | |
void | Reset () alter |
void | SetName (int length) alter |
void | SetName (char const *name) alter |
void | SetSegment (int length) alter |
void | SetSegment (char const *segment) alter |
TK_Named_Style_Def () | |
TK_Status | Write (BStreamFileToolkit &tk) alter |
TK_Status | WriteAscii (BStreamFileToolkit &tk) alter |
Deprecated. | |
Protected Attributes | |
bool | m_follow |
for internal use only | |
ID_Key | m_key |
for internal use only | |
char * | m_name |
int | m_name_length |
BBaseOpcodeHandler * | m_referee |
for internal use only | |
char * | m_segment |
int | m_segment_length |
TK_Named_Style_Def provides support for writing/reading the TKE_Named_Style_Def opcode object to/from an HSF file.
The HOOPS/3dGS scene-graph supports 'named style definition', which define style segments by name.
TK_Named_Style_Def::TK_Named_Style_Def | ( | ) | [inline] |
constructor
TK_Status TK_Named_Style_Def::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 alter* TK_Named_Style_Def::GetName | ( | ) | [inline] |
Returns the glyph name buffer, which can be modified directly
char const* TK_Named_Style_Def::GetName | ( | ) | const [inline] |
Returns the glyph name
char alter* TK_Named_Style_Def::GetSegment | ( | ) | [inline] |
Get the segment name buffer. Returns a pointer to the current segment name buffer which may then be modified directly
char const* TK_Named_Style_Def::GetSegment | ( | ) | const [inline] |
Get the segment name. Returns a pointer to the current segment name
TK_Status TK_Named_Style_Def::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_Named_Style_Def::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_Named_Style_Def::SetName | ( | int | length | ) |
Sets the glyph name buffer. Allocates a buffer large enough to hold a string of 'length' characters
void TK_Named_Style_Def::SetName | ( | char const * | name | ) |
Sets the glyph name. Allocates the buffer and copies the name string
void TK_Named_Style_Def::SetSegment | ( | int | length | ) |
Set the segment name. Makes sure the buffer is big enough to hold a string of 'length' characters
void TK_Named_Style_Def::SetSegment | ( | char const * | segment | ) |
Set the segment name. Makes sure the buffer is big enough to hold the segment name, and copies it in
TK_Status TK_Named_Style_Def::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_Named_Style_Def::m_name [protected] |
internal use; Glyph name
int TK_Named_Style_Def::m_name_length [protected] |
internal use; Glyph name length
char* TK_Named_Style_Def::m_segment [protected] |
Segment name. for internal use only
int TK_Named_Style_Def::m_segment_length [protected] |
Length of segment string name. for internal use only