Public Member Functions | Protected Member Functions | List of all members
HPS.StandAloneWindowKey Class Reference

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

Inheritance diagram for HPS.StandAloneWindowKey:
HPS.WindowKey HPS.SegmentKey HPS.Key HPS.Object

Public Member Functions

override void Dispose ()
 
 StandAloneWindowKey ()
 The default constructor creates an uninitialized StandAloneWindowKey object. The Type() function will return Type::None. More...
 
 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. More...
 
 StandAloneWindowKey (HPS.StandAloneWindowKey in_that)
 The copy constructor creates a StandAloneWindowKey object that shares the underlying smart-pointer of the source StandAloneWindowKey. More...
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More...
 
HPS.StandAloneWindowOptionsControl GetWindowOptionsControl ()
 Gets a control that allows querying options specific to stand-alone windows. More...
 
bool ShowWindowOptions (out HPS.StandAloneWindowOptionsKit out_kit)
 Shows the stand-alone-window-specific options for this StandAloneWindowKey. More...
 
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. More...
 
- Public Member Functions inherited from HPS.WindowKey
override void Dispose ()
 
 WindowKey ()
 An uninitialized key refers to no database object and Type() will return Type::None. More...
 
 WindowKey (HPS.WindowKey in_window)
 Shares a reference to a database object referred to by in_window. More...
 
 WindowKey (HPS.Key in_key)
 Shares a reference to a database object referred to by in_that. If the key assignment is invalid, this key will revert to an uninitialized state. More...
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More...
 
bool ConvertCoordinate (HPS.Coordinate.Space in_space, HPS.Point in_point, HPS.Coordinate.Space in_output_space, out HPS.Point out_point)
 Converts the point in_point from in_space to in_output_space using the transforms associated with this window. Returns success. More...
 
ulong FindFonts (out HPS.FontSearchResults out_results)
 Searches the system for fonts. More...
 
HPS.WindowKey SetPostProcessEffects (HPS.PostProcessEffectsKit in_kit)
 Sets the post-process effects attributes designated by in_kit on this segment. More...
 
bool ShowPostProcessEffects (out HPS.PostProcessEffectsKit out_kit)
 Shows the post-process effects attribute settings on this segment. Returns false if no post-process effects attribute settings exist on this segment. More...
 
HPS.PostProcessEffectsControl GetPostProcessEffectsControl ()
 Returns a control that allows the user to manipulate and query details of the post-process effects attribute on this segment. More...
 
HPS.WindowKey SetDebugging (HPS.DebuggingKit in_kit)
 Sets the debugging attributes designated by in_kit on this segment. More...
 
HPS.WindowKey SetDriverEventHandler (HPS.DriverEventHandler in_handler, IntPtr in_type)
 Sets the specified driver event handler as the handler for the specified driver event type on this window. More...
 
HPS.WindowKey UnsetDriverEventHandler (IntPtr in_type)
 Unsets the driver event handler for the specified driver event type on this window. More...
 
bool ShowDebugging (out HPS.DebuggingKit out_kit)
 Shows the debugging attribute settings on this segment. More...
 
HPS.DebuggingControl GetDebuggingControl ()
 Returns a control that allows the user to manipulate and query details of the debugging attribute on this segment. More...
 
HPS.WindowInfoControl GetWindowInfoControl ()
 Returns a control that allows the user to query various window properties, including size, aspect ratio, resolution, etc. More...
 
bool ShowWindowInfo (out HPS.WindowInfoKit out_kit)
 
HPS.WindowKey SetSelectionOptions (HPS.SelectionOptionsKit in_kit)
 Sets the options that will be used by default for selections performed from this window. Note: these options cannot be unset. More...
 
bool ShowSelectionOptions (out HPS.SelectionOptionsKit out_kit)
 Shows the options that will be used by default for selections performed from this window. More...
 
HPS.WindowKey SetUpdateOptions (HPS.UpdateOptionsKit in_kit)
 Sets the options that will be used by default for update options performed from this window. Note: these options cannot be unset. More...
 
bool ShowUpdateOptions (out HPS.UpdateOptionsKit out_kit)
 Shows the options that will be used by default for update options performed from this window. More...
 
HPS.SelectionOptionsControl GetSelectionOptionsControl ()
 Returns a control that allows the user to manipulate and query details of the selection options on this window. More...
 
HPS.SelectionControl GetSelectionControl ()
 Returns a control that allows the user to perform selections in this window. More...
 
HPS.HighlightControl GetHighlightControl ()
 Returns a control that allows the user to highlight segments or geometry in this window. More...
 
HPS.UpdateOptionsControl GetUpdateOptionsControl ()
 Returns a control that allows the user to change update options in this window. More...
 
void Update ()
 Performs a default update in this window, redrawing and refreshing the display. More...
 
void Update (HPS.UpdateOptionsKit in_kit)
 Performs an update in this window, redrawing and refreshing the display using the options in the UpdateOptionsKit. More...
 
void Update (HPS.Window.UpdateControl in_control, double in_time_limit)
 Performs an update in this window within the specified amount of time, redrawing and refreshing the display based on the Window::UpdateControl value. Key behavioral notes regarding a timed-update: More...
 
void Update (HPS.Window.UpdateControl in_control)
 Performs an update in this window within the specified amount of time, redrawing and refreshing the display based on the Window::UpdateControl value. Key behavioral notes regarding a timed-update: More...
 
HPS.UpdateNotifier UpdateWithNotifier ()
 Performs a default update in this window, redrawing and refreshing the display. More...
 
HPS.UpdateNotifier UpdateWithNotifier (HPS.UpdateOptionsKit in_kit)
 Performs a default update in this window, redrawing and refreshing the display. More...
 
HPS.UpdateNotifier UpdateWithNotifier (HPS.Window.UpdateControl in_control, double in_time_limit)
 Performs an update in this window, redrawing and refreshing the display. More...
 
HPS.UpdateNotifier UpdateWithNotifier (HPS.Window.UpdateControl in_control)
 Performs an update in this window, redrawing and refreshing the display. More...
 
HPS.EventDispatcher GetEventDispatcher ()
 Returns a control that allows the user to interact with events in various ways. More...
 
