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

override void Dispose ()

HPS.StandAloneWindowOptionsControl GetWindowOptionsControl ()

Gets a control that allows querying options specific to stand-alone windows.

Return: A control that allows querying options specific to stand-alone windows.

override HPS.Type ObjectType ()

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).

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

HPS.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.

Return: The status of the triggered update.

bool ShowWindowOptions (out HPS.StandAloneWindowOptionsKit out_kit)

Shows the stand-alone-window-specific options for this StandAloneWindowKey.

Param out_kit: The stand-alone-window-specific options for this StandAloneWindowKey.
Return: 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 (HPS.Key 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.

Param in_key: The source Key to copy.

StandAloneWindowKey (HPS.StandAloneWindowKey in_that)

The copy constructor creates a StandAloneWindowKey object that shares the underlying smart-pointer of the source StandAloneWindowKey.

Param in_that: The source StandAloneWindowKey to copy.