TK_Thumbnail Class Reference

#include <BOpcodeHandler.h>

Inheritance diagram for TK_Thumbnail:

Inheritance graph
[legend]
Collaboration diagram for TK_Thumbnail:

Collaboration graph
[legend]
List of all members.

Detailed Description

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.

Definition at line 7357 of file BOpcodeHandler.h.

Public Member Functions

 TK_Thumbnail ()
TK_Status Read (BStreamFileToolkit &tk) alter
TK_Status Write (BStreamFileToolkit &tk) alter
TK_Status Clone (BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const
TK_Status Execute (BStreamFileToolkit &tk) alter
TK_Status Interpret (BStreamFileToolkit &tk, ID_Key key, int variant) alter
TK_Status Interpret (BStreamFileToolkit &tk, ID_Key key, char const *special) alter
void Reset (void) alter
void SetBytes (int size, unsigned char const *bytes=0) alter
char const * GetBytes (void) const
char alter * GetBytes (void) alter
void SetSize (int w, int h) alter
void SetSize (int const *s) alter
int const * GetSize (void) const
void SetFormat (int f) alter
int GetFormat (void) const

Protected Attributes

char * m_bytes
int m_size [2]
unsigned char m_format


Constructor & Destructor Documentation

TK_Thumbnail::TK_Thumbnail  )  [inline]
 

constructor

Definition at line 7368 of file BOpcodeHandler.h.


Member Function Documentation

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

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.

Reimplemented from BBaseOpcodeHandler.

char alter* TK_Thumbnail::GetBytes void   )  [inline]
 

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

Definition at line 7392 of file BOpcodeHandler.h.

char const* TK_Thumbnail::GetBytes void   )  const [inline]
 

Returns the address of the data buffer

Definition at line 7390 of file BOpcodeHandler.h.

int TK_Thumbnail::GetFormat void   )  const [inline]
 

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

Definition at line 7404 of file BOpcodeHandler.h.

int const* TK_Thumbnail::GetSize void   )  const [inline]
 

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

Definition at line 7399 of file BOpcodeHandler.h.

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.

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 7380 of file BOpcodeHandler.h.

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.

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.

Parameters:
tk A reference to the BStreamFileToolkit object.
Returns:
The result of the function call.

Implements BBaseOpcodeHandler.

void TK_Thumbnail::Reset void   )  [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.

Definition at line 7402 of file BOpcodeHandler.h.

void TK_Thumbnail::SetSize int const *  s  )  [inline]
 

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

Definition at line 7397 of file BOpcodeHandler.h.

void TK_Thumbnail::SetSize int  w,
int  h
[inline]
 

Sets the size of the thumbnail using discrete integer values

Definition at line 7395 of file BOpcodeHandler.h.

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.

Implements BBaseOpcodeHandler.


Member Data Documentation

char* TK_Thumbnail::m_bytes [protected]
 

internal use; Image data

Definition at line 7362 of file BOpcodeHandler.h.

unsigned char TK_Thumbnail::m_format [protected]
 

internal use; Format of data

Definition at line 7364 of file BOpcodeHandler.h.

int TK_Thumbnail::m_size[2] [protected]
 

internal use; Width & Height

Definition at line 7363 of file BOpcodeHandler.h.


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