Inheritance diagram for HPS.SubwindowControl:
HPS.Control HPS.Object

Public Member Functions

override void Dispose ()
 
override HPS.Type ObjectType ()
 
HPS.SubwindowControl SetBackground (HPS.Subwindow.Background in_bg_type, string in_definition_name)
 
HPS.SubwindowControl SetBackground (HPS.Subwindow.Background in_bg_type)
 
HPS.SubwindowControl SetBorder (HPS.Subwindow.Border in_border_type)
 
HPS.SubwindowControl SetModelCompareMode (bool in_state, HPS.SegmentKey in_source1, HPS.SegmentKey in_source2)
 
HPS.SubwindowControl SetModelCompareMode (bool in_state, HPS.SegmentKey in_source1)
 
HPS.SubwindowControl SetModelCompareMode (bool in_state)
 
HPS.SubwindowControl SetModelCompareMode (HPS.SegmentKey in_source1, HPS.SegmentKey in_source2)
 
HPS.SubwindowControl SetRenderingAlgorithm (HPS.Subwindow.RenderingAlgorithm in_hsra)
 
HPS.SubwindowControl SetSubwindow (HPS.Rectangle in_window_position, HPS.Subwindow.Type in_type)
 
HPS.SubwindowControl SetSubwindow (HPS.Rectangle in_window_position)
 
HPS.SubwindowControl SetSubwindow (HPS.Rectangle in_window_position, HPS.IntRectangle in_window_offsets, HPS.Subwindow.Type in_type)
 
HPS.SubwindowControl SetSubwindow (HPS.Rectangle in_window_position, HPS.IntRectangle in_window_offsets)
 
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)
 
 SubwindowControl (HPS.SegmentKey in_seg)
 
 SubwindowControl (HPS.SubwindowControl in_that)
 
override HPS.Type Type ()
 
HPS.SubwindowControl UnsetBackground ()
 
HPS.SubwindowControl UnsetBorder ()
 
HPS.SubwindowControl UnsetEverything ()
 
HPS.SubwindowControl UnsetModelCompareMode ()
 
HPS.SubwindowControl UnsetRenderingAlgorithm ()
 
HPS.SubwindowControl UnsetSubwindow ()
 
- Public Member Functions inherited from HPS.Control
 Control (HPS.Control in_that)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 

Protected Member Functions

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

Additional Inherited Members

- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 
- Protected Attributes inherited from HPS.Object
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

◆ SubwindowControl() [1/2]

HPS.SubwindowControl.SubwindowControl ( HPS.SegmentKey  in_seg)
inline

Initializes a control tied to the segment in_seg.

◆ SubwindowControl() [2/2]

HPS.SubwindowControl.SubwindowControl ( HPS.SubwindowControl  in_that)
inline

Initializes a control tied to the same object as in_that.

Member Function Documentation

◆ ObjectType()

override HPS.Type HPS.SubwindowControl.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.Control.

◆ SetBackground() [1/2]

HPS.SubwindowControl HPS.SubwindowControl.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.SubwindowControl HPS.SubwindowControl.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.SubwindowControl HPS.SubwindowControl.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.SubwindowControl HPS.SubwindowControl.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.SubwindowControl HPS.SubwindowControl.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.SubwindowControl HPS.SubwindowControl.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.SubwindowControl HPS.SubwindowControl.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.SubwindowControl HPS.SubwindowControl.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.
See also
Rendering algorithm default value

◆ SetSubwindow() [1/4]

HPS.SubwindowControl HPS.SubwindowControl.SetSubwindow ( HPS.Rectangle  in_window_position,
HPS.Subwindow.Type  in_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_window_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_typeThe type of subwindow to create.
Returns
A reference to this object.
See also
Subwindowdefault value

◆ SetSubwindow() [2/4]

HPS.SubwindowControl HPS.SubwindowControl.SetSubwindow ( HPS.Rectangle  in_window_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_window_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.
See also
Subwindowdefault value

◆ SetSubwindow() [3/4]

HPS.SubwindowControl HPS.SubwindowControl.SetSubwindow ( HPS.Rectangle  in_window_position,
HPS.IntRectangle  in_window_offsets,
HPS.Subwindow.Type  in_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_window_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_window_offsetsThe pixel-space offsets to apply to each side of the given window position.
in_typeThe type of subwindow to create.
Returns
A reference to this object.
See also
Subwindowdefault value

◆ SetSubwindow() [4/4]

HPS.SubwindowControl HPS.SubwindowControl.SetSubwindow ( HPS.Rectangle  in_window_position,
HPS.IntRectangle  in_window_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_window_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_window_offsetsThe pixel-space offsets to apply to each side of the given window position.
Returns
A reference to this object.
See also
Subwindowdefault value

◆ ShowBackground()

bool HPS.SubwindowControl.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.SubwindowControl.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.SubwindowControl.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.SubwindowControl.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.SubwindowControl.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.

◆ Type()

override HPS.Type HPS.SubwindowControl.Type ( )
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.

Warning
This function must synchronize the database (by waiting for all pending database operations to complete) in order to know the type status of this object with certainty. Therefore this function can negatively impact performance. You should vigorously avoid using this function in high-traffic or peformance-critical areas of your code.
Returns
The true type of the object in question.

Reimplemented from HPS.Control.

◆ UnsetBackground()

HPS.SubwindowControl HPS.SubwindowControl.UnsetBackground ( )
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.

◆ UnsetBorder()

HPS.SubwindowControl HPS.SubwindowControl.UnsetBorder ( )
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.

◆ UnsetEverything()

HPS.SubwindowControl HPS.SubwindowControl.UnsetEverything ( )
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.

◆ UnsetModelCompareMode()

HPS.SubwindowControl HPS.SubwindowControl.UnsetModelCompareMode ( )
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.

◆ UnsetRenderingAlgorithm()

HPS.SubwindowControl HPS.SubwindowControl.UnsetRenderingAlgorithm ( )
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.

◆ UnsetSubwindow()

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