TK_Heuristics
-
class
TK_Heuristics Handles the TKE_Heuristics opcode.
TK_Heuristicsprovides 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
Inherits from:
BBaseOpcodeHandlerIndex
Methods
Clone()GetCulling()GetEMask()GetEValue()GetExtras()GetForceDefer()GetHardExtent()GetInternalPolylineSelectionLimit()GetInternalSelectionLimit()GetInternalShellSelectionLimit()GetMask()GetMaxDistance()GetMaximumExtent()GetMaximumExtentLevel()GetMaximumExtentMode()GetOrderedWeight()GetOrderedWeights()GetOrderedWeights()GetOrderedWeightsMask()GetPixelThreshold()GetRelatedSelectionLimit()GetSelectionBias()GetSelectionCulling()GetSelectionLevel()GetSelectionSorting()GetStaticOptions()GetValue()GetVector()GetVectorTolerance()GetViewVolume()Read()ReadAscii()Reset()SetCulling()SetEMask()SetEValue()SetExtras()SetForceDefer()SetHardExtent()SetInternalPolylineSelectionLimit()SetInternalSelectionLimit()SetInternalShellSelectionLimit()SetMask()SetMaxDistance()SetMaximumExtent()SetMaximumExtentLevel()SetMaximumExtentMode()SetOrderedWeight()SetOrderedWeightsMask()SetPixelThreshold()SetRelatedSelectionLimit()SetSelectionBias()SetSelectionCulling()SetSelectionLevel()SetSelectionSorting()SetStaticOptions()SetValue()SetVector()SetVector()SetVectorTolerance()SetViewVolume()SetViewVolume()TK_Heuristics()Write()WriteAscii()~TK_Heuristics()
Variables
m_cullingm_emaskm_evaluem_extrasm_force_deferm_hard_extentm_internal_polylinem_internal_shellm_maskm_max_distancem_maximum_extentm_maximum_extent_levelm_maximum_extent_modem_model_typem_ordered_weightsm_ordered_weights_maskm_pixel_thresholdm_relatedm_selection_biasm_selection_cullingm_selection_levelm_selection_sortingm_static_optionsm_valuem_vectorm_vector_tolerancem_view_volume
Methods
-
TK_Heuristics::TK_Heuristics() constructor
-
TK_Heuristics::~TK_Heuristics()
-
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 theBStreamFileToolkitobject.Returns
The result of the function call.
-
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 theBStreamFileToolkitobject.Returns
The result of the function call.
-
TK_Status
TK_Heuristics::Clone(BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const const virtual
Copies the opcode handler
Parameters
tk: A reference to the
BStreamFileToolkitobject.handler: A pointer to the opcode handler object. Passed by reference.
Returns
The result of the function call.
-
void
TK_Heuristics::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_Heuristics::ReadAscii(BStreamFileToolkit &tk) Deprecated.
-
TK_Status
TK_Heuristics::WriteAscii(BStreamFileToolkit &tk) Deprecated.
-
void
TK_Heuristics::SetMask(int m) Sets the mask indicating which heuristics have a setting. Options are specified by
TKO_Heuristic_Bits.
-
int
TK_Heuristics::GetMask() const const
Returns the mask indicating which heuristics have a setting. Options are specified by
TKO_Heuristic_Bits.
-
void
TK_Heuristics::SetValue(int v) Sets the mask indicating which heuristics are set on/active. Options are specified by
TKO_Heuristic_Bits.
-
int
TK_Heuristics::GetValue() const const
Returns the mask indicating which heuristics are set on/active. Options are specified by
TKO_Heuristic_Bits.
-
void
TK_Heuristics::SetEMask(int m) Sets the extended mask indicating which heuristics have a setting. Options are specified by
TKO_Heuristic_Bits.
-
int
TK_Heuristics::GetEMask() const const
Returns the extended mask indicating which heuristics have a setting. Options are specified by
TKO_Heuristic_Bits.
-
void
TK_Heuristics::SetEValue(int v) Sets the extended mask indicating which heuristics are set on/active. Options are specified by
TKO_Heuristic_Bits.
-
int
TK_Heuristics::GetEValue() const const
Returns the extended mask indicating which heuristics are set on/active. Options are specified by
TKO_Heuristic_Bits.
-
void
TK_Heuristics::SetRelatedSelectionLimit(int r) Sets the related selection limit
-
int
TK_Heuristics::GetRelatedSelectionLimit() const const
Returns the related selection limit
-
void
TK_Heuristics::SetInternalSelectionLimit(int i) Sets the internal selection limit
-
int
TK_Heuristics::GetInternalSelectionLimit() const const
Returns the internal selection limit
-
void
TK_Heuristics::SetInternalShellSelectionLimit(int i) Sets the internal shell selection limit
-
int
TK_Heuristics::GetInternalShellSelectionLimit() const const
Returns the internal shell selection limit
-
void
TK_Heuristics::SetInternalPolylineSelectionLimit(int i) Sets the internal polyline selection limit
-
int
TK_Heuristics::GetInternalPolylineSelectionLimit() const const
Returns the internal polyline selection limit
-
void
TK_Heuristics::SetExtras(int e) Sets the ‘extra’ bits. These bits are used to indicate an alternate form for some of the options.
-
int
TK_Heuristics::GetExtras() const const
Returns the ‘extra’ bits.
-
void
TK_Heuristics::SetCulling(int c) Sets the culling mode. These bits indicate forms of scene culling which may be used.
-
int
TK_Heuristics::GetCulling() const const
Returns the culling mode.
-
void
TK_Heuristics::SetSelectionCulling(int c) Sets the selection culling mode. These bits indicate forms of scene culling which may be used.
-
int
TK_Heuristics::GetSelectionCulling() const const
Returns the culling mode.
-
void
TK_Heuristics::SetSelectionBias(int c) Sets the selection bias mode. These bits indicate items to favor during selection.
-
int
TK_Heuristics::GetSelectionBias() const const
Returns the selection bias mode.
-
void
TK_Heuristics::SetPixelThreshold(int c) Sets the minimum number of pixels that must be touched under an occlusion culling node for it to be considered for drawing
-
int
TK_Heuristics::GetPixelThreshold() const const
Gets the Pixel Threshold
-
void
TK_Heuristics::SetMaximumExtent(int c) Sets the upper limit for extent culling
-
int
TK_Heuristics::GetMaximumExtent() const const
Gets the Maximum Extent
-
int
TK_Heuristics::GetMaximumExtentMode() const const
Gets the Maximum Extent Mode
-
void
TK_Heuristics::SetMaximumExtentMode(int c) Sets the Maximum Extent Mode
-
int
TK_Heuristics::GetMaximumExtentLevel() const const
Gets the Maximum Extent Level
-
void
TK_Heuristics::SetMaximumExtentLevel(int c) Sets the Maximum Extent Level
-
void
TK_Heuristics::SetHardExtent(int c) Sets the limit for hard extent culling
-
int
TK_Heuristics::GetHardExtent() const const
Gets the Hard Extent
-
float const *
TK_Heuristics::GetVector() const const
Gets the Culling Vector
-
void
TK_Heuristics::SetVector(float x, float y, float z) Sets the Culling Vector using discrete values
-
void
TK_Heuristics::SetVector(float const v[]) Sets the Culling Vector using a float array
-
float
TK_Heuristics::GetVectorTolerance() const const
Gets the Culling Vector Tolerance
-
void
TK_Heuristics::SetVectorTolerance(float tol) Sets the Culling Vector Tolerance
-
void
TK_Heuristics::SetMaxDistance(float m)
-
float
TK_Heuristics::GetMaxDistance() const const
Gets the Hard Extent
-
float const *
TK_Heuristics::GetViewVolume() const const
Gets the Culling view volume
-
void
TK_Heuristics::SetViewVolume(float ax, float ay, float az, float bx, float by, float bz) Sets the Culling view volume using discrete values
-
void
TK_Heuristics::SetViewVolume(float const v[]) Sets the Culling view volume using a float array
-
void
TK_Heuristics::SetOrderedWeightsMask(int c) Sets the mask of drawing order weight values which are interesting
-
int
TK_Heuristics::GetOrderedWeightsMask() const const
Gets the mask of drawing order weight values which are interesting
-
void
TK_Heuristics::SetOrderedWeight(int index, float weight) Sets a specified drawing order weighting factor
-
float
TK_Heuristics::GetOrderedWeight(int index) const const
Return a single drawing order weighting factor
-
float const *
TK_Heuristics::GetOrderedWeights() const const
Returns the array of drawing order weighting factors
-
float *
TK_Heuristics::GetOrderedWeights() Returns the array of drawing order weighting factors, which may be modified directly
-
void
TK_Heuristics::SetSelectionLevel(int l) Sets the selection level mode.
-
int
TK_Heuristics::GetSelectionLevel() const const
Returns the selection level mode.
-
void
TK_Heuristics::SetSelectionSorting(int s) Sets the selection sorting mode.
-
int
TK_Heuristics::GetSelectionSorting() const const
Returns the selection sorting mode.
-
void
TK_Heuristics::SetForceDefer(int l) Sets the force defer level.
-
int
TK_Heuristics::GetForceDefer() const const
Returns the force defer level.
-
void
TK_Heuristics::SetStaticOptions(int o) Sets the static options (such as condition handling mode).
-
int
TK_Heuristics::GetStaticOptions() const const
Returns the static options.
Variables
-
int
TK_Heuristics::m_mask protected
intinternal use
-
int
TK_Heuristics::m_value protected
intinternal use
-
int
TK_Heuristics::m_emask protected
intinternal use
-
int
TK_Heuristics::m_evalue protected
intinternal use
protected
intinternal use
-
int
TK_Heuristics::m_internal_shell protected
intinternal use
-
int
TK_Heuristics::m_internal_polyline protected
intinternal use
-
unsigned char
TK_Heuristics::m_extras protected
unsigned charinternal use; low bit set == left handed, second bit set == spriting
-
int
TK_Heuristics::m_culling protected
intinternal use; culling options
-
int
TK_Heuristics::m_selection_culling protected
intinternal use; selection culling options
-
unsigned short
TK_Heuristics::m_selection_bias protected
unsigned shortinternal use; selection bias options
-
int
TK_Heuristics::m_pixel_threshold protected
intinternal use; pixel threshold
-
int
TK_Heuristics::m_maximum_extent protected
intinternal use; maximum extent
-
int
TK_Heuristics::m_maximum_extent_mode protected
intinternal use; maximum extent mode int! argh…
-
char
TK_Heuristics::m_maximum_extent_level protected
charinternal use; maximum extent level
-
int
TK_Heuristics::m_hard_extent protected
intinternal use; hard extent
-
int
TK_Heuristics::m_force_defer protected
intinternal use; hard extent
-
float
TK_Heuristics::m_vector[3] protected
floatinternal use; culling vector
-
float
TK_Heuristics::m_vector_tolerance protected
floatinternal use; culling vector tolerance
-
float
TK_Heuristics::m_max_distance protected
floatinternal use; max distance
-
float
TK_Heuristics::m_view_volume[6] protected
floatinternal use; view volume
-
unsigned char
TK_Heuristics::m_ordered_weights_mask protected
unsigned char
-
float
TK_Heuristics::m_ordered_weights[TKO_Heur_Order_Count] protected
float
-
unsigned char
TK_Heuristics::m_selection_level protected
unsigned char
-
unsigned char
TK_Heuristics::m_selection_sorting protected
unsigned char
-
unsigned char
TK_Heuristics::m_model_type protected
unsigned char
-
unsigned short
TK_Heuristics::m_static_options protected
unsigned short