Inheritance diagram for HPS.SubwindowKit:
HPS.Kit HPS.Object

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.SubwindowKit in_kit)
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 
void Set (HPS.SubwindowKit in_kit)
 
HPS.SubwindowKit SetBackground (HPS.Subwindow.Background in_bg_type, string in_definition_name)
 
HPS.SubwindowKit SetBackground (HPS.Subwindow.Background in_bg_type)
 
HPS.SubwindowKit SetBorder (HPS.Subwindow.Border in_border_type)
 
HPS.SubwindowKit SetModelCompareMode (bool in_state, HPS.SegmentKey in_source1, HPS.SegmentKey in_source2)
 
HPS.SubwindowKit SetModelCompareMode (bool in_state, HPS.SegmentKey in_source1)
 
HPS.SubwindowKit SetModelCompareMode (bool in_state)
 
HPS.SubwindowKit SetModelCompareMode (HPS.SegmentKey in_source1, HPS.SegmentKey in_source2)
 
HPS.SubwindowKit SetRenderingAlgorithm (HPS.Subwindow.RenderingAlgorithm in_hsra)
 
HPS.SubwindowKit SetSubwindow (HPS.Rectangle in_subwindow_position, HPS.Subwindow.Type in_subwindow_type)
 
HPS.SubwindowKit SetSubwindow (HPS.Rectangle in_subwindow_position)
 
HPS.SubwindowKit SetSubwindow (HPS.Rectangle in_subwindow_position, HPS.IntRectangle in_subwindow_offsets, HPS.Subwindow.Type in_subwindow_type)
 
HPS.SubwindowKit SetSubwindow (HPS.Rectangle in_subwindow_position, HPS.IntRectangle in_subwindow_offsets)
 
void Show (out HPS.SubwindowKit out_kit)
 
bool ShowBackground (out HPS.Subwindow.Background out_bg_type, out string out_definition_name)
 
bool ShowBorder (out HPS.Subwindow.Border out_border_type)
 
bool ShowModelCompareMode (out bool out_state, out HPS.SegmentKey out_source1, out HPS.SegmentKey out_source2)
 
bool ShowRenderingAlgorithm (out HPS.Subwindow.RenderingAlgorithm out_hsra)
 
bool ShowSubwindow (out HPS.Rectangle out_subwindow_position, out HPS.IntRectangle out_subwindow_offsets, out HPS.Subwindow.Type out_subwindow_type)
 
 SubwindowKit ()
 
 SubwindowKit (HPS.SubwindowKit in_kit)
 
HPS.SubwindowKit UnsetBackground ()
 
HPS.SubwindowKit UnsetBorder ()
 
HPS.SubwindowKit UnsetEverything ()
 
HPS.SubwindowKit UnsetModelCompareMode ()
 
HPS.SubwindowKit UnsetRenderingAlgorithm ()
 
HPS.SubwindowKit UnsetSubwindow ()
 
- Public Member Functions inherited from HPS.Kit
 Kit (HPS.Kit in_that)
 
override HPS.Type Type ()
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 

Static Public Member Functions

static HPS.SubwindowKit GetDefault ()
 
static bool operator!= (HPS.SubwindowKit a, HPS.SubwindowKit b)
 
