Alphabetical Class Index   Class Hierarchy   Compound Members   File Members   File List  

Public Member Functions | Protected Attributes
TK_Reference Class Reference

Handles the TKE_Reference opcodes. More...

#include <BOpcodeHandler.h>

List of all members.

Public Member Functions

TK_Status Clone (BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const
char const * GetCondition () const
char alter * GetCondition () alter
bool GetFollow () alter
ID_Key GetIndex () alter
TK_Status Read (BStreamFileToolkit &tk) alter
TK_Status ReadAscii (BStreamFileToolkit &tk) alter
 Deprecated.
void Reset () alter
void SetCondition (char const *condition) alter
void SetCondition (int length) alter
void SetFollow (bool f) alter
void SetIndex (int index) alter
 TK_Reference ()
TK_Status Write (BStreamFileToolkit &tk) alter
TK_Status WriteAscii (BStreamFileToolkit &tk) alter
 Deprecated.

Protected Attributes

int m_cond_allocated
int m_cond_length
char * m_condition
bool m_follow
 for internal use only
int m_index
ID_Key m_key
 for internal use only
BBaseOpcodeHandlerm_referee
 for internal use only
ID_Key m_this_key
 for internal use only

Detailed Description

Handles the TKE_Reference opcodes.

TK_Reference provides support for writing/reading the TKE_Reference opcode object 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 an individual geometry item, or all geometry items, from another segment as if they were within the current segment, without the attributes or additional subsegments that would be brought along with an 'include'.


Constructor & Destructor Documentation

TK_Reference::TK_Reference ( )

constructor


Member Function Documentation

TK_Status TK_Reference::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.

char const* TK_Reference::GetCondition ( ) const [inline]

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

char alter* TK_Reference::GetCondition ( ) [inline]

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

bool TK_Reference::GetFollow ( ) [inline]

Returns the flag indicating whether the referenced item should be processed itself

ID_Key TK_Reference::GetIndex ( ) [inline]

Returns the id of the referenced item

TK_Status TK_Reference::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_Reference::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_Reference::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_Reference::SetCondition ( int  length)

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

void TK_Reference::SetFollow ( bool  f) [inline]

Sets the flag indicating whether the referenced item should be processed itself

void TK_Reference::SetIndex ( int  index) [inline]

Sets the id of the referenced item

TK_Status TK_Reference::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

Size of currently available condition buffer. for internal use only

int TK_Reference::m_cond_length [protected]

Length of condition. for internal use only

char* TK_Reference::m_condition [protected]

Condition. for internal use only

int TK_Reference::m_index [protected]

tag index of referenced item. for internal use only


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