TK_Visibility

class TK_Visibility

Handles the TKE_Visibility opcode.

TK_Visibility provides support for writing/reading the TKE_Visibility opcode object to/from an HSF file.

The HOOPS/3dGS scene-graph supports an attribute called Visibility which affects the display of objects.

Inherits from: BBaseOpcodeHandler

Methods

TK_Visibility::TK_Visibility(void)

constructor

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

Deprecated.

TK_Status TK_Visibility::WriteAscii(BStreamFileToolkit &tk)

Deprecated.

void TK_Visibility::SetGeometry(int m)

Sets the mask indicating which geometries have a visibility setting. Geometry types are specified by TKO_Geometry_Bits.

int TK_Visibility::GetGeometry() const

const

Returns the mask indicating which geometries have a visibility setting. Geometry types are specified by TKO_Geometry_Bits.

void TK_Visibility::SetValue(int m)

Sets the mask indicating which geometries have visibility set on. Geometry types are specified by TKO_Geometry_Bits.

int TK_Visibility::GetValue() const

const

Returns the mask indicating which geometries have visibility set on. Geometry types are specified by TKO_Geometry_Bits.

Variables

int TK_Visibility::m_mask

protected

int

internal use; specifies which visibility settings are active (and hence, which are valid). For internal use only.

int TK_Visibility::m_value

protected

int

internal use; specifies what values to set for boolean options. For internal use only.