
Public Member Functions | |
override void | Dispose () |
override HPS.Type | ObjectType () |
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. More... | |
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. 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. This has no effect when applied to segments without a subwindow present. More... | |
HPS.SubwindowControl | SetModelCompareMode (bool in_state, HPS.SegmentKey in_source1, HPS.SegmentKey in_source2) |
Sets 'model compare' rendering mode which displays a visual diff between the two source segments in this subwindow. More... | |
HPS.SubwindowControl | SetModelCompareMode (bool in_state, HPS.SegmentKey in_source1) |
Sets 'model compare' rendering mode which displays a visual diff between the two source segments in this subwindow. More... | |
HPS.SubwindowControl | SetModelCompareMode (bool in_state) |
Sets 'model compare' rendering mode which displays a visual diff between the two source segments in this subwindow. More... | |
HPS.SubwindowControl | SetModelCompareMode (HPS.SegmentKey in_source1, HPS.SegmentKey in_source2) |
Sets 'model compare' rendering mode which displays a visual diff between the two source segments in this subwindow. 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. This has no effect when applied to segments without a subwindow present. 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. 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. More... | |
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. More... | |
HPS.SubwindowControl | SetSubwindow (HPS.Rectangle in_window_position, HPS.IntRectangle in_window_offsets, 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. More... | |
HPS.SubwindowControl | SetSubwindow (HPS.Rectangle in_window_position, HPS.IntRectangle in_window_offsets) |
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. 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 | ShowModelCompareMode (out bool out_state, out HPS.SegmentKey out_source1, out HPS.SegmentKey out_source2) |
Shows the model compare setting. More... | |
bool | ShowRenderingAlgorithm (out HPS.Subwindow.RenderingAlgorithm out_hsra) |
Shows the rendering algorithm setting. More... | |
bool | ShowSubwindow (out HPS.Rectangle out_subwindow_position, out HPS.IntRectangle out_subwindow_offsets, 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... | |
override 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... | |
HPS.SubwindowControl | UnsetBackground () |
Removes a subwindow background setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by SubwindowKit.GetDefault(). More... | |
HPS.SubwindowControl | UnsetBorder () |
Removes a subwindow border setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by SubwindowKit.GetDefault(). More... | |
HPS.SubwindowControl | UnsetEverything () |
Removes all settings from this object. If the control is attached to a WindowKey this function restores the default settings of this control as specified by SubwindowKit.GetDefault(). More... | |
HPS.SubwindowControl | UnsetModelCompareMode () |
Removes model compare setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by SubwindowKit.GetDefault(). More... | |
HPS.SubwindowControl | UnsetRenderingAlgorithm () |
Removes a rendering algorithm setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by SubwindowKit.GetDefault(). More... | |
HPS.SubwindowControl | UnsetSubwindow () |
Removes a subwindow setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by SubwindowKit.GetDefault(). 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. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object that) | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
The HPS.SubwindowControl class is a smart pointer that is tied to a database object. The HPS.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 HPS.SubwindowControl can be found here.
Constructor & Destructor Documentation
|
inline |
Initializes a control tied to the segment in_seg.
|
inline |
Initializes a control tied to the same object as in_that.
Member Function Documentation
|
inline |
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.
- Parameters
-
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 Image or Cubemap.
- Returns
- A reference to this object.
|
inline |
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.
- Parameters
-
in_bg_type The type of background to be used for subwindows originating from this segment.
- Returns
- A reference to this object.
|
inline |
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.
- Parameters
-
in_border_type The type of border, if any, that should be drawn for subwindows originating from this segment.
- Returns
- A reference to this object.
|
inline |
Sets 'model compare' rendering mode which displays a visual diff between the two source segments in this subwindow.
- Parameters
-
in_state Toggles compare mode on or off. in_source1 The first source model. in_source2 The second source model.
- Returns
- A reference to this object.
|
inline |
Sets 'model compare' rendering mode which displays a visual diff between the two source segments in this subwindow.
- Parameters
-
in_state Toggles compare mode on or off. in_source1 The first source model.
- Returns
- A reference to this object.
|
inline |
Sets 'model compare' rendering mode which displays a visual diff between the two source segments in this subwindow.
- Parameters
-
in_state Toggles compare mode on or off.
- Returns
- A reference to this object.
|
inline |
Sets 'model compare' rendering mode which displays a visual diff between the two source segments in this subwindow.
- Parameters
-
in_source1 The first source model. in_source2 The second source model.
- Returns
- A reference to this object.
|
inline |
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.
- Parameters
-
in_hsra The algorithm used to identify and remove hidden surfaces.
- Returns
- A reference to this object.
Rendering algorithm default value
|
inline |
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.
- Parameters
-
in_window_position The portion of the containing window that should be reserved for a subwindow. The subwindow is defined in the context of a rectangle extending out a single unit in each direction from the origin. For example, a subwindow rectangle defined as Rectangle(0, 1, -1, 0) would occupy the lower right quarter of the containing window. in_type The type of subwindow to create.
- Returns
- A reference to this object.
Subwindowdefault value
|
inline |
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.
- Parameters
-
in_window_position The portion of the containing window that should be reserved for a subwindow. The subwindow is defined in the context of a rectangle extending out a single unit in each direction from the origin. For example, a subwindow rectangle defined as Rectangle(0, 1, -1, 0) would occupy the lower right quarter of the containing window.
- Returns
- A reference to this object.
Subwindowdefault value
|
inline |
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.
- Parameters
-
in_window_position The portion of the containing window that should be reserved for a subwindow. The subwindow is defined in the context of a rectangle extending out a single unit in each direction from the origin. For example, a subwindow rectangle defined as Rectangle(0, 1, -1, 0) would occupy the lower right quarter of the containing window. in_window_offsets The pixel-space offsets to apply to each side of the given window position. in_type The type of subwindow to create.
- Returns
- A reference to this object.
Subwindowdefault value
|
inline |
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.
- Parameters
-
in_window_position The portion of the containing window that should be reserved for a subwindow. The subwindow is defined in the context of a rectangle extending out a single unit in each direction from the origin. For example, a subwindow rectangle defined as Rectangle(0, 1, -1, 0) would occupy the lower right quarter of the containing window. in_window_offsets The pixel-space offsets to apply to each side of the given window position.
- Returns
- A reference to this object.
Subwindowdefault value
|
inline |
Shows the window background setting
- Parameters
-
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.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
Shows the subwindow border setting
- Parameters
-
out_border_type The type of border, if any, that should be drawn for subwindows originating from this segment.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
Shows the model compare setting.
- Parameters
-
out_state The model compare enabled state. out_source1 The first source model. out_source2 The second source model.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
Shows the rendering algorithm setting.
- Parameters
-
out_hsra The algorithm used to identify and remove hidden surfaces.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
Shows the subwindow setting.
- Parameters
-
out_subwindow_position The portion of the containing window that should be reserved for a subwindow. out_subwindow_offsets The pixel-space offsets being applied to the subwindow position. out_subwindow_type The type of subwindow to create.
- Returns
- true if the setting is valid, false otherwise.
|
inlinevirtual |
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.
- Returns
- The true type of the object in question.
Reimplemented from HPS.Control.
|
inline |
Removes a subwindow background setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by SubwindowKit.GetDefault().
- Returns
- A reference to this object.
|
inline |
Removes a subwindow border setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by SubwindowKit.GetDefault().
- Returns
- A reference to this object.
|
inline |
Removes all settings from this object. If the control is attached to a WindowKey this function restores the default settings of this control as specified by SubwindowKit.GetDefault().
- Returns
- A reference to this object.
|
inline |
Removes model compare setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by SubwindowKit.GetDefault().
- Returns
- A reference to this object.
|
inline |
Removes a rendering algorithm setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by SubwindowKit.GetDefault().
- Returns
- A reference to this object.
|
inline |
Removes a subwindow setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by SubwindowKit.GetDefault().
- Returns
- A reference to this object.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.SubwindowControl.cs