TK_Named_Style_Def

class TK_Named_Style_Def

Handles the TKE_Named_Style_Def opcode.

TK_Named_Style_Def provides support for writing/reading the TKE_Named_Style_Def opcode object to/from an HSF file.

The HOOPS/3dGS scene-graph supports ‘named style definition’, which define style segments by name.

Inherits from: BBaseOpcodeHandler

Methods

TK_Named_Style_Def::TK_Named_Style_Def()

constructor

TK_Named_Style_Def::~TK_Named_Style_Def()
TK_Status TK_Named_Style_Def::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_Named_Style_Def::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_Named_Style_Def::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_Named_Style_Def::ReadAscii(BStreamFileToolkit &tk)

Deprecated.

TK_Status TK_Named_Style_Def::WriteAscii(BStreamFileToolkit &tk)

Deprecated.

void TK_Named_Style_Def::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_Named_Style_Def::SetName(char const *name)

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

void TK_Named_Style_Def::SetName(int length)

Sets the style name buffer. Allocates a buffer large enough to hold a string of ‘length’ characters

char const *TK_Named_Style_Def::GetName() const

const

Returns the style name

char *TK_Named_Style_Def::GetName()

Returns the style name buffer, which can be modified directly

void TK_Named_Style_Def::SetSegment(char const *segment)

Set the segment name. Makes sure the buffer is big enough to hold the segment name, and copies it in

void TK_Named_Style_Def::SetSegment(int length)

Set the segment name. Makes sure the buffer is big enough to hold a string of ‘length’ characters

char const *TK_Named_Style_Def::GetSegment() const

const

Get the segment name. Returns a pointer to the current segment name

char *TK_Named_Style_Def::GetSegment()

Get the segment name buffer. Returns a pointer to the current segment name buffer which may then be modified directly

Variables

int TK_Named_Style_Def::m_name_length

protected

int

internal use; Style name length

char *TK_Named_Style_Def::m_name

protected

char

internal use; Style name

int TK_Named_Style_Def::m_segment_length

protected

int

Length of segment string name. for internal use only

char *TK_Named_Style_Def::m_segment

protected

char

Segment name. for internal use only

int TK_Named_Style_Def::m_cond_length

protected

int

Length of condition. for internal use only

int TK_Named_Style_Def::m_cond_allocated

protected

int

Size of currently available condition buffer. for internal use only

char *TK_Named_Style_Def::m_condition

protected

char

Condition. for internal use only

ID_Key TK_Named_Style_Def::m_key

protected

for internal use only

BBaseOpcodeHandler *TK_Named_Style_Def::m_referee

protected

for internal use only

bool TK_Named_Style_Def::m_follow

protected

bool

for internal use only