Main Page | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members

TK_Image Class Reference

#include <BOpcodeHandler.h>

Inheritance diagram for TK_Image:

Inheritance graph
[legend]
Collaboration diagram for TK_Image:

Collaboration graph
[legend]
List of all members.

Detailed Description

Handles the TKE_Image opcode.

TK_Image provides support for writing/reading the TKE_Image opcode object to/from an HSF file.

The HOOPS/3dGS scene-graph supports 'image' primitives which are defined by a position, size (width and height), and an array of bytes which is interpretted according to the specified format.

Definition at line 4587 of file BOpcodeHandler.h.

Public Member Functions

 TK_Image ()
TK_Status Read (BStreamFileToolkit &tk) alter
TK_Status Write (BStreamFileToolkit &tk) alter
void Reset (void) alter
void SetBytes (int size, char const *bytes=0, unsigned char data_format=TKO_Compression_None) alter
char const * GetBytes (void) const
char alter * GetBytes (void) alter
void SetName (char const *string) alter
void SetName (int length) alter
char const * GetName (void) const
char alter * GetName (void) alter
void SetPosition (float x, float y, float z) alter
void SetPosition (float const *p) alter
float const * GetPosition (void) const
void SetSize (int w, int h) alter
int const * GetSize (void) const
void SetFormat (int f) alter
int GetFormat (void) const
void SetCompression (int c) alter
int GetCompression (void) const

Protected Member Functions

void set_data (int size, char const *bytes=0, unsigned char data_format=TKO_Compression_None) alter
 internal use
void set_name (char const *string) alter
 internal use
void set_name (int length) alter
 internal use
TK_Status compress_image (BStreamFileToolkit &tk) alter
 internal use
TK_Status decompress_image (BStreamFileToolkit &tk) alter
 internal use
TK_Status read_jpeg_header (void) alter
 internal use

Protected Attributes

char * m_bytes
char * m_name
float m_position [3]
int m_size [2]
int m_name_length
unsigned char m_format
unsigned char m_compression
unsigned char m_bytes_format
TK_Image_Data_Buffer m_work_area


Constructor & Destructor Documentation

TK_Image::TK_Image  )  [inline]
 

constructor

Definition at line 4619 of file BOpcodeHandler.h.


Member Function Documentation

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

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

Definition at line 4637 of file BOpcodeHandler.h.

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

Returns the address of the data buffer

Definition at line 4635 of file BOpcodeHandler.h.

int TK_Image::GetCompression void   )  const [inline]
 

Returns how the image data is compressed. Compression types are specified in TKO_Compression.

Definition at line 4669 of file BOpcodeHandler.h.

int TK_Image::GetFormat void   )  const [inline]
 

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

Definition at line 4664 of file BOpcodeHandler.h.

char alter* TK_Image::GetName void   )  [inline]
 

Returns the image name string buffer, which may be modified directly

Definition at line 4646 of file BOpcodeHandler.h.

char const* TK_Image::GetName void   )  const [inline]
 

Returns the image name string

Definition at line 4644 of file BOpcodeHandler.h.

float const* TK_Image::GetPosition void   )  const [inline]
 

Returns the text position as the address of a float triplet

Definition at line 4654 of file BOpcodeHandler.h.

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

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

Definition at line 4659 of file BOpcodeHandler.h.

TK_Status TK_Image::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_Image::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_Image::SetBytes int  size,
char const *  bytes = 0,
unsigned char  data_format = TKO_Compression_None
[inline]
 

Sets the image data. Allocates a buffer which can hold 'size' bytes, and if specified, copies the data from 'bytes' to the buffer

Definition at line 4631 of file BOpcodeHandler.h.

void TK_Image::SetCompression int  c  )  [inline]
 

Sets how the image data is compressed. Compression types are specified in TKO_Compression.

Definition at line 4667 of file BOpcodeHandler.h.

void TK_Image::SetFormat int  f  )  [inline]
 

Sets the format of the image. Formats are specified in TKO_Image_Formats. TKO_Image_Is_Named should not be set here, it is handled through SetName()

Definition at line 4662 of file BOpcodeHandler.h.

void TK_Image::SetName int  length  )  [inline]
 

Sets the name buffer. Allocates a buffer large enough to hold a string of 'length' characters

Definition at line 4642 of file BOpcodeHandler.h.

void TK_Image::SetName char const *  string  )  [inline]
 

Sets the name of the image. Allocates the buffer and copies the string

Definition at line 4640 of file BOpcodeHandler.h.

void TK_Image::SetPosition float const *  p  )  [inline]
 

Sets the text position using a float triplet

Definition at line 4652 of file BOpcodeHandler.h.

void TK_Image::SetPosition float  x,
float  y,
float  z
[inline]
 

Sets the text position using discrete float values

Definition at line 4649 of file BOpcodeHandler.h.

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

Sets the size of the image using discrete integer values

Definition at line 4657 of file BOpcodeHandler.h.

TK_Status TK_Image::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_Image::m_bytes [protected]
 

internal use; Image data

Definition at line 4593 of file BOpcodeHandler.h.

unsigned char TK_Image::m_bytes_format [protected]
 

internal use; Inficates if input data is already compressed

Definition at line 4600 of file BOpcodeHandler.h.

unsigned char TK_Image::m_compression [protected]
 

internal use; How (or if) data is compressed in stream

Definition at line 4599 of file BOpcodeHandler.h.

unsigned char TK_Image::m_format [protected]
 

internal use; Format of data

Definition at line 4598 of file BOpcodeHandler.h.

char* TK_Image::m_name [protected]
 

internal use; name applied to image (if any)

Definition at line 4594 of file BOpcodeHandler.h.

int TK_Image::m_name_length [protected]
 

internal use; Length of name

Definition at line 4597 of file BOpcodeHandler.h.

float TK_Image::m_position[3] [protected]
 

internal use; Insertion point

Definition at line 4595 of file BOpcodeHandler.h.

int TK_Image::m_size[2] [protected]
 

internal use; Width & Height

Definition at line 4596 of file BOpcodeHandler.h.

TK_Image_Data_Buffer TK_Image::m_work_area [protected]
 

internal use; Buffer for compression data

Definition at line 4601 of file BOpcodeHandler.h.


The documentation for this class was generated from the following file:
Generated on Tue May 17 12:06:10 2005 for Autodesk DWF 3D Toolkit by  doxygen 1.4.1