bool ShowSnapshot (out HPS.ImageKit out_kit)
 Shows the current display as an image. Note: this will return false if an Update was never made. More...
 
- Public Member Functions inherited from HPS.SegmentKey
 SegmentKey ()
 An uninitialized key refers to no database object and Type() will return Type::None. More...
 
 SegmentKey (HPS.SegmentKey in_that)
 Shares a reference to a database object referred to by in_that. More...
 
 SegmentKey (HPS.Key in_that)
 Shares a reference to a database object referred to by in_that. More...
 
string Name ()
 Returns the name given to this segment when it was created. More...
 
HPS.SegmentKey SetName (string in_name)
 Sets the new name of this segment. More...
 
HPS.SegmentKey Down (string in_segment_name, bool in_create_if_not_present)
 Returns the segment contained by this key with name of in_segment_name. If the segment does not exist and the flag in_create_if_not_present is not set, the key returned will be uninitialized. More...
 
HPS.SegmentKey Down (string in_segment_name)
 Returns the segment contained by this key with name of in_segment_name. If the segment does not exist and the flag in_create_if_not_present is not set, the key returned will be uninitialized. More...
 
HPS.SegmentKey Subsegment (string in_segment_name, bool in_create_if_not_present)
 Returns the segment contained by this key with name of in_segment_name. The segment will be created automatically if it does not exist. To prevent automatic segment creation, pass a value of false for in_create_not_present. More...
 
HPS.SegmentKey Subsegment (string in_segment_name)
 Returns the segment contained by this key with name of in_segment_name. The segment will be created automatically if it does not exist. To prevent automatic segment creation, pass a value of false for in_create_not_present. More...
 
HPS.SegmentKey Subsegment ()
 Returns the segment contained by this key with name of in_segment_name. The segment will be created automatically if it does not exist. To prevent automatic segment creation, pass a value of false for in_create_not_present. More...
 
void Flush (HPS.Search.Type in_type_to_remove, HPS.Search.Space in_search_space)
 Searches in_search_space for in_type_to_remove and deletes all instances from the segment(s). More...
 
void Flush (HPS.Search.Type in_type_to_remove)
 Searches in_search_space for in_type_to_remove and deletes all instances from the segment(s). More...
 
void Flush ()
 Searches in_search_space for in_type_to_remove and deletes all instances from the segment(s). More...
 
void Flush (HPS.Search.Type[] in_types_to_remove, HPS.Search.Space in_search_space)
 Searches in_search_space for in_types_to_remove and deletes all instances from the segment(s). More...
 
void Flush (HPS.Search.Type[] in_types_to_remove)
 Searches in_search_space for in_types_to_remove and deletes all instances from the segment(s). More...
 
ulong Find (HPS.Search.Type in_request, HPS.Search.Space in_search_space, out HPS.SearchResults out_results)
 Searches in_search_space for in_request and returns a handle to the results. More...
 
ulong Find (HPS.Search.Type[] in_requests, HPS.Search.Space in_search_space, out HPS.SearchResults out_results)
 Searches in_search_space for in_request and returns a handle to the results. More...
 
ulong Find (HPS.SearchOptionsKit in_options, out HPS.SearchResults out_results)
 Searches starting at this segment using in_options and writes found objects into out_results, returns count. More...
 
ulong Find (HPS.SearchOptionsKit in_options)
 Searches starting at this segment using in_options, returns count. More...
 
HPS.IncludeKey IncludeSegment (HPS.SegmentKey in_seg)
 Creates a link between this segment and in_seg, returns a handle to the include itself. Included segments are treated like child segments for most operations including drawing. More...
 
HPS.IncludeKey IncludeSegment (HPS.SegmentKey in_seg, HPS.Condition in_condition)
 Creates a link between this segment and in_seg, returns a handle to the include itself. The link will only be applied if the condition is set in the draw path. Included segments are treated like child segments for most operations including drawing. More...
 
HPS.ReferenceKey ReferenceGeometry (HPS.Key in_key)
 References either a geometry key or a segment key in this segment. If the provided key is a geometry key, that geometry will be drawn as though it was in this segment. If the provided key is a segment key, all geometry in that segment will be drawn as though they were in this segment, however no attributes, subsegments or geometry in subsegments will be brought along (though attributes set directly on geometry within the segment will be preserved). More...
 
HPS.ReferenceKey ReferenceGeometry (HPS.Key in_key, HPS.Condition in_condition)
 Conditionally references either a geometry key or a segment key in this segment. If the provided key is a geometry key, that geometry will be drawn as though it was in this segment. If the provided key is a segment key, all geometry in that segment will be drawn as though they were in this segment, however no attributes, subsegments or geometry in subsegments will be brought along (though attributes set directly on geometry within the segment will be preserved). The referenced geometry will only get drawn in this segment if a condition is set above the geometry reference satisfying the provided condition. More...
 
ulong ShowSubsegments ()
 
Returns
A count of all child segments of this segment

 
ulong ShowSubsegments (out HPS.SegmentKey[] out_children)
 
Returns
A count of all child segments of this segment and populates out_children with keys to them.

 
ulong ShowReferrers (out HPS.SegmentKey[] out_segments)
 Shows the all the segments which contain references to this key. Note that while a segment may only appear once in the returned array, that segment could have multiple references to this key. More...
 
ulong ShowReferrers (out HPS.ReferenceKey[] out_references)
 Shows the all the references to this key. More...
 
ulong ShowStylers (out HPS.SegmentKey[] out_segments)
 Shows the all the segments which are styled by this key. Note that while a segment may only appear once in the returned array, that segment could have multiple styles which refer to this key. More...
 
ulong ShowStylers (out HPS.StyleKey[] out_styles)
 Shows the all the styles which refer to this key. More...
 
ulong ShowIncluders (out HPS.SegmentKey[] out_segments)
 Shows the all the segments which contain includes of this key. More...
 
ulong ShowIncluders (out HPS.IncludeKey[] out_includes)
 Shows the all the includes of this key. More...
 
HPS.StyleControl GetStyleControl ()
 
Returns
A control that allows the user to manipulate and query details of styles on this segment.

 
HPS.PortfolioControl GetPortfolioControl ()
 
