#include <hps.h>
The SelectionOptionsKit class is a user space object. It contains options related to selection. Default values for the SelectionOptionsKit can be found in this table.
SelectionOptionsKit::SelectionOptionsKit |
( |
| ) |
|
bool SelectionOptionsKit::Empty |
( |
| ) |
const |
|
virtual |
Creates a SelectionOptionsKit which contains the default settings. The returned object will not necessarily have values set for every option, but it will have settings for those options where it is reasonable to have a default.
- Returns
- A SelectionOptionsKit with the default settings.
Type SelectionOptionsKit::ObjectType |
( |
| ) |
const |
|
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 Object.
The move assignment operator transfers the underlying impl of the rvalue reference to this SelectionOptionsKit thereby avoiding a copy.
- Parameters
-
- Returns
- A reference to this SelectionOptionsKit.
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).
- Parameters
-
in_algorithm | The type of selection algorithm to use. |
- Returns
- A reference to this SelectionOptionsKit.
- See also
- Default value
Sets whether to respect the deferral extent culling option during selection. If this value is set to false, the deferral extent culling option (see CullingKit) will be ignored.
- Parameters
-
in_state | Whether to respect the deferral extent culling option during selection. |
- Returns
- A reference to this SelectionOptionsKit.
- See also
- Default value
Sets whether to respect the extent culling option during selection. If this value is set to false, the extent culling option (see CullingKit) will be ignored.
- Parameters
-
in_state | Whether to respect the extent culling option during selection. |
- Returns
- A reference to this SelectionOptionsKit.
- See also
- Default value
Sets whether to respect the frustum culling option during selection. If this value is set to false, the frustum culling option (see CullingKit) will be ignored.
- Parameters
-
in_state | Whether to respect the frustum culling option during selection. |
- Returns
- A reference to this SelectionOptionsKit.
- See also
- Default value
Sets the selection granularity to use.
- Parameters
-
in_granularity | The selection granularity to use. |
- Returns
- A reference to this SelectionOptionsKit.
- See also
- Default value
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.
- Parameters
-
in_limit | The internal selection limit. |
- Returns
- A reference to this SelectionOptionsKit.
Sets the level at which selection will occur.
- Parameters
-
in_level | The level at which selection will occur. |
- Returns
- A reference to this SelectionOptionsKit.
- See also
- Default value
Sets the selection proximity in centimeters.
- Parameters
-
in_proximity | The radius around the selection within which objects will be returned as selected. Values must be positive except for shell selections, in which case it indicates the distance a shell must penetrate before it is considered a clash. |
- Returns
- A reference to this SelectionOptionsKit.
- See also
- Default value
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).
- Parameters
-
in_limit | Limit on the number of items that will be returned as selected when performing a selection. |
- Returns
- A reference to this SelectionOptionsKit.
- See also
- Default value
Sets the starting location at which selection testing will begin. If the selection is being performed from a window, there must be a path from this segment to that window.
- Parameters
-
in_start_segment | A segment, that must be a child of the window key, in which to begin selection testing. |
- Returns
- A reference to this SelectionOptionsKit.
Sets the starting location at which selection testing will begin. If the selection is being performed from a window, there must be a path from this segment to that window.
- Parameters
-
in_start_path | A path of segments and includes, leaf to root, from the segment to begin selection testing to the window key. |
- Returns
- A reference to this SelectionOptionsKit.
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).
- Parameters
-
in_sorted | Whether to sort selection results by relevance. |
- Returns
- A reference to this SelectionOptionsKit.
- See also
- Default value
Sets a tree context to be used for this selection. If many selections are going to be computed without modifying the segment tree, using the same tree context for all of them can be a significant optimization. If one is not specified, a new one is computed each time.
- Parameters
-
in_tree_context | The tree context to use for this relation test. |
- Returns
- A reference to this object.
Sets whether to respect the vector culling option during selection. If this value is set to false, the vector culling option (see CullingKit) will be ignored.
- Parameters
-
in_state | Whether to respect the vector culling option during selection. |
- Returns
- A reference to this SelectionOptionsKit.
- See also
- Default value Default value
Shows the selection algorithm.
- Parameters
-
out_algorithm | The selection algorithm. |
- Returns
- true if the selection algorithm is valid, false otherwise.
bool SelectionOptionsKit::ShowDeferralExtentCullingRespected |
( |
bool & |
out_state | ) |
const |
Shows the deferral extent culling respected state.
- Parameters
-
out_state | The deferral extent culling respected state. |
- Returns
- true if the deferral extent culling respected state is valid, false otherwise.
bool SelectionOptionsKit::ShowExtentCullingRespected |
( |
bool & |
out_state | ) |
const |
Shows the extent culling respected state.
- Parameters
-
out_state | The extent culling respected state. |
- Returns
- true if the extent culling respected state is valid, false otherwise.
bool SelectionOptionsKit::ShowFrustumCullingRespected |
( |
bool & |
out_state | ) |
const |
Shows the frustum culling respected state.
- Parameters
-
out_state | The frustum culling respected state. |
- Returns
- true if the frustum culling respected state is valid, false otherwise.
Shows the selection granularity.
- Parameters
-
out_granularity | The selection granularity. |
- Returns
- true if the selection granularity is valid, false otherwise.
bool SelectionOptionsKit::ShowInternalLimit |
( |
size_t & |
out_limit | ) |
const |
Shows the internal selection limit.
- Parameters
-
out_limit | The internal selection limit. |
- Returns
- true if the internal selection limit is valid, false otherwise.
Shows the selection level.
- Parameters
-
out_level | The selection level. |
- Returns
- true if the level is valid, false otherwise.
bool SelectionOptionsKit::ShowProximity |
( |
float & |
out_proximity | ) |
const |
Shows the selection proximity.
- Parameters
-
out_proximity | The selection proximity. |
- Returns
- true if the proximity is valid, false otherwise.
bool SelectionOptionsKit::ShowRelatedLimit |
( |
size_t & |
out_limit | ) |
const |
Shows the related selection limit.
- Parameters
-
out_limit | The related selection limit. |
- Returns
- true if the related selection limit is valid, false otherwise.
bool SelectionOptionsKit::ShowScope |
( |
KeyPath & |
out_start_path | ) |
const |
Shows the starting location at which selection testing will begin.
- Parameters
-
out_start_path | A segment or collection of segments and includes organized from leaf to root. |
- Returns
- true if a selection scope was set, false otherwise.
bool SelectionOptionsKit::ShowSorting |
( |
bool & |
out_sorted | ) |
const |
Shows whether selection sorting is enabled.
- Parameters
-
out_sorted | whether selection sorting is enabled. |
- Returns
- true if the flag is valid, false otherwise.
bool SelectionOptionsKit::ShowTreeContext |
( |
TreeContext & |
out_tree_context | ) |
const |
Shows the tree context for this SelectionOptionsKit.
- Parameters
-
out_tree_context | The tree context to use for this relation test. |
- Returns
- true if a tree context was set, false otherwise.
bool SelectionOptionsKit::ShowVectorCullingRespected |
( |
bool & |
out_state | ) |
const |
Shows the vector culling respected state.
- Parameters
-
out_state | The vector culling respected state. |
- Returns
- true if the vector culling respected state is valid, false otherwise.
Removes the deferral extent culling respected option.
- Returns
- A reference to this SelectionOptionsKit.
Removes the selection scope setting from this SelectionOptionsKit.
- Returns
- A reference to this object.
The documentation for this class was generated from the following file: