Alphabetical Class Index   Class Hierarchy   Compound Members   File Members   File List  

TK_Line_Style Class Reference

Handles the TKE_Line_Style opcode. More...

#include <BOpcodeHandler.h>

List of all members.

Public Member Functions

TK_Status Clone (BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const
char const * GetDefinition () const
char alter * GetDefinition () alter
char const * GetName () const
char alter * GetName () alter
TK_Status Read (BStreamFileToolkit &tk) alter
TK_Status ReadAscii (BStreamFileToolkit &tk) alter
 Deprecated.
void Reset () alter
void SetDefinition (char const *def) alter
void SetDefinition (int length) alter
void SetName (char const *name) alter
void SetName (int length) alter
 TK_Line_Style ()
TK_Status Write (BStreamFileToolkit &tk) alter
TK_Status WriteAscii (BStreamFileToolkit &tk) alter
 Deprecated.

Protected Attributes

char * m_definition
int m_definition_length
char * m_name
int m_name_length

Detailed Description

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.


Constructor & Destructor Documentation

TK_Line_Style::TK_Line_Style ( ) [inline]

constructor


Member Function Documentation

TK_Status TK_Line_Style::Clone ( BStreamFileToolkit tk,
BBaseOpcodeHandler **  handler 
) const [virtual]

Copies the opcode handler

Parameters:
tkA reference to the BStreamFileToolkit object.
handlerA pointer to the opcode handler object. Passed by reference.
Returns:
The result of the function call.

Reimplemented from BBaseOpcodeHandler.

Reimplemented in HTK_Line_Style.

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

Returns the definition buffer

char alter* 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 alter* 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.

Parameters:
tkA reference to the BStreamFileToolkit object.
Returns:
The result of the function call.

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.

Parameters:
tkA reference to the BStreamFileToolkit object.
Returns:
The result of the function call.

Implements BBaseOpcodeHandler.


Member Data Documentation

char* TK_Line_Style::m_definition [protected]

internal use; definition

internal use; definition length

char* TK_Line_Style::m_name [protected]

internal use; Line Pattern name

internal use; Pattern name length


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