REFERENCE MANUAL
The SelectionControl class is a smart pointer that is tied to a database object. More...
Public Member Functions | |
override void | Dispose () |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
ulong | SelectByArea (HPS.Rectangle in_area, HPS.SelectionOptionsKit in_options, out HPS.SelectionResults out_results) |
Perform a window space area selection starting at the specified segment using the specified selection options. More... | |
ulong | SelectByArea (HPS.Rectangle in_area, out HPS.SelectionResults out_results) |
Perform a window space area selection starting at the specified segment using selection options set in the segment tree. More... | |
ulong | SelectByLine (HPS.Point[] in_points, HPS.SelectionOptionsKit in_options, out HPS.SelectionResults out_results) |
Perform a window space line selection starting at the specified segment using the specified selection options. More... | |
ulong | SelectByLine (HPS.Point[] in_points, out HPS.SelectionResults out_results) |
Perform a window space line selection with the specified line and start segment using the selection options set in the segment tree. More... | |
ulong | SelectByPoint (HPS.Point in_location, HPS.SelectionOptionsKit in_options, out HPS.SelectionResults out_results) |
Perform a window space point selection starting at the specified segment using the specified selection options. More... | |
ulong | SelectByPoint (HPS.Point in_location, out HPS.SelectionResults out_results) |
Perform a window space point selection starting at the specified segment using selection options set in segment tree. More... | |
ulong | SelectByPolygon (HPS.Point[] in_points, HPS.SelectionOptionsKit in_options, out HPS.SelectionResults out_results) |
Perform a window space polygon selection starting at the specified segment using the specified selection options. More... | |
ulong | SelectByPolygon (HPS.Point[] in_points, out HPS.SelectionResults out_results) |
Perform a window space polygon selection starting at the specified segment using selection options set in the segment tree. More... | |
ulong | SelectByRay (HPS.Point in_start_point, HPS.Vector in_direction, HPS.SelectionOptionsKit in_options, out HPS.SelectionResults out_results) |
Performs an object space selection by ray starting at the specified segment using the specified selection options. More... | |
ulong | SelectByRay (HPS.Point in_start_point, HPS.Vector in_direction, out HPS.SelectionResults out_results) |
Performs an object space selection by ray starting at the specified segment using the selection options set in the segment tree. More... | |
ulong | SelectByShell (HPS.ShellKit in_shell, HPS.SelectionOptionsKit in_options, out HPS.SelectionResults out_results) |
Performs an object space selection by shell starting at the specified segment using the specified selection options. More... | |
ulong | SelectByShell (HPS.ShellKit in_shell, out HPS.SelectionResults out_results) |
Performs an object space selection by shell starting at the specified segment using the selection options set in the segment tree. More... | |
ulong | SelectByShell (HPS.ShellKey in_shell, HPS.SelectionOptionsKit in_options, out HPS.SelectionResults out_results) |
Performs an object space selection by shell starting at the specified segment using the specified selection options. More... | |
ulong | SelectByShell (HPS.ShellKey in_shell, out HPS.SelectionResults out_results) |
Performs an object space selection by shell starting at the specified segment using the selection options set in the segment tree. More... | |
ulong | SelectByVolume (HPS.SimpleCuboid in_volume, HPS.SelectionOptionsKit in_options, out HPS.SelectionResults out_results) |
Performs an object space selection by volume starting at the specified segment using the specified selection options. More... | |
ulong | SelectByVolume (HPS.SimpleCuboid in_volume, out HPS.SelectionResults out_results) |
Performs an object space selection by volume starting at the specified segment using the selection options set in the segment tree. More... | |
SelectionControl (HPS.WindowKey in_window) | |
This constructor creates a SelectionControl object which is tied to the specified window. More... | |
SelectionControl (HPS.SelectionControl in_that) | |
The copy constructor creates a SelectionControl object that shares the underlying smart-pointer of the source SelectionControl. More... | |
![]() | |
virtual bool | Empty () |
Indicates whether this object has any values set on it. More... | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object in_that) | |
The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More... | |
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. More... | |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
The SelectionControl class is a smart pointer that is tied to a database object.
It is used to perform both window space selections (by point, by area, by polygon, by line) and object space selections (by shell, by volume, by ray).
HPS.SelectionControl.SelectionControl | ( | HPS.WindowKey | in_window | ) |
This constructor creates a SelectionControl object which is tied to the specified window.
in_window | The window which this <ref refid="class_h_p_s_1_1_selection_control" kindref="compound">SelectionControl</ref> should operate on. |
HPS.SelectionControl.SelectionControl | ( | HPS.SelectionControl | in_that | ) |
The copy constructor creates a SelectionControl object that shares the underlying smart-pointer of the source SelectionControl.
in_that | The source <ref refid="class_h_p_s_1_1_selection_control" kindref="compound">SelectionControl</ref> to copy. |
|
virtual |
This function returns the type the object, as declared.
This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.Object.
ulong HPS.SelectionControl.SelectByArea | ( | HPS.Rectangle | in_area, |
HPS.SelectionOptionsKit | in_options, | ||
out HPS.SelectionResults | out_results | ||
) |
Perform a window space area selection starting at the specified segment using the specified selection options.
in_area | <ref refid="struct_h_p_s_1_1_rectangle" kindref="compound">Rectangle</ref> in window space at which to perform the selection. |
in_options | <ref refid="class_h_p_s_1_1_selection" kindref="compound">Selection</ref> options to use when performing the selection. |
out_results | Results of the selection. |
ulong HPS.SelectionControl.SelectByArea | ( | HPS.Rectangle | in_area, |
out HPS.SelectionResults | out_results | ||
) |
Perform a window space area selection starting at the specified segment using selection options set in the segment tree.
in_area | <ref refid="struct_h_p_s_1_1_rectangle" kindref="compound">Rectangle</ref> in window space at which to perform the selection. |
out_results | Results of the selection. |
ulong HPS.SelectionControl.SelectByLine | ( | HPS.Point[] | in_points, |
HPS.SelectionOptionsKit | in_options, | ||
out HPS.SelectionResults | out_results | ||
) |
Perform a window space line selection starting at the specified segment using the specified selection options.
in_point_count | Size of the following array. |
in_points | <ref refid="class_h_p_s_1_1_line" kindref="compound">Line</ref> in window space at which to perform the selection. |
in_options | <ref refid="class_h_p_s_1_1_selection" kindref="compound">Selection</ref> options to use when performing the selection. |
out_results | Results of the selection. |
ulong HPS.SelectionControl.SelectByLine | ( | HPS.Point[] | in_points, |
out HPS.SelectionResults | out_results | ||
) |
Perform a window space line selection with the specified line and start segment using the selection options set in the segment tree.
in_point_count | Size of the following array. |
in_points | <ref refid="class_h_p_s_1_1_line" kindref="compound">Line</ref> in window space at which to perform the selection. |
out_results | Results of the selection. |
ulong HPS.SelectionControl.SelectByPoint | ( | HPS.Point | in_location, |
HPS.SelectionOptionsKit | in_options, | ||
out HPS.SelectionResults | out_results | ||
) |
Perform a window space point selection starting at the specified segment using the specified selection options.
in_location | Point in window space at which to perform the selection. |
in_options | <ref refid="class_h_p_s_1_1_selection" kindref="compound">Selection</ref> options to use when performing the selection. |
out_results | Results of the selection. |
ulong HPS.SelectionControl.SelectByPoint | ( | HPS.Point | in_location, |
out HPS.SelectionResults | out_results | ||
) |
Perform a window space point selection starting at the specified segment using selection options set in segment tree.
in_location | Point in window space at which to perform the selection. |
out_results | Results of the selection. |
ulong HPS.SelectionControl.SelectByPolygon | ( | HPS.Point[] | in_points, |
HPS.SelectionOptionsKit | in_options, | ||
out HPS.SelectionResults | out_results | ||
) |
Perform a window space polygon selection starting at the specified segment using the specified selection options.
in_point_count | Size of the following array. |
in_points | Polygon in window space for the polygon at which to perform the selection. |
in_options | <ref refid="class_h_p_s_1_1_selection" kindref="compound">Selection</ref> options to use when performing the selection. |
out_results | Results of the selection. |
ulong HPS.SelectionControl.SelectByPolygon | ( | HPS.Point[] | in_points, |
out HPS.SelectionResults | out_results | ||
) |
Perform a window space polygon selection starting at the specified segment using selection options set in the segment tree.
in_point_count | Size of the following array. |
in_points | Polygon in window space at which to perform the selection. |
out_results | Results of the selection. |
ulong HPS.SelectionControl.SelectByRay | ( | HPS.Point | in_start_point, |
HPS.Vector | in_direction, | ||
HPS.SelectionOptionsKit | in_options, | ||
out HPS.SelectionResults | out_results | ||
) |
Performs an object space selection by ray starting at the specified segment using the specified selection options.
in_start_point | Start point of ray. |
in_direction | Direction vector for ray. |
in_options | <ref refid="class_h_p_s_1_1_selection" kindref="compound">Selection</ref> options to use when performing the selection. |
out_results | Results of the selection. |
ulong HPS.SelectionControl.SelectByRay | ( | HPS.Point | in_start_point, |
HPS.Vector | in_direction, | ||
out HPS.SelectionResults | out_results | ||
) |
Performs an object space selection by ray starting at the specified segment using the selection options set in the segment tree.
in_start_point | Start point of ray. |
in_direction | Direction vector for ray. |
out_results | Results of the selection. |
ulong HPS.SelectionControl.SelectByShell | ( | HPS.ShellKit | in_shell, |
HPS.SelectionOptionsKit | in_options, | ||
out HPS.SelectionResults | out_results | ||
) |
Performs an object space selection by shell starting at the specified segment using the specified selection options.
in_shell | <ref refid="class_h_p_s_1_1_shell" kindref="compound">Shell</ref> to use to perform the selection. |
in_options | <ref refid="class_h_p_s_1_1_selection" kindref="compound">Selection</ref> options to use when performing the selection. |
out_results | Results of the selection. |
ulong HPS.SelectionControl.SelectByShell | ( | HPS.ShellKit | in_shell, |
out HPS.SelectionResults | out_results | ||
) |
Performs an object space selection by shell starting at the specified segment using the selection options set in the segment tree.
in_shell | <ref refid="class_h_p_s_1_1_shell" kindref="compound">Shell</ref> to use to perform the selection. |
out_results | Results of the selection. |
ulong HPS.SelectionControl.SelectByShell | ( | HPS.ShellKey | in_shell, |
HPS.SelectionOptionsKit | in_options, | ||
out HPS.SelectionResults | out_results | ||
) |
Performs an object space selection by shell starting at the specified segment using the specified selection options.
in_shell | <ref refid="class_h_p_s_1_1_shell" kindref="compound">Shell</ref> to use to perform the selection. |
in_options | <ref refid="class_h_p_s_1_1_selection" kindref="compound">Selection</ref> options to use when performing the selection. |
out_results | Results of the selection. |
ulong HPS.SelectionControl.SelectByShell | ( | HPS.ShellKey | in_shell, |
out HPS.SelectionResults | out_results | ||
) |
Performs an object space selection by shell starting at the specified segment using the selection options set in the segment tree.
in_shell | <ref refid="class_h_p_s_1_1_shell" kindref="compound">Shell</ref> to use to perform the selection. |
out_results | Results of the selection. |
ulong HPS.SelectionControl.SelectByVolume | ( | HPS.SimpleCuboid | in_volume, |
HPS.SelectionOptionsKit | in_options, | ||
out HPS.SelectionResults | out_results | ||
) |
Performs an object space selection by volume starting at the specified segment using the specified selection options.
If the volume is invalid, i.e., min > max for any component, an exception will be thrown.
in_volume | Volume to use when performing the selection. |
in_options | <ref refid="class_h_p_s_1_1_selection" kindref="compound">Selection</ref> options to use when performing the selection. |
out_results | Results of the selection. |
ulong HPS.SelectionControl.SelectByVolume | ( | HPS.SimpleCuboid | in_volume, |
out HPS.SelectionResults | out_results | ||
) |
Performs an object space selection by volume starting at the specified segment using the selection options set in the segment tree.
If the volume is invalid, i.e., min > max for any component, an exception will be thrown.
in_volume | Volume to use when performing the selection. |
out_results | Results of the selection. |