Alphabetical Class Index   Class Hierarchy   Compound Members   File Members   File List  

HTK_Reference Class Reference

Provides HOOPS/3dGS-specific handling of the TKE_Reference opcode. More...

#include <HOpcodeHandler.h>

List of all members.

Public Member Functions

TK_Status Clone (BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const
bool Direct () const
TK_Status Execute (BStreamFileToolkit &tk)
 HTK_Reference ()
TK_Status Interpret (BStreamFileToolkit &tk, ID_Key key, int variant=0)
TK_Status Interpret (BStreamFileToolkit &tk, ID_Key key, char const *special)
bool NeedsContext (BStreamFileToolkit &tk) const
void Reset ()
TK_Status Write (BStreamFileToolkit &tk)

Protected Attributes

ID_Key mh_owner
int mh_stage

Detailed Description

Provides HOOPS/3dGS-specific handling of the TKE_Reference opcode.

This class complements the read/write functionality implemented in the base class by overloading the Interpret and Execute methods to provide HOOPS/3dGS-specific opcode handling.

Writing: The HOOPS/3dGS database is queried in the Interpret method, and this data is then written to the HSF file by the Write method Reading: The data is read from the HSF file by the Read method, and is mapped to the HOOPS/3dGS scene-graph within the Execute method.

Export/import of additional user-data (which is associated with this HSF object) would typically be done by overloading the Write and Read methods.


Constructor & Destructor Documentation

HTK_Reference::HTK_Reference ( ) [inline]

constructor


Member Function Documentation

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

TK_Status HTK_Reference::Execute ( BStreamFileToolkit tk) [virtual]

Processes the binary data that has been read for the current object, which involves passing the data to application-specific data structures.

Parameters:
tkA reference to the BStreamFileToolkit object.
Returns:
The result of the function call.

Reimplemented from BBaseOpcodeHandler.

TK_Status HTK_Reference::Interpret ( BStreamFileToolkit tk,
ID_Key  key,
int  variant = 0 
) [virtual]

Extracts graphics data (typically from the application's scene-graph) and maps it to the opcode handler's data members in preparation for writing out an object to the file.

Parameters:
tkA reference to the BStreamFileToolkit object.
keyAn identifier to the object (for example, the HOOPS key of a geometry item)
variantoptional specification of an alternate form, such as a Level-of-Detail representation
Returns:
The result of the function call.

Reimplemented from BBaseOpcodeHandler.

TK_Status HTK_Reference::Interpret ( BStreamFileToolkit tk,
ID_Key  key,
char const *  special 
) [inline, virtual]

Extracts graphics data (typically from the application's scene-graph) and maps it to the opcode handler's data members in preparation for writing out an object to the file.

Parameters:
tkA reference to the BStreamFileToolkit object.
keyAn identifier to the object (for example, the HOOPS key of a geometry item)
specialA string value of particular data
Returns:
The result of the function call.

Reimplemented from BBaseOpcodeHandler.

References BBaseOpcodeHandler::Interpret().

bool HTK_Reference::NeedsContext ( BStreamFileToolkit tk) const [virtual]

Allows the handler to specify if it needs the containing context to be reopened (currently only used for revisits on geometry references)

Returns:
The amswer.

Reimplemented from BBaseOpcodeHandler.

void HTK_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 TK_Reference.

TK_Status HTK_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.

Reimplemented from TK_Reference.


Member Data Documentation

ID_Key HTK_Reference::mh_owner [protected]

owner will need to be reopened if we delay & revisit solitary references

int HTK_Reference::mh_stage [protected]

create a class-specific 'stage' var to avoid confusion with base class 'stage' variable


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