TK_Line_Style Class Reference

#include <BOpcodeHandler.h>

Inheritance diagram for TK_Line_Style:

Inheritance graph
[legend]
Collaboration diagram for TK_Line_Style:

Collaboration graph
[legend]
List of all members.

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.

Definition at line 7467 of file BOpcodeHandler.h.

Public Member Functions

 TK_Line_Style ()
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 (char const *def) alter
void SetDefinition (int length) alter
char const * GetDefinition (void) const
char alter * GetDefinition (void) alter

Protected Attributes

int m_name_length
int m_definition_length
char * m_name
char * m_definition


Constructor & Destructor Documentation

TK_Line_Style::TK_Line_Style  )  [inline]
 

constructor

Definition at line 7479 of file BOpcodeHandler.h.


Member Function Documentation

TK_Status TK_Line_Style::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_Line_Style::GetDefinition void   )  [inline]
 

Returns the definition buffer, which can be modified directly

Definition at line 7509 of file BOpcodeHandler.h.

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

Returns the definition buffer

Definition at line 7507 of file BOpcodeHandler.h.

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

Returns the pattern name buffer, which can be modified directly

Definition at line 7500 of file BOpcodeHandler.h.

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

Returns the pattern name

Definition at line 7498 of file BOpcodeHandler.h.

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:
tk A reference to the BStreamFileToolkit object.
Returns:
The result of the function call.

Implements BBaseOpcodeHandler.

void TK_Line_Style::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_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::SetDefinition char const *  def  ) 
 

Sets the definition. Allocates the buffer and copies the definition

void TK_Line_Style::SetName int  length  ) 
 

Sets the pattern name 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

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:
tk A 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

Definition at line 7475 of file BOpcodeHandler.h.

int TK_Line_Style::m_definition_length [protected]
 

internal use; definition length

Definition at line 7473 of file BOpcodeHandler.h.

char* TK_Line_Style::m_name [protected]
 

internal use; Line Pattern name

Definition at line 7474 of file BOpcodeHandler.h.

int TK_Line_Style::m_name_length [protected]
 

internal use; Pattern name length

Definition at line 7472 of file BOpcodeHandler.h.


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