HTK_Named Class Reference

Provides HOOPS/3dGS-specific handling of the TKE_Marker_Symbol, TKE_Line_Pattern, and TKE_Edge_Pattern opcodes. More...

#include <HOpcodeHandler.h>

Inheritance diagram for HTK_Named:

List of all members.

Public Member Functions
TK_Status	Clone (BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const
TK_Status	Execute (BStreamFileToolkit &tk) alter
	HTK_Named (unsigned char opcode)
TK_Status	Interpret (BStreamFileToolkit &tk, ID_Key key, char const *special) alter
TK_Status	Interpret (BStreamFileToolkit &tk, ID_Key key=-1, int variant=0) alter

---

Detailed Description

Provides HOOPS/3dGS-specific handling of the TKE_Marker_Symbol, TKE_Line_Pattern, and TKE_Edge_Pattern opcodes.

TKE_Marker_Symbol, TKE_Line_Pattern, and TKE_Edge_Pattern opcode objects represent either a string, or an enumeration of a preselected set of values.

---

Constructor & Destructor Documentation

HTK_Named::HTK_Named

(

unsigned char

opcode

)

[inline]

constructor

---

Member Function Documentation

TK_Status HTK_Named::Clone	(	BStreamFileToolkit &	tk,
		BBaseOpcodeHandler **	handler
	)			const [virtual]

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.

Reimplemented from TK_Named.

TK_Status HTK_Named::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 the BStreamFileToolkit object.

Returns:

The result of the function call.

Reimplemented from BBaseOpcodeHandler.

TK_Status HTK_Named::Interpret	(	BStreamFileToolkit &	tk,
		ID_Key	key,
		char const *	special
	)			[inline, virtual]

Extracts graphics data (typically from the application's scene-graph) and maps it to the opcode handler's data members in preparation for writing out an object to the file.

Parameters:

	tk	A reference to the BStreamFileToolkit object.
	key	An identifier to the object (for example, the HOOPS key of a geometry item)
	special	A string value of particular data

Returns:

The result of the function call.

Reimplemented from BBaseOpcodeHandler.

References BBaseOpcodeHandler::Interpret().

TK_Status HTK_Named::Interpret	(	BStreamFileToolkit &	tk,
		ID_Key	key = -1,
		int	variant = 0
	)			[virtual]

Extracts graphics data (typically from the application's scene-graph) and maps it to the opcode handler's data members in preparation for writing out an object to the file.

Parameters:

	tk	A reference to the BStreamFileToolkit object.
	key	An identifier to the object (for example, the HOOPS key of a geometry item)
	variant	optional specification of an alternate form, such as a Level-of-Detail representation

Returns:

The result of the function call.

Reimplemented from BBaseOpcodeHandler.

---

The documentation for this class was generated from the following file:

• HOpcodeHandler.h