Returns
A control that allows the user to manipulate and query portfolios in use on this segment.

 
HPS.SegmentKey SetCondition (string in_condition)
 Sets in_condition as the only condition on this segment, replacing any existing conditions. More...
 
HPS.SegmentKey SetConditions (string[] in_conditions)
 Sets in_conditions as the only conditions on this segment, replacing any existing conditions. More...
 
HPS.SegmentKey UnsetConditions ()
 Unsets all conditions on this segment. More...
 
bool ShowConditions (out string[] out_conditions)
 Shows all conditions on this segment. More...
 
HPS.ConditionControl GetConditionControl ()
 
Returns
A control that allows the user to manipulate and query details of conditions on this segment.

 
HPS.SegmentKey SetMaterialPalette (string in_name)
 Applies the material palette associated with in_name to this segment, replacing any existing material palette. More...
 
HPS.SegmentKey UnsetMaterialPalette ()
 Removes the existing material palette, if any, that is active on this segment. More...
 
bool ShowMaterialPalette (out string out_name)
 Shows the existing material palette, if any, that is active on this segment. More...
 
HPS.SegmentKey SetPriority (int in_priority)
 Assigns a specific drawing priority value to this segment. It affects the order in which the segment is visited if and only if the rendering algorithm is set to Priority. Segments have a default drawing priority assigned, based on the order that they were created. More...
 
HPS.SegmentKey UnsetPriority ()
 Removes the drawing priority setting. More...
 
bool ShowPriority (out int out_priority)
 Shows the drawing priority. More...
 
HPS.SegmentKey SetUserData (IntPtr[] in_indices, byte[][] in_data)
 Sets user data on this key. More...
 
HPS.SegmentKey SetUserData (IntPtr in_index, ulong in_bytes, byte[] in_data)
 Sets user data on this key. More...
 
HPS.SegmentKey SetUserData (IntPtr in_index, byte[] in_data)
 Sets user data on this key. More...
 
HPS.SegmentKey UnsetUserData (IntPtr in_index)
 Removes the user data at the given index from this key. More...
 
HPS.SegmentKey UnsetUserData (IntPtr[] in_indices)
 Removes the user data at the given indices from this key. More...
 
HPS.SegmentKey UnsetAllUserData ()
 Removes all user data from this key. More...
 
ulong ShowUserDataCount ()
 Get the number of user data indices set on this key. More...
 
bool ShowUserData (out IntPtr[] out_indices, out byte[][] out_data)
 Shows all user data for this key. More...
 
bool ShowUserData (IntPtr in_index, out byte[] out_data)
 Shows the user data at a given index for this key. More...
 
bool ShowUserDataIndices (out IntPtr[] out_indices)
 Shows the indices of all user data set on this key. More...
 
HPS.LineKey InsertLine (HPS.LineKit in_kit)
 Creates a new line geometry in this segment and returns a key to it. More...
 
HPS.LineKey InsertLine (HPS.Point[] in_pts)
 Creates a new line geometry in this segment and returns a key to it. More...
 
HPS.LineKey InsertLine (HPS.Point pt1, HPS.Point pt2)
 Creates a new line geometry in this segment and returns a key to it. More...
 
HPS.CylinderKey InsertCylinder (HPS.CylinderKit in_kit)
 Creates a new cylinder geometry in this segment and returns a key to it. More...
 
HPS.CylinderKey InsertCylinder (HPS.Point[] in_points, float[] in_radii, HPS.Cylinder.Capping in_caps)
 Creates a new cylinder geometry in this segment and returns a key to it. More...
 
HPS.CylinderKey InsertCylinder (HPS.Point[] in_points, float[] in_radii)
 Creates a new cylinder geometry in this segment and returns a key to it. More...
 
HPS.CylinderKey InsertCylinder (HPS.Point in_point1, HPS.Point in_point2, float in_radius, HPS.Cylinder.Capping in_caps)
 Creates a new cylinder geometry in this segment and returns a key to it. More...
 
HPS.CylinderKey InsertCylinder (HPS.Point in_point1, HPS.Point in_point2, float in_radius)
 Creates a new cylinder geometry in this segment and returns a key to it. More...
 
HPS.SphereKey InsertSphere (HPS.SphereKit in_kit)
 Creates a new sphere geometry in this segment and returns a key to it. More...
 
HPS.SphereKey InsertSphere (HPS.Point in_center, float in_radius, HPS.Vector in_axis, HPS.Vector in_prime_meridian)
 Creates a new sphere geometry in this segment and returns a key to it. More...
 
HPS.SphereKey InsertSphere (HPS.Point in_center, float in_radius, HPS.Vector in_axis)
 Creates a new sphere geometry in this segment and returns a key to it. More...
 
HPS.SphereKey InsertSphere (HPS.Point in_center, float in_radius)
 Creates a new sphere geometry in this segment and returns a key to it. More...
 
HPS.CircleKey InsertCircle (HPS.CircleKit in_kit)
 Creates a new circle geometry in this segment and returns a key to it. More...
 
HPS.CircleKey InsertCircle (HPS.Point in_start, HPS.Point in_middle, HPS.Point in_end)
 Creates a new circle geometry in this segment and returns a key to it. More...
 
HPS.CircleKey InsertCircle (HPS.Point in_center, float in_radius, HPS.Vector in_normal)
 Creates a new circle geometry in this segment and returns a key to it. More...
 
HPS.CircularArcKey InsertCircularArc (HPS.CircularArcKit in_kit)
 Creates a new circular arc geometry in this segment and returns a key to it. More...
 
HPS.CircularArcKey InsertCircularArc (HPS.Point in_start, HPS.Point in_middle, HPS.Point in_end)
 Creates a new circular arc geometry in this segment and returns a key to it. More...
 
HPS.CircularWedgeKey InsertCircularWedge (HPS.CircularWedgeKit in_kit)
 Creates a new circular wedge geometry in this segment and returns a key to it. More...
 
HPS.CircularWedgeKey InsertCircularWedge (HPS.Point in_start, HPS.Point in_middle, HPS.Point in_end)
 Creates a new circular wedge geometry in this segment and returns a key to it. More...
 
