TK_Point

class TK_Point

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.

Inherits from: BBaseOpcodeHandler

Methods

TK_Point::TK_Point(unsigned char opcode)

constructor

TK_Status TK_Point::Read(BStreamFileToolkit &tk)

virtual

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.
TK_Status TK_Point::Write(BStreamFileToolkit &tk)

virtual

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.
TK_Status TK_Point::Clone(BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const

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.
TK_Status TK_Point::ReadAscii(BStreamFileToolkit &tk)

Deprecated.

TK_Status TK_Point::WriteAscii(BStreamFileToolkit &tk)

Deprecated.

void TK_Point::Reset(void)

virtual

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 TK_Point::SetPoint(float x, float y, float z)

Sets the point using discrete float values

void TK_Point::SetPoint(float const p[])

Sets the point using a float triplet

float const *TK_Point::GetPoint() const

const

Returns the point as the address of a float triplet

void TK_Point::SetDPoint(double x, double y, double z)

Sets the point using discrete double values

void TK_Point::SetDPoint(double const p[])

Sets the point using a float triplet

double const *TK_Point::GetDPoint() const

const

Returns the point as the address of a float triplet

void TK_Point::SetOptions(int o)

Sets the options (for lights only)

int TK_Point::GetOptions() const

const

Returns the options (for lights only)

Variables

float TK_Point::m_point[3]

protected

float

internal use; an array of three floats defining the x,y,z coordinates of the marker

double TK_Point::m_dpoint[3]

protected

double

internal use; an array of three doubles defining the x,y,z coordinates of the marker

char TK_Point::m_options

protected

char

relevant to TKE_Distant_Light and TKE_Local_Light only. See TKO_Light_Options.