TK_Point

Functions

	`TK_Point`
`TK_Status`	`Read`
`TK_Status`	`Write`
`TK_Status`	`Clone`
`TK_Status`	`ReadAscii`
`TK_Status`	`WriteAscii`
void	`Reset`
void	`SetPoint`
void	`SetPoint`
float const *	`GetPoint`
void	`SetDPoint`
void	`SetDPoint`
double const *	`GetDPoint`
void	`SetOptions`
int	`GetOptions`

Detailed Description

class TK_Point : public BBaseOpcodeHandler

Handles the TKE_Marker, TKE_Text_Path TKE_Distant_Light, and TKE_Local_Light opcodes.

TK_Point provides support for writing/reading the TKE_Marker, TKE_Distant_Light, and TKE_Local_Light opcode objects to/from an HSF file.

The HOOPS/3dGS scene-graph supports ‘marker’ primitives which consist of a 3D point, as well as distant and local lights which are also denoted by a single 3D point.

Public Functions

inline TK_Point(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 virtual void Reset(void): 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 SetPoint(float x, float y, float z): Sets the point using discrete float values

inline void SetPoint(float const p[]): Sets the point using a float triplet

inline float const *GetPoint() const: Returns the point as the address of a float triplet

inline void SetDPoint(double x, double y, double z): Sets the point using discrete double values

inline void SetDPoint(double const p[]): Sets the point using a float triplet

inline double const *GetDPoint() const: Returns the point as the address of a float triplet

inline void SetOptions(int o): Sets the options (for lights only)

inline int GetOptions() const: Returns the options (for lights only)