HPS.PerformanceControl Class Reference
Inheritance diagram for HPS.PerformanceControl:
HPS.Control HPS.Object

Public Member Functions

override void Dispose ()
 
override HPS.Type ObjectType ()
 
 PerformanceControl (HPS.SegmentKey in_seg)
 
 PerformanceControl (HPS.PerformanceControl in_that)
 
HPS.PerformanceControl SetDisplayLists (HPS.Performance.DisplayLists in_display_list)
 
HPS.PerformanceControl SetDisplayLists ()
 
HPS.PerformanceControl SetStaticConditions (HPS.Performance.StaticConditions in_conditions)
 
HPS.PerformanceControl SetStaticModel (HPS.Performance.StaticModel in_model_type)
 
bool ShowDisplayLists (out HPS.Performance.DisplayLists out_display_list)
 
bool ShowStaticConditions (out HPS.Performance.StaticConditions out_conditions)
 
bool ShowStaticModel (out HPS.Performance.StaticModel out_model_type)
 
override HPS.Type Type ()
 
HPS.PerformanceControl UnsetDisplayLists ()
 
HPS.PerformanceControl UnsetEverything ()
 
HPS.PerformanceControl UnsetStaticConditions ()
 
HPS.PerformanceControl UnsetStaticModel ()
 
- Public Member Functions inherited from HPS.Control
 Control (HPS.Control in_that)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

The HPS.PerformanceControl class is a smart pointer that is tied to a database object. This object is used to enable and disable performance-related attributes, such as display lists and static model.

This table lists default values for the various segment attributes accessible from HPS.PerformanceControl.

Constructor & Destructor Documentation

◆ PerformanceControl() [1/2]

HPS.PerformanceControl.PerformanceControl ( HPS.SegmentKey  in_seg)
inline

Initializes a control tied to the segment in_seg.

◆ PerformanceControl() [2/2]

HPS.PerformanceControl.PerformanceControl ( HPS.PerformanceControl  in_that)
inline

Initializes a control tied to the same object as in_that.

Member Function Documentation

◆ ObjectType()

override HPS.Type HPS.PerformanceControl.ObjectType ( )
inlinevirtual

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

Returns
The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from HPS.Control.

◆ SetDisplayLists() [1/2]

HPS.PerformanceControl HPS.PerformanceControl.SetDisplayLists ( HPS.Performance.DisplayLists  in_display_list)
inline

Sets the display list state. Display lists enables the drivers to cache data in video card memory for improved rendering performance.

Parameters
in_display_listThe type of display lists, if any, that should be used.
Returns
A reference to this object.

◆ SetDisplayLists() [2/2]

HPS.PerformanceControl HPS.PerformanceControl.SetDisplayLists ( )
inline

Sets the display list state. Display lists enables the drivers to cache data in video card memory for improved rendering performance.

Returns
A reference to this object.

◆ SetStaticConditions()

HPS.PerformanceControl HPS.PerformanceControl.SetStaticConditions ( HPS.Performance.StaticConditions  in_conditions)
inline

Sets the mode for processing conditional expressions inn a static tree.

Parameters
in_conditionsThe type of conditional processing that should be used.
Returns
A reference to this object.

◆ SetStaticModel()

HPS.PerformanceControl HPS.PerformanceControl.SetStaticModel ( HPS.Performance.StaticModel  in_model_type)
inline

Sets the static tree state. This will create a compiled draw tree for the scene which should result in better rendering performance. It is important to note that the compiled tree will need to be regenerated if a change occurs within the segment tree.

Parameters
in_model_typeThe type of static tree, if any, that should be used.
Returns
A reference to this object.

◆ ShowDisplayLists()

bool HPS.PerformanceControl.ShowDisplayLists ( out HPS.Performance.DisplayLists  out_display_list)
inline

Shows the display list state.

Parameters
out_display_listThe type of display lists, if any.
Returns
true if the setting is valid, false otherwise.

◆ ShowStaticConditions()

bool HPS.PerformanceControl.ShowStaticConditions ( out HPS.Performance.StaticConditions  out_conditions)
inline

Shows the static conditions state.

Parameters
out_conditionsThe type of conditional expression processing
Returns
true if the setting is valid, false otherwise.

◆ ShowStaticModel()

bool HPS.PerformanceControl.ShowStaticModel ( out HPS.Performance.StaticModel  out_model_type)
inline

Shows the static model state.

Parameters
out_model_typeThe type of static tree, if any
Returns
true if the setting is valid, false otherwise.

◆ Type()

override HPS.Type HPS.PerformanceControl.Type ( )
inlinevirtual

This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types.

Warning
This function must synchronize the database (by waiting for all pending database operations to complete) in order to know the type status of this object with certainty. Therefore this function can negatively impact performance. You should vigorously avoid using this function in high-traffic or peformance-critical areas of your code.
Returns
The true type of the object in question.

Reimplemented from HPS.Control.

◆ UnsetDisplayLists()

HPS.PerformanceControl HPS.PerformanceControl.UnsetDisplayLists ( )
inline

Removes the display list setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by PerformanceKit.GetDefault().

Returns
A reference to this object.

◆ UnsetEverything()

HPS.PerformanceControl HPS.PerformanceControl.UnsetEverything ( )
inline

Removes all settings from this object. If the control is attached to a WindowKey this function restores the default settings of this control as specified by PerformanceKit.GetDefault().

Returns
A reference to this object.

◆ UnsetStaticConditions()

HPS.PerformanceControl HPS.PerformanceControl.UnsetStaticConditions ( )
inline

Removes the static condition state. setting as specified by PerformanceKit.GetDefault().

Returns
A reference to this object.

◆ UnsetStaticModel()

HPS.PerformanceControl HPS.PerformanceControl.UnsetStaticModel ( )
inline

Removes the static model state, releasing the compiled draw tree. If the control is attached to a WindowKey this function restores the default value of this setting as specified by PerformanceKit.GetDefault().

Returns
A reference to this object.

The documentation for this class was generated from the following file:
  • internals/hps_core/source/cs/HPS.PerformanceControl.cs