TK_Size
Functions
void |
|
float |
|
int |
Detailed Description
-
class TK_Size : public BBaseOpcodeHandler
TK_Size provides support for writing/reading opcode objects which represent a single value representing a scale or size, possibly including a specification of the reference system. This includes opcodes such as TKE_Line_Weight, TKE_Edge_Weight, TKE_Marker_Size and TKE_Text_Spacing
Subclassed by HTK_Size
Public Functions
-
inline TK_Size(unsigned char opcode)
constructor
-
virtual TK_Status Read(BStreamFileToolkit &tk)
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.
-
virtual TK_Status Write(BStreamFileToolkit &tk)
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.
-
virtual TK_Status Clone(BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const
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 ReadAscii(BStreamFileToolkit &tk)
Deprecated.
-
TK_Status WriteAscii(BStreamFileToolkit &tk)
Deprecated.
-
inline void SetSize(float value, int units = TKO_Generic_Size_Unspecified)
Sets the size value & units (value may not be negative, units only meaningful if positive)
-
inline float GetSize() const
Returns the size value
-
inline int GetUnits() const
Returns the size value
-
inline TK_Size(unsigned char opcode)