HPS.EllipseKey InsertEllipse (HPS.EllipseKit in_kit)
 Creates a new ellipse geometry in this segment and returns a key to it. More...
 
HPS.EllipseKey InsertEllipse (HPS.Point in_center, HPS.Point in_major, HPS.Point in_minor)
 Creates a new ellipse geometry in this segment and returns a key to it. More...
 
HPS.EllipticalArcKey InsertEllipticalArc (HPS.EllipticalArcKit in_kit)
 Creates a new elliptical arc geometry in this segment and returns a key to it. More...
 
HPS.EllipticalArcKey InsertEllipticalArc (HPS.Point in_center, HPS.Point in_major, HPS.Point in_minor, float start, float end)
 Creates a new elliptical arc geometry in this segment and returns a key to it. More...
 
HPS.PolygonKey InsertPolygon (HPS.PolygonKit in_kit)
 Creates a new polygon geometry in this segment and returns a key to it. More...
 
HPS.PolygonKey InsertPolygon (HPS.Point[] in_points)
 Creates a new polygon geometry in this segment and returns a key to it. More...
 
HPS.ShellKey InsertShell (HPS.ShellKit in_kit)
 Creates a new shell geometry in this segment and returns a key to it. More...
 
HPS.ShellKey InsertShell (HPS.Point[] in_points, int[] in_facelist)
 Creates a new shell geometry in this segment and returns a key to it. More...
 
HPS.ShellKey InsertShellByTristrips (HPS.Point[] in_points, int[] in_tristrips)
 Creates a new shell geometry in this segment and returns a key to it. More...
 
HPS.MeshKey InsertMesh (HPS.MeshKit in_kit)
 Creates a new mesh geometry in this segment and returns a key to it. More...
 
HPS.MeshKey InsertMesh (ulong in_rows, ulong in_columns, HPS.Point[] in_points)
 Creates a new mesh geometry in this segment and returns a key to it. More...
 
HPS.MarkerKey InsertMarker (HPS.Point in_position)
 Creates a new marker geometry in this segment and returns a key to it. More...
 
HPS.MarkerKey InsertMarker (HPS.MarkerKit in_kit)
 Creates a new marker geometry in this segment and returns a key to it. More...
 
HPS.DistantLightKey InsertDistantLight (HPS.Vector in_direction)
 Creates a new distant light geometry in this segment and returns a key to it. More...
 
HPS.DistantLightKey InsertDistantLight (HPS.DistantLightKit in_kit)
 Creates a new distant light geometry in this segment and returns a key to it. More...
 
HPS.CuttingSectionKey InsertCuttingSection (HPS.Plane in_plane)
 Creates a new cutting section in this segment and returns a key to it. More...
 
HPS.CuttingSectionKey InsertCuttingSection (HPS.CuttingSectionKit in_kit)
 Creates a new cutting section in this segment and returns a key to it. More...
 
HPS.CuttingSectionKey InsertCuttingSection (HPS.Plane[] in_planes)
 Creates a new cutting section in this segment and returns a key to it. More...
 
HPS.InfiniteLineKey InsertInfiniteLine (HPS.InfiniteLineKit in_kit)
 Creates a new infinite line geometry in this segment and returns a key to it. More...
 
HPS.InfiniteLineKey InsertInfiniteLine (HPS.Point in_first, HPS.Point in_second, HPS.InfiniteLine.Type in_type)
 Creates a new infinite line geometry in this segment and returns a key to it. More...
 
HPS.SpotlightKey InsertSpotlight (HPS.Point in_position, HPS.Point in_target)
 Creates a new spot light geometry in this segment and returns a key to it. More...
 
HPS.SpotlightKey InsertSpotlight (HPS.SpotlightKit in_kit)
 Creates a new spot light geometry in this segment and returns a key to it. More...
 
HPS.NURBSCurveKey InsertNURBSCurve (HPS.NURBSCurveKit in_kit)
 Creates a new NURBS curve geometry in this segment and returns a key to it. More...
 
HPS.NURBSCurveKey InsertNURBSCurve (ulong in_degree, HPS.Point[] in_points, float[] in_weights, float[] in_knots, float in_start_u, float in_end_u)
 Creates a new NURBS curve geometry in this segment and returns a key to it. More...
 
HPS.NURBSSurfaceKey InsertNURBSSurface (HPS.NURBSSurfaceKit in_kit)
 Creates a new NURBS surface geometry in this segment and returns a key to it. More...
 
HPS.NURBSSurfaceKey InsertNURBSSurface (ulong in_udegree, ulong in_vdegree, ulong in_ucount, ulong in_vcount, HPS.Point[] in_points, float[] in_weights, float[] in_uknots, float[] in_vknots)
 Creates a new NURBS surface geometry in this segment and returns a key to it. More...
 
HPS.NURBSSurfaceKey InsertNURBSSurface (ulong in_udegree, ulong in_vdegree, ulong in_ucount, ulong in_vcount, HPS.Point[] in_points, float[] in_weights, float[] in_uknots, float[] in_vknots, HPS.TrimKit[] in_trims)
 Creates a new NURBS surface geometry in this segment and returns a key to it. More...
 
HPS.TextKey InsertText (HPS.TextKit in_kit)
 Creates a new text geometry in this segment and returns a key to it. More...
 
HPS.TextKey InsertText (HPS.Point in_position, string in_text)
 Creates a new text geometry in this segment and returns a key to it. More...
 
HPS.GridKey InsertGrid (HPS.GridKit in_kit)
 Creates a new grid in this segment and returns a key to it. More...
 
HPS.GridKey InsertGrid (HPS.Point in_origin, HPS.Point in_first_point, HPS.Point in_second_point, int in_first_count, int in_second_count, HPS.Grid.Type in_type)
 Creates a new grid in this segment and returns a key to it. More...
 
HPS.GridKey InsertGrid (HPS.Point in_origin, HPS.Point in_first_point, HPS.Point in_second_point, int in_first_count, int in_second_count)
 Creates a new grid in this segment and returns a key to it. More...
 
HPS.GridKey InsertGrid (HPS.Point in_origin, HPS.Point in_first_point, HPS.Point in_second_point, int in_first_count)
 Creates a new grid in this segment and returns a key to it. More...
 
