TK_Tag Class Reference

#include <BOpcodeHandler.h>

Inheritance diagram for TK_Tag:

Inheritance graph
[legend]
Collaboration diagram for TK_Tag:

Collaboration graph
[legend]
List of all members.

Detailed Description

Handles the TKE_Tag opcode.

Tags are a means of instructing the toolkit that an object should be 'recorded' during file import and/or export. Things that may be revisited later for refinement should be tagged. See the Programming Guide for more detailed information.

Definition at line 1615 of file BOpcodeHandler.h.

Public Member Functions

 TK_Tag (unsigned char opcode=TKE_Tag)
TK_Status Read (BStreamFileToolkit &tk) alter
TK_Status Write (BStreamFileToolkit &tk) alter
TK_Status Execute (BStreamFileToolkit &tk) alter
TK_Status Interpret (BStreamFileToolkit &tk, ID_Key key, int variant=0) alter
TK_Status Interpret (BStreamFileToolkit &tk, ID_Key key, char const *special) alter


Constructor & Destructor Documentation

TK_Tag::TK_Tag unsigned char  opcode = TKE_Tag  )  [inline]
 

constructor

Definition at line 1624 of file BOpcodeHandler.h.


Member Function Documentation

TK_Status TK_Tag::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:
tk A reference to the BStreamFileToolkit object.
Returns:
The result of the function call.

Reimplemented from BBaseOpcodeHandler.

TK_Status TK_Tag::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:
tk A reference to the BStreamFileToolkit object.
key An identifier to the object (for example, the HOOPS key of a geometry item)
special A string value of particular data
Returns:
The result of the function call.

Reimplemented from BBaseOpcodeHandler.

Definition at line 1634 of file BOpcodeHandler.h.

TK_Status TK_Tag::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:
tk A reference to the BStreamFileToolkit object.
key An identifier to the object (for example, the HOOPS key of a geometry item)
variant optional specification of an alternate form, such as a Level-of-Detail representation
Returns:
The result of the function call.

Reimplemented from BBaseOpcodeHandler.

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

Implements BBaseOpcodeHandler.

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

Implements BBaseOpcodeHandler.


The documentation for this class was generated from the following file:
Generated on Tue Jan 6 22:41:47 2009 for Autodesk DWF 3D Toolkit by  doxygen 1.4.5