
Public Member Functions | |
override void | Dispose () |
override HPS.Type | ObjectType () |
SelectionOptionsControl (HPS.WindowKey in_window) | |
This constructor creates a SelectionOptionsControl object which is tied to the specified window. More... | |
SelectionOptionsControl (HPS.SelectionOptionsControl in_that) | |
The copy constructor creates a SelectionOptionsControl object that shares the underlying smart-pointer of the source SelectionOptionsControl. More... | |
HPS.SelectionOptionsControl | 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.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 HPS.CullingControl) will be ignored. More... | |
HPS.SelectionOptionsControl | SetDistanceCullingRespected (bool in_state) |
Sets whether to respect the distance culling option during selection. If this value is set to false, the distance culling option (see HPS.CullingControl) will be ignored. More... | |
HPS.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 HPS.CullingControl) will be ignored. More... | |
HPS.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 HPS.CullingControl) will be ignored. More... | |
HPS.SelectionOptionsControl | SetGranularity (HPS.Selection.Granularity in_granularity) |
Sets the selection granularity to use. More... | |
HPS.SelectionOptionsControl | 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.SelectionOptionsControl | SetLevel (HPS.Selection.Level in_level) |
Sets the level at which selection will occur. More... | |
HPS.SelectionOptionsControl | 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.SelectionOptionsControl | 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.SelectionOptionsControl | SetSorting (bool in_sorting) |
Sets whether to sort selection results. This is only relevant if the related selection limit is greater than 0 (see SetRelatedLimit). Sorting works on an entity level. Subentity components like edges, vertices and faces are not sorted. More... | |
HPS.SelectionOptionsControl | SetSorting (HPS.Selection.Sorting in_sorting) |
Sets how selection results will be sorted. More... | |
HPS.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 HPS.CullingControl) will be ignored. More... | |
HPS.SelectionOptionsControl | SetVolumeCullingRespected (bool in_state) |
Sets whether to respect the volume culling option during selection. If this value is set to false, the volume culling option (see HPS.CullingControl) will be ignored. More... | |
bool | ShowAlgorithm (out HPS.Selection.Algorithm out_algorithm) |
Shows the selection algorithm for the associated window. More... | |
bool | ShowDeferralExtentCullingRespected (out bool out_state) |
Shows the deferral extent culling respected state for the associated window. More... | |
bool | ShowDistanceCullingRespected (out bool out_state) |
Shows the distance culling respected state for the associated window. More... | |
bool | ShowExtentCullingRespected (out bool out_state) |
Shows the extent culling respected state for the associated window. More... | |
bool | ShowFrustumCullingRespected (out bool out_state) |
Shows the frustum culling respected state for the associated window. More... | |
bool | ShowGranularity (out HPS.Selection.Granularity out_granularity) |
Shows the selection granularity for the associated window. More... | |
bool | ShowInternalLimit (out ulong out_limit) |
Shows the internal selection limit for the associated window. More... | |
bool | ShowLevel (out HPS.Selection.Level out_level) |
Shows the selection level for the associated window. More... | |
bool | ShowProximity (out float out_proximity) |
Shows the selection proximity for the associated window. More... | |
bool | ShowRelatedLimit (out ulong out_limit) |
Shows the related selection limit for the associated window. More... | |
bool | ShowSorting (out HPS.Selection.Sorting out_sorting) |
Shows the type of selection sorting for the associated window. More... | |
bool | ShowVectorCullingRespected (out bool out_state) |
Shows the vector culling respected state for the associated window. More... | |
bool | ShowVolumeCullingRespected (out bool out_state) |
Shows the volume culling respected state for the associated window. More... | |
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... | |
HPS.SelectionOptionsControl | UnsetAlgorithm () |
Removes the Algorithm setting from this control. If the control is attached to a WindowKey this function restores the default setting as specified by SelectionOptionsKit.GetDefault(). More... | |
HPS.SelectionOptionsControl | UnsetDeferralExtentCullingRespected () |
Removes the Deferral Culling setting from this control. If the control is attached to a WindowKey this function restores the default setting as specified by SelectionOptionsKit.GetDefault(). More... | |
HPS.SelectionOptionsControl | UnsetDistanceCullingRespected () |
Removes the distance Culling setting from this control. If the control is attached to a WindowKey this function restores the default setting as specified by SelectionOptionsKit.GetDefault(). More... | |
HPS.SelectionOptionsControl | UnsetEverything () |
Removes all settings from this control. If the control is attached to a WindowKey this function restores the default settings of this control as specified by SelectionOptionsKit.GetDefault(). More... | |
HPS.SelectionOptionsControl | UnsetExtentCullingRespected () |
Removes the Extent Culling setting from this control. If the control is attached to a WindowKey this function restores the default setting as specified by SelectionOptionsKit.GetDefault(). More... | |
HPS.SelectionOptionsControl | UnsetFrustumCullingRespected () |
Removes the Frustum Culling setting from this control. If the control is attached to a WindowKey this function restores the default setting as specified by SelectionOptionsKit.GetDefault(). More... | |
HPS.SelectionOptionsControl | UnsetGranularity () |
Removes the Granularity setting from this control. If the control is attached to a WindowKey this function restores the default setting as specified by SelectionOptionsKit.GetDefault(). More... | |
HPS.SelectionOptionsControl | UnsetInternalLimit () |
Removes the Internal Limit setting from this control. If the control is attached to a WindowKey this function restores the default setting as specified by SelectionOptionsKit.GetDefault(). More... | |
HPS.SelectionOptionsControl | UnsetLevel () |
Removes the Selection Level setting from this control. If the control is attached to a WindowKey this function restores the default setting as specified by SelectionOptionsKit.GetDefault(). More... | |
HPS.SelectionOptionsControl | UnsetProximity () |
Removes the Proximity setting from this control. If the control is attached to a WindowKey this function restores the default setting as specified by SelectionOptionsKit.GetDefault(). More... | |
HPS.SelectionOptionsControl | UnsetRelatedLimit () |
Removes the Related Limit setting from this control. If the control is attached to a WindowKey this function restores the default setting as specified by SelectionOptionsKit.GetDefault(). More... | |
HPS.SelectionOptionsControl | UnsetSorting () |
Removes the Sorting setting from this control. If the control is attached to a WindowKey this function restores the default setting as specified by SelectionOptionsKit.GetDefault(). More... | |
HPS.SelectionOptionsControl | UnsetVectorCullingRespected () |
Removes the Vector Culling setting from this control. If the control is attached to a WindowKey this function restores the default setting as specified by SelectionOptionsKit.GetDefault(). More... | |
HPS.SelectionOptionsControl | UnsetVolumeCullingRespected () |
Removes the Volume Culling setting from this control. If the control is attached to a WindowKey this function restores the default setting as specified by SelectionOptionsKit.GetDefault(). More... | |
![]() | |
Control (HPS.Control in_that) | |
![]() | |
virtual bool | Empty () |
Indicates whether this object has any values set on it. More... | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns the object's database handle, which can be used to determine which instance of a class the object is. For example, controls are simply aliases for segment keys that group related functions. Therefore, a SegmentKey and all of its controls would return the same instance id. 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... | |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
The HPS.SelectionOptionsControl class is a smart pointer that is tied to a database object. It is used to set selection related options on a HPS.WindowKey. Options include the selection algorithm, granularity, internal limit, related limit, level, proximity, and sorting. Default values for the various fields of HPS.SelectionOptionsControl can be found here.
Constructor & Destructor Documentation
|
inline |
This constructor creates a SelectionOptionsControl object which is tied to the specified window.
- Parameters
-
in_window The window which this SelectionOptionsControl should operate on.
|
inline |
The copy constructor creates a SelectionOptionsControl object that shares the underlying smart-pointer of the source SelectionOptionsControl.
- Parameters
-
in_that The source SelectionOptionsControl to copy.
Member Function Documentation
|
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 SelectionOptionsControl.
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.CullingControl) will be ignored.
- Parameters
-
in_state Whether to respect the deferral extent culling option during selection.
- Returns
- A reference to this SelectionOptionsControl.
Default value
|
inline |
Sets whether to respect the distance culling option during selection. If this value is set to false, the distance culling option (see HPS.CullingControl) will be ignored.
- Parameters
-
in_state Whether to respect the distance culling option during selection.
- Returns
- A reference to this SelectionOptionsControl.
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.CullingControl) will be ignored.
- Parameters
-
in_state Whether to respect the extent culling option during selection.
- Returns
- A reference to this SelectionOptionsControl.
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.CullingControl) will be ignored.
- Parameters
-
in_state Whether to respect the frustum culling option during selection.
- Returns
- A reference to this SelectionOptionsControl.
Default value
|
inline |
Sets the selection granularity to use.
- Parameters
-
in_granularity The selection granularity to use.
- Returns
- A reference to this SelectionOptionsControl.
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 SelectionOptionsControl.
Default value
|
inline |
Sets the level at which selection will occur.
- Parameters
-
in_level The level at which selection will occur.
- Returns
- A reference to this SelectionOptionsControl.
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 SelectionOptionsControl.
Default value
SetSorting(Selection.Sorting)
|
inline |
Sets whether to sort selection results. This is only relevant if the related selection limit is greater than 0 (see SetRelatedLimit). Sorting works on an entity level. Subentity components like edges, vertices and faces are not sorted.
- Deprecated:
- This function exists for compatibility and SetSorting(Selection.Sorting) should be preferred in general usage.
- Parameters
-
in_sorting Whether to sort selection results. A value of true is equivalent to passing Selection.Sorting.Default to SetSorting(Selection.Sorting), and a value of false is equivalent to passing Selection.Sorting.Off to SetSorting(Selection.Sorting).
- Returns
- A reference to this SelectionOptionsControl.
Default value
|
inline |
Sets how selection results will be sorted.
|
inline |
Sets whether to respect the vector culling option during selection. If this value is set to false, the vector culling option (see HPS.CullingControl) will be ignored.
- Parameters
-
in_state Whether to respect the vector culling option during selection.
- Returns
- A reference to this SelectionOptionsControl.
Default value
|
inline |
Sets whether to respect the volume culling option during selection. If this value is set to false, the volume culling option (see HPS.CullingControl) will be ignored.
- Parameters
-
in_state Whether to respect the volume culling option during selection.
- Returns
- A reference to this SelectionOptionsControl.
Default value
|
inline |
Shows the selection algorithm for the associated window.
- Parameters
-
out_algorithm The selection algorithm for the associated window.
- Returns
- true if the selection algorithm is valid, false otherwise.
|
inline |
Shows the deferral extent culling respected state for the associated window.
- 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 distance culling respected state for the associated window.
- Parameters
-
out_state The distance culling respected state.
- Returns
- true if the distance culling respected state is valid, false otherwise.
|
inline |
Shows the extent culling respected state for the associated window.
- 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 for the associated window.
- 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 for the associated window.
- Parameters
-
out_granularity The selection granularity for the associated window.
- Returns
- true if the selection granularity is valid, false otherwise.
|
inline |
Shows the internal selection limit for the associated window.
- Parameters
-
out_limit The internal selection limit for the associated window.
- Returns
- true if the internal selection limit is valid, false otherwise.
|
inline |
Shows the selection level for the associated window.
- Parameters
-
out_level The selection level for the associated window.
- Returns
- true if the level is valid, false otherwise.
|
inline |
Shows the selection proximity for the associated window.
- Parameters
-
out_proximity The selection proximity for the associated window.
- Returns
- true if the proximity is valid, false otherwise.
|
inline |
Shows the related selection limit for the associated window.
- Parameters
-
out_limit The related selection limit for the associated window.
- Returns
- true if the related selection limit is valid, false otherwise.
|
inline |
Shows the type of selection sorting for the associated window.
- Parameters
-
out_sorting The type of selection sorting to use for the associated window.
- Returns
- true if the selection sorting type is valid, false otherwise.
|
inline |
Shows the vector culling respected state for the associated window.
- Parameters
-
out_state The vector culling respected state.
- Returns
- true if the vector culling respected state is valid, false otherwise.
|
inline |
Shows the volume culling respected state for the associated window.
- Parameters
-
out_state The volume culling respected state.
- Returns
- true if the volume culling respected state is valid, false otherwise.
|
inlinevirtual |
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.
- Returns
- The true type of the object in question.
Reimplemented from HPS.Control.
|
inline |
Removes the Algorithm setting from this control. If the control is attached to a WindowKey this function restores the default setting as specified by SelectionOptionsKit.GetDefault().
- Returns
- A reference to this object.
|
inline |
Removes the Deferral Culling setting from this control. If the control is attached to a WindowKey this function restores the default setting as specified by SelectionOptionsKit.GetDefault().
- Returns
- A reference to this object.
|
inline |
Removes the distance Culling setting from this control. If the control is attached to a WindowKey this function restores the default setting as specified by SelectionOptionsKit.GetDefault().
- Returns
- A reference to this object.
|
inline |
Removes all settings from this control. If the control is attached to a WindowKey this function restores the default settings of this control as specified by SelectionOptionsKit.GetDefault().
- Returns
- A reference to this object.
|
inline |
Removes the Extent Culling setting from this control. If the control is attached to a WindowKey this function restores the default setting as specified by SelectionOptionsKit.GetDefault().
- Returns
- A reference to this object.
|
inline |
Removes the Frustum Culling setting from this control. If the control is attached to a WindowKey this function restores the default setting as specified by SelectionOptionsKit.GetDefault().
- Returns
- A reference to this object.
|
inline |
Removes the Granularity setting from this control. If the control is attached to a WindowKey this function restores the default setting as specified by SelectionOptionsKit.GetDefault().
- Returns
- A reference to this object.
|
inline |
Removes the Internal Limit setting from this control. If the control is attached to a WindowKey this function restores the default setting as specified by SelectionOptionsKit.GetDefault().
- Returns
- A reference to this object.
|
inline |
Removes the Selection Level setting from this control. If the control is attached to a WindowKey this function restores the default setting as specified by SelectionOptionsKit.GetDefault().
- Returns
- A reference to this object.
|
inline |
Removes the Proximity setting from this control. If the control is attached to a WindowKey this function restores the default setting as specified by SelectionOptionsKit.GetDefault().
- Returns
- A reference to this object.
|
inline |
Removes the Related Limit setting from this control. If the control is attached to a WindowKey this function restores the default setting as specified by SelectionOptionsKit.GetDefault().
- Returns
- A reference to this object.
|
inline |
Removes the Sorting setting from this control. If the control is attached to a WindowKey this function restores the default setting as specified by SelectionOptionsKit.GetDefault().
- Returns
- A reference to this object.
|
inline |
Removes the Vector Culling setting from this control. If the control is attached to a WindowKey this function restores the default setting as specified by SelectionOptionsKit.GetDefault().
- Returns
- A reference to this object.
|
inline |
Removes the Volume Culling setting from this control. If the control is attached to a WindowKey this function restores the default setting as specified by SelectionOptionsKit.GetDefault().
- Returns
- A reference to this object.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.SelectionOptionsControl.cs