HPS.GridKey InsertGrid (HPS.Point in_origin, HPS.Point in_first_point, HPS.Point in_second_point)
 Creates a new grid in this segment and returns a key to it. More...
 
HPS.GridKey InsertGrid (HPS.Point in_origin, HPS.Point in_first_point)
 Creates a new grid in this segment and returns a key to it. More...
 
HPS.GridKey InsertGrid (HPS.Point in_origin)
 Creates a new grid in this segment and returns a key to it. More...
 
HPS.LineKey InsertLineFromGeometry (HPS.CircleKey in_circle, float in_deviation)
 Creates a new line geometry in this segment which approximates the given circle and returns a key to it. More...
 
HPS.LineKey InsertLineFromGeometry (HPS.CircleKey in_circle)
 Creates a new line geometry in this segment which approximates the given circle and returns a key to it. More...
 
HPS.LineKey InsertLineFromGeometry (HPS.CircularArcKey in_circular_arc, float in_deviation)
 Creates a new line geometry in this segment which approximates the given circular arc and returns a key to it. More...
 
HPS.LineKey InsertLineFromGeometry (HPS.CircularArcKey in_circular_arc)
 Creates a new line geometry in this segment which approximates the given circular arc and returns a key to it. More...
 
HPS.LineKey InsertLineFromGeometry (HPS.CircularWedgeKey in_circular_wedge, float in_deviation)
 Creates a new line geometry in this segment which approximates the given circular wedge and returns a key to it. More...
 
HPS.LineKey InsertLineFromGeometry (HPS.CircularWedgeKey in_circular_wedge)
 Creates a new line geometry in this segment which approximates the given circular wedge and returns a key to it. More...
 
HPS.LineKey InsertLineFromGeometry (HPS.EllipseKey in_ellipse, float in_deviation)
 Creates a new line geometry in this segment which approximates the given ellipse and returns a key to it. More...
 
HPS.LineKey InsertLineFromGeometry (HPS.EllipseKey in_ellipse)
 Creates a new line geometry in this segment which approximates the given ellipse and returns a key to it. More...
 
HPS.LineKey InsertLineFromGeometry (HPS.EllipticalArcKey in_elliptical_arc, float in_deviation)
 Creates a new line geometry in this segment which approximates the given elliptical arc and returns a key to it. More...
 
HPS.LineKey InsertLineFromGeometry (HPS.EllipticalArcKey in_elliptical_arc)
 Creates a new line geometry in this segment which approximates the given elliptical arc and returns a key to it. More...
 
HPS.LineKey InsertLineFromGeometry (HPS.NURBSCurveKey in_nurbs_curve, float in_deviation)
 Creates a new line geometry in this segment which approximates the given NURBS curve and returns a key to it. More...
 
HPS.LineKey InsertLineFromGeometry (HPS.NURBSCurveKey in_nurbs_curve)
 Creates a new line geometry in this segment which approximates the given NURBS curve and returns a key to it. More...
 
HPS.ShellKey InsertShellFromGeometry (HPS.SphereKey in_sphere)
 Creates a new shell geometry in this segment which approximates the given sphere and returns a key to it. More...
 
HPS.ShellKey InsertShellFromGeometry (HPS.CylinderKey in_cylinder)
 Creates a new shell geometry in this segment which approximates the given cylinder and returns a key to it. More...
 
HPS.ShellKey InsertShellFromGeometry (HPS.NURBSSurfaceKey in_nurbs_surface)
 Creates a new shell geometry in this segment which approximates the given NURBS surface and returns a key to it. More...
 
HPS.ShellKey InsertShellFromGeometry (HPS.MeshKey in_mesh)
 Creates a new shell geometry in this segment which approximates the given mesh and returns a key to it. More...
 
HPS.ShellKey InsertShellFromGeometry (HPS.PolygonKey in_polygon)
 Creates a new shell geometry in this segment which approximates the given polygon and returns a key to it. More...
 
HPS.ShellKey InsertShellFromGeometry (HPS.TextKey in_text)
 Creates a new shell geometry in this segment which approximates the given text and returns a key to it. The text must be inserted into the window segment in order for this call to succeed. More...
 
HPS.SegmentKey SetAttributeLocks (HPS.AttributeLockKit in_kit)
 Sets the attribute locks designated by in_kit on this segment. More...
 
HPS.SegmentKey UnsetAttributeLocks ()
 Removes all attribute locks settings from this segment. More...
 
bool ShowAttributeLocks (out HPS.AttributeLockKit out_kit)
 Shows the attribute locks settings on this segment. More...
 
HPS.AttributeLockControl GetAttributeLockControl ()
 Returns a control that allows the user to manipulate and query details of the attribute locks on this segment. More...
 
HPS.SegmentKey SetBoundings (HPS.BoundingKit in_kit)
 Sets the bounding designated by in_kit on this segment. More...
 
HPS.SegmentKey UnsetBoundings ()
 Removes all bounding settings from this segment. More...
 
bool ShowBoundings (out HPS.BoundingKit out_kit)
 Shows the bounding or bounding settings on this segment. More...
 
HPS.BoundingControl GetBoundingControl ()
 Returns a control that allows the user to manipulate and query details of the bounding control on this segment. More...
 
HPS.SegmentKey SetCamera (HPS.CameraKit in_kit)
 Sets the camera attribute designated by in_kit on this segment. More...
 
HPS.SegmentKey UnsetCamera ()
 Removes any camera set on this segment. More...
 
bool ShowCamera (out HPS.CameraKit out_kit)
 Shows the camera attribute settings on this segment. Returns false if no camera is set on this segment. More...
 
HPS.CameraControl GetCameraControl ()
 
Returns
A control that allows the user to manipulate and query details of the camera attribute on this segment.

 
HPS.SegmentKey SetColorInterpolation (HPS.ColorInterpolationKit in_kit)
 Sets the color interpolation attributes designated by in_kit on this segment. More...
 
HPS.SegmentKey UnsetColorInterpolation ()
 Removes any color interpolation attributes set on this segment. More...
 
