REFERENCE MANUAL
The SelectionOptionsKit class is a user space object. 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. 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. More... | |
HPS.SelectionOptionsKit | SetDeferralExtentCullingRespected (bool in_state) |
Sets whether to respect the deferral extent culling option during selection. More... | |
HPS.SelectionOptionsKit | SetExtentCullingRespected (bool in_state) |
Sets whether to respect the extent culling option during selection. More... | |
HPS.SelectionOptionsKit | SetFrustumCullingRespected (bool in_state) |
Sets whether to respect the frustum culling option during selection. 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. 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. More... | |
HPS.SelectionOptionsKit | SetRelatedLimit (ulong in_limit) |
Sets the related selection limit. More... | |
HPS.SelectionOptionsKit | SetScope (HPS.SegmentKey in_start_segment) |
Sets the starting location at which selection testing will begin. More... | |
HPS.SelectionOptionsKit | SetScope (HPS.KeyPath in_start_path) |
Sets the starting location at which selection testing will begin. More... | |
HPS.SelectionOptionsKit | SetSorting (bool in_sorted) |
Sets whether to sort selection results by relevance. More... | |
HPS.SelectionOptionsKit | SetTreeContext (HPS.TreeContext in_tree_context) |
Sets a tree context to be used for this selection. More... | |
HPS.SelectionOptionsKit | SetVectorCullingRespected (bool in_state) |
Sets whether to respect the vector culling option during selection. 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 | 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 | 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... | |
![]() | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object in_that) | |
The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
HPS.Type | Type () |
This function returns the true type of the underlying object. More... | |
Static Public Member Functions | |
static HPS.SelectionOptionsKit | GetDefault () |
Creates a SelectionOptionsKit which contains the default settings. 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 |
HandleRef | scptr |
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.
HPS.SelectionOptionsKit.SelectionOptionsKit | ( | ) |
The default constructor creates an empty SelectionOptionsKit object.
HPS.SelectionOptionsKit.SelectionOptionsKit | ( | HPS.SelectionOptionsKit | in_kit | ) |
The copy constructor creates a new SelectionOptionsKit object that contains the same settings as the source SelectionOptionsKit.
in_kit | The source <ref refid="class_h_p_s_1_1_selection_options_kit" kindref="compound">SelectionOptionsKit</ref> to copy. |
|
virtual |
Indicates whether this SelectionOptionsKit has any values set on it.
Reimplemented from HPS.Object.
bool HPS.SelectionOptionsKit.Equals | ( | HPS.SelectionOptionsKit | in_kit | ) |
Check if the source SelectionOptionsKit is equivalent to this SelectionOptionsKit.
in_kit | The source <ref refid="class_h_p_s_1_1_selection_options_kit" kindref="compound">SelectionOptionsKit</ref> to compare to this <ref refid="class_h_p_s_1_1_selection_options_kit" kindref="compound">SelectionOptionsKit</ref>. |
|
static |
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.
|
virtual |
This function returns the type the object, as declared.
This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.Object.
void HPS.SelectionOptionsKit.Set | ( | HPS.SelectionOptionsKit | in_kit | ) |
Copies the source SelectionOptionsKit into this SelectionOptionsKit.
in_kit | The source <ref refid="class_h_p_s_1_1_selection_options_kit" kindref="compound">SelectionOptionsKit</ref> to copy. |
HPS.SelectionOptionsKit 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).
in_algorithm | The type of selection algorithm to use. |
Default value
HPS.SelectionOptionsKit 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 CullingKit) will be ignored.
in_state | Whether to respect the deferral extent culling option during selection. |
Default value
HPS.SelectionOptionsKit 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 CullingKit) will be ignored.
in_state | Whether to respect the extent culling option during selection. |
Default value
HPS.SelectionOptionsKit 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 CullingKit) will be ignored.
in_state | Whether to respect the frustum culling option during selection. |
Default value
HPS.SelectionOptionsKit HPS.SelectionOptionsKit.SetGranularity | ( | HPS.Selection.Granularity | in_granularity | ) |
Sets the selection granularity to use.
in_granularity | The selection granularity to use. |
Default value
HPS.SelectionOptionsKit 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.
in_limit | The internal selection limit. |
HPS.SelectionOptionsKit HPS.SelectionOptionsKit.SetLevel | ( | HPS.Selection.Level | in_level | ) |
Sets the level at which selection will occur.
in_level | The level at which selection will occur. |
Default value
HPS.SelectionOptionsKit HPS.SelectionOptionsKit.SetProximity | ( | float | in_proximity | ) |
Sets the selection proximity in centimeters.
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. |
Default value
HPS.SelectionOptionsKit 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).
in_limit | Limit on the number of items that will be returned as selected when performing a selection. |
Default value
HPS.SelectionOptionsKit 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.
in_start_segment | A segment, that must be a child of the window key, in which to begin selection testing. |
HPS.SelectionOptionsKit 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.
in_start_path | A path of segments and includes, leaf to root, from the segment to begin selection testing to the window key. |
HPS.SelectionOptionsKit 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).
in_sorted | Whether to sort selection results by relevance. |
Default value
HPS.SelectionOptionsKit 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.
in_tree_context | The tree context to use for this relation test. |
HPS.SelectionOptionsKit 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 CullingKit) will be ignored.
in_state | Whether to respect the vector culling option during selection. |
Default value Default value
void HPS.SelectionOptionsKit.Show | ( | out HPS.SelectionOptionsKit | out_kit | ) |
Copies this SelectionOptionsKit into the given SelectionOptionsKit.
out_kit | The <ref refid="class_h_p_s_1_1_selection_options_kit" kindref="compound">SelectionOptionsKit</ref> to populate with the contents of this <ref refid="class_h_p_s_1_1_selection_options_kit" kindref="compound">SelectionOptionsKit</ref>. |
bool HPS.SelectionOptionsKit.ShowAlgorithm | ( | out HPS.Selection.Algorithm | out_algorithm | ) |
Shows the selection algorithm.
out_algorithm | The selection algorithm. |
bool HPS.SelectionOptionsKit.ShowDeferralExtentCullingRespected | ( | out bool | out_state | ) |
Shows the deferral extent culling respected state.
out_state | The deferral extent culling respected state. |
bool HPS.SelectionOptionsKit.ShowExtentCullingRespected | ( | out bool | out_state | ) |
Shows the extent culling respected state.
out_state | The extent culling respected state. |
bool HPS.SelectionOptionsKit.ShowFrustumCullingRespected | ( | out bool | out_state | ) |
Shows the frustum culling respected state.
out_state | The frustum culling respected state. |
bool HPS.SelectionOptionsKit.ShowGranularity | ( | out HPS.Selection.Granularity | out_granularity | ) |
Shows the selection granularity.
out_granularity | The selection granularity. |
bool HPS.SelectionOptionsKit.ShowInternalLimit | ( | out ulong | out_limit | ) |
Shows the internal selection limit.
out_limit | The internal selection limit. |
bool HPS.SelectionOptionsKit.ShowLevel | ( | out HPS.Selection.Level | out_level | ) |
Shows the selection level.
out_level | The selection level. |
bool HPS.SelectionOptionsKit.ShowProximity | ( | out float | out_proximity | ) |
Shows the selection proximity.
out_proximity | The selection proximity. |
bool HPS.SelectionOptionsKit.ShowRelatedLimit | ( | out ulong | out_limit | ) |
Shows the related selection limit.
out_limit | The related selection limit. |
bool HPS.SelectionOptionsKit.ShowScope | ( | out HPS.KeyPath | out_start_path | ) |
Shows the starting location at which selection testing will begin.
out_start_path | A segment or collection of segments and includes organized from leaf to root. |
bool HPS.SelectionOptionsKit.ShowSorting | ( | out bool | out_sorted | ) |
Shows whether selection sorting is enabled.
out_sorted | whether selection sorting is enabled. |
bool HPS.SelectionOptionsKit.ShowTreeContext | ( | out HPS.TreeContext | out_tree_context | ) |
Shows the tree context for this SelectionOptionsKit.
out_tree_context | The tree context to use for this relation test. |
bool HPS.SelectionOptionsKit.ShowVectorCullingRespected | ( | out bool | out_state | ) |
Shows the vector culling respected state.
out_state | The vector culling respected state. |
HPS.SelectionOptionsKit HPS.SelectionOptionsKit.UnsetAlgorithm | ( | ) |
Removes the selection algorithm.
HPS.SelectionOptionsKit HPS.SelectionOptionsKit.UnsetDeferralExtentCullingRespected | ( | ) |
Removes the deferral extent culling respected option.
HPS.SelectionOptionsKit HPS.SelectionOptionsKit.UnsetEverything | ( | ) |
Removes all settings from this SelectionOptionsKit.
HPS.SelectionOptionsKit HPS.SelectionOptionsKit.UnsetExtentCullingRespected | ( | ) |
Removes the extent culling respected option.
HPS.SelectionOptionsKit HPS.SelectionOptionsKit.UnsetFrustumCullingRespected | ( | ) |
Removes the frustum culling respected option.
HPS.SelectionOptionsKit HPS.SelectionOptionsKit.UnsetGranularity | ( | ) |
Removes the selection granularity.
HPS.SelectionOptionsKit HPS.SelectionOptionsKit.UnsetInternalLimit | ( | ) |
Removes the internal selection limit.
HPS.SelectionOptionsKit HPS.SelectionOptionsKit.UnsetLevel | ( | ) |
Removes the selection level.
HPS.SelectionOptionsKit HPS.SelectionOptionsKit.UnsetProximity | ( | ) |
Removes the selection proximity.
HPS.SelectionOptionsKit HPS.SelectionOptionsKit.UnsetRelatedLimit | ( | ) |
Removes the related selection limit.
HPS.SelectionOptionsKit HPS.SelectionOptionsKit.UnsetScope | ( | ) |
Removes the selection scope setting from this SelectionOptionsKit.
HPS.SelectionOptionsKit HPS.SelectionOptionsKit.UnsetSorting | ( | ) |
Removes whether selection sorting is enabled.
HPS.SelectionOptionsKit HPS.SelectionOptionsKit.UnsetTreeContext | ( | ) |
Removes the tree context from this SelectionOptionsKit.
HPS.SelectionOptionsKit HPS.SelectionOptionsKit.UnsetVectorCullingRespected | ( | ) |
Removes the vector culling respected option.