TK_Glyph_Definition Class Reference

#include <BOpcodeHandler.h>

Inheritance diagram for TK_Glyph_Definition:

Inheritance graph
[legend]
Collaboration diagram for TK_Glyph_Definition:

Collaboration graph
[legend]
List of all members.

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.

Definition at line 7416 of file BOpcodeHandler.h.

Public Member Functions

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

Protected Attributes

int m_name_length
int m_size
char * m_name
char * m_data


Constructor & Destructor Documentation

TK_Glyph_Definition::TK_Glyph_Definition  )  [inline]
 

constructor

Definition at line 7428 of file BOpcodeHandler.h.


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 void   )  [inline]
 

Returns the definition buffer, which can be modified directly

Definition at line 7458 of file BOpcodeHandler.h.

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

Returns the definition buffer

Definition at line 7456 of file BOpcodeHandler.h.

int TK_Glyph_Definition::GetDefinitionSize void   )  const [inline]
 

Returns the definition size

Definition at line 7454 of file BOpcodeHandler.h.

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

Returns the glyph name buffer, which can be modified directly

Definition at line 7449 of file BOpcodeHandler.h.

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

Returns the glyph name

Definition at line 7447 of file BOpcodeHandler.h.

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 void   )  [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

Definition at line 7424 of file BOpcodeHandler.h.

char* TK_Glyph_Definition::m_name [protected]
 

internal use; Glyph name

Definition at line 7423 of file BOpcodeHandler.h.

int TK_Glyph_Definition::m_name_length [protected]
 

internal use; Glyph name length

Definition at line 7421 of file BOpcodeHandler.h.

int TK_Glyph_Definition::m_size [protected]
 

internal use; Data length

Definition at line 7422 of file BOpcodeHandler.h.


The documentation for this class was generated from the following file:
Generated on Tue Jan 6 22:41:43 2009 for Autodesk DWF 3D Toolkit by  doxygen 1.4.5