bool ShowColorInterpolation (out HPS.ColorInterpolationKit out_kit)
 Shows the color interpolation attribute settings on this segment. Returns false if no color interpolation attribute settings exist on this segment. More...
 
HPS.ColorInterpolationControl GetColorInterpolationControl ()
 
Returns
A control that allows the user to manipulate and query details of the color interpolation attributes on this segment.

 
HPS.SegmentKey SetContourLine (HPS.ContourLineKit in_kit)
 Sets the contour line attributes designated by in_kit on this segment. More...
 
HPS.SegmentKey UnsetContourLine ()
 Removes any contour line attributes set on this segment. More...
 
bool ShowContourLine (out HPS.ContourLineKit out_kit)
 Shows the contour line attribute settings on this segment. Returns false if no contour line attribute settings exist on this segment. More...
 
HPS.ContourLineControl GetContourLineControl ()
 
Returns
A control that allows the user to manipulate and query details of the contour line attributes on this segment.

 
HPS.SegmentKey SetCulling (HPS.CullingKit in_kit)
 Sets the culling attributes designated by in_kit on this segment. More...
 
HPS.SegmentKey UnsetCulling ()
 Removes all culling attribute settings from this segment. More...
 
bool ShowCulling (out HPS.CullingKit out_kit)
 Shows the culling attribute settings on this segment. More...
 
HPS.CullingControl GetCullingControl ()
 Returns a control that allows the user to manipulate and query details of the culling attribute on this segment. More...
 
HPS.SegmentKey SetCurveAttributes (HPS.CurveAttributeKit in_kit)
 Sets the curve attributes designated by in_kit on this segment. More...
 
HPS.SegmentKey UnsetCurveAttributes ()
 Removes all curve attribute settings from this segment. More...
 
bool ShowCurveAttributes (out HPS.CurveAttributeKit out_kit)
 Shows the curve attribute settings on this segment. Returns false if no curve attribute settings exist on this segment. More...
 
HPS.CurveAttributeControl GetCurveAttributeControl ()
 Returns a control that allows the user to manipulate and query details of the curve attribute on this segment. More...
 
HPS.SegmentKey SetCuttingSectionAttributes (HPS.CuttingSectionAttributeKit in_kit)
 Sets the cutting section attributes designated by in_kit on this segment. More...
 
HPS.SegmentKey UnsetCuttingSectionAttributes ()
 Removes all cutting section attribute settings from this segment. More...
 
bool ShowCuttingSectionAttributes (out HPS.CuttingSectionAttributeKit out_kit)
 Shows the cutting section attribute settings on this segment. Returns false if no cutting section attribute settings exist on this segment. More...
 
HPS.CuttingSectionAttributeControl GetCuttingSectionAttributeControl ()
 Returns a control that allows the user to manipulate and query details of the cutting section attributes on this segment. More...
 
HPS.SegmentKey SetCylinderAttributes (HPS.CylinderAttributeKit in_kit)
 Sets the cylinder attributes designated by in_kit on this segment. More...
 
HPS.SegmentKey UnsetCylinderAttributes ()
 Removes all cylinder attribute settings from this segment. More...
 
bool ShowCylinderAttributes (out HPS.CylinderAttributeKit out_kit)
 Shows the cylinder attribute settings on this segment. Returns false if no cylinder attribute settings exist on this segment. More...
 
HPS.CylinderAttributeControl GetCylinderAttributeControl ()
 Returns a control that allows the user to manipulate and query details of the cylinder attribute on this segment. More...
 
HPS.SegmentKey SetDrawingAttribute (HPS.DrawingAttributeKit in_kit)
 Sets the drawing attributes designated by in_kit on this segment. More...
 
HPS.SegmentKey UnsetDrawingAttribute ()
 Removes all drawing settings from this segment. More...
 
bool ShowDrawingAttribute (out HPS.DrawingAttributeKit out_kit)
 Shows the drawing attribute settings on this segment. Returns false if no drawing settings exist on this segment. More...
 
HPS.DrawingAttributeControl GetDrawingAttributeControl ()
 Returns a control that allows the user to manipulate and query details of the drawing attribute on this segment. More...
 
HPS.SegmentKey SetEdgeAttributes (HPS.EdgeAttributeKit in_kit)
 Sets the edge attributes designated by in_kit on this segment. More...
 
HPS.SegmentKey UnsetEdgeAttributes ()
 Removes all edge attribute settings from this segment. More...
 
bool ShowEdgeAttributes (out HPS.EdgeAttributeKit out_kit)
 Shows the edge attribute settings on this segment. Returns false if no edge attribute settings exist on this segment. More...
 
HPS.EdgeAttributeControl GetEdgeAttributeControl ()
 Returns a control that allows the user to manipulate and query details of the edge attribute on this segment. More...
 
HPS.SegmentKey SetHiddenLineAttribute (HPS.HiddenLineAttributeKit in_kit)
 Sets the hidden line attributes designated by in_kit on this segment. More...
 
HPS.SegmentKey UnsetHiddenLineAttribute ()
 Removes all hidden line settings from this segment. More...
 
bool ShowHiddenLineAttribute (out HPS.HiddenLineAttributeKit out_kit)
 Shows the hidden line attribute settings on this segment. Returns false if no hidden line settings exist on this segment. More...
 
HPS.HiddenLineAttributeControl GetHiddenLineAttributeControl ()
 Returns a control that allows the user to manipulate and query details of the hidden line attribute on this segment. More...
 
HPS.SegmentKey SetLightingAttributes (HPS.LightingAttributeKit in_kit)
 Sets the lighting attributes designated by in_kit on this segment. More...
 
HPS.SegmentKey UnsetLightingAttributes ()
 Removes all lighting attribute settings from this segment. More...
 
bool ShowLightingAttributes (out HPS.LightingAttributeKit out_kit)
 Shows the lighting attribute settings on this segment. Returns false if no lighting attribute settings exist on this segment. More...
 
HPS.LightingAttributeControl GetLightingAttributeControl ()
 Returns a control that allows the user to manipulate and query details of the lighting attribute on this segment. More...
 
HPS.SegmentKey SetLineAttributes (HPS.LineAttributeKit in_kit)
 Sets the line attributes designated by in_kit on this segment. More...
 
