StandAloneWindowKey
-
class HPS::StandAloneWindowKey : public HPS::WindowKey
The StandAloneWindowKey object is a handle to a stand-alone window that Visualize can draw into. Standalone windows are always directly created by Visualize. The Visualize rendering context will use the entire window for rendering. Standalone windows are only supported on Microsoft Windows and Linux platforms.
Public Functions
-
StandAloneWindowOptionsControl GetWindowOptionsControl()
Gets a control that allows querying options specific to stand-alone windows.
- Returns
A control that allows querying options specific to stand-alone windows.
-
StandAloneWindowOptionsControl const GetWindowOptionsControl() const
Gets a control that allows querying options specific to stand-alone windows.
- Returns
A control that allows querying options specific to stand-alone windows.
-
inline virtual HPS::Type ObjectType() const
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.
-
StandAloneWindowKey &operator=(StandAloneWindowKey &&in_that)
The move assignment operator transfers the underlying impl of the rvalue reference to this StandAloneWindowKey thereby avoiding a copy.
- Parameters
in_that – An rvalue reference to an StandAloneWindowKey to take the impl from.
- Returns
A reference to this StandAloneWindowKey.
-
Window::UpdateStatus Pause()
Triggers an update and puts the calling thread into a wait loop which will only be exited when a mouse, touch, or keyboard event occurs.
- Returns
The status of the triggered update.
-
bool ShowWindowOptions(StandAloneWindowOptionsKit &out_kit) const
Shows the stand-alone-window-specific options for this StandAloneWindowKey.
- Parameters
out_kit – The stand-alone-window-specific options for this StandAloneWindowKey.
- Returns
true if any options are set, false otherwise.
-
StandAloneWindowKey()
The default constructor creates an uninitialized StandAloneWindowKey object. The Type() function will return Type::None.
-
StandAloneWindowKey(Key const &in_key)
This constructor creates an StandAloneWindowKey object that shares the underlying smart-pointer of the source Key. The copy will only be successful if the source key is really an upcast of an application window. Otherwise the copy will fail and the resulting StandAloneWindowKey will be invalid.
- Parameters
in_key – The source Key to copy.
-
StandAloneWindowKey(StandAloneWindowKey &&in_that)
The move constructor creates a StandAloneWindowKey by transferring the underlying impl of the rvalue reference to this StandAloneWindowKey thereby avoiding a copy and allocation.
- Parameters
in_that – An rvalue reference to a StandAloneWindowKey to take the impl from.
-
StandAloneWindowKey(StandAloneWindowKey const &in_that)
The copy constructor creates a StandAloneWindowKey object that shares the underlying smart-pointer of the source StandAloneWindowKey.
- Parameters
in_that – The source StandAloneWindowKey to copy.
-
~StandAloneWindowKey()
Public Static Attributes
-
static const HPS::Type staticType = HPS::Type::StandAloneWindowKey
-
StandAloneWindowOptionsControl GetWindowOptionsControl()
