TK_Delete_Object Class Reference

#include <BOpcodeHandler.h>

Inheritance diagram for TK_Delete_Object:

Inheritance graph
[legend]
Collaboration diagram for TK_Delete_Object:

Collaboration graph
[legend]
List of all members.

Detailed Description

Handles the TKE_Delete_Object opcode.

As its name implies, the TKE_Delete_Object is an instruction to remove a previously given object.

Definition at line 1449 of file BOpcodeHandler.h.

Public Member Functions

 TK_Delete_Object ()
TK_Status Read (BStreamFileToolkit &tk) alter
TK_Status Write (BStreamFileToolkit &tk) alter
TK_Status Clone (BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const
void SetIndex (int i) alter
int GetIndex (void) alter

Protected Attributes

int m_index
 internal use


Constructor & Destructor Documentation

TK_Delete_Object::TK_Delete_Object  )  [inline]
 

constructor

Definition at line 1459 of file BOpcodeHandler.h.


Member Function Documentation

TK_Status TK_Delete_Object::Clone BStreamFileToolkit tk,
BBaseOpcodeHandler **  handler
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.

Reimplemented from BBaseOpcodeHandler.

int TK_Delete_Object::GetIndex void   )  [inline]
 

Returns the index of the item to be deleted

Definition at line 1471 of file BOpcodeHandler.h.

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

void TK_Delete_Object::SetIndex int  i  )  [inline]
 

Sets the index of the item to be deleted

Definition at line 1469 of file BOpcodeHandler.h.

TK_Status TK_Delete_Object::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:42 2009 for Autodesk DWF 3D Toolkit by  doxygen 1.4.5