HPS.SegmentKey UnsetLineAttributes ()
 Removes all line attribute settings from this segment. More...
 
bool ShowLineAttributes (out HPS.LineAttributeKit out_kit)
 Shows the line attribute settings on this segment. Returns false if no line attribute settings exist on this segment. More...
 
HPS.LineAttributeControl GetLineAttributeControl ()
 Returns a control that allows the user to manipulate and query details of the line attribute on this segment. More...
 
HPS.SegmentKey SetMaterialMapping (HPS.MaterialMappingKit in_kit)
 Sets the material mappings designated by in_kit on this segment. More...
 
HPS.SegmentKey UnsetMaterialMapping ()
 Removes all material mapping settings from this segment. More...
 
bool ShowMaterialMapping (out HPS.MaterialMappingKit out_kit)
 Shows the material mapping settings on this segment. Returns false if no material mapping settings exist on this segment. More...
 
HPS.MaterialMappingControl GetMaterialMappingControl ()
 Returns a control that allows the user to manipulate and query details of the material mapping on this segment. More...
 
HPS.SegmentKey SetMarkerAttributes (HPS.MarkerAttributeKit in_kit)
 Sets the marker attributes designated by in_kit on this segment. More...
 
HPS.SegmentKey UnsetMarkerAttributes ()
 Removes all marker attribute settings from this segment. More...
 
bool ShowMarkerAttributes (out HPS.MarkerAttributeKit out_kit)
 Shows the marker attribute settings on this segment. Returns false if no marker attribute settings exist on this segment. More...
 
HPS.MarkerAttributeControl GetMarkerAttributeControl ()
 Returns a control that allows the user to manipulate and query details of the marker attribute on this segment. More...
 
HPS.SegmentKey SetModellingMatrix (HPS.MatrixKit in_kit)
 Sets the modelling matrix attributes designated by in_kit on this segment. More...
 
HPS.SegmentKey UnsetModellingMatrix ()
 Removes any modelling matrix settings from this segment. More...
 
bool ShowModellingMatrix (out HPS.MatrixKit out_kit)
 Shows the modelling matrix setting on this segment. Returns false if no modelling matrix setting exists on this segment. More...
 
HPS.ModellingMatrixControl GetModellingMatrixControl ()
 Returns a control that allows the user to manipulate and query details of the modelling matrix on this segment. More...
 
HPS.SegmentKey SetNURBSSurfaceAttributes (HPS.NURBSSurfaceAttributeKit in_kit)
 Sets the NURBS surface attributes designated by in_kit on this segment. More...
 
HPS.SegmentKey UnsetNURBSSurfaceAttributes ()
 Removes all NURBS surface attribute settings from this segment. More...
 
bool ShowNURBSSurfaceAttributes (out HPS.NURBSSurfaceAttributeKit out_kit)
 Shows the NURBS surface attribute settings on this segment. Returns false if no NURBS surface attribute settings exist on this segment. More...
 
HPS.NURBSSurfaceAttributeControl GetNURBSSurfaceAttributeControl ()
 Returns a control that allows the user to manipulate and query details of the NURBS surface attribute on this segment. More...
 
HPS.SegmentKey SetPerformance (HPS.PerformanceKit in_kit)
 Sets the performance attributes designated by in_kit on this segment. More...
 
HPS.SegmentKey UnsetPerformance ()
 Removes all performance settings from this segment. More...
 
bool ShowPerformance (out HPS.PerformanceKit out_kit)
 Shows the performance attribute settings on this segment. Returns false if no performance settings exist on this segment. More...
 
HPS.PerformanceControl GetPerformanceControl ()
 Returns a control that allows the user to manipulate and query details of the performance attribute on this segment. More...
 
HPS.SegmentKey SetSelectability (HPS.SelectabilityKit in_kit)
 Sets the selectability attributes designated by in_kit on this segment. More...
 
HPS.SegmentKey UnsetSelectability ()
 Removes all selectability settings from this segment. More...
 
bool ShowSelectability (out HPS.SelectabilityKit out_kit)
 Shows the selectability attribute settings on this segment. More...
 
HPS.SelectabilityControl GetSelectabilityControl ()
 Returns a control that allows the user to manipulate and query details of the selectability attribute on this segment. More...
 
HPS.SegmentKey SetSphereAttributes (HPS.SphereAttributeKit in_kit)
 Sets the sphere attributes designated by in_kit on this segment. More...
 
HPS.SegmentKey UnsetSphereAttributes ()
 Removes all sphere attribute settings from this segment. More...
 
bool ShowSphereAttributes (out HPS.SphereAttributeKit out_kit)
 Shows the sphere attribute settings on this segment. More...
 
HPS.SphereAttributeControl GetSphereAttributeControl ()
 Returns a control that allows the user to manipulate and query details of the sphere attribute on this segment. More...
 
HPS.SegmentKey SetSubwindow (HPS.SubwindowKit in_kit)
 Sets the subwindow attributes designated by in_kit on this segment. More...
 
HPS.SegmentKey UnsetSubwindow ()
 Removes all subwindow attribute settings from this segment. More...
 
bool ShowSubwindow (out HPS.SubwindowKit out_kit)
 Shows the subwindow attribute settings on this segment. More...
 
HPS.SubwindowControl GetSubwindowControl ()
 Returns a control that allows the user to manipulate and query details of the subwindow attribute on this segment. More...
 
HPS.SegmentKey SetTextAttributes (HPS.TextAttributeKit in_kit)
 Sets the text attributes designated by in_kit on this segment. More...
 
HPS.SegmentKey UnsetTextAttributes ()
 Removes all text attribute settings from this segment. More...
 
bool ShowTextAttributes (out HPS.TextAttributeKit out_kit)
 Shows the text attribute settings on this segment. Returns false if no text attribute settings exist on this segment. More...
 
HPS.TextAttributeControl GetTextAttributeControl ()
 Returns a control that allows the user to manipulate and query details of the text attribute on this segment. More...
 
HPS.SegmentKey SetTextureMatrix (HPS.MatrixKit in_kit)
 Sets the texture matrix attributes designated by in_kit on this segment. More...
 
