#include <BOpcodeHandler.h>
Public Member Functions | |
TK_Status | Clone (BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const |
TK_Status | Execute (BStreamFileToolkit &tk) alter |
unsigned char alter * | GetBytes () alter |
unsigned char const * | GetBytes () const |
int | GetFormat () const |
int const * | GetSize () const |
TK_Status | Interpret (BStreamFileToolkit &tk, ID_Key key, char const *special) alter |
TK_Status | Interpret (BStreamFileToolkit &tk, ID_Key key, int variant) alter |
TK_Status | Read (BStreamFileToolkit &tk) alter |
TK_Status | ReadAscii (BStreamFileToolkit &tk) alter |
Deprecated. | |
void | Reset () alter |
void | SetBytes (int size, unsigned char const *bytes=0) alter |
void | SetFormat (int f) alter |
void | SetSize (int const *s) alter |
void | SetSize (int w, int h) alter |
TK_Thumbnail () | |
TK_Status | Write (BStreamFileToolkit &tk) alter |
TK_Status | WriteAscii (BStreamFileToolkit &tk) alter |
Deprecated. | |
Protected Attributes | |
unsigned char * | m_bytes |
unsigned char | m_format |
int | m_size [2] |
TK_Thumbnail provides support for writing/reading the TKE_Thumbnail opcode object to/from an HSF file.
Many file systems and part viewers provide for a thumbnail -- a small image representing the data. This is essentially an extremely simplified version of the TK_Image handler.
TK_Thumbnail::TK_Thumbnail | ( | ) | [inline] |
constructor
TK_Status TK_Thumbnail::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_Thumbnail::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.
tk | A reference to the BStreamFileToolkit object. |
Reimplemented from BBaseOpcodeHandler.
unsigned char alter* TK_Thumbnail::GetBytes | ( | ) | [inline] |
Returns the address of the data buffer, which may be modified directly
unsigned char const* TK_Thumbnail::GetBytes | ( | ) | const [inline] |
Returns the address of the data buffer
int TK_Thumbnail::GetFormat | ( | ) | const [inline] |
Returns the format of the image. Formats are specified in TKO_Thumbnail_Formats.
int const* TK_Thumbnail::GetSize | ( | ) | const [inline] |
Returns the size of the image as the address of a pair of integers
TK_Status TK_Thumbnail::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.
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 |
Reimplemented from BBaseOpcodeHandler.
References BBaseOpcodeHandler::Interpret().
TK_Status TK_Thumbnail::Interpret | ( | BStreamFileToolkit & | tk, | |
ID_Key | key, | |||
int | variant | |||
) | [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.
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 |
Reimplemented from BBaseOpcodeHandler.
TK_Status TK_Thumbnail::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_Thumbnail::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_Thumbnail::SetBytes | ( | int | size, | |
unsigned char const * | bytes = 0 | |||
) |
Sets the image data. Allocates a buffer which can hold 'size' bytes, and if specified, copies the data from 'bytes' to the buffer
void TK_Thumbnail::SetFormat | ( | int | f | ) | [inline] |
Sets the format of the image. Formats are specified in TKO_Thumbnail_Formats.
void TK_Thumbnail::SetSize | ( | int const * | s | ) | [inline] |
Sets the size of the image using an array of integer values
void TK_Thumbnail::SetSize | ( | int | w, | |
int | h | |||
) | [inline] |
Sets the size of the thumbnail using discrete integer values
TK_Status TK_Thumbnail::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.
unsigned char* TK_Thumbnail::m_bytes [protected] |
internal use; Image data
unsigned char TK_Thumbnail::m_format [protected] |
internal use; Format of data
int TK_Thumbnail::m_size[2] [protected] |
internal use; Width & Height