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

Public Member Functions | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this object has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.SubwindowKit in_kit) |
Check if the source SubwindowKit is equivalent to this object. More... | |
override int | GetHashCode () |
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... | |
void | Set (HPS.SubwindowKit in_kit) |
Copies the source SubwindowKit into this object. More... | |
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. More... | |
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. More... | |
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. More... | |
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. More... | |
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. More... | |
HPS.SubwindowKit | SetModelCompareMode (bool in_state) |
Sets 'model compare' rendering mode which displays a visual diff between the two source segments in this subwindow. More... | |
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. More... | |
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. More... | |
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. More... | |
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. More... | |
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. More... | |
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. More... | |
void | Show (out HPS.SubwindowKit out_kit) |
Copies this object into the given SubwindowKit. 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... | |
bool | ShowSubwindow (out HPS.Rectangle out_subwindow_position, out HPS.Subwindow.Type out_subwindow_type) |
Shows the subwindow setting. <xrefsect id="deprecated_1_deprecated000003"> <xreftitle>Deprecated</xreftitle> <xrefdescription> More... | |
SubwindowKit () | |
Initializes an empty kit. More... | |
SubwindowKit (HPS.SubwindowKit in_kit) | |
Copies the kit in_kit into this kit. More... | |
HPS.SubwindowKit | UnsetBackground () |
Removes a subwindow background setting. More... | |
HPS.SubwindowKit | UnsetBorder () |
Removes a subwindow border setting. More... | |
HPS.SubwindowKit | UnsetEverything () |
Removes all settings from this object. More... | |
HPS.SubwindowKit | UnsetModelCompareMode () |
Removes model compare setting. More... | |
HPS.SubwindowKit | UnsetRenderingAlgorithm () |
Removes a rendering algorithm setting. More... | |
HPS.SubwindowKit | UnsetSubwindow () |
Removes a subwindow setting. 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... | |
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... | |
Static Public Member Functions | |
static 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. More... | |
static bool | operator!= (HPS.SubwindowKit a, HPS.SubwindowKit b) |
static bool | operator== (HPS.SubwindowKit a, HPS.SubwindowKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
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.
Constructor & Destructor Documentation
|
inline |
Initializes an empty kit.
|
inline |
Copies the kit in_kit into this kit.
Member Function Documentation
|
inlinevirtual |
Indicates whether this object has any values set on it.
- Returns
- true if no values are set on this object, false otherwise.
Reimplemented from HPS.Object.
|
inline |
Check if the source SubwindowKit is equivalent to this object.
- Parameters
-
in_kit The source SubwindowKit to compare to this object.
- Returns
- true if the objects are equivalent, false otherwise.
|
inlinestatic |
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.
- Returns
- A SubwindowKit with the default settings.
|
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.Object.
|
inline |
Copies the source SubwindowKit into this object.
- Parameters
-
in_kit The source object to copy.
|
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.
|
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_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. in_subwindow_type The type of subwindow to create.
- Returns
- A reference to this object.
|
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_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.
- Returns
- A reference to this object.
|
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_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. in_subwindow_offsets The pixel-space offsets to apply to each side of the given window position. in_subwindow_type The type of subwindow to create.
- Returns
- A reference to this object.
|
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_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. in_subwindow_offsets The pixel-space offsets to apply to each side of the given window position.
- Returns
- A reference to this object.
|
inline |
Copies this object into the given SubwindowKit.
- Parameters
-
out_kit The SubwindowKit to populate with the contents of this object.
|
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.
|
inline |
Shows the subwindow setting. <xrefsect id="deprecated_1_deprecated000003"> <xreftitle>Deprecated</xreftitle> <xrefdescription>
This function exists for compatibility and the other overload should be preferred in general usage. <simplesect kind="return">
true if the setting is valid, false otherwise.
</simplesect>
</xrefdescription> </xrefsect>
- Parameters
-
out_subwindow_position The portion of the containing window that should be reserved for a subwindow. out_subwindow_type The type of subwindow to create.
|
inline |
Removes a subwindow background setting.
- Returns
- A reference to this object.
|
inline |
Removes a subwindow border setting.
- Returns
- A reference to this object.
|
inline |
Removes all settings from this object.
- Returns
- A reference to this object.
|
inline |
Removes model compare setting.
- Returns
- A reference to this object.
|
inline |
Removes a rendering algorithm setting.
- Returns
- A reference to this object.
|
inline |
Removes a subwindow setting.
- Returns
- A reference to this object.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.SubwindowKit.cs