HPS.SegmentKey UnsetTextureMatrix ()
 Removes any texture matrix settings from this segment. More...
 
bool ShowTextureMatrix (out HPS.MatrixKit out_kit)
 Shows the texture matrix setting on this segment. More...
 
HPS.TextureMatrixControl GetTextureMatrixControl ()
 Returns a control that allows the user to manipulate and query details of the texture matrix on this segment. More...
 
HPS.SegmentKey SetTransformMask (HPS.TransformMaskKit in_kit)
 Sets the transform mask designated by in_kit on this segment. More...
 
HPS.SegmentKey UnsetTransformMask ()
 Removes all transform mask settings from this segment. More...
 
bool ShowTransformMask (out HPS.TransformMaskKit out_kit)
 Shows the transform mask settings on this segment. More...
 
HPS.TransformMaskControl GetTransformMaskControl ()
 Returns a control that allows the user to manipulate and query details of the transform mask on this segment. More...
 
HPS.SegmentKey SetTransparency (HPS.TransparencyKit in_kit)
 Sets the transparency attributes designated by in_kit on this segment. More...
 
HPS.SegmentKey UnsetTransparency ()
 Removes all transparency attribute settings from this segment. More...
 
bool ShowTransparency (out HPS.TransparencyKit out_kit)
 Shows the transparency attribute settings on this segment. More...
 
HPS.TransparencyControl GetTransparencyControl ()
 Returns a control that allows the user to manipulate and query details of the transparency attribute on this segment. More...
 
HPS.SegmentKey SetVisibility (HPS.VisibilityKit in_kit)
 Sets the visibility attribute designated by in_kit on this segment. More...
 
HPS.SegmentKey UnsetVisibility ()
 Removes all visibility settings from this segment. More...
 
bool ShowVisibility (out HPS.VisibilityKit out_kit)
 Shows the visibility attribute settings on this segment. More...
 
HPS.VisibilityControl GetVisibilityControl ()
 Returns a control that allows the user to manipulate and query details of the visibility attribute on this segment. More...
 
HPS.SegmentKey SetVisualEffects (HPS.VisualEffectsKit in_kit)
 Sets the visual effects attributes designated by in_kit on this segment. More...
 
HPS.SegmentKey UnsetVisualEffects ()
 Removes all visual effects attribute settings from this segment. More...
 
bool ShowVisualEffects (out HPS.VisualEffectsKit out_kit)
 Shows the visual effects attribute settings on this segment. More...
 
HPS.VisualEffectsControl GetVisualEffectsControl ()
 Returns a control that allows the user to manipulate and query details of the visual effects attribute on this segment. More...
 
void Optimize (HPS.SegmentOptimizationOptionsKit in_kit)
 
- Public Member Functions inherited from HPS.Key
 Key ()
 An uninitialized key refers to no database object and Type() will return Type::None. More...
 
 Key (HPS.Key in_that)
 Shares a reference to a database object referred to by in_that. More...
 
 Key (HPS.Control in_control)
 Initializes a key tied to the Control in_control. More...
 
bool HasOwner ()
 
Returns
Indicates whether this key has an owner or not.

 
HPS.SegmentKey Up ()
 
Returns
The segment containing this key.

 
HPS.SegmentKey Owner ()
 
Returns
The segment containing this key.

 
void Delete ()
 Removes the database object referred to by this key. More...
 
void MoveTo (HPS.SegmentKey in_new_owner)
 Moves the database object referred to by this key into a new containing segment pointed to by in_new_owner. More...
 
HPS.Key CopyTo (HPS.SegmentKey in_destination)
 Copies the database object referred to by this key into a segment pointed to by in_destination. More...
 
virtual void Assign (HPS.Key in_that)
 Share the smart-pointer. More...
 
override bool Equals (System.Object obj)
 
override int GetHashCode ()
 
bool Equals (HPS.Key in_that)
 Determines whether the database objects pointed to by this key and in_that are the same. Empty keys (when key.Empty() returns true) are never equal to any key, even when the key is compared against itself (they act analogously to NaN comparisons in this case.) More...
 
ulong GetHash ()
 Returns a hash code for the key. More...
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
 Object (HPS.Object in_that)
 The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More...
 
HPS.Type Type ()
 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. More...
 
virtual bool Empty ()
 Indicates whether this object has any values set on it. More...
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
IntPtr GetInstanceID ()
 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. More...
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.WindowKey
override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS.Key
static bool operator== (HPS.Key a, HPS.Key b)
 
static bool operator!= (HPS.Key a, HPS.Key b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 
- Protected Attributes inherited from HPS.Object
HandleRef cptr
 
HandleRef scptr
 
bool cMemOwn
 

Detailed Description

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.

Constructor & Destructor Documentation

HPS.StandAloneWindowKey.StandAloneWindowKey ( )
inline

The default constructor creates an uninitialized StandAloneWindowKey object. The Type() function will return Type::None.

HPS.StandAloneWindowKey.StandAloneWindowKey ( HPS.Key  in_key)
inline

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_keyThe source <ref refid="class_h_p_s_1_1_key" kindref="compound">Key</ref> to copy.
HPS.StandAloneWindowKey.StandAloneWindowKey ( HPS.StandAloneWindowKey  in_that)
inline

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

Parameters
in_thatThe source <ref refid="class_h_p_s_1_1_stand_alone_window_key" kindref="compound">StandAloneWindowKey</ref> to copy.

Member Function Documentation

HPS.StandAloneWindowOptionsControl HPS.StandAloneWindowKey.GetWindowOptionsControl ( )
inline

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

Returns
A control that allows querying options specific to stand-alone windows.
override HPS.Type HPS.StandAloneWindowKey.ObjectType ( )
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.SegmentKey.

HPS.Window.UpdateStatus HPS.StandAloneWindowKey.Pause ( )
inline

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 HPS.StandAloneWindowKey.ShowWindowOptions ( out HPS.StandAloneWindowOptionsKit  out_kit)
inline

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

Parameters
out_kitThe stand-alone-window-specific options for this <ref refid="class_h_p_s_1_1_stand_alone_window_key" kindref="compound">StandAloneWindowKey</ref>.
Returns
true if any options are set, false otherwise.

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