Main Page | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members

TK_Heuristics Class Reference

#include <BOpcodeHandler.h>

Inheritance diagram for TK_Heuristics:

Inheritance graph
[legend]
Collaboration diagram for TK_Heuristics:

Collaboration graph
[legend]
List of all members.

Detailed Description

Handles the TKE_Heuristics opcode.

TK_Heuristics provides support for writing/reading the TKE_Heuristics opcode object to/from an HSF file.

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

Definition at line 2489 of file BOpcodeHandler.h.

Public Member Functions

 TK_Heuristics ()
TK_Status Read (BStreamFileToolkit &tk) alter
TK_Status Write (BStreamFileToolkit &tk) alter
void SetMask (int m) alter
int GetMask (void) const
void SetValue (int v) alter
int GetValue (void) const
void SetRelatedSelectionLimit (int r) alter
int GetRelatedSelectionLimit (void) const
void SetInternalSelectionLimit (int i) alter
int GetInternalSelectionLimit (void) const
void SetExtras (int e) alter
int GetExtras (void) const
void SetCulling (int c) alter
int GetCulling (void) const

Protected Attributes

int m_mask
 internal use
int m_value
 internal use
int m_related
 internal use
int m_internal
 internal use
unsigned char m_extras
 internal use; low bit set == left handed, second bit set == spriting
unsigned char m_culling
 internal use; culling options


Constructor & Destructor Documentation

TK_Heuristics::TK_Heuristics  )  [inline]
 

constructor

Definition at line 2506 of file BOpcodeHandler.h.


Member Function Documentation

int TK_Heuristics::GetCulling void   )  const [inline]
 

Returns the culling mode.

Definition at line 2541 of file BOpcodeHandler.h.

int TK_Heuristics::GetExtras void   )  const [inline]
 

Returns the 'extra' bits.

Definition at line 2536 of file BOpcodeHandler.h.

int TK_Heuristics::GetInternalSelectionLimit void   )  const [inline]
 

Returns the internal selection limit

Definition at line 2531 of file BOpcodeHandler.h.

int TK_Heuristics::GetMask void   )  const [inline]
 

Returns the mask indicating which heuristics have a setting. Options are specified by TKO_Heuristic_Bits.

Definition at line 2516 of file BOpcodeHandler.h.

int TK_Heuristics::GetRelatedSelectionLimit void   )  const [inline]
 

Returns the related selection limit

Definition at line 2526 of file BOpcodeHandler.h.

int TK_Heuristics::GetValue void   )  const [inline]
 

Returns the mask indicating which heuristics are set on/active. Options are specified by TKO_Heuristic_Bits.

Definition at line 2521 of file BOpcodeHandler.h.

TK_Status TK_Heuristics::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.

Implements BBaseOpcodeHandler.

void TK_Heuristics::SetCulling int  c  )  [inline]
 

Sets the culling mode. These bits indicate forms of scene culling which may be used.

Definition at line 2539 of file BOpcodeHandler.h.

void TK_Heuristics::SetExtras int  e  )  [inline]
 

Sets the 'extra' bits. These bits are used to indicate an alternate form for some of the options.

Definition at line 2534 of file BOpcodeHandler.h.

void TK_Heuristics::SetInternalSelectionLimit int  i  )  [inline]
 

Sets the internal selection limit

Definition at line 2529 of file BOpcodeHandler.h.

void TK_Heuristics::SetMask int  m  )  [inline]
 

Sets the mask indicating which heuristics have a setting. Options are specified by TKO_Heuristic_Bits.

Definition at line 2514 of file BOpcodeHandler.h.

void TK_Heuristics::SetRelatedSelectionLimit int  r  )  [inline]
 

Sets the related selection limit

Definition at line 2524 of file BOpcodeHandler.h.

void TK_Heuristics::SetValue int  v  )  [inline]
 

Sets the mask indicating which heuristics are set on/active. Options are specified by TKO_Heuristic_Bits.

Definition at line 2519 of file BOpcodeHandler.h.

TK_Status TK_Heuristics::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.

Implements BBaseOpcodeHandler.


The documentation for this class was generated from the following file:
Generated on Tue May 17 12:06:09 2005 for Autodesk DWF 3D Toolkit by  doxygen 1.4.1