TK_Referenced_Segment

class TK_Referenced_Segment

Handles the TKE_Inlude_Segment TKE_Named_Style and TKE_Style_Segment opcodes.

TK_Referenced_Segment provides support for writing/reading the TKE_Inlude_Segment TKE_Named_Style and TKE_Style_Segment opcode objects to/from an HSF file.

The HOOPS/3dGS scene-graph nodes are called ‘segments’ which store, geometry, attributes, and subsegments. The scene-graph provides support for referencing segments where they can either be ‘included’ as virtual subsegments, or they can be ‘styled’ so that only the attributes are referenced.

Inherits from: BBaseOpcodeHandler

Methods

void TK_Referenced_Segment::set_segment(char const *segment)

protected

for internal use only

void TK_Referenced_Segment::set_segment(int length)

protected

for internal use only

TK_Referenced_Segment::TK_Referenced_Segment(unsigned char opcode)

constructor

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

Deprecated.

TK_Status TK_Referenced_Segment::WriteAscii(BStreamFileToolkit &tk)

Deprecated.

void TK_Referenced_Segment::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_Referenced_Segment::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_Referenced_Segment::SetSegment(int length)

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

char const *TK_Referenced_Segment::GetSegment() const

const

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

char *TK_Referenced_Segment::GetSegment()

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

void TK_Referenced_Segment::SetCondition(char const *condition)

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

void TK_Referenced_Segment::SetCondition(int length)

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

char const *TK_Referenced_Segment::GetCondition() const

const

Get the condition string. Returns a pointer to the current condition

char *TK_Referenced_Segment::GetCondition()

Get the condition string buffer. Returns a pointer to the current condition buffer which may then be modified directly

void TK_Referenced_Segment::SetFollow(bool f)

Sets the flag indicating whether the reference segment should be processed itself

bool TK_Referenced_Segment::GetFollow()

Returns the flag indicating whether the reference segment should be processed itself

Variables

int TK_Referenced_Segment::m_length

protected

int

Length of segment string name. for internal use only

int TK_Referenced_Segment::m_allocated

protected

int

Size of currently available string buffer. for internal use only

char *TK_Referenced_Segment::m_string

protected

char

Segment name. for internal use only

int TK_Referenced_Segment::m_cond_length

protected

int

Length of condition. for internal use only

int TK_Referenced_Segment::m_cond_allocated

protected

int

Size of currently available condition buffer. for internal use only

char *TK_Referenced_Segment::m_condition

protected

char

Condition. for internal use only

ID_Key TK_Referenced_Segment::m_key

protected

for internal use only

ID_Key TK_Referenced_Segment::m_renumbered_key

protected

for internal use only

unsigned char TK_Referenced_Segment::m_renumbered_scope

protected

unsigned char

for internal use only

BBaseOpcodeHandler *TK_Referenced_Segment::m_referee

protected

for internal use only

bool TK_Referenced_Segment::m_follow

protected

bool

for internal use only

Lock_Masks TK_Referenced_Segment::m_filter

protected

for internal use only

bool TK_Referenced_Segment::m_referee_has_priority

protected

bool
int TK_Referenced_Segment::m_referee_priority

protected

int