REFERENCE MANUAL
The SubwindowControl class is a smart pointer that is tied to a database object. More...
Public Member Functions | |
override void | Dispose () |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
HPS.SubwindowControl | SetBackground (HPS.Subwindow.Background in_bg_type, string in_definition_name) |
Controls the type of background to be used for subwindows originating from this segment. More... | |
HPS.SubwindowControl | SetBackground (HPS.Subwindow.Background in_bg_type) |
Controls the type of background to be used for subwindows originating from this segment. More... | |
HPS.SubwindowControl | SetBorder (HPS.Subwindow.Border in_border_type) |
Controls the type of border, if any, that should be drawn for subwindows originating from this segment. More... | |
HPS.SubwindowControl | SetRenderingAlgorithm (HPS.Subwindow.RenderingAlgorithm in_hsra) |
Determines the algorithm used to remove objects (or parts of objects) that are hidden from view by other objects. More... | |
HPS.SubwindowControl | SetSubwindow (HPS.Rectangle in_window_position, HPS.Subwindow.Type in_type) |
Defines a portion of the containing window to act as a subwindow. More... | |
HPS.SubwindowControl | SetSubwindow (HPS.Rectangle in_window_position) |
Defines a portion of the containing window to act as a subwindow. More... | |
bool | ShowBackground (out HPS.Subwindow.Background out_bg_type, out string out_definition_name) |
Shows the window background setting More... | |
bool | ShowBorder (out HPS.Subwindow.Border out_border_type) |
Shows the subwindow border setting More... | |
bool | ShowRenderingAlgorithm (out HPS.Subwindow.RenderingAlgorithm out_hsra) |
Shows the rendering algorithm setting. More... | |
bool | ShowSubwindow (out HPS.Rectangle out_window_position, out HPS.Subwindow.Type out_subwindow_type) |
Shows the subwindow setting. More... | |
SubwindowControl (HPS.SegmentKey in_seg) | |
Initializes a control tied to the segment in_seg. More... | |
SubwindowControl (HPS.SubwindowControl in_that) | |
Initializes a control tied to the same object as in_that. More... | |
HPS.SubwindowControl | UnsetBackground () |
Removes a subwindow background setting. More... | |
HPS.SubwindowControl | UnsetBorder () |
Removes a subwindow border setting. More... | |
HPS.SubwindowControl | UnsetEverything () |
Removes all settings from this object. More... | |
HPS.SubwindowControl | UnsetRenderingAlgorithm () |
Removes a rendering algorithm setting. More... | |
HPS.SubwindowControl | UnsetSubwindow () |
Removes a subwindow setting. More... | |
![]() | |
Control (HPS.Control in_that) | |
![]() | |
virtual bool | Empty () |
Indicates whether this object has any values set on it. More... | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
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... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
HPS.Type | Type () |
This function returns the true type of the underlying object. More... | |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
The SubwindowControl class is a smart pointer that is tied to a database object.
The SubwindowControl allows you to manipulate the various settings associated with subwindows, such as border, background, and priority. As the main Visualize window is also an implicit subwindow, this control also allows you to set the rendering algorithm. The rendering algorithm should only have a single setting for each window or subwindow. Setting disparate rendering algorithms in multiple places in your scene can lead to unexpected results. Default values for the various fields of SubwindowControl can be found here.
HPS.SubwindowControl.SubwindowControl | ( | HPS.SegmentKey | in_seg | ) |
Initializes a control tied to the segment in_seg.
HPS.SubwindowControl.SubwindowControl | ( | HPS.SubwindowControl | in_that | ) |
Initializes a control tied to the same object as in_that.
|
virtual |
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.
HPS.SubwindowControl HPS.SubwindowControl.SetBackground | ( | HPS.Subwindow.Background | in_bg_type, |
string | in_definition_name | ||
) |
Controls the type of background to be used for subwindows originating from this segment.
This has no effect when applied to segments without a subwindow present.
in_bg_type | The type of background to be used for subwindows originating from this segment. |
in_definition_name | the name of a definition to be used in the background. Only relevant if in_bg_type is <ref refid="class_h_p_s_1_1_image" kindref="compound">Image</ref> or Cubemap. |
HPS.SubwindowControl HPS.SubwindowControl.SetBackground | ( | HPS.Subwindow.Background | in_bg_type | ) |
Controls the type of background to be used for subwindows originating from this segment.
This has no effect when applied to segments without a subwindow present.
in_bg_type | The type of background to be used for subwindows originating from this segment. |
HPS.SubwindowControl HPS.SubwindowControl.SetBorder | ( | HPS.Subwindow.Border | in_border_type | ) |
Controls the type of border, if any, that should be drawn for subwindows originating from this segment.
This has no effect when applied to segments without a subwindow present.
in_border_type | The type of border, if any, that should be drawn for subwindows originating from this segment. |
HPS.SubwindowControl HPS.SubwindowControl.SetRenderingAlgorithm | ( | HPS.Subwindow.RenderingAlgorithm | in_hsra | ) |
Determines the algorithm used to remove objects (or parts of objects) that are hidden from view by other objects.
This has no effect when applied to segments without a subwindow present.
in_hsra | The algorithm used to identify and remove hidden surfaces. |
Rendering algorithm default value
HPS.SubwindowControl HPS.SubwindowControl.SetSubwindow | ( | HPS.Rectangle | in_window_position, |
HPS.Subwindow.Type | in_type | ||
) |
Defines a portion of the containing window to act as a subwindow.
Window segments have an implicit subwindow of -1 to 1 in both x and y directions that cannot be changed. Other segments can be constrained to some portion of that space. Most other subwindow-related settings are only relevant if they are applied on a segment that also contains a subwindow.
Subwindowdefault value
HPS.SubwindowControl HPS.SubwindowControl.SetSubwindow | ( | HPS.Rectangle | in_window_position | ) |
Defines a portion of the containing window to act as a subwindow.
Window segments have an implicit subwindow of -1 to 1 in both x and y directions that cannot be changed. Other segments can be constrained to some portion of that space. Most other subwindow-related settings are only relevant if they are applied on a segment that also contains a subwindow.
Subwindowdefault value
bool HPS.SubwindowControl.ShowBackground | ( | out HPS.Subwindow.Background | out_bg_type, |
out string | out_definition_name | ||
) |
Shows the window background setting
out_bg_type | The type of background to be used for subwindows originating from this segment. |
out_definition_name | the name of a definition to be used in the background. |
bool HPS.SubwindowControl.ShowBorder | ( | out HPS.Subwindow.Border | out_border_type | ) |
Shows the subwindow border setting
out_border_type | The type of border, if any, that should be drawn for subwindows originating from this segment. |
bool HPS.SubwindowControl.ShowRenderingAlgorithm | ( | out HPS.Subwindow.RenderingAlgorithm | out_hsra | ) |
Shows the rendering algorithm setting.
out_hsra | The algorithm used to identify and remove hidden surfaces. |
bool HPS.SubwindowControl.ShowSubwindow | ( | out HPS.Rectangle | out_window_position, |
out HPS.Subwindow.Type | out_subwindow_type | ||
) |
Shows the subwindow setting.
out_subwindow_type | The type of subwindow to create. |
HPS.SubwindowControl HPS.SubwindowControl.UnsetBackground | ( | ) |
Removes a subwindow background setting.
HPS.SubwindowControl HPS.SubwindowControl.UnsetBorder | ( | ) |
Removes a subwindow border setting.
HPS.SubwindowControl HPS.SubwindowControl.UnsetEverything | ( | ) |
Removes all settings from this object.
HPS.SubwindowControl HPS.SubwindowControl.UnsetRenderingAlgorithm | ( | ) |
Removes a rendering algorithm setting.
HPS.SubwindowControl HPS.SubwindowControl.UnsetSubwindow | ( | ) |
Removes a subwindow setting.