Public Member Functions | Protected Member Functions | List of all members
HPS.SubwindowControl Class Reference

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

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

Public Member Functions

override void Dispose ()
 
 SubwindowControl (HPS.SegmentKey in_seg)
 Initializes a control tied to the segment in_seg. More...
 
 SubwindowControl (HPS.SubwindowControl in_that)
 Initializes a control tied to the same object as in_that. More...
 
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...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
HPS.SubwindowControl SetModelCompareMode (bool in_state)
 Sets 'model compare' rendering mode which displays a visual diff between the two source segments in this subwindow. More...
 
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. More...
 
HPS.SubwindowControl UnsetSubwindow ()
 Removes a subwindow setting. More...
 
HPS.SubwindowControl UnsetBackground ()
 Removes a subwindow background setting. More...
 
HPS.SubwindowControl UnsetBorder ()
 Removes a subwindow border setting. More...
 
HPS.SubwindowControl UnsetRenderingAlgorithm ()
 Removes a rendering algorithm setting. More...
 
HPS.SubwindowControl UnsetModelCompareMode ()
 Removes model compare setting. More...
 
HPS.SubwindowControl UnsetEverything ()
 Removes all settings from this object. More...
 
bool ShowSubwindow (out HPS.Rectangle out_subwindow_position, out HPS.Subwindow.Type out_subwindow_type)
 Shows the subwindow setting. 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 ShowRenderingAlgorithm (out HPS.Subwindow.RenderingAlgorithm out_hsra)
 Shows the rendering algorithm setting. More...
 
bool ShowModelCompareMode (out bool out_state, out HPS.SegmentKey out_source1, out HPS.SegmentKey out_source2)
 Shows the model compare setting. More...
 
- Public Member Functions inherited from HPS.Control
 Control (HPS.Control in_that)
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
 Object (HPS.Object that)
 
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...
 
virtual bool Empty ()
 Indicates whether this object has any values set on it. More...
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
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...
 

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
HandleRef cptr
 
HandleRef scptr
 
bool cMemOwn
 

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

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

Initializes a control tied to the segment in_seg.

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

Initializes a control tied to the same object as in_that.

Member Function Documentation

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

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

Rendering algorithm default value

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.

Returns
A reference to this object.

Subwindowdefault value

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.

Returns
A reference to this object.

Subwindowdefault value

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.
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.
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.
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.
bool HPS.SubwindowControl.ShowSubwindow ( out HPS.Rectangle  out_subwindow_position,
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_typeThe type of subwindow to create.
Returns
true if the setting is valid, false otherwise.
HPS.SubwindowControl HPS.SubwindowControl.UnsetBackground ( )
inline

Removes a subwindow background setting.

Returns
A reference to this object.
HPS.SubwindowControl HPS.SubwindowControl.UnsetBorder ( )
inline

Removes a subwindow border setting.

Returns
A reference to this object.
HPS.SubwindowControl HPS.SubwindowControl.UnsetEverything ( )
inline

Removes all settings from this object.

Returns
A reference to this object.
HPS.SubwindowControl HPS.SubwindowControl.UnsetModelCompareMode ( )
inline

Removes model compare setting.

Returns
A reference to this object.
HPS.SubwindowControl HPS.SubwindowControl.UnsetRenderingAlgorithm ( )
inline

Removes a rendering algorithm setting.

Returns
A reference to this object.
HPS.SubwindowControl HPS.SubwindowControl.UnsetSubwindow ( )
inline

Removes a subwindow setting.

Returns
A reference to this object.

The documentation for this class was generated from the following file: