|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
static IntPtr | ClassID< T > () |
|
bool | cMemOwn |
|
HandleRef | cptr |
|
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.
◆ SelectionOptionsControl() [1/2]
HPS.SelectionOptionsControl.SelectionOptionsControl |
( |
HPS.WindowKey |
in_window | ) |
|
|
inline |
◆ SelectionOptionsControl() [2/2]
◆ ObjectType()
override HPS.Type HPS.SelectionOptionsControl.ObjectType |
( |
| ) |
|
|
inlinevirtual |
This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS.Control.
◆ SetAlgorithm()
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
◆ SetDeferralExtentCullingRespected()
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
◆ SetDistanceCullingRespected()
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
◆ SetExtentCullingRespected()
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
◆ SetFrustumCullingRespected()
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
◆ SetGranularity()
Sets the selection granularity to use.
- Parameters
-
in_granularity | The selection granularity to use. |
- Returns
- A reference to this SelectionOptionsControl.
Default value
◆ SetInternalLimit()
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
◆ SetLevel()
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
◆ SetProximity()
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.
◆ SetRelatedLimit()
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)
◆ SetSorting() [1/2]
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
-
- Returns
- A reference to this SelectionOptionsControl.
Default value
◆ SetSorting() [2/2]
Sets how selection results will be sorted.
◆ SetVectorCullingRespected()
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
◆ SetVolumeCullingRespected()
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
◆ ShowAlgorithm()
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.
◆ ShowDeferralExtentCullingRespected()
bool HPS.SelectionOptionsControl.ShowDeferralExtentCullingRespected |
( |
out bool |
out_state | ) |
|
|
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.
◆ ShowDistanceCullingRespected()
bool HPS.SelectionOptionsControl.ShowDistanceCullingRespected |
( |
out bool |
out_state | ) |
|
|
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.
◆ ShowExtentCullingRespected()
bool HPS.SelectionOptionsControl.ShowExtentCullingRespected |
( |
out bool |
out_state | ) |
|
|
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.
◆ ShowFrustumCullingRespected()
bool HPS.SelectionOptionsControl.ShowFrustumCullingRespected |
( |
out bool |
out_state | ) |
|
|
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.
◆ ShowGranularity()
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.
◆ ShowInternalLimit()
bool HPS.SelectionOptionsControl.ShowInternalLimit |
( |
out ulong |
out_limit | ) |
|
|
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.
◆ ShowLevel()
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.
◆ ShowProximity()
bool HPS.SelectionOptionsControl.ShowProximity |
( |
out float |
out_proximity | ) |
|
|
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.
◆ ShowRelatedLimit()
bool HPS.SelectionOptionsControl.ShowRelatedLimit |
( |
out ulong |
out_limit | ) |
|
|
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.
◆ ShowSorting()
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.
◆ ShowVectorCullingRespected()
bool HPS.SelectionOptionsControl.ShowVectorCullingRespected |
( |
out bool |
out_state | ) |
|
|
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.
◆ ShowVolumeCullingRespected()
bool HPS.SelectionOptionsControl.ShowVolumeCullingRespected |
( |
out bool |
out_state | ) |
|
|
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.
◆ Type()
override HPS.Type HPS.SelectionOptionsControl.Type |
( |
| ) |
|
|
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.
◆ 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().
- Returns
- A reference to this object.
◆ 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().
- Returns
- A reference to this object.
◆ 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().
- Returns
- A reference to this object.
◆ 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().
- Returns
- A reference to this object.
◆ UnsetExtentCullingRespected()
◆ 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().
- Returns
- A reference to this object.
◆ 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().
- Returns
- A reference to this object.
◆ 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().
- Returns
- A reference to this object.
◆ UnsetLevel()
◆ 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().
- Returns
- A reference to this object.
◆ 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().
- Returns
- A reference to this object.
◆ 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().
- Returns
- A reference to this object.
◆ UnsetVectorCullingRespected()
◆ 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().
- 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