TK_Color_Map

Functions

	`TK_Color_Map`
	`~TK_Color_Map`
`TK_Status`	`Read`
`TK_Status`	`Write`
`TK_Status`	`Clone`
`TK_Status`	`ReadAscii`
`TK_Status`	`WriteAscii`
void	`Reset`
void	`SetFormat`
int	`GetFormat`
void	`SetValues`
float const *	`GetValues`
float *	`GetValues`
int	`GetLength`
void	`SetString`
void	`SetString`
char const *	`GetString`
char *	`GetString`

Detailed Description

class TK_Color_Map : public BBaseOpcodeHandler

Handles the TKE_Color_Map opcode.

TK_Color_Map provides support for writing/reading the TKE_Color_Map opcode object to/from an HSF file.

The HOOPS/3dGS scene-graph can store local colormaps

Public Functions

inline TK_Color_Map(): constructor

~TK_Color_Map()

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.

virtual void Reset(): 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.

inline void SetFormat(int f): Sets the format of the color map. The format is specified by TKO_Map_Format.

inline int GetFormat() const: Returns the format of the color map. The format is specified by TKO_Map_Format.

inline void SetValues(int count, float const values[] = 0): Sets the color map values. Allocates a buffer to hold ‘count’ float triplets of rgb values, and if ‘values’ is specified, copies the array into the buffer

inline float const *GetValues() const: Returns the color map values (rgb triplets)

inline float *GetValues(): Returns the color map values buffer, which may be modified directly

inline int GetLength() const: Returns the size of the color map (or length of the string buffer)

void SetString(char const *string): Set the color map string. Makes sure the buffer is big enough to hold the string, and copies it in

void SetString(int length): Set the color map. Makes sure the buffer is big enough to hold a string of ‘length’ characters

inline char const *GetString() const: Get the color map string. Returns a pointer to the current string

inline char *GetString(): Get the color map string buffer. Returns a pointer to the current string buffer, which may then be modified directly