TK_Thumbnail

class TK_Thumbnail

Handles the TKE_Thumbnail opcode.

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.

Inherits from: BBaseOpcodeHandler

Methods

TK_Thumbnail::TK_Thumbnail()

constructor

TK_Thumbnail::~TK_Thumbnail()
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.

Parameters

tk: A reference to the BStreamFileToolkit object.

Returns

The result of the function call.
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.

Parameters

tk: A reference to the BStreamFileToolkit object.

Returns

The result of the function call.
TK_Status TK_Thumbnail::Clone(BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const

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.
TK_Status TK_Thumbnail::ReadAscii(BStreamFileToolkit &tk)

Deprecated.

TK_Status TK_Thumbnail::WriteAscii(BStreamFileToolkit &tk)

Deprecated.

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.

Parameters

tk: A reference to the BStreamFileToolkit object.

Returns

The result of the function call.
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.

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.
TK_Status TK_Thumbnail::Interpret(BStreamFileToolkit &tk, ID_Key key, char const *special)

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

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

unsigned char const *TK_Thumbnail::GetBytes() const

const

Returns the address of the data buffer

unsigned char *TK_Thumbnail::GetBytes()

Returns the address of the data buffer, which may be modified directly

void TK_Thumbnail::SetSize(int w, int h)

Sets the size of the thumbnail using discrete integer values

void TK_Thumbnail::SetSize(int const s[])

Sets the size of the image using an array of integer values

int const *TK_Thumbnail::GetSize() const

const

Returns the size of the image as the address of a pair of integers

void TK_Thumbnail::SetFormat(int f)

Sets the format of the image. Formats are specified in TKO_Thumbnail_Formats.

int TK_Thumbnail::GetFormat() const

const

Returns the format of the image. Formats are specified in TKO_Thumbnail_Formats.

Variables

unsigned char *TK_Thumbnail::m_bytes

protected

unsigned char

internal use; Image data

int TK_Thumbnail::m_allocated

protected

int

internal use; Size of bytes array

int TK_Thumbnail::m_size[2]

protected

int

internal use; Width & Height

unsigned char TK_Thumbnail::m_format

protected

unsigned char

internal use; Format of data