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 4086 of file BOpcodeHandler.h.

Public Member Functions

 TK_Heuristics ()
TK_Status Read (BStreamFileToolkit &tk) alter
TK_Status Write (BStreamFileToolkit &tk) alter
TK_Status Clone (BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const
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 SetInternalShellSelectionLimit (int i) alter
int GetInternalShellSelectionLimit (void) const
void SetInternalPolylineSelectionLimit (int i) alter
int GetInternalPolylineSelectionLimit (void) const
void SetExtras (int e) alter
int GetExtras (void) const
void SetCulling (int c) alter
int GetCulling (void) const
void SetPixelThreshold (int c) alter
int GetPixelThreshold (void) const
void SetMaximumExtent (int c) alter
int GetMaximumExtent (void) const
int GetMaximumExtentMode (void) const
void SetMaximumExtentMode (int c) alter
float const * GetVector (void) const
void SetVector (float x, float y, float z) alter
void SetVector (float const *v) alter
float GetVectorTolerance (void) const
void SetVectorTolerance (float tol) alter
void SetOrderedWeightsMask (int c) alter
int GetOrderedWeightsMask (void) const
void SetOrderedWeight (int index, float weight) alter
float GetOrderedWeight (int index) const
float const * GetOrderedWeights (void) const
float alter * GetOrderedWeights (void) alter
void SetSelectionLevel (int l) alter
int GetSelectionLevel (void) const

Protected Attributes

int m_mask
 internal use
int m_value
 internal use
int m_related
 internal use
int m_internal_shell
 internal use
int m_internal_polyline
 internal use
unsigned char m_extras
 internal use; low bit set == left handed, second bit set == spriting
unsigned short m_culling
 internal use; culling options
int m_pixel_threshold
 internal use; pixel threshold
int m_maximum_extent
 internal use; maximum extent
int m_maximum_extent_mode
 internal use; maximum extent mode
float m_vector [3]
 internal use; culling vector
float m_vector_tolerance
 internal use; culling vector tolerance
unsigned char m_ordered_weights_mask
float m_ordered_weights [TKO_Heur_Order_Count]
unsigned char m_selection_level


Constructor & Destructor Documentation

TK_Heuristics::TK_Heuristics  )  [inline]
 

constructor

Definition at line 4113 of file BOpcodeHandler.h.


Member Function Documentation

TK_Status TK_Heuristics::Clone BStreamFileToolkit tk,
BBaseOpcodeHandler **  handler
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.

Reimplemented from BBaseOpcodeHandler.

int TK_Heuristics::GetCulling void   )  const [inline]
 

Returns the culling mode.

Definition at line 4166 of file BOpcodeHandler.h.

int TK_Heuristics::GetExtras void   )  const [inline]
 

Returns the 'extra' bits.

Definition at line 4161 of file BOpcodeHandler.h.

int TK_Heuristics::GetInternalPolylineSelectionLimit void   )  const [inline]
 

Returns the internal polyline selection limit

Definition at line 4156 of file BOpcodeHandler.h.

int TK_Heuristics::GetInternalSelectionLimit void   )  const [inline]
 

Returns the internal selection limit

Definition at line 4146 of file BOpcodeHandler.h.

int TK_Heuristics::GetInternalShellSelectionLimit void   )  const [inline]
 

Returns the internal shell selection limit

Definition at line 4151 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 4131 of file BOpcodeHandler.h.

int TK_Heuristics::GetMaximumExtent void   )  const [inline]
 

Gets the Maximum Extent

Definition at line 4174 of file BOpcodeHandler.h.

int TK_Heuristics::GetMaximumExtentMode void   )  const [inline]
 

Gets the Maximum Extent Mode

Definition at line 4176 of file BOpcodeHandler.h.

float TK_Heuristics::GetOrderedWeight int  index  )  const [inline]
 

Return a single drawing order weighting factor

Definition at line 4200 of file BOpcodeHandler.h.

float alter* TK_Heuristics::GetOrderedWeights void   )  [inline]
 

Returns the array of drawing order weighting factors, which may be modified directly

Definition at line 4204 of file BOpcodeHandler.h.

float const* TK_Heuristics::GetOrderedWeights void   )  const [inline]
 

Returns the array of drawing order weighting factors

Definition at line 4202 of file BOpcodeHandler.h.

int TK_Heuristics::GetOrderedWeightsMask void   )  const [inline]
 

Gets the mask of drawing order weight values which are interesting

Definition at line 4192 of file BOpcodeHandler.h.

int TK_Heuristics::GetPixelThreshold void   )  const [inline]
 

Gets the Pixel Threshold

Definition at line 4170 of file BOpcodeHandler.h.

int TK_Heuristics::GetRelatedSelectionLimit void   )  const [inline]
 

Returns the related selection limit

Definition at line 4141 of file BOpcodeHandler.h.

int TK_Heuristics::GetSelectionLevel void   )  const [inline]
 

Returns the selection level mode.

Definition at line 4209 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 4136 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 4164 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 4159 of file BOpcodeHandler.h.

void TK_Heuristics::SetInternalPolylineSelectionLimit int  i  )  [inline]
 

Sets the internal polyline selection limit

Definition at line 4154 of file BOpcodeHandler.h.

void TK_Heuristics::SetInternalSelectionLimit int  i  )  [inline]
 

Sets the internal selection limit

Definition at line 4144 of file BOpcodeHandler.h.

void TK_Heuristics::SetInternalShellSelectionLimit int  i  )  [inline]
 

Sets the internal shell selection limit

Definition at line 4149 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 4125 of file BOpcodeHandler.h.

void TK_Heuristics::SetMaximumExtent int  c  )  [inline]
 

Sets the upper limit for extent culling

Definition at line 4172 of file BOpcodeHandler.h.

void TK_Heuristics::SetMaximumExtentMode int  c  )  [inline]
 

Sets the Maximum Extent Mode

Definition at line 4178 of file BOpcodeHandler.h.

void TK_Heuristics::SetOrderedWeight int  index,
float  weight
[inline]
 

Sets a specified drawing order weighting factor

Definition at line 4195 of file BOpcodeHandler.h.

void TK_Heuristics::SetOrderedWeightsMask int  c  )  [inline]
 

Sets the mask of drawing order weight values which are interesting

Definition at line 4190 of file BOpcodeHandler.h.

void TK_Heuristics::SetPixelThreshold int  c  )  [inline]
 

Sets the minimum number of pixels that must be touched under an occlusion culling node for it to be considered for drawing

Definition at line 4168 of file BOpcodeHandler.h.

void TK_Heuristics::SetRelatedSelectionLimit int  r  )  [inline]
 

Sets the related selection limit

Definition at line 4139 of file BOpcodeHandler.h.

void TK_Heuristics::SetSelectionLevel int  l  )  [inline]
 

Sets the selection level mode.

Definition at line 4207 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 4134 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 Jan 6 22:41:43 2009 for Autodesk DWF 3D Toolkit by  doxygen 1.4.5