TK_Geometry_Options

class TK_Geometry_Options

Handles the TKE_Geometry_Options opcode.

TK_Geometry_Options provides support for writing/reading the TKE_Geometry_Options opcode object to/from an HSF file.

The HOOPS/3dGS scene-graph supports an attribute called Geometry_Options which provide instructions about scene-graph optimizations or required calculations

Inherits from: BBaseOpcodeHandler

Methods

TK_Geometry_Options::TK_Geometry_Options()

constructor

TK_Geometry_Options::~TK_Geometry_Options()
void TK_Geometry_Options::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.

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

Deprecated.

TK_Status TK_Geometry_Options::WriteAscii(BStreamFileToolkit &tk)

Deprecated.

void TK_Geometry_Options::SetMask(int m)

Sets the mask indicating which options have a setting. Options are specified by TKO_Geometry_Options.

int TK_Geometry_Options::GetMask() const

const

Returns the mask indicating which options have a setting. Options are specified by TKO_Geometry_Options.

void TK_Geometry_Options::SetOrientation(int count, float const o[])

Sets the one or two orientation vectors (as 3 or 6 float values)

int TK_Geometry_Options::GetOrientationCount() const

const

returns the number of float values associated with the orientation vectors

float const *TK_Geometry_Options::GetOrientation() const

const

returns the array of floats representing the orientation vectors

void TK_Geometry_Options::SetCoordinateSystems(int count, char const cs[])

Sets the array of coordinate system identifiers

int TK_Geometry_Options::GetCoordinateSystemCount() const

const

returns the number of coordinate system identifiers

char const *TK_Geometry_Options::GetCoordinateSystems() const

const

returns the array of bytes representing the coordinate system identifiers

void TK_Geometry_Options::SetCutVisualizationMask(int m)

Sets the mask indicating which cut visualization options have a setting. Options are specified by TKO_Geometry_Options.

int TK_Geometry_Options::GetCutVisualizationMask() const

const

Returns the mask indicating which cut visualization options have a setting. Options are specified by TKO_Geometry_Options.

void TK_Geometry_Options::SetCutVisualizationMode(int m)

Sets the cut visualization mode (shape). Options are specified by TKO_Geometry_Options.

int TK_Geometry_Options::GetCutVisualizationMode() const

const

Returns the cut visualization mode (shape). Options are specified by TKO_Geometry_Options.

void TK_Geometry_Options::SetCutVisualizationColor(float const *c)

Sets the cut visualization color given a float triplet. Options are specified by TKO_Geometry_Options.

float const *TK_Geometry_Options::GetCutVisualizationColor() const

const

Returns the cut visualization mode color as the address of a float triplet. Options are specified by TKO_Geometry_Options.

void TK_Geometry_Options::SetCutVisualizationAlpha(float a)

Sets the cut visualization alpha (opacity). Options are specified by TKO_Geometry_Options.

float TK_Geometry_Options::GetCutVisualizationAlpha() const

const

Returns the cut visualization alpha (opacity)). Options are specified by TKO_Geometry_Options.

void TK_Geometry_Options::SetCutVisualizationSCale(float s)

Sets the cut visualization scale factor. Options are specified by TKO_Geometry_Options.

float TK_Geometry_Options::GetCutVisualizationScale() const

const

Returns the cut visualization scale factor. Options are specified by TKO_Geometry_Options.

Variables

unsigned short TK_Geometry_Options::m_mask

protected

unsigned short

internal use

unsigned short TK_Geometry_Options::m_value

protected

unsigned short

internal use

char TK_Geometry_Options::m_orientation_count

protected

char

internal use

float TK_Geometry_Options::m_orientation[6]

protected

float

internal use

int TK_Geometry_Options::m_coordinate_system_count

protected

int

internal use

char *TK_Geometry_Options::m_coordinate_systems

protected

char

internal use

struct TK_Geometry_Options::[anonymous] TK_Geometry_Options::m_cut_visualization

protected

struct TK_Geometry_Options::@0

internal use

unsigned char TK_Geometry_Options::mask
unsigned char

internal use

unsigned char TK_Geometry_Options::mode
unsigned char
float TK_Geometry_Options::color[3]
float
float TK_Geometry_Options::alpha
float
float TK_Geometry_Options::scale
float