Alphabetical Class Index   Class Hierarchy   Compound Members   File Members   File List  

TK_Geometry_Options Class Reference

Handles the TKE_Geometry_Options opcode. More...

#include <BOpcodeHandler.h>

List of all members.

Public Member Functions

TK_Status Clone (BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const
int GetMask () const
float const * GetOrientation () const
int GetOrientationCount () const
TK_Status Read (BStreamFileToolkit &tk)
TK_Status ReadAscii (BStreamFileToolkit &tk)
 Deprecated.
void SetMask (int m)
void SetOrientation (int count, float const *o)
 TK_Geometry_Options ()
TK_Status Write (BStreamFileToolkit &tk)
TK_Status WriteAscii (BStreamFileToolkit &tk)
 Deprecated.

Protected Attributes

unsigned short m_mask
 internal use
float m_orientation [6]
 internal use
char m_orientation_count
 internal use
unsigned short m_value
 internal use

Detailed Description

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


Constructor & Destructor Documentation

TK_Geometry_Options::TK_Geometry_Options ( ) [inline]

constructor


Member Function Documentation

TK_Status TK_Geometry_Options::Clone ( BStreamFileToolkit tk,
BBaseOpcodeHandler **  handler 
) const [virtual]

Copies the opcode handler

Parameters:
tkA reference to the BStreamFileToolkit object.
handlerA pointer to the opcode handler object. Passed by reference.
Returns:
The result of the function call.

Reimplemented from BBaseOpcodeHandler.

Reimplemented in HTK_Geometry_Options.

int TK_Geometry_Options::GetMask ( ) const [inline]

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

float const* TK_Geometry_Options::GetOrientation ( ) const [inline]

returns the array of floats representing the orientation vectors

int TK_Geometry_Options::GetOrientationCount ( ) const [inline]

returns the number of float values associated with the orientation vectors

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:
tkA reference to the BStreamFileToolkit object.
Returns:
The result of the function call.

Implements BBaseOpcodeHandler.

void TK_Geometry_Options::SetMask ( int  m) [inline]

Sets 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 
) [inline]

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

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:
tkA reference to the BStreamFileToolkit object.
Returns:
The result of the function call.

Implements BBaseOpcodeHandler.


The documentation for this class was generated from the following file: