Handles the TKE_Material opcode. More...
#include <BOpcodeHandler.h>
Public Member Functions | |
TK_Status | Clone (BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const |
TK_Status | GetBlock (char const **ptr, int *buffer_size) |
TK_Status | PushUserData (char const *buffer, int buffer_size, bool tally_total_size=true) |
TK_Status | Read (BStreamFileToolkit &tk) alter |
void | Reset () alter |
TK_Material () | |
TK_Status | Write (BStreamFileToolkit &tk) alter |
Protected Attributes | |
struct vlist_s * | m_data |
int | m_total_size |
the total size of the blind material data |
Handles the TKE_Material opcode.
To ensure that user data will be gracefully handled (skipped-over) by non-custom handlers (meaning, an application that is using the default toolkit and doesn't understand the custom user data), custom user data must be written out by exporting the following elements in order:
1. the TKE_Material opcode 2. the number of bytes of data that will follow 3. the contents of the material
The default implementation simply skips over these opcodes without any further processing.
TK_Material::TK_Material | ( | ) | [inline] |
constructor
TK_Status TK_Material::Clone | ( | BStreamFileToolkit & | tk, |
BBaseOpcodeHandler ** | handler | ||
) | const [virtual] |
Copies the opcode handler
tk | A reference to the BStreamFileToolkit object. |
handler | A pointer to the opcode handler object. Passed by reference. |
Reimplemented from BBaseOpcodeHandler.
TK_Status TK_Material::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.
tk | A reference to the BStreamFileToolkit object. |
Implements BBaseOpcodeHandler.
void TK_Material::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.
TK_Status TK_Material::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.
tk | A reference to the BStreamFileToolkit object. |
Implements BBaseOpcodeHandler.
struct vlist_s* TK_Material::m_data [protected] |
The internal blind data storage. The HMaterialLibrary will know how to generate or parse it. Since data is expected to be VERY large in some cases, we use a list of buffers rather than a flat array