static bool operator== (HPS.SubwindowKit a, HPS.SubwindowKit b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
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

◆ SubwindowKit() [1/2]

HPS.SubwindowKit.SubwindowKit ( )
inline

Initializes an empty kit.

◆ SubwindowKit() [2/2]

HPS.SubwindowKit.SubwindowKit ( HPS.SubwindowKit  in_kit)
inline

Copies the kit in_kit into this kit.

Member Function Documentation

◆ Empty()

override bool HPS.SubwindowKit.Empty ( )
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.

◆ Equals()

bool HPS.SubwindowKit.Equals ( HPS.SubwindowKit  in_kit)
inline

Check if the source SubwindowKit is equivalent to this object.

Parameters
in_kitThe source SubwindowKit to compare to this object.
Returns
true if the objects are equivalent, false otherwise.

◆ GetDefault()

static HPS.SubwindowKit HPS.SubwindowKit.GetDefault ( )
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.

◆ ObjectType()

override HPS.Type HPS.SubwindowKit.ObjectType ( )
inlinevirtual

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

Returns
The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from HPS.Kit.

◆ Set()

void HPS.SubwindowKit.Set ( HPS.SubwindowKit  in_kit)
inline

Copies the source SubwindowKit into this object.

Parameters
in_kitThe source object to copy.

◆ SetBackground() [1/2]

HPS.SubwindowKit HPS.SubwindowKit.SetBackground ( HPS.Subwindow.Background  in_bg_type,
string  in_definition_name 
)
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_typeThe type of background to be used for subwindows originating from this segment.
in_definition_namethe 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.

◆ SetBackground() [2/2]

HPS.SubwindowKit HPS.SubwindowKit.SetBackground ( HPS.Subwindow.Background  in_bg_type)
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_typeThe type of background to be used for subwindows originating from this segment.
Returns
A reference to this object.

◆ SetBorder()

HPS.SubwindowKit HPS.SubwindowKit.SetBorder ( HPS.Subwindow.Border  in_border_type)
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_typeThe type of border, if any, that should be drawn for subwindows originating from this segment.
Returns
A reference to this object.

◆ SetModelCompareMode() [1/4]

HPS.SubwindowKit HPS.SubwindowKit.SetModelCompareMode ( bool  in_state,
HPS.SegmentKey  in_source1,
HPS.SegmentKey  in_source2 
)
inline

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

Parameters
in_stateToggles compare mode on or off.
in_source1The first source model.
in_source2The second source model.
Returns
A reference to this object.

◆ SetModelCompareMode() [2/4]

HPS.SubwindowKit HPS.SubwindowKit.SetModelCompareMode ( bool  in_state,
HPS.SegmentKey  in_source1 
)
inline

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

Parameters
in_stateToggles compare mode on or off.
in_source1The first source model.
Returns
A reference to this object.

◆ SetModelCompareMode() [3/4]

HPS.SubwindowKit HPS.SubwindowKit.SetModelCompareMode ( bool  in_state)
inline

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

Parameters
in_stateToggles compare mode on or off.
Returns
A reference to this object.

◆ SetModelCompareMode() [4/4]

HPS.SubwindowKit HPS.SubwindowKit.SetModelCompareMode ( HPS.SegmentKey  in_source1,
HPS.SegmentKey  in_source2 
)
inline

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

Parameters
in_source1The first source model.
in_source2The second source model.
Returns
A reference to this object.

◆ SetRenderingAlgorithm()

HPS.SubwindowKit HPS.SubwindowKit.SetRenderingAlgorithm ( HPS.Subwindow.RenderingAlgorithm  in_hsra)
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_hsraThe algorithm used to identify and remove hidden surfaces.
Returns
A reference to this object.

◆ SetSubwindow() [1/4]

HPS.SubwindowKit HPS.SubwindowKit.SetSubwindow ( HPS.Rectangle  in_subwindow_position,
HPS.Subwindow.Type  in_subwindow_type 
)
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_positionThe 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_typeThe type of subwindow to create.
Returns
A reference to this object.

◆ SetSubwindow() [2/4]

HPS.SubwindowKit HPS.SubwindowKit.SetSubwindow ( HPS.Rectangle  in_subwindow_position)
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_positionThe 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.

◆ SetSubwindow() [3/4]

HPS.SubwindowKit HPS.SubwindowKit.SetSubwindow ( HPS.Rectangle  in_subwindow_position,
HPS.IntRectangle  in_subwindow_offsets,
HPS.Subwindow.Type  in_subwindow_type 
)
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_positionThe 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_offsetsThe pixel-space offsets to apply to each side of the given window position.
in_subwindow_typeThe type of subwindow to create.
Returns
A reference to this object.

◆ SetSubwindow() [4/4]

HPS.SubwindowKit HPS.SubwindowKit.SetSubwindow ( HPS.Rectangle  in_subwindow_position,
HPS.IntRectangle  in_subwindow_offsets 
)
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_positionThe 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_offsetsThe pixel-space offsets to apply to each side of the given window position.
Returns
A reference to this object.

◆ Show()

void HPS.SubwindowKit.Show ( out HPS.SubwindowKit  out_kit)
inline

Copies this object into the given SubwindowKit.

Parameters
out_kitThe SubwindowKit to populate with the contents of this object.

◆ ShowBackground()

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

Shows the window background setting

Parameters
out_bg_typeThe type of background to be used for subwindows originating from this segment.
out_definition_namethe name of a definition to be used in the background.
Returns
true if the setting is valid, false otherwise.

◆ ShowBorder()

bool HPS.SubwindowKit.ShowBorder ( out HPS.Subwindow.Border  out_border_type)
inline

Shows the subwindow border setting

Parameters
out_border_typeThe type of border, if any, that should be drawn for subwindows originating from this segment.
Returns
true if the setting is valid, false otherwise.

◆ ShowModelCompareMode()

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

Shows the model compare setting.

Parameters
out_stateThe model compare enabled state.
out_source1The first source model.
out_source2The second source model.
Returns
true if the setting is valid, false otherwise.

◆ ShowRenderingAlgorithm()

bool HPS.SubwindowKit.ShowRenderingAlgorithm ( out HPS.Subwindow.RenderingAlgorithm  out_hsra)
inline

Shows the rendering algorithm setting.

Parameters
out_hsraThe algorithm used to identify and remove hidden surfaces.
Returns
true if the setting is valid, false otherwise.

◆ ShowSubwindow()

bool HPS.SubwindowKit.ShowSubwindow ( out HPS.Rectangle  out_subwindow_position,
out HPS.IntRectangle  out_subwindow_offsets,
out HPS.Subwindow.Type  out_subwindow_type 
)
inline

Shows the subwindow setting.

Parameters
out_subwindow_positionThe portion of the containing window that should be reserved for a subwindow.
out_subwindow_offsetsThe pixel-space offsets being applied to the subwindow position.
out_subwindow_typeThe type of subwindow to create.
Returns
true if the setting is valid, false otherwise.

◆ UnsetBackground()

HPS.SubwindowKit HPS.SubwindowKit.UnsetBackground ( )
inline

Removes a subwindow background setting.

Returns
A reference to this object.

◆ UnsetBorder()

HPS.SubwindowKit HPS.SubwindowKit.UnsetBorder ( )
inline

Removes a subwindow border setting.

Returns
A reference to this object.

◆ UnsetEverything()

HPS.SubwindowKit HPS.SubwindowKit.UnsetEverything ( )
inline

Removes all settings from this object.

Returns
A reference to this object.

◆ UnsetModelCompareMode()

HPS.SubwindowKit HPS.SubwindowKit.UnsetModelCompareMode ( )
inline

Removes model compare setting.

Returns
A reference to this object.

◆ UnsetRenderingAlgorithm()

HPS.SubwindowKit HPS.SubwindowKit.UnsetRenderingAlgorithm ( )
inline

Removes a rendering algorithm setting.

Returns
A reference to this object.

◆ UnsetSubwindow()

HPS.SubwindowKit HPS.SubwindowKit.UnsetSubwindow ( )
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