REFERENCE MANUAL
#include <hps.h>
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
![]() | |
Control (Control &&in_that) | |
Control & | operator= (Control &&in_that) |
The SelectionOptionsControl class is a smart pointer that is tied to a database object. It is used to set selection related options on a WindowKey. Options include the selection algorithm, granularity, internal limit, related limit, level, proximity, and sorting. Default values for the various fields of SelectionOptionsControl can be found here.
|
explicit |
This constructor creates a SelectionOptionsControl object which is tied to the specified window.
in_window | The window which this SelectionOptionsControl should operate on. |
SelectionOptionsControl::SelectionOptionsControl | ( | SelectionOptionsControl const & | in_that | ) |
The copy constructor creates a SelectionOptionsControl object that shares the underlying smart-pointer of the source SelectionOptionsControl.
in_that | The source SelectionOptionsControl to copy. |
SelectionOptionsControl::SelectionOptionsControl | ( | SelectionOptionsControl && | in_that | ) |
The move constructor creates a SelectionOptionsControl by transferring the underlying impl of the rvalue reference to this SelectionOptionsControl thereby avoiding a copy and allocation.
in_that | An rvalue reference to a SelectionOptionsControl 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 Control.
SelectionOptionsControl& SelectionOptionsControl::operator= | ( | SelectionOptionsControl && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this SelectionOptionsControl thereby avoiding a copy.
in_that | An rvalue reference to a SelectionOptionsControl to take the impl from. |
SelectionOptionsControl& SelectionOptionsControl::operator= | ( | SelectionOptionsControl const & | in_that | ) |
Share the underlying smart-pointer of the SelectionOptionsControl source.
in_that | The SelectionOptionsControl source of the assignment. |
SelectionOptionsControl& SelectionOptionsControl::SetAlgorithm | ( | Selection::Algorithm | in_algorithm | ) |
Sets the type of selection algorithm to use. This setting has no effect on object space selections (i.e., select by shell, volume and ray).
in_algorithm | The type of selection algorithm to use. |
SelectionOptionsControl& SelectionOptionsControl::SetDeferralExtentCullingRespected | ( | bool | in_state | ) |
Sets whether to respect the deferral extent culling option during selection. If this value is set to false, the deferral extent culling option (see CullingControl) will be ignored.
in_state | Whether to respect the deferral extent culling option during selection. |
SelectionOptionsControl& SelectionOptionsControl::SetExtentCullingRespected | ( | bool | in_state | ) |
Sets whether to respect the extent culling option during selection. If this value is set to false, the extent culling option (see CullingControl) will be ignored.
in_state | Whether to respect the extent culling option during selection. |
SelectionOptionsControl& SelectionOptionsControl::SetFrustumCullingRespected | ( | bool | in_state | ) |
Sets whether to respect the frustum culling option during selection. If this value is set to false, the frustum culling option (see CullingControl) will be ignored.
in_state | Whether to respect the frustum culling option during selection. |
SelectionOptionsControl& SelectionOptionsControl::SetGranularity | ( | Selection::Granularity | in_granularity | ) |
Sets the selection granularity to use.
in_granularity | The selection granularity to use. |
SelectionOptionsControl& SelectionOptionsControl::SetInternalLimit | ( | size_t | in_limit | ) |
Sets the internal selection limit. The internal selection limit is the maximum number of subentities for shells and meshes that will be returned if performing subentity selection.
in_limit | The internal selection limit. |
SelectionOptionsControl& SelectionOptionsControl::SetLevel | ( | Selection::Level | in_level | ) |
Sets the level at which selection will occur.
in_level | The level at which selection will occur. |
SelectionOptionsControl& SelectionOptionsControl::SetProximity | ( | float | in_proximity | ) |
Sets the selection proximity in centimeters. This will throw an exception if a negative proximity value is specified.
in_proximity | The radius around the selection point within which objects will be returned as selected. The value must be nonnegative. |
SelectionOptionsControl& SelectionOptionsControl::SetRelatedLimit | ( | size_t | in_limit | ) |
Sets the related selection limit. The related selection limit is the maximum number of items that will be returned as selected when performing a selection. A related selection limit of 0 would result in only the first item getting returned. If the value is greater than 0, this indicates the number of additional items beyond the first to return. The order of these additional items will depend on whether sorting is enabled (see SetSorting).
in_limit | Limit on the number of items that will be returned as selected when performing a selection. |
SelectionOptionsControl& SelectionOptionsControl::SetSorting | ( | bool | in_sorted | ) |
Sets whether to sort selection results by relevance. For selection by area or ray, this means sorting results front to back. For all other types of selection, it means sorting results by proximity. This is only relevant if the related selection limit is greater than 0 (see SetRelatedLimit).
in_sorted | Whether to sort selection results by relevance. |
SelectionOptionsControl& SelectionOptionsControl::SetVectorCullingRespected | ( | bool | in_state | ) |
Sets whether to respect the vector culling option during selection. If this value is set to false, the vector culling option (see CullingControl) will be ignored.
in_state | Whether to respect the vector culling option during selection. |
bool SelectionOptionsControl::ShowAlgorithm | ( | Selection::Algorithm & | out_algorithm | ) | const |
Shows the selection algorithm for the associated window.
out_algorithm | The selection algorithm for the associated window. |
bool SelectionOptionsControl::ShowDeferralExtentCullingRespected | ( | bool & | out_state | ) | const |
Shows the deferral extent culling respected state for the associated window.
out_state | The deferral extent culling respected state. |
bool SelectionOptionsControl::ShowExtentCullingRespected | ( | bool & | out_state | ) | const |
Shows the extent culling respected state for the associated window.
out_state | The extent culling respected state. |
bool SelectionOptionsControl::ShowFrustumCullingRespected | ( | bool & | out_state | ) | const |
Shows the frustum culling respected state for the associated window.
out_state | The frustum culling respected state. |
bool SelectionOptionsControl::ShowGranularity | ( | Selection::Granularity & | out_granularity | ) | const |
Shows the selection granularity for the associated window.
out_granularity | The selection granularity for the associated window. |
bool SelectionOptionsControl::ShowInternalLimit | ( | size_t & | out_limit | ) | const |
Shows the internal selection limit for the associated window.
out_limit | The internal selection limit for the associated window. |
bool SelectionOptionsControl::ShowLevel | ( | Selection::Level & | out_level | ) | const |
Shows the selection level for the associated window.
out_level | The selection level for the associated window. |
bool SelectionOptionsControl::ShowProximity | ( | float & | out_proximity | ) | const |
Shows the selection proximity for the associated window.
out_proximity | The selection proximity for the associated window. |
bool SelectionOptionsControl::ShowRelatedLimit | ( | size_t & | out_limit | ) | const |
Shows the related selection limit for the associated window.
out_limit | The related selection limit for the associated window. |
bool SelectionOptionsControl::ShowSorting | ( | bool & | out_sorted | ) | const |
Shows whether selection sorting is enabled for the associated window.
out_sorted | whether selection sorting is enabled for the associated window. |
bool SelectionOptionsControl::ShowVectorCullingRespected | ( | bool & | out_state | ) | const |
Shows the vector culling respected state for the associated window.
out_state | The vector culling respected state. |