The HPS::PerformanceKit class is a user space object, useful for carrying a group of attribute settings related to performance settings. More...

#include <hps.h>

Inheritance diagram for HPS::PerformanceKit:

[legend]

Collaboration diagram for HPS::PerformanceKit:

[legend]

Public Member Functions
	PerformanceKit ()
	Initializes an empty kit. More...

	PerformanceKit (PerformanceKit const &in_kit)
	The copy constructor creates a new PerformanceKit object that contains the same settings as the source object. More...

	PerformanceKit (PerformanceKit &&in_that)
	The move constructor creates a PerformanceKit by transferring the underlying impl of the rvalue reference to this PerformanceKit thereby avoiding a copy and allocation. More...

PerformanceKit &	operator= (PerformanceKit &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this PerformanceKit thereby avoiding a copy. More...

virtual	~PerformanceKit ()
	Destroy this kit. More...

HPS::Type	ObjectType () const

void	Set (PerformanceKit const &in_kit)
	Copies the source PerformanceKit into this object. More...

void	Show (PerformanceKit &out_kit) const
	Copies this object into the given PerformanceKit. More...

PerformanceKit &	operator= (PerformanceKit const &in_kit)
	Copies the source PerformanceKit into this object. More...

bool	Empty () const
	Indicates whether this object has any values set on it. More...

bool	Equals (PerformanceKit const &in_kit) const
	Check if the source PerformanceKit is equivalent to this object. More...

bool	operator== (PerformanceKit const &in_kit) const
	Check if the source PerformanceKit is equivalent to this object. More...

bool	operator!= (PerformanceKit const &in_kit) const
	Check if the source PerformanceKit is not equivalent to this object. More...

PerformanceKit &	SetDisplayLists (Performance::DisplayLists in_display_list=Performance::DisplayLists::Segment)
	Sets the display list state. More...

PerformanceKit &	SetStaticModel (Performance::StaticModel in_model_type)
	Sets the static tree state. More...

PerformanceKit &	UnsetDisplayLists ()
	Removes the display list setting. More...

PerformanceKit &	UnsetStaticModel ()
	Removes the static model state, releasing the compiled draw tree. More...

PerformanceKit &	UnsetEverything ()
	Removes all settings from this object. More...

bool	ShowDisplayLists (Performance::DisplayLists &out_display_list) const
	Shows the display list state. More...

bool	ShowStaticModel (Performance::StaticModel &out_model_type) const
	Shows the static model state. More...

virtual HPS::Type	Type () const
	This function returns the true type of the underlying object. More...

virtual void	Reset ()
	Resets this object to its initial, uninitialized state. More...

bool	HasType (HPS::Type in_mask) const
	This function indicates whether this Object has the given Type mask. More...

intptr_t	GetClassID () const
	Returns a unique identifier that is shared by all objects of the same class. More...

intptr_t	GetInstanceID () const
	Returns an identifier that can be used to identify which instance of a class an object is. More...

Static Public Member Functions
static PerformanceKit	GetDefault ()
	Creates a PerformanceKit which contains the default settings. More...

template<typename T >
static intptr_t	ClassID ()
	Unique identifier for this class. More...

Static Public Attributes
static const HPS::Type	staticType = HPS::Type::PerformanceKit

Detailed Description

The HPS::PerformanceKit class is a user space object, useful for carrying a group of attribute settings related to performance settings.

Calling HPS::PerformanceKit::GetDefault() will return a kit with values found in this table.

Constructor & Destructor Documentation

◆ PerformanceKit() [1/3]

HPS::PerformanceKit::PerformanceKit ( )

Initializes an empty kit.

◆ PerformanceKit() [2/3]

HPS::PerformanceKit::PerformanceKit ( PerformanceKit const & in_kit )

The copy constructor creates a new PerformanceKit object that contains the same settings as the source object.

Parameters

in_kit The source object to copy.

◆ PerformanceKit() [3/3]

HPS::PerformanceKit::PerformanceKit ( PerformanceKit && in_that )

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

Parameters

in_that An rvalue reference to a PerformanceKit to take the impl from.

◆ ~PerformanceKit()

virtual HPS::PerformanceKit::~PerformanceKit ( )

virtual

Destroy this kit.

Member Function Documentation

◆ ClassID()

template<typename T >

static intptr_t HPS::Object::ClassID ( )

inlinestaticinherited

Unique identifier for this class.

Note: this method uses construction of static objects. If used in a constructor, it should be used in the body not the initializer list.

◆ Empty()

bool HPS::PerformanceKit::Empty ( ) const

virtual

Indicates whether this object has any values set on it.

Returns: true if no values are set on this object, false otherwise.

Reimplemented from HPS::Object.

◆ Equals()

bool HPS::PerformanceKit::Equals ( PerformanceKit const & in_kit ) const

Check if the source PerformanceKit is equivalent to this object.

Parameters

in_kit The source PerformanceKit to compare to this object.

Returns: true if the objects are equivalent, false otherwise.

◆ GetClassID()

intptr_t HPS::Object::GetClassID ( ) const

inherited

Returns a unique identifier that is shared by all objects of the same class.

Returns: A unique value shared by all objects of the same class.

◆ GetDefault()

static PerformanceKit HPS::PerformanceKit::GetDefault ( )

static

Creates a PerformanceKit which contains the default settings.

The returned object will not necessarily have values set for every option, but it will have settings for those options where it is reasonable to have a default.

Returns: A PerformanceKit with the default settings.

◆ GetInstanceID()

intptr_t HPS::Object::GetInstanceID ( ) const

inherited

Returns an identifier that can be used to identify which instance of a class an object is.

Different keys and controls will return the same value if they are backed by the same database resource.

Returns: A value unique to an instance of an object and all objects that are backed by the same database resource.

◆ HasType()

bool HPS::Object::HasType ( HPS::Type in_mask ) const

inherited

This function indicates whether this Object has the given Type mask.

Parameters

in_mask The Type mask to check against this Object.

Returns: true if this Object has the given Type mask, false otherwise.

◆ ObjectType()

HPS::Type HPS::PerformanceKit::ObjectType ( ) const

inlinevirtual

Reimplemented from HPS::Kit.

Here is the call graph for this function:

◆ operator!=()

bool HPS::PerformanceKit::operator!= ( PerformanceKit const & in_kit ) const

Check if the source PerformanceKit is not equivalent to this object.

Parameters

in_kit The source PerformanceKit to compare to this object.

Returns: true if the objects are not equivalent, false otherwise.

◆ operator=() [1/2]

PerformanceKit& HPS::PerformanceKit::operator= ( PerformanceKit && in_that )

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

Parameters

in_that An rvalue reference to a PerformanceKit to take the impl from.

Returns: A reference to this PerformanceKit.

◆ operator=() [2/2]

PerformanceKit& HPS::PerformanceKit::operator= ( PerformanceKit const & in_kit )

Copies the source PerformanceKit into this object.

Parameters

in_kit The source PerformanceKit to copy.

Returns: A reference to this object.

◆ operator==()

bool HPS::PerformanceKit::operator== ( PerformanceKit const & in_kit ) const

Check if the source PerformanceKit is equivalent to this object.

Parameters

in_kit The source PerformanceKit to compare to this object.

Returns: true if the objects are equivalent, false otherwise.

◆ Reset()

virtual void HPS::Object::Reset ( )

virtualinherited

Resets this object to its initial, uninitialized state.

Reimplemented in HPS::EventHandler, HPS::EventDispatcher, HPS::World, HPS::HighlightSearchResults, HPS::HighlightSearchResultsIterator, HPS::SelectionResults, HPS::SelectionResultsIterator, HPS::FontSearchResults, HPS::FontSearchResultsIterator, HPS::SearchResults, and HPS::SearchResultsIterator.

◆ Set()

void HPS::PerformanceKit::Set ( PerformanceKit const & in_kit )

Copies the source PerformanceKit into this object.

Parameters

in_kit The source object to copy.

◆ SetDisplayLists()

PerformanceKit& HPS::PerformanceKit::SetDisplayLists ( Performance::DisplayLists in_display_list = Performance::DisplayLists::Segment )

Sets the display list state.

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

Parameters

in_display_list The type of display lists, if any, that should be used.

Returns: A reference to this object.

◆ SetStaticModel()

PerformanceKit& HPS::PerformanceKit::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_type The type of static tree, if any, that should be used.

Returns: A reference to this object.

◆ Show()

void HPS::PerformanceKit::Show ( PerformanceKit & out_kit ) const

Copies this object into the given PerformanceKit.

Parameters

out_kit The PerformanceKit to populate with the contents of this object.

◆ ShowDisplayLists()

bool HPS::PerformanceKit::ShowDisplayLists ( Performance::DisplayLists & out_display_list ) const

Shows the display list state.

Parameters

out_display_list The type of display lists, if any.

Returns: true if the setting is valid, false otherwise.

◆ ShowStaticModel()

bool HPS::PerformanceKit::ShowStaticModel ( Performance::StaticModel & out_model_type ) const

Shows the static model state.

Parameters

out_model_type The type of static tree, if any

Returns: true if the setting is valid, false otherwise.

◆ Type()

virtual HPS::Type HPS::Kit::Type ( ) const

inlinevirtualinherited

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.

Returns: The true type of the object in question.

Reimplemented from HPS::Object.

◆ UnsetDisplayLists()

PerformanceKit& HPS::PerformanceKit::UnsetDisplayLists ( )

Removes the display list setting.

Returns: A reference to this object.

◆ UnsetEverything()

PerformanceKit& HPS::PerformanceKit::UnsetEverything ( )

Removes all settings from this object.

Returns: A reference to this object.

◆ UnsetStaticModel()

PerformanceKit& HPS::PerformanceKit::UnsetStaticModel ( )

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

Returns: A reference to this object.

Member Data Documentation

◆ staticType

const HPS::Type HPS::PerformanceKit::staticType = HPS::Type::PerformanceKit

static

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

hps.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PerformanceKit() [1/3]

◆ PerformanceKit() [2/3]

◆ PerformanceKit() [3/3]

◆ ~PerformanceKit()

Member Function Documentation

◆ ClassID()

◆ Empty()

◆ Equals()

◆ GetClassID()

◆ GetDefault()

◆ GetInstanceID()

◆ HasType()

◆ ObjectType()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ Reset()

◆ Set()

◆ SetDisplayLists()

◆ SetStaticModel()

◆ Show()

◆ ShowDisplayLists()

◆ ShowStaticModel()

◆ Type()

◆ UnsetDisplayLists()

◆ UnsetEverything()

◆ UnsetStaticModel()

Member Data Documentation

◆ staticType