TK_Named_Style_Def

Functions

	`TK_Named_Style_Def`
	`~TK_Named_Style_Def`
`TK_Status`	`Read`
`TK_Status`	`Write`
`TK_Status`	`Clone`
`TK_Status`	`ReadAscii`
`TK_Status`	`WriteAscii`
void	`Reset`
void	`SetName`
void	`SetName`
char const *	`GetName`
char *	`GetName`
void	`SetSegment`
void	`SetSegment`
char const *	`GetSegment`
char *	`GetSegment`

Detailed Description

class TK_Named_Style_Def : public BBaseOpcodeHandler 

Handles the TKE_Named_Style_Def opcode.

TK_Named_Style_Def provides support for writing/reading the TKE_Named_Style_Def opcode object to/from an HSF file.

The HOOPS/3dGS scene-graph supports ‘named style definition’, which define style segments by name.

Subclassed by HTK_Named_Style_Def

Public Functions

inline TK_Named_Style_Def(): constructor

~TK_Named_Style_Def()

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.

void SetName(char const *name): Sets the style name. Allocates the buffer and copies the name string

void SetName(int length): Sets the style name buffer. Allocates a buffer large enough to hold a string of ‘length’ characters

inline char const *GetName() const: Returns the style name

inline char *GetName(): Returns the style name buffer, which can be modified directly

void SetSegment(char const *segment): Set the segment name. Makes sure the buffer is big enough to hold the segment name, and copies it in

void SetSegment(int length): Set the segment name. Makes sure the buffer is big enough to hold a string of ‘length’ characters

inline char const *GetSegment() const: Get the segment name. Returns a pointer to the current segment name

inline char *GetSegment(): Get the segment name buffer. Returns a pointer to the current segment name buffer which may then be modified directly