SubwindowControl

class HPS.SubwindowControl : public HPS.Control

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.

Public Functions

override void Dispose ()

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

Param in_bg_type

The type of background to be used for subwindows originating from this segment.

Return

A reference to this object.

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.

Param in_bg_type

The type of background to be used for subwindows originating from this segment.

Param in_definition_name

the name of a definition to be used in the background. Only relevant if in_bg_type is Image or Cubemap.

Return

A reference to this object.

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.

Param in_border_type

The type of border, if any, that should be drawn for subwindows originating from this segment.

Return

A reference to this object.

HPS.SubwindowControl SetModelCompareMode (bool in_state)

Sets ‘model compare’ rendering mode which displays a visual diff between the two source segments in this subwindow.

Param in_state

Toggles compare mode on or off.

Return

A reference to this object.

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.

Param in_state

Toggles compare mode on or off.

Param in_source1

The first source model.

Return

A reference to this object.

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.

Param in_state

Toggles compare mode on or off.

Param in_source1

The first source model.

Param in_source2

The second source model.

Return

A reference to this object.

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.

Param in_source1

The first source model.

Param in_source2

The second source model.

Return

A reference to this object.

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.

See

Rendering algorithm default value

Param in_hsra

The algorithm used to identify and remove hidden surfaces.

Return

A reference to this object.

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.

See

Subwindowdefault value

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

Return

A reference to this object.

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.

See

Subwindowdefault value

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

Param in_window_offsets

The pixel-space offsets to apply to each side of the given window position.

Return

A reference to this object.

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.

See

Subwindowdefault value

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

Param in_window_offsets

The pixel-space offsets to apply to each side of the given window position.

Param in_type

The type of subwindow to create.

Return

A reference to this object.

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.

See

Subwindowdefault value

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

Param in_type

The type of subwindow to create.

Return

A reference to this object.

bool ShowBackground (out HPS.Subwindow.Background out_bg_type, out string out_definition_name)

Shows the window background setting

Param out_bg_type

The type of background to be used for subwindows originating from this segment.

Param out_definition_name

the name of a definition to be used in the background.

Return

true if the setting is valid, false otherwise.

bool ShowBorder (out HPS.Subwindow.Border out_border_type)

Shows the subwindow border setting

Param out_border_type

The type of border, if any, that should be drawn for subwindows originating from this segment.

Return

true if the setting is valid, false otherwise.

bool ShowModelCompareMode (out bool out_state, out HPS.SegmentKey out_source1, out HPS.SegmentKey out_source2)

Shows the model compare setting.

Param out_state

The model compare enabled state.

Param out_source1

The first source model.

Param out_source2

The second source model.

Return

true if the setting is valid, false otherwise.

bool ShowRenderingAlgorithm (out HPS.Subwindow.RenderingAlgorithm out_hsra)

Shows the rendering algorithm setting.

Param out_hsra

The algorithm used to identify and remove hidden surfaces.

Return

true if the setting is valid, false otherwise.

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.

Param out_subwindow_position

The portion of the containing window that should be reserved for a subwindow.

Param out_subwindow_offsets

The pixel-space offsets being applied to the subwindow position.

Param out_subwindow_type

The type of subwindow to create.

Return

true if the setting is valid, false otherwise.

SubwindowControl (HPS.SegmentKey in_seg)

Initializes a control tied to the segment in_seg.

SubwindowControl (HPS.SubwindowControl in_that)

Initializes a control tied to the same object as in_that.

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

Return

A reference to this object.

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

Return

A reference to this object.

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

Return

A reference to this object.

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

Return

A reference to this object.

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

Return

A reference to this object.

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

Return

A reference to this object.