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

Public Member Functions | |
override void | Dispose () |
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... | |
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 starting at the specified 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. This method can only select faceted geometry. 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. This method can only select faceted geometry. 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. This method can only select faceted geometry. 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. This method can only select faceted geometry. 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. This method can only select faceted geometry. 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. This method can only select faceted geometry. 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. If the volume is invalid, i.e., min > max for any component, an exception will be thrown. 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. If the volume is invalid, i.e., min > max for any component, an exception will be thrown. 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... | |
![]() | |
Control (HPS.Control in_that) | |
override 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... | |
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... | |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
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).
Constructor & Destructor Documentation
|
inline |
This constructor creates a SelectionControl object which is tied to the specified window.
- Parameters
-
in_window The window which this SelectionControl should operate on.
|
inline |
The copy constructor creates a SelectionControl object that shares the underlying smart-pointer of the source SelectionControl.
- Parameters
-
in_that The source SelectionControl to copy.
Member Function Documentation
|
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.Control.
|
inline |
Perform a window space area selection starting at the specified segment using the specified selection options.
- Parameters
-
in_area Rectangle in window space at which to perform the selection. in_options Selection options to use when performing the selection. out_results Results of the selection.
- Returns
- Number of selected items.
|
inline |
Perform a window space area selection starting at the specified segment using selection options set in the segment tree.
- Parameters
-
in_area Rectangle in window space at which to perform the selection. out_results Results of the selection.
- Returns
- Number of selected items.
|
inline |
Perform a window space line selection starting at the specified segment using the specified selection options.
- Parameters
-
in_points Line in window space at which to perform the selection. in_options Selection options to use when performing the selection. out_results Results of the selection.
- Returns
- Number of selected items.
|
inline |
Perform a window space line selection starting at the specified segment using the selection options set in the segment tree.
- Parameters
-
in_points Line in window space at which to perform the selection. out_results Results of the selection.
- Returns
- Number of selected items.
|
inline |
Perform a window space point selection starting at the specified segment using the specified selection options.
- Parameters
-
in_location Point in window space at which to perform the selection. in_options Selection options to use when performing the selection. out_results Results of the selection.
- Returns
- Number of selected items.
|
inline |
Perform a window space point selection starting at the specified segment using selection options set in segment tree.
- Parameters
-
in_location Point in window space at which to perform the selection. out_results Results of the selection.
- Returns
- Number of selected items.
|
inline |
Perform a window space polygon selection starting at the specified segment using the specified selection options.
- Parameters
-
in_points Polygon in window space at which to perform the selection. in_options Selection options to use when performing the selection. out_results Results of the selection.
- Returns
- Number of selected items.
|
inline |
Perform a window space polygon selection starting at the specified segment using selection options set in the segment tree.
- Parameters
-
in_points Polygon in window space at which to perform the selection. out_results Results of the selection.
- Returns
- Number of selected items.
|
inline |
Performs an object space selection by ray starting at the specified segment using the specified selection options. This method can only select faceted geometry.
- Parameters
-
in_start_point Start point of ray. in_direction Direction vector for ray. in_options Selection options to use when performing the selection. out_results Results of the selection.
- Returns
- Number of selected items.
|
inline |
Performs an object space selection by ray starting at the specified segment using the selection options set in the segment tree. This method can only select faceted geometry.
- Parameters
-
in_start_point Start point of ray. in_direction Direction vector for ray. out_results Results of the selection.
- Returns
- Number of selected items.
|
inline |
Performs an object space selection by shell starting at the specified segment using the specified selection options. This method can only select faceted geometry.
- Parameters
-
in_shell Shell to use to perform the selection. in_options Selection options to use when performing the selection. out_results Results of the selection.
- Returns
- Number of selected items.
|
inline |
Performs an object space selection by shell starting at the specified segment using the selection options set in the segment tree. This method can only select faceted geometry.
- Parameters
-
in_shell Shell to use to perform the selection. out_results Results of the selection.
- Returns
- Number of selected items.
|
inline |
Performs an object space selection by shell starting at the specified segment using the specified selection options. This method can only select faceted geometry.
- Parameters
-
in_shell Shell in the database to use to perform the selection. in_options Selection options to use when performing the selection. out_results Results of the selection.
- Returns
- Number of selected items.
|
inline |
Performs an object space selection by shell starting at the specified segment using the selection options set in the segment tree. This method can only select faceted geometry.
- Parameters
-
in_shell Shell in the database to use to perform the selection. out_results Results of the selection.
- Returns
- Number of selected items.
|
inline |
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.
- Parameters
-
in_volume Volume to use when performing the selection. in_options Selection options to use when performing the selection. out_results Results of the selection.
- Returns
- Number of selected items.
|
inline |
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.
- Parameters
-
in_volume Volume to use when performing the selection. out_results Results of the selection.
- Returns
- Number of selected items.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.SelectionControl.cs