REFERENCE MANUAL
#include <hps.h>
Public Member Functions | |
Type | ObjectType () const |
SelectionControl & | operator= (SelectionControl &&in_that) |
SelectionControl & | operator= (SelectionControl const &in_that) |
size_t | SelectByArea (Rectangle const &in_area, SelectionOptionsKit const &in_options, SelectionResults &out_results) const |
size_t | SelectByArea (Rectangle const &in_area, SelectionResults &out_results) const |
size_t | SelectByLine (PointArray const &in_points, SelectionOptionsKit const &in_options, SelectionResults &out_results) const |
size_t | SelectByLine (PointArray const &in_points, SelectionResults &out_results) const |
size_t | SelectByLine (size_t in_point_count, Point const in_points[], SelectionOptionsKit const &in_options, SelectionResults &out_results) const |
size_t | SelectByLine (size_t in_point_count, Point const in_points[], SelectionResults &out_results) const |
size_t | SelectByPoint (Point const &in_location, SelectionOptionsKit const &in_options, SelectionResults &out_results) const |
size_t | SelectByPoint (Point const &in_location, SelectionResults &out_results) const |
size_t | SelectByPolygon (PointArray const &in_points, SelectionOptionsKit const &in_options, SelectionResults &out_results) const |
size_t | SelectByPolygon (PointArray const &in_points, SelectionResults &out_results) const |
size_t | SelectByPolygon (size_t in_point_count, Point const in_points[], SelectionOptionsKit const &in_options, SelectionResults &out_results) const |
size_t | SelectByPolygon (size_t in_point_count, Point const in_points[], SelectionResults &out_results) const |
size_t | SelectByRay (Point const &in_start_point, Vector const &in_direction, SelectionOptionsKit const &in_options, SelectionResults &out_results) |
size_t | SelectByRay (Point const &in_start_point, Vector const &in_direction, SelectionResults &out_results) |
size_t | SelectByShell (ShellKit const &in_shell, SelectionOptionsKit const &in_options, SelectionResults &out_results) |
size_t | SelectByShell (ShellKit const &in_shell, SelectionResults &out_results) |
size_t | SelectByShell (ShellKey const &in_shell, SelectionOptionsKit const &in_options, SelectionResults &out_results) |
size_t | SelectByShell (ShellKey const &in_shell, SelectionResults &out_results) |
size_t | SelectByVolume (SimpleCuboid const &in_volume, SelectionOptionsKit const &in_options, SelectionResults &out_results) |
size_t | SelectByVolume (SimpleCuboid const &in_volume, SelectionResults &out_results) |
SelectionControl (WindowKey const &in_window) | |
SelectionControl (SelectionControl const &in_that) | |
SelectionControl (SelectionControl &&in_that) | |
![]() | |
virtual bool | Empty () const |
intptr_t | GetClassID () const |
intptr_t | GetInstanceID () const |
bool | HasType (Type in_mask) const |
Object (Object &&in_that) | |
Object & | operator= (Object const &other_object) |
Object & | operator= (Object &&in_that) |
virtual void | Reset () |
Type | Type () const |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
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).
|
explicit |
This constructor creates a SelectionControl object which is tied to the specified window.
in_window | The window which this SelectionControl should operate on. |
SelectionControl::SelectionControl | ( | SelectionControl const & | in_that | ) |
The copy constructor creates a SelectionControl object that shares the underlying smart-pointer of the source SelectionControl.
in_that | The source SelectionControl to copy. |
SelectionControl::SelectionControl | ( | SelectionControl && | in_that | ) |
The move constructor creates a SelectionControl by transferring the underlying impl of the rvalue reference to this SelectionControl thereby avoiding a copy and allocation.
in_that | An rvalue reference to a SelectionControl to take the impl from. |
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from Object.
SelectionControl& SelectionControl::operator= | ( | SelectionControl && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this SelectionControl thereby avoiding a copy.
in_that | An rvalue reference to a SelectionControl to take the impl from. |
SelectionControl& SelectionControl::operator= | ( | SelectionControl const & | in_that | ) |
Share the underlying smart-pointer of the SelectionControl source.
in_that | The SelectionControl source of the assignment. |
size_t SelectionControl::SelectByArea | ( | Rectangle const & | in_area, |
SelectionOptionsKit const & | in_options, | ||
SelectionResults & | out_results | ||
) | const |
Perform a window space area selection starting at the specified segment using the specified selection options.
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. |
size_t SelectionControl::SelectByArea | ( | Rectangle const & | in_area, |
SelectionResults & | out_results | ||
) | const |
Perform a window space area selection starting at the specified segment using selection options set in the segment tree.
in_area | Rectangle in window space at which to perform the selection. |
out_results | Results of the selection. |
size_t SelectionControl::SelectByLine | ( | PointArray const & | in_points, |
SelectionOptionsKit const & | in_options, | ||
SelectionResults & | out_results | ||
) | const |
Perform a window space line selection starting at the specified segment using the specified selection options.
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. |
size_t SelectionControl::SelectByLine | ( | PointArray const & | in_points, |
SelectionResults & | out_results | ||
) | const |
Perform a window space line selection starting at the specified segment using the selection options set in the segment tree.
in_points | Line in window space at which to perform the selection. |
out_results | Results of the selection. |
size_t SelectionControl::SelectByLine | ( | size_t | in_point_count, |
Point const | in_points[], | ||
SelectionOptionsKit const & | in_options, | ||
SelectionResults & | out_results | ||
) | const |
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 | 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. |
size_t SelectionControl::SelectByLine | ( | size_t | in_point_count, |
Point const | in_points[], | ||
SelectionResults & | out_results | ||
) | const |
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 | Line in window space at which to perform the selection. |
out_results | Results of the selection. |
size_t SelectionControl::SelectByPoint | ( | Point const & | in_location, |
SelectionOptionsKit const & | in_options, | ||
SelectionResults & | out_results | ||
) | const |
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 | Selection options to use when performing the selection. |
out_results | Results of the selection. |
size_t SelectionControl::SelectByPoint | ( | Point const & | in_location, |
SelectionResults & | out_results | ||
) | const |
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. |
size_t SelectionControl::SelectByPolygon | ( | PointArray const & | in_points, |
SelectionOptionsKit const & | in_options, | ||
SelectionResults & | out_results | ||
) | const |
Perform a window space polygon selection starting at the specified segment using the specified selection options.
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. |
size_t SelectionControl::SelectByPolygon | ( | PointArray const & | in_points, |
SelectionResults & | out_results | ||
) | const |
Perform a window space polygon selection starting at the specified segment using selection options set in the segment tree.
in_points | Polygon in window space at which to perform the selection. |
out_results | Results of the selection. |
size_t SelectionControl::SelectByPolygon | ( | size_t | in_point_count, |
Point const | in_points[], | ||
SelectionOptionsKit const & | in_options, | ||
SelectionResults & | out_results | ||
) | const |
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 | Selection options to use when performing the selection. |
out_results | Results of the selection. |
size_t SelectionControl::SelectByPolygon | ( | size_t | in_point_count, |
Point const | in_points[], | ||
SelectionResults & | out_results | ||
) | const |
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. |
size_t SelectionControl::SelectByRay | ( | Point const & | in_start_point, |
Vector const & | in_direction, | ||
SelectionOptionsKit const & | in_options, | ||
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 | Selection options to use when performing the selection. |
out_results | Results of the selection. |
size_t SelectionControl::SelectByRay | ( | Point const & | in_start_point, |
Vector const & | in_direction, | ||
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. |
size_t SelectionControl::SelectByShell | ( | ShellKit const & | in_shell, |
SelectionOptionsKit const & | in_options, | ||
SelectionResults & | out_results | ||
) |
Performs an object space selection by shell starting at the specified segment using the specified selection options.
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. |
size_t SelectionControl::SelectByShell | ( | ShellKit const & | in_shell, |
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 | Shell to use to perform the selection. |
out_results | Results of the selection. |
size_t SelectionControl::SelectByShell | ( | ShellKey const & | in_shell, |
SelectionOptionsKit const & | in_options, | ||
SelectionResults & | out_results | ||
) |
Performs an object space selection by shell starting at the specified segment using the specified selection options.
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. |
size_t SelectionControl::SelectByShell | ( | ShellKey const & | in_shell, |
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 | Shell in the database to use to perform the selection. |
out_results | Results of the selection. |
size_t SelectionControl::SelectByVolume | ( | SimpleCuboid const & | in_volume, |
SelectionOptionsKit const & | in_options, | ||
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 | Selection options to use when performing the selection. |
out_results | Results of the selection. |
size_t SelectionControl::SelectByVolume | ( | SimpleCuboid const & | in_volume, |
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. |