SelectionControl

class HPS.SelectionControl : public HPS.Control 

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

Public Functions

override void Dispose ()

override HPS.Type ObjectType ()

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

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

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.

Param in_area: Rectangle in window space at which to perform the selection.
Param in_options: Selection options to use when performing the selection.
Param out_results: Results of the selection.
Return: Number of selected items.

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.

Param in_area: Rectangle in window space at which to perform the selection.
Param out_results: Results of the selection.
Return: Number of selected items.

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. Items outside of the frustum can be selected through this method when using Analytic selection.

Param in_points: Line in window space at which to perform the selection.
Param in_options: Selection options to use when performing the selection.
Param out_results: Results of the selection.
Return: Number of selected items.

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. Items outside of the frustum can be selected through this method when using Analytic selection.

Param in_points: Line in window space at which to perform the selection.
Param out_results: Results of the selection.
Return: Number of selected items.

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.

Param in_location: Point in window space at which to perform the selection.
Param in_options: Selection options to use when performing the selection.
Param out_results: Results of the selection.
Return: Number of selected items.

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.

Param in_location: Point in window space at which to perform the selection.
Param out_results: Results of the selection.
Return: Number of selected items.

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. Items outside of the frustum can be selected through this method when using Analytic selection.

Param in_points: Polygon in window space at which to perform the selection.
Param in_options: Selection options to use when performing the selection.
Param out_results: Results of the selection.
Return: Number of selected items.

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. Items outside of the frustum can be selected through this method when using Analytic selection.

Param in_points: Polygon in window space at which to perform the selection.
Param out_results: Results of the selection.
Return: Number of selected items.

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

Param in_start_point: Start point of ray.
Param in_direction: Direction vector for ray.
Param in_options: Selection options to use when performing the selection.
Param out_results: Results of the selection.
Return: Number of selected items.

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

Param in_start_point: Start point of ray.
Param in_direction: Direction vector for ray.
Param out_results: Results of the selection.
Return: Number of selected items.

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.

Param in_shell: Shell in the database to use to perform the selection.
Param in_options: Selection options to use when performing the selection.
Param out_results: Results of the selection.
Return: Number of selected items.

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.

Param in_shell: Shell in the database to use to perform the selection.
Param out_results: Results of the selection.
Return: Number of selected items.

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.

Param in_shell: Shell to use to perform the selection.
Param in_options: Selection options to use when performing the selection.
Param out_results: Results of the selection.
Return: Number of selected items.

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.

Param in_shell: Shell to use to perform the selection.
Param out_results: Results of the selection.
Return: Number of selected items.

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.

Param in_volume: Volume to use when performing the selection.
Param in_options: Selection options to use when performing the selection.
Param out_results: Results of the selection.
Return: Number of selected items.

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.

Param in_volume: Volume to use when performing the selection.
Param out_results: Results of the selection.
Return: Number of selected items.

SelectionControl (HPS.SelectionControl in_that)

The copy constructor creates a SelectionControl object that shares the underlying smart-pointer of the source SelectionControl.

Param in_that: The source SelectionControl to copy.

SelectionControl (HPS.WindowKey in_window)

This constructor creates a SelectionControl object which is tied to the specified window.

Param in_window: The window which this SelectionControl should operate on.