#include <hps.h>
Static Public Member Functions | |
static UpdateOptionsKit | GetDefault () |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
The HPS::UpdateOptionsKit class is a user space object. It contains options related to selection. Calling HPS::UpdateOptionsKit::GetDefault() will return a kit with values found in this table.
HPS::UpdateOptionsKit::UpdateOptionsKit | ( | ) |
The default constructor creates an empty UpdateOptionsKit object.
HPS::UpdateOptionsKit::UpdateOptionsKit | ( | UpdateOptionsKit const & | in_kit | ) |
The copy constructor creates a new UpdateOptionsKit object that contains the same settings as the source UpdateOptionsKit.
in_kit | The source UpdateOptionsKit to copy. |
HPS::UpdateOptionsKit::UpdateOptionsKit | ( | UpdateOptionsKit && | in_that | ) |
The move constructor creates a UpdateOptionsKit by transferring the underlying impl of the rvalue reference to this UpdateOptionsKit thereby avoiding a copy and allocation.
in_that | An rvalue reference to a UpdateOptionsKit to take the impl from. |
|
virtual |
Indicates whether this UpdateOptionsKit has any values set on it.
Reimplemented from HPS::Object.
bool HPS::UpdateOptionsKit::Equals | ( | UpdateOptionsKit const & | in_kit | ) | const |
Check if the source UpdateOptionsKit is equivalent to this UpdateOptionsKit.
in_kit | The source UpdateOptionsKit to compare to this UpdateOptionsKit. |
|
static |
Creates a UpdateOptionsKit 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.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from HPS::Object.
bool HPS::UpdateOptionsKit::operator!= | ( | UpdateOptionsKit const & | in_kit | ) | const |
Check if the source UpdateOptionsKit is not equivalent to this UpdateOptionsKit.
in_kit | The source UpdateOptionsKit to compare to this UpdateOptionsKit. |
UpdateOptionsKit& HPS::UpdateOptionsKit::operator= | ( | UpdateOptionsKit && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this UpdateOptionsKit thereby avoiding a copy.
in_that | An rvalue reference to a UpdateOptionsKit to take the impl from. |
UpdateOptionsKit& HPS::UpdateOptionsKit::operator= | ( | UpdateOptionsKit const & | in_kit | ) |
Copies the source UpdateOptionsKit into this UpdateOptionsKit.
in_kit | The source UpdateOptionsKit to copy. |
bool HPS::UpdateOptionsKit::operator== | ( | UpdateOptionsKit const & | in_kit | ) | const |
Check if the source UpdateOptionsKit is equivalent to this UpdateOptionsKit.
in_kit | The source UpdateOptionsKit to compare to this UpdateOptionsKit. |
void HPS::UpdateOptionsKit::Set | ( | UpdateOptionsKit const & | in_kit | ) |
Copies the source UpdateOptionsKit into this UpdateOptionsKit.
in_kit | The source UpdateOptionsKit to copy. |
UpdateOptionsKit& HPS::UpdateOptionsKit::SetTimeLimit | ( | HPS::Time | in_time_limit | ) |
Sets the time limit of this UpdateOptionsKit.
in_time_limit | The time limit for this UpdateOptionsKit update. |
UpdateOptionsKit& HPS::UpdateOptionsKit::SetUpdateControl | ( | HPS::Window::UpdateControl | in_control | ) |
Sets the type of update of this UpdateOptionsKit.
in_control | The type of update that this UpdateOptionsKit will perform. |
void HPS::UpdateOptionsKit::Show | ( | UpdateOptionsKit & | out_kit | ) | const |
Copies this UpdateOptionsKit into the given UpdateOptionsKit.
out_kit | The UpdateOptionsKit to populate with the contents of this UpdateOptionsKit. |
bool HPS::UpdateOptionsKit::ShowTimeLimit | ( | HPS::Time & | out_time_limit | ) | const |
Shows the time limit from this UpdateOptionsKit.
out_proximity | The selection proximity. |
bool HPS::UpdateOptionsKit::ShowUpdateControl | ( | HPS::Window::UpdateControl & | out_control | ) | const |
Shows the type of control from this UpdateOptionsKit.
out_proximity | The selection proximity. |
UpdateOptionsKit& HPS::UpdateOptionsKit::UnsetEverything | ( | ) |
Removes all settings from this UpdateOptionsKit.
UpdateOptionsKit& HPS::UpdateOptionsKit::UnsetTimeLimit | ( | ) |
Removes the time limit of this UpdateOptionsKit.
UpdateOptionsKit& HPS::UpdateOptionsKit::UnsetUpdateControl | ( | ) |
Removes the type of control for this UpdateOptionsKit.