Alphabetical Class Index   Class Hierarchy   Compound Members   File Members   File List  

TK_Glyph_Definition Class Reference

Handles the TKE_Glyph_Definition opcode. More...

#include <BOpcodeHandler.h>

Inheritance diagram for TK_Glyph_Definition:

BBaseOpcodeHandler BControlledMemoryObject

List of all members.

Public Member Functions

TK_Status Clone (BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const
char alter * GetDefinition () alter
char const * GetDefinition () const
int GetDefinitionSize () const
char alter * GetName () alter
char const * GetName () const
TK_Status Read (BStreamFileToolkit &tk) alter
TK_Status ReadAscii (BStreamFileToolkit &tk) alter
 Deprecated.
void Reset () alter
void SetDefinition (int size, char const *data=0) alter
void SetName (int length) alter
void SetName (char const *name) alter
 TK_Glyph_Definition ()
TK_Status Write (BStreamFileToolkit &tk) alter
TK_Status WriteAscii (BStreamFileToolkit &tk) alter
 Deprecated.

Protected Attributes

char * m_data
char * m_name
int m_name_length
int m_size


Detailed Description

Handles the TKE_Glyph_Definition opcode.

TK_Glyph_Definition provides support for writing/reading the TKE_Glyph_Definition opcode object to/from an HSF file.

The HOOPS/3dGS scene-graph supports 'glyph definitions', which define how to draw markers and components of line patterns.


Constructor & Destructor Documentation

TK_Glyph_Definition::TK_Glyph_Definition (  )  [inline]

constructor


Member Function Documentation

TK_Status TK_Glyph_Definition::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_Glyph_Definition::GetDefinition (  )  [inline]

Returns the definition buffer, which can be modified directly

char const* TK_Glyph_Definition::GetDefinition (  )  const [inline]

Returns the definition buffer

int TK_Glyph_Definition::GetDefinitionSize (  )  const [inline]

Returns the definition size

char alter* TK_Glyph_Definition::GetName (  )  [inline]

Returns the glyph name buffer, which can be modified directly

char const* TK_Glyph_Definition::GetName (  )  const [inline]

Returns the glyph name

TK_Status TK_Glyph_Definition::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_Glyph_Definition::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_Glyph_Definition::SetDefinition ( int  size,
char const *  data = 0 
)

Sets the definition. Allocates the buffer and copies the data if provided

void TK_Glyph_Definition::SetName ( int  length  ) 

Sets the glyph name buffer. Allocates a buffer large enough to hold a string of 'length' characters

void TK_Glyph_Definition::SetName ( char const *  name  ) 

Sets the glyph name. Allocates the buffer and copies the name string

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

char* TK_Glyph_Definition::m_data [protected]

internal use; Definition

char* TK_Glyph_Definition::m_name [protected]

internal use; Glyph name

internal use; Glyph name length

int TK_Glyph_Definition::m_size [protected]

internal use; Data length


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