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

Public Member Functions

override void Dispose ()
 
override HPS.Type ObjectType ()
 
ulong SelectByArea (HPS.Rectangle in_area, HPS.SelectionOptionsKit in_options, out HPS.SelectionResults out_results)
 
ulong SelectByArea (HPS.Rectangle in_area, out HPS.SelectionResults out_results)
 
ulong SelectByLine (HPS.Point[] in_points, HPS.SelectionOptionsKit in_options, out HPS.SelectionResults out_results)
 
ulong SelectByLine (HPS.Point[] in_points, out HPS.SelectionResults out_results)
 
ulong SelectByPoint (HPS.Point in_location, HPS.SelectionOptionsKit in_options, out HPS.SelectionResults out_results)
 
ulong SelectByPoint (HPS.Point in_location, out HPS.SelectionResults out_results)
 
ulong SelectByPolygon (HPS.Point[] in_points, HPS.SelectionOptionsKit in_options, out HPS.SelectionResults out_results)
 
ulong SelectByPolygon (HPS.Point[] in_points, out HPS.SelectionResults out_results)
 
ulong SelectByRay (HPS.Point in_start_point, HPS.Vector in_direction, HPS.SelectionOptionsKit in_options, out HPS.SelectionResults out_results)
 
ulong SelectByRay (HPS.Point in_start_point, HPS.Vector in_direction, out HPS.SelectionResults out_results)
 
ulong SelectByShell (HPS.ShellKit in_shell, HPS.SelectionOptionsKit in_options, out HPS.SelectionResults out_results)
 
ulong SelectByShell (HPS.ShellKit in_shell, out HPS.SelectionResults out_results)
 
ulong SelectByShell (HPS.ShellKey in_shell, HPS.SelectionOptionsKit in_options, out HPS.SelectionResults out_results)
 
ulong SelectByShell (HPS.ShellKey in_shell, out HPS.SelectionResults out_results)
 
ulong SelectByVolume (HPS.SimpleCuboid in_volume, HPS.SelectionOptionsKit in_options, out HPS.SelectionResults out_results)
 
ulong SelectByVolume (HPS.SimpleCuboid in_volume, out HPS.SelectionResults out_results)
 
 SelectionControl (HPS.WindowKey in_window)
 
 SelectionControl (HPS.SelectionControl in_that)
 
- Public Member Functions inherited from HPS.Control
 Control (HPS.Control in_that)
 
override HPS.Type Type ()
 
- 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 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

◆ SelectionControl() [1/2]

HPS.SelectionControl.SelectionControl ( HPS.WindowKey  in_window)
inline

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

Parameters
in_windowThe window which this SelectionControl should operate on.

◆ SelectionControl() [2/2]

HPS.SelectionControl.SelectionControl ( HPS.SelectionControl  in_that)
inline

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

Parameters
in_thatThe source SelectionControl to copy.

Member Function Documentation

◆ ObjectType()

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

◆ SelectByArea() [1/2]

ulong HPS.SelectionControl.SelectByArea ( HPS.Rectangle  in_area,
HPS.SelectionOptionsKit  in_options,
out HPS.SelectionResults  out_results 
)
inline

Perform a window space area selection starting at the specified segment using the specified selection options.

Parameters
in_areaRectangle in window space at which to perform the selection.
in_optionsSelection options to use when performing the selection.
out_resultsResults of the selection.
Returns
Number of selected items.

◆ SelectByArea() [2/2]

ulong HPS.SelectionControl.SelectByArea ( HPS.Rectangle  in_area,
out HPS.SelectionResults  out_results 
)
inline

Perform a window space area selection starting at the specified segment using selection options set in the segment tree.

Parameters
in_areaRectangle in window space at which to perform the selection.
out_resultsResults of the selection.
Returns
Number of selected items.

◆ SelectByLine() [1/2]

ulong HPS.SelectionControl.SelectByLine ( HPS.Point []  in_points,
HPS.SelectionOptionsKit  in_options,
out HPS.SelectionResults  out_results 
)
inline

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.

Parameters
in_pointsLine in window space at which to perform the selection.
in_optionsSelection options to use when performing the selection.
out_resultsResults of the selection.
Returns
Number of selected items.

◆ SelectByLine() [2/2]

ulong HPS.SelectionControl.SelectByLine ( HPS.Point []  in_points,
out HPS.SelectionResults  out_results 
)
inline

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.

Parameters
in_pointsLine in window space at which to perform the selection.
out_resultsResults of the selection.
Returns
Number of selected items.

