#include <hps.h>

Public Member Functions | |
bool | Empty () const |
bool | Equals (UpdateOptionsKit const &in_kit) const |
HPS::Type | ObjectType () const |
bool | operator!= (UpdateOptionsKit const &in_kit) const |
UpdateOptionsKit & | operator= (UpdateOptionsKit &&in_that) |
UpdateOptionsKit & | operator= (UpdateOptionsKit const &in_kit) |
bool | operator== (UpdateOptionsKit const &in_kit) const |
void | Set (UpdateOptionsKit const &in_kit) |
UpdateOptionsKit & | SetTimeLimit (HPS::Time in_time_limit) |
UpdateOptionsKit & | SetUpdateType (HPS::Window::UpdateType in_type) |
void | Show (UpdateOptionsKit &out_kit) const |
bool | ShowTimeLimit (HPS::Time &out_time_limit) const |
bool | ShowUpdateType (HPS::Window::UpdateType &out_type) const |
UpdateOptionsKit & | UnsetEverything () |
UpdateOptionsKit & | UnsetTimeLimit () |
UpdateOptionsKit & | UnsetUpdateType () |
UpdateOptionsKit () | |
UpdateOptionsKit (UpdateOptionsKit const &in_kit) | |
UpdateOptionsKit (UpdateOptionsKit &&in_that) | |
![]() | |
virtual HPS::Type | Type () const |
![]() | |
intptr_t | GetClassID () const |
intptr_t | GetInstanceID () const |
bool | HasType (HPS::Type in_mask) const |
Object (Object const &that) | |
Object (Object &&in_that) | |
Object & | operator= (Object const &other_object) |
Object & | operator= (Object &&in_that) |
virtual void | Reset () |
Static Public Member Functions | |
static UpdateOptionsKit | GetDefault () |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
Additional Inherited Members | |
![]() | |
Kit (Kit &&in_that) | |
Kit & | operator= (Kit &&in_that) |
Detailed Description
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.
Constructor & Destructor Documentation
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.
- Parameters
-
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.
- Parameters
-
in_that An rvalue reference to a UpdateOptionsKit to take the impl from.
Member Function Documentation
|
virtual |
Indicates whether this UpdateOptionsKit has any values set on it.
- Returns
- true if no values are set on this UpdateOptionsKit, false otherwise.
Reimplemented from HPS::Object.
bool HPS::UpdateOptionsKit::Equals | ( | UpdateOptionsKit const & | in_kit | ) | const |
Check if the source UpdateOptionsKit is equivalent to this UpdateOptionsKit.
- Parameters
-
in_kit The source UpdateOptionsKit to compare to this UpdateOptionsKit.
- Returns
- true if the objects are equivalent, false otherwise.
|
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.
- Returns
- A UpdateOptionsKit with the default settings.
|
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 HPS::Kit.
bool HPS::UpdateOptionsKit::operator!= | ( | UpdateOptionsKit const & | in_kit | ) | const |
Check if the source UpdateOptionsKit is not equivalent to this UpdateOptionsKit.
- Parameters
-
in_kit The source UpdateOptionsKit to compare to this UpdateOptionsKit.
- Returns
- true if the objects are not equivalent, false otherwise.
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.
- Parameters
-
in_that An rvalue reference to a UpdateOptionsKit to take the impl from.
- Returns
- A reference to this UpdateOptionsKit.
UpdateOptionsKit& HPS::UpdateOptionsKit::operator= | ( | UpdateOptionsKit const & | in_kit | ) |
Copies the source UpdateOptionsKit into this UpdateOptionsKit.
- Parameters
-
in_kit The source UpdateOptionsKit to copy.
- Returns
- A reference to this UpdateOptionsKit.
bool HPS::UpdateOptionsKit::operator== | ( | UpdateOptionsKit const & | in_kit | ) | const |
Check if the source UpdateOptionsKit is equivalent to this UpdateOptionsKit.
- Parameters
-
in_kit The source UpdateOptionsKit to compare to this UpdateOptionsKit.
- Returns
- true if the objects are equivalent, false otherwise.
void HPS::UpdateOptionsKit::Set | ( | UpdateOptionsKit const & | in_kit | ) |
Copies the source UpdateOptionsKit into this UpdateOptionsKit.
- Parameters
-
in_kit The source UpdateOptionsKit to copy.
UpdateOptionsKit& HPS::UpdateOptionsKit::SetTimeLimit | ( | HPS::Time | in_time_limit | ) |
Sets the time limit of this UpdateOptionsKit.
- Parameters
-
in_time_limit The time limit for this UpdateOptionsKit update.
- Returns
- A reference to this UpdateOptionsKit.
UpdateOptionsKit& HPS::UpdateOptionsKit::SetUpdateType | ( | HPS::Window::UpdateType | in_type | ) |
Sets the type of update of this UpdateOptionsKit.
- Parameters
-
in_type The type of update that this UpdateOptionsKit will perform.
- Returns
- A reference to this UpdateOptionsKit.
void HPS::UpdateOptionsKit::Show | ( | UpdateOptionsKit & | out_kit | ) | const |
Copies this UpdateOptionsKit into the given UpdateOptionsKit.
- Parameters
-
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.
- Parameters
-
out_proximity The selection proximity.
- Returns
- true if the time limit is valid, false otherwise.
bool HPS::UpdateOptionsKit::ShowUpdateType | ( | HPS::Window::UpdateType & | out_type | ) | const |
Shows the type of control from this UpdateOptionsKit.
- Parameters
-
out_type The type of update.
- Returns
- true if the type is valid, false otherwise.
UpdateOptionsKit& HPS::UpdateOptionsKit::UnsetEverything | ( | ) |
Removes all settings from this UpdateOptionsKit.
- Returns
- A reference to this UpdateOptionsKit.
UpdateOptionsKit& HPS::UpdateOptionsKit::UnsetTimeLimit | ( | ) |
Removes the time limit of this UpdateOptionsKit.
- Returns
- A reference to this UpdateOptionsKit.
UpdateOptionsKit& HPS::UpdateOptionsKit::UnsetUpdateType | ( | ) |
Removes the type of control for this UpdateOptionsKit.
- Returns
- A reference to this UpdateOptionsKit.
The documentation for this class was generated from the following file:
- include/hps.h