SubwindowKit

class HPS.SubwindowKit : public HPS.Kit

The HPS.SubwindowKit class is a user space object, useful for carrying a group of attribute settings related to subwindows. Calling HPS.SubwindowKit.GetDefault() will return a kit with values found in this table.

Public Functions

override void Dispose ()

override bool Empty ()

Indicates whether this object has any values set on it.

Return

true if no values are set on this object, false otherwise.

bool Equals (HPS.SubwindowKit in_kit)

Check if the source SubwindowKit is equivalent to this object.

Param in_kit

The source SubwindowKit to compare to this object.

Return

true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

override int GetHashCode ()

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.

void Set (HPS.SubwindowKit in_kit)

Copies the source SubwindowKit into this object.

Param in_kit

The source object to copy.

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

Param in_hsra

The algorithm used to identify and remove hidden surfaces.

Return

A reference to this object.

HPS.SubwindowKit SetSubwindow (HPS.Rectangle in_subwindow_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.

Param in_subwindow_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.SubwindowKit SetSubwindow (HPS.Rectangle in_subwindow_position, HPS.IntRectangle in_subwindow_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.

Param in_subwindow_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_subwindow_offsets

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

Return

A reference to this object.

HPS.SubwindowKit SetSubwindow (HPS.Rectangle in_subwindow_position, HPS.IntRectangle in_subwindow_offsets, HPS.Subwindow.Type in_subwindow_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.

Param in_subwindow_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_subwindow_offsets

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

Param in_subwindow_type

The type of subwindow to create.

Return

A reference to this object.

HPS.SubwindowKit SetSubwindow (HPS.Rectangle in_subwindow_position, HPS.Subwindow.Type in_subwindow_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.

Param in_subwindow_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_subwindow_type

The type of subwindow to create.

Return

A reference to this object.

void Show (out HPS.SubwindowKit out_kit)

Copies this object into the given SubwindowKit.

Param out_kit

The SubwindowKit to populate with the contents of 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.

SubwindowKit ()

Initializes an empty kit.

SubwindowKit (HPS.SubwindowKit in_kit)

Copies the kit in_kit into this kit.

HPS.SubwindowKit UnsetBackground ()

Removes a subwindow background setting.

Return

A reference to this object.

HPS.SubwindowKit UnsetBorder ()

Removes a subwindow border setting.

Return

A reference to this object.

HPS.SubwindowKit UnsetEverything ()

Removes all settings from this object.

Return

A reference to this object.

HPS.SubwindowKit UnsetModelCompareMode ()

Removes model compare setting.

Return

A reference to this object.

HPS.SubwindowKit UnsetRenderingAlgorithm ()

Removes a rendering algorithm setting.

Return

A reference to this object.

HPS.SubwindowKit UnsetSubwindow ()

Removes a subwindow setting.

Return

A reference to this object.

Public Static Functions

HPS.SubwindowKit GetDefault ()

Creates a SubwindowKit which contains the default settings. The returned object will not necessarily have values set for every option, but it will have settings for those options where it is reasonable to have a default.

Return

A SubwindowKit with the default settings.

bool operator!= (HPS.SubwindowKit a, HPS.SubwindowKit b)

bool operator== (HPS.SubwindowKit a, HPS.SubwindowKit b)