◆ SelectByPoint() [1/2]

ulong HPS.SelectionControl.SelectByPoint ( HPS.Point  in_location,
HPS.SelectionOptionsKit  in_options,
out HPS.SelectionResults  out_results 
)
inline

Perform a window space point selection starting at the specified segment using the specified selection options.

Parameters
in_locationPoint in window space at which to perform the selection.
in_optionsSelection options to use when performing the selection.
out_resultsResults of the selection.
Returns
Number of selected items.

◆ SelectByPoint() [2/2]

ulong HPS.SelectionControl.SelectByPoint ( HPS.Point  in_location,
out HPS.SelectionResults  out_results 
)
inline

Perform a window space point selection starting at the specified segment using selection options set in segment tree.

Parameters
in_locationPoint in window space at which to perform the selection.
out_resultsResults of the selection.
Returns
Number of selected items.

◆ SelectByPolygon() [1/2]

ulong HPS.SelectionControl.SelectByPolygon ( HPS.Point []  in_points,
HPS.SelectionOptionsKit  in_options,
out HPS.SelectionResults  out_results 
)
inline

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.

Parameters
in_pointsPolygon in window space at which to perform the selection.
in_optionsSelection options to use when performing the selection.
out_resultsResults of the selection.
Returns
Number of selected items.

◆ SelectByPolygon() [2/2]

ulong HPS.SelectionControl.SelectByPolygon ( HPS.Point []  in_points,
out HPS.SelectionResults  out_results 
)
inline

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.

Parameters
in_pointsPolygon in window space at which to perform the selection.
out_resultsResults of the selection.
Returns
Number of selected items.

◆ SelectByRay() [1/2]

ulong HPS.SelectionControl.SelectByRay ( HPS.Point  in_start_point,
HPS.Vector  in_direction,
HPS.SelectionOptionsKit  in_options,
out HPS.SelectionResults  out_results 
)
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_pointStart point of ray.
in_directionDirection vector for ray.
in_optionsSelection options to use when performing the selection.
out_resultsResults of the selection.
Returns
Number of selected items.

◆ SelectByRay() [2/2]

ulong HPS.SelectionControl.SelectByRay ( HPS.Point  in_start_point,
HPS.Vector  in_direction,
out HPS.SelectionResults  out_results 
)
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_pointStart point of ray.
in_directionDirection vector for ray.
out_resultsResults of the selection.
Returns
Number of selected items.

◆ SelectByShell() [1/4]

ulong HPS.SelectionControl.SelectByShell ( HPS.ShellKit  in_shell,
HPS.SelectionOptionsKit  in_options,
out HPS.SelectionResults  out_results 
)
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_shellShell to use to perform the selection.
in_optionsSelection options to use when performing the selection.
out_resultsResults of the selection.
Returns
Number of selected items.

◆ SelectByShell() [2/4]

ulong HPS.SelectionControl.SelectByShell ( HPS.ShellKit  in_shell,
out HPS.SelectionResults  out_results 
)
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_shellShell to use to perform the selection.
out_resultsResults of the selection.
Returns
Number of selected items.

◆ SelectByShell() [3/4]

ulong HPS.SelectionControl.SelectByShell ( HPS.ShellKey  in_shell,
HPS.SelectionOptionsKit  in_options,
out HPS.SelectionResults  out_results 
)
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_shellShell in the database to use to perform the selection.
in_optionsSelection options to use when performing the selection.
out_resultsResults of the selection.
Returns
Number of selected items.

◆ SelectByShell() [4/4]

ulong HPS.SelectionControl.SelectByShell ( HPS.ShellKey  in_shell,
out HPS.SelectionResults  out_results 
)
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_shellShell in the database to use to perform the selection.
out_resultsResults of the selection.
Returns
Number of selected items.

◆ SelectByVolume() [1/2]

ulong HPS.SelectionControl.SelectByVolume ( HPS.SimpleCuboid  in_volume,
HPS.SelectionOptionsKit  in_options,
out HPS.SelectionResults  out_results 
)
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_volumeVolume to use when performing the selection.
in_optionsSelection options to use when performing the selection.
out_resultsResults of the selection.
Returns
Number of selected items.

◆ SelectByVolume() [2/2]

ulong HPS.SelectionControl.SelectByVolume ( HPS.SimpleCuboid  in_volume,
out HPS.SelectionResults  out_results 
)
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_volumeVolume to use when performing the selection.
out_resultsResults 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