TK_Line_Style

class TK_Line_Style

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.

Inherits from: BBaseOpcodeHandler

Methods

TK_Line_Style::TK_Line_Style()

constructor

TK_Line_Style::~TK_Line_Style()
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.
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.
TK_Status TK_Line_Style::Clone(BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const

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.
TK_Status TK_Line_Style::ReadAscii(BStreamFileToolkit &tk)

Deprecated.

TK_Status TK_Line_Style::WriteAscii(BStreamFileToolkit &tk)

Deprecated.

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.

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

char const *TK_Line_Style::GetName() const

const

Returns the pattern name

char *TK_Line_Style::GetName()

Returns the pattern name buffer, which can be modified directly

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

char const *TK_Line_Style::GetDefinition() const

const

Returns the definition buffer

char *TK_Line_Style::GetDefinition()

Returns the definition buffer, which can be modified directly

Variables

int TK_Line_Style::m_name_length

protected

int

internal use; Pattern name length

int TK_Line_Style::m_definition_length

protected

int

internal use; definition length

char *TK_Line_Style::m_name

protected

char

internal use; Line Pattern name

char *TK_Line_Style::m_definition

protected

char

internal use; definition