TK_Image_XRef
-
class
TK_Image_XRef Handles the TKE_Image_XRef opcodes.
TK_Image_XRefprovides support for writing/reading the TKE_Image_XRef opcode object to/from an HSF file.An Image XRef is a common referral to an external image, implemented here to prevent it being replicated in many other components.
Inherits from:
BBaseOpcodeHandler
Methods
-
void
TK_Image_XRef::set_name(char const *string) protected
internal use
-
void
TK_Image_XRef::set_name(int length) protected
internal use
-
TK_Image_XRef::TK_Image_XRef()
-
TK_Image_XRef::~TK_Image_XRef()
-
TK_Status
TK_Image_XRef::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_XRef::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_XRef::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_XRef::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 theBStreamFileToolkitobject.Returns
The result of the function call.
-
void
TK_Image_XRef::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.
-
void
TK_Image_XRef::SetName(char const *string) Sets the name of the image. Allocates the buffer and copies the string
-
void
TK_Image_XRef::SetName(int length) Sets the name buffer. Allocates a buffer large enough to hold a string of ‘length’ characters
-
char const *
TK_Image_XRef::GetName(void) const const
Returns the image name string
-
char *
TK_Image_XRef::GetName(void) Returns the image name string buffer, which may be modified directly
-
void
TK_Image_XRef::SetSize(int x, int y)
-
int const *
TK_Image_XRef::GetSize(void) const const
-
int *
TK_Image_XRef::GetSize(void)
-
void
TK_Image_XRef::SetBitDepth(char bpp)
-
char
TK_Image_XRef::GetBitDepth(void) const const
-
char
TK_Image_XRef::GetBitDepth(void)
Variables
-
char *
TK_Image_XRef::m_name protected
charinternal use; name applied to image (if any)
-
int
TK_Image_XRef::m_name_length protected
intinternal use; Length of name
-
int
TK_Image_XRef::m_size[2] protected
int
-
char
TK_Image_XRef::m_bpp protected
char