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

Public Member Functions | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this SelectionOptionsKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.SelectionOptionsKit in_kit) |
Check if the source SelectionOptionsKit is equivalent to this SelectionOptionsKit. More... | |
override int | GetHashCode () |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More... | |
SelectionOptionsKit () | |
The default constructor creates an empty SelectionOptionsKit object. More... | |
SelectionOptionsKit (HPS.SelectionOptionsKit in_kit) | |
The copy constructor creates a new SelectionOptionsKit object that contains the same settings as the source SelectionOptionsKit. More... | |
void | Set (HPS.SelectionOptionsKit in_kit) |
Copies the source SelectionOptionsKit into this SelectionOptionsKit. More... | |
HPS.SelectionOptionsKit | SetAlgorithm (HPS.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). More... | |
HPS.SelectionOptionsKit | 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 HPS.CullingKit) will be ignored. More... | |
HPS.SelectionOptionsKit | 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 HPS.CullingKit) will be ignored. More... | |
HPS.SelectionOptionsKit | 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 HPS.CullingKit) will be ignored. More... | |
HPS.SelectionOptionsKit | SetGranularity (HPS.Selection.Granularity in_granularity) |
Sets the selection granularity to use. More... | |
HPS.SelectionOptionsKit | SetInternalLimit (ulong 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. More... | |
HPS.SelectionOptionsKit | SetLevel (HPS.Selection.Level in_level) |
Sets the level at which selection will occur. More... | |
HPS.SelectionOptionsKit | SetProximity (float in_proximity) |
Sets the selection proximity in centimeters or object-relative-units (ORU), depending on the selection-routine being utilized. The selection proximity augments point-based or shell-based selections by also factoring in the area surrounding the selection-point or selection-shell. More... | |
HPS.SelectionOptionsKit | SetRelatedLimit (ulong 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). More... | |
HPS.SelectionOptionsKit | SetScope (HPS.SegmentKey in_start_segment) |
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. More... | |
HPS.SelectionOptionsKit | SetScope (HPS.KeyPath in_start_path) |
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. More... | |
HPS.SelectionOptionsKit | SetSelectability (HPS.SelectabilityKit in_selectability) |
HPS.SelectionOptionsKit | 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). More... | |
HPS.SelectionOptionsKit | SetTreeContext (HPS.TreeContext in_tree_context) |
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. More... | |
HPS.SelectionOptionsKit | 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 HPS.CullingKit) will be ignored. More... | |
void | Show (out HPS.SelectionOptionsKit out_kit) |
Copies this SelectionOptionsKit into the given SelectionOptionsKit. More... | |
bool | ShowAlgorithm (out HPS.Selection.Algorithm out_algorithm) |
Shows the selection algorithm. More... | |
bool | ShowDeferralExtentCullingRespected (out bool out_state) |
Shows the deferral extent culling respected state. More... | |
bool | ShowExtentCullingRespected (out bool out_state) |
Shows the extent culling respected state. More... | |
bool | ShowFrustumCullingRespected (out bool out_state) |
Shows the frustum culling respected state. More... | |
bool | ShowGranularity (out HPS.Selection.Granularity out_granularity) |
Shows the selection granularity. More... | |
bool | ShowInternalLimit (out ulong out_limit) |
Shows the internal selection limit. More... | |
bool | ShowLevel (out HPS.Selection.Level out_level) |
Shows the selection level. More... | |
bool | ShowProximity (out float out_proximity) |
Shows the selection proximity. More... | |
bool | ShowRelatedLimit (out ulong out_limit) |
Shows the related selection limit. More... | |
bool | ShowScope (out HPS.KeyPath out_start_path) |
Shows the starting location at which selection testing will begin. More... | |
bool | ShowSelectability (out HPS.SelectabilityKit out_selectability) |
bool | ShowSorting (out bool out_sorted) |
Shows whether selection sorting is enabled. More... | |
bool | ShowTreeContext (out HPS.TreeContext out_tree_context) |
Shows the tree context for this SelectionOptionsKit. More... | |
bool | ShowVectorCullingRespected (out bool out_state) |
Shows the vector culling respected state. More... | |
HPS.SelectionOptionsKit | UnsetAlgorithm () |
Removes the selection algorithm. More... | |
HPS.SelectionOptionsKit | UnsetDeferralExtentCullingRespected () |
Removes the deferral extent culling respected option. More... | |
HPS.SelectionOptionsKit | UnsetEverything () |
Removes all settings from this SelectionOptionsKit. More... | |
HPS.SelectionOptionsKit | UnsetExtentCullingRespected () |
Removes the extent culling respected option. More... | |
HPS.SelectionOptionsKit | UnsetFrustumCullingRespected () |
Removes the frustum culling respected option. More... | |
HPS.SelectionOptionsKit | UnsetGranularity () |
Removes the selection granularity. More... | |
HPS.SelectionOptionsKit | UnsetInternalLimit () |
Removes the internal selection limit. More... | |
HPS.SelectionOptionsKit | UnsetLevel () |
Removes the selection level. More... | |
HPS.SelectionOptionsKit | UnsetProximity () |
Removes the selection proximity. More... | |
HPS.SelectionOptionsKit | UnsetRelatedLimit () |
Removes the related selection limit. More... | |
HPS.SelectionOptionsKit | UnsetScope () |
Removes the selection scope setting from this SelectionOptionsKit. More... | |
HPS.SelectionOptionsKit | UnsetSelectability () |
HPS.SelectionOptionsKit | UnsetSorting () |
Removes whether selection sorting is enabled. More... | |
HPS.SelectionOptionsKit | UnsetTreeContext () |
Removes the tree context from this SelectionOptionsKit. More... | |
HPS.SelectionOptionsKit | UnsetVectorCullingRespected () |
Removes the vector culling respected option. More... | |
![]() | |
Kit (HPS.Kit in_that) | |
override HPS.Type | Type () |
This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More... | |
![]() | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object that) | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
Static Public Member Functions | |
static HPS.SelectionOptionsKit | GetDefault () |
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. More... | |
static bool | operator!= (HPS.SelectionOptionsKit a, HPS.SelectionOptionsKit b) |
static bool | operator== (HPS.SelectionOptionsKit a, HPS.SelectionOptionsKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
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.
Constructor & Destructor Documentation
|
inline |
The default constructor creates an empty SelectionOptionsKit object.
|
inline |
The copy constructor creates a new SelectionOptionsKit object that contains the same settings as the source SelectionOptionsKit.
- Parameters
-
in_kit The source SelectionOptionsKit to copy.
Member Function Documentation
|
inlinevirtual |
Indicates whether this SelectionOptionsKit has any values set on it.
- Returns
- true if no values are set on this SelectionOptionsKit, false otherwise.
Reimplemented from HPS.Object.
|
inline |
Check if the source SelectionOptionsKit is equivalent to this SelectionOptionsKit.
- Parameters
-
in_kit The source SelectionOptionsKit to compare to this SelectionOptionsKit.
- Returns
- true if the objects are equivalent, false otherwise.
|
inlinestatic |
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.
|
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 HPS.Kit.
|
inline |
Copies the source SelectionOptionsKit into this SelectionOptionsKit.
- Parameters
-
in_kit The source SelectionOptionsKit to copy.
|
inline |
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.
Default value
|
inline |
Sets whether to respect the deferral extent culling option during selection. If this value is set to false, the deferral extent culling option (see HPS.CullingKit) will be ignored.
- Parameters
-
in_state Whether to respect the deferral extent culling option during selection.
- Returns
- A reference to this SelectionOptionsKit.
Default value
|
inline |
Sets whether to respect the extent culling option during selection. If this value is set to false, the extent culling option (see HPS.CullingKit) will be ignored.
- Parameters
-
in_state Whether to respect the extent culling option during selection.
- Returns
- A reference to this SelectionOptionsKit.
Default value
|
inline |
Sets whether to respect the frustum culling option during selection. If this value is set to false, the frustum culling option (see HPS.CullingKit) will be ignored.
- Parameters
-
in_state Whether to respect the frustum culling option during selection.
- Returns
- A reference to this SelectionOptionsKit.
Default value
|
inline |
Sets the selection granularity to use.
- Parameters
-
in_granularity The selection granularity to use.
- Returns
- A reference to this SelectionOptionsKit.
Default value
|
inline |
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
Internal limit in Programming Guide
|
inline |
Sets the level at which selection will occur.
- Parameters
-
in_level The level at which selection will occur.
- Returns
- A reference to this SelectionOptionsKit.
Default value
|
inline |
Sets the selection proximity in centimeters or object-relative-units (ORU), depending on the selection-routine being utilized. The selection proximity augments point-based or shell-based selections by also factoring in the area surrounding the selection-point or selection-shell.
|
inline |
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.
Default value
Related limit in Programming Guide
|
inline |
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.
|
inline |
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.
|
inline |
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.
Default value
|
inline |
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.
|
inline |
Sets whether to respect the vector culling option during selection. If this value is set to false, the vector culling option (see HPS.CullingKit) will be ignored.
- Parameters
-
in_state Whether to respect the vector culling option during selection.
- Returns
- A reference to this SelectionOptionsKit.
Default value Default value
|
inline |
Copies this SelectionOptionsKit into the given SelectionOptionsKit.
- Parameters
-
out_kit The SelectionOptionsKit to populate with the contents of this SelectionOptionsKit.
|
inline |
Shows the selection algorithm.
- Parameters
-
out_algorithm The selection algorithm.
- Returns
- true if the selection algorithm is valid, false otherwise.
|
inline |
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.
|
inline |
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.
|
inline |
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.
|
inline |
Shows the selection granularity.
- Parameters
-
out_granularity The selection granularity.
- Returns
- true if the selection granularity is valid, false otherwise.
|
inline |
Shows the internal selection limit.
- Parameters
-
out_limit The internal selection limit.
- Returns
- true if the internal selection limit is valid, false otherwise.
|
inline |
Shows the selection level.
- Parameters
-
out_level The selection level.
- Returns
- true if the level is valid, false otherwise.
|
inline |
Shows the selection proximity.
- Parameters
-
out_proximity The selection proximity.
- Returns
- true if the proximity is valid, false otherwise.
|
inline |
Shows the related selection limit.
- Parameters
-
out_limit The related selection limit.
- Returns
- true if the related selection limit is valid, false otherwise.
|
inline |
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.
|
inline |
Shows whether selection sorting is enabled.
- Parameters
-
out_sorted whether selection sorting is enabled.
- Returns
- true if the flag is valid, false otherwise.
|
inline |
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.
|
inline |
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.
|
inline |
Removes the selection algorithm.
- Returns
- A reference to this SelectionOptionsKit.
|
inline |
Removes the deferral extent culling respected option.
- Returns
- A reference to this SelectionOptionsKit.
|
inline |
Removes all settings from this SelectionOptionsKit.
- Returns
- A reference to this SelectionOptionsKit.
|
inline |
Removes the extent culling respected option.
- Returns
- A reference to this SelectionOptionsKit.
|
inline |
Removes the frustum culling respected option.
- Returns
- A reference to this SelectionOptionsKit.
|
inline |
Removes the selection granularity.
- Returns
- A reference to this SelectionOptionsKit.
|
inline |
Removes the internal selection limit.
- Returns
- A reference to this SelectionOptionsKit.
|
inline |
Removes the selection level.
- Returns
- A reference to this SelectionOptionsKit.
|
inline |
Removes the selection proximity.
- Returns
- A reference to this SelectionOptionsKit.
|
inline |
Removes the related selection limit.
- Returns
- A reference to this SelectionOptionsKit.
|
inline |
Removes the selection scope setting from this SelectionOptionsKit.
- Returns
- A reference to this object.
|
inline |
Removes whether selection sorting is enabled.
- Returns
- A reference to this SelectionOptionsKit.
|
inline |
Removes the tree context from this SelectionOptionsKit.
- Returns
- A reference to this object.
|
inline |
Removes the vector culling respected option.
- Returns
- A reference to this SelectionOptionsKit.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.SelectionOptionsKit.cs