TK_Image
-
class
TK_Image Handles the TKE_Image opcode.
TK_Imageprovides 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.
Inherits from:
BBaseOpcodeHandlerIndex
Methods
Clone()compress_image()compress_image_ascii()decompress_image()GetBytes()GetBytes()GetCompression()GetDPosition()GetFormat()GetName()GetName()GetOptions()GetPosition()GetReference()GetReference()GetSize()Read()read_jpeg_header()ReadAscii()Reset()set_data()set_name()set_name()SetBytes()SetCompression()SetDPosition()SetDPosition()SetFormat()SetName()SetName()SetOptions()SetPosition()SetPosition()SetReference()SetReference()SetSize()SetSize()TK_Image()Write()WriteAscii()~TK_Image()
Variables
Methods
-
void
TK_Image::set_data(int size, char const *bytes = 0, unsigned char data_format = TKO_Compression_None) protected
internal use
-
TK_Status
TK_Image::compress_image(BStreamFileToolkit &tk, int active_work_area = 0) protected
internal use
-
TK_Status
TK_Image::decompress_image(BStreamFileToolkit &tk, int active_work_area = 0) protected
internal use
-
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 theBStreamFileToolkitobject.Returns
The result of the function call.
-
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 theBStreamFileToolkitobject.Returns
The result of the function call.
-
TK_Status
TK_Image::Clone(BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const const virtual
Copies the opcode handler
Parameters
tk: A reference to the
BStreamFileToolkitobject.handler: A pointer to the opcode handler object. Passed by reference.
Returns
The result of the function call.
-
TK_Status
TK_Image::ReadAscii(BStreamFileToolkit &tk) Deprecated.
-
TK_Status
TK_Image::WriteAscii(BStreamFileToolkit &tk) Deprecated.
-
TK_Status
TK_Image::compress_image_ascii(BStreamFileToolkit &tk)
-
void
TK_Image::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_Image::SetBytes(int size, char const *bytes = 0, unsigned char data_format = TKO_Compression_None) 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_Image::SetName(char const *string) Sets the name of the image. Allocates the buffer and copies the string
-
void
TK_Image::SetName(int length) Sets the name buffer. Allocates a buffer large enough to hold a string of ‘length’ characters
-
void
TK_Image::SetReference(char const *string) Sets the reference to the image data. Allocates the buffer and copies the string
-
void
TK_Image::SetReference(int length) Sets the reference buffer. Allocates a buffer large enough to hold a string of ‘length’ characters
-
void
TK_Image::SetPosition(float x, float y, float z) Sets the text position using discrete float values
-
float const *
TK_Image::GetPosition() const const
Returns the text position as the address of a float triplet
-
void
TK_Image::SetDPosition(double x, double y, double z) Sets the text position using discrete double values
-
double const *
TK_Image::GetDPosition() const const
Returns the text position as the address of a float triplet
-
int const *
TK_Image::GetSize() const const
Returns the size of the image as the address of a pair of integers
-
void
TK_Image::SetFormat(int f) Sets the format of the image. Formats are specified in
TKO_Image_Formats.
-
int
TK_Image::GetFormat() const const
Returns the format of the image. Formats are specified in
TKO_Image_Formats.
-
void
TK_Image::SetOptions(int f) Sets the options of the image. Options are specified in
TKO_Image_Formats.
-
int
TK_Image::GetOptions() const const
Returns the options of the image. Options are specified in
TKO_Image_Formats.
-
void
TK_Image::SetCompression(int c) Sets how the image data is compressed. Compression types are specified in
TKO_Compression.
-
int
TK_Image::GetCompression() const const
Returns how the image data is compressed. Compression types are specified in
TKO_Compression.
Variables
-
int
TK_Image::m_data_size protected
intinternal use; Explicit length of data block used only for precompressed images (dxt or jpeg) passed straight through.
-
unsigned int
TK_Image::m_options protected
unsigned intinternal use; Extra options (named, explicit size)
-
unsigned char
TK_Image::m_compression protected
unsigned charinternal use; How (or if) data is compressed in stream
-
unsigned char
TK_Image::m_bytes_format protected
unsigned charinternal use; Indicates if input data is already compressed
-
TK_Image_Data_Buffer
TK_Image::m_work_area[2] protected
TK_Image_Data_Bufferinternal use; Buffers for compression data