TK_Cellular_Volume

class TK_Cellular_Volume

Handles the TKE_Cellular_Volume opcode.

TK_Cellular_Volume provides support for writing/reading the TKE_Cellular_Volume opcode object to/from an HSF file.

The HOOPS/3dGS scene-graph can contain ‘cellular volume’ primitives which consist of a points array and a connectivity list to define the cells of the volume.

Inherits from: TK_Polyhedron

Methods

TK_Status TK_Cellular_Volume::SetCellsList(int length, int const *cell_list = 0)

protected

Allocate an array of the provided length for the cell list, and set values if given.

int const *TK_Cellular_Volume::GetCellsList() const

protected const

Returns

a pointer to the cell list, an array of integers
int TK_Cellular_Volume::GetCellsLength() const

protected const

Returns

the length of the cell list
TK_Cellular_Volume::TK_Cellular_Volume()
TK_Cellular_Volume::~TK_Cellular_Volume()
TK_Status TK_Cellular_Volume::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_Cellular_Volume::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.
void TK_Cellular_Volume::Reset()

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.

Variables

int TK_Cellular_Volume::m_substage

protected

int

Tracks progress in subroutines

unsigned char TK_Cellular_Volume::m_compression_scheme

protected

unsigned char

The compression scheme currently in use