< Home

< Table of Contents

REFERENCE MANUAL

PerformanceControl Class Reference

#include <hps.h>

Inheritance diagram for PerformanceControl:
Control Object

Public Member Functions

Type ObjectType () const
 
PerformanceControloperator= (PerformanceControl &&in_that)
 
PerformanceControloperator= (PerformanceControl const &in_that)
 
 PerformanceControl (SegmentKey &in_seg)
 
 PerformanceControl (PerformanceControl const &in_that)
 
 PerformanceControl (PerformanceControl &&in_that)
 
PerformanceControlSetDisplayLists (Performance::DisplayLists in_display_list=Performance::DisplayLists::SegmentDisplayLists)
 
PerformanceControlSetStaticModel (Performance::StaticModel in_model_type)
 
bool ShowDisplayLists (Performance::DisplayLists &out_display_list) const
 
bool ShowStaticModel (Performance::StaticModel &out_model_type) const
 
PerformanceControlUnsetDisplayLists ()
 
PerformanceControlUnsetEverything ()
 
PerformanceControlUnsetStaticModel ()
 
 ~PerformanceControl ()
 
- Public Member Functions inherited from Object
virtual bool Empty () const
 
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (Type in_mask) const
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 
Type Type () const
 

Additional Inherited Members

- Static Public Member Functions inherited from Object
template<typename T >
static intptr_t ClassID ()
 
- Protected Member Functions inherited from Control
 Control (Control &&in_that)
 
Controloperator= (Control &&in_that)
 

Detailed Description

The 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 PerformanceControl.

Constructor & Destructor Documentation

PerformanceControl::PerformanceControl ( SegmentKey in_seg)
explicit

Initializes a control tied to the segment in_seg.

PerformanceControl::PerformanceControl ( PerformanceControl const &  in_that)

Initializes a control tied to the same object as in_that.

PerformanceControl::PerformanceControl ( PerformanceControl &&  in_that)

The move constructor creates a PerformanceControl by transferring the underlying impl of the rvalue reference to this PerformanceControl thereby avoiding a copy and allocation.

Parameters
in_thatAn rvalue reference to a PerformanceControl to take the impl from.
PerformanceControl::~PerformanceControl ( )

Releases a reference to the database object this control is tied to.

Member Function Documentation

Type PerformanceControl::ObjectType ( ) const
inlinevirtual

This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.

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

Reimplemented from Control.

PerformanceControl& PerformanceControl::operator= ( PerformanceControl &&  in_that)

The move assignment operator transfers the underlying impl of the rvalue reference to this PerformanceControl thereby avoiding a copy.

Parameters
in_thatAn rvalue reference to a PerformanceControl to take the impl from.
Returns
A reference to this PerformanceControl.
PerformanceControl& PerformanceControl::operator= ( PerformanceControl const &  in_that)

Share the smart-pointer.

PerformanceControl& PerformanceControl::SetDisplayLists ( Performance::DisplayLists  in_display_list = Performance::DisplayLists::SegmentDisplayLists)

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.
PerformanceControl& PerformanceControl::SetStaticModel ( Performance::StaticModel  in_model_type)

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.
bool PerformanceControl::ShowDisplayLists ( Performance::DisplayLists out_display_list) const

Shows the display list state.

Parameters
out_display_listThe type of display lists, if any.
Returns
true if the setting is valid, false otherwise.
bool PerformanceControl::ShowStaticModel ( Performance::StaticModel out_model_type) const

Shows the static model state.

Parameters
out_model_typeThe type of static tree, if any
Returns
true if the setting is valid, false otherwise.
PerformanceControl& PerformanceControl::UnsetDisplayLists ( )

Removes the display list setting.

Returns
A reference to this object.
PerformanceControl& PerformanceControl::UnsetEverything ( )

Removes all settings from this object.

Returns
A reference to this object.
PerformanceControl& PerformanceControl::UnsetStaticModel ( )

Removes the static model state, releasing the compiled draw tree.

Returns
A reference to this object.

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