< Home

< Table of Contents

REFERENCE MANUAL

HPS.SelectionOptionsControl Class Reference

The SelectionOptionsControl class is a smart pointer that is tied to a database object. More...

Inheritance diagram for HPS.SelectionOptionsControl:
HPS.Control HPS.Object

Public Member Functions

override void Dispose ()
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. More...
 
 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. More...
 
HPS.SelectionOptionsControl SetDeferralExtentCullingRespected (bool in_state)
 Sets whether to respect the deferral extent culling option during selection. More...
 
HPS.SelectionOptionsControl SetExtentCullingRespected (bool in_state)
 Sets whether to respect the extent culling option during selection. More...
 
HPS.SelectionOptionsControl SetFrustumCullingRespected (bool in_state)
 Sets whether to respect the frustum culling option during selection. 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. 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. More...
 
HPS.SelectionOptionsControl SetRelatedLimit (ulong in_limit)
 Sets the related selection limit. More...
 
HPS.SelectionOptionsControl SetSorting (bool in_sorted)
 Sets whether to sort selection results by relevance. More...
 
HPS.SelectionOptionsControl SetVectorCullingRespected (bool in_state)
 Sets whether to respect the vector culling option during selection. 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 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 bool out_sorted)
 Shows whether selection sorting is enabled for the associated window. More...
 
bool ShowVectorCullingRespected (out bool out_state)
 Shows the vector culling respected state for the associated window. More...
 
- Public Member Functions inherited from HPS.Control
 Control (HPS.Control in_that)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 Indicates whether this object has any values set on it. 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...
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 
HandleRef scptr
 

Detailed Description

The SelectionOptionsControl class is a smart pointer that is tied to a database object.

It is used to set selection related options on a WindowKey. Options include the selection algorithm, granularity, internal limit, related limit, level, proximity, and sorting. Default values for the various fields of SelectionOptionsControl can be found here.

Constructor & Destructor Documentation

HPS.SelectionOptionsControl.SelectionOptionsControl ( HPS.WindowKey  in_window)

This constructor creates a SelectionOptionsControl object which is tied to the specified window.

Parameters
in_windowThe window which this <ref refid="class_h_p_s_1_1_selection_options_control" kindref="compound">SelectionOptionsControl</ref> should operate on.
HPS.SelectionOptionsControl.SelectionOptionsControl ( HPS.SelectionOptionsControl  in_that)

The copy constructor creates a SelectionOptionsControl object that shares the underlying smart-pointer of the source SelectionOptionsControl.

Parameters
in_thatThe source <ref refid="class_h_p_s_1_1_selection_options_control" kindref="compound">SelectionOptionsControl</ref> to copy.

Member Function Documentation

override HPS.Type HPS.SelectionOptionsControl.ObjectType ( )
virtual

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

HPS.SelectionOptionsControl 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).

Parameters
in_algorithmThe type of selection algorithm to use.
Returns
A reference to this SelectionOptionsControl.

Default value

HPS.SelectionOptionsControl 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 CullingControl) will be ignored.

Parameters
in_stateWhether to respect the deferral extent culling option during selection.
Returns
A reference to this SelectionOptionsControl.

Default value

HPS.SelectionOptionsControl 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 CullingControl) will be ignored.

Parameters
in_stateWhether to respect the extent culling option during selection.
Returns
A reference to this SelectionOptionsControl.

Default value

HPS.SelectionOptionsControl 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 CullingControl) will be ignored.

Parameters
in_stateWhether to respect the frustum culling option during selection.
Returns
A reference to this SelectionOptionsControl.

Default value

HPS.SelectionOptionsControl HPS.SelectionOptionsControl.SetGranularity ( HPS.Selection.Granularity  in_granularity)

Sets the selection granularity to use.

Parameters
in_granularityThe selection granularity to use.
Returns
A reference to this SelectionOptionsControl.

Default value

HPS.SelectionOptionsControl 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.

Parameters
in_limitThe internal selection limit.
Returns
A reference to this SelectionOptionsControl.

Default value

HPS.SelectionOptionsControl HPS.SelectionOptionsControl.SetLevel ( HPS.Selection.Level  in_level)

Sets the level at which selection will occur.

Parameters
in_levelThe level at which selection will occur.
Returns
A reference to this SelectionOptionsControl.

Default value

HPS.SelectionOptionsControl HPS.SelectionOptionsControl.SetProximity ( float  in_proximity)

Sets the selection proximity in centimeters.

This will throw an exception if a negative proximity value is specified.

Parameters
in_proximityThe radius around the selection point within which objects will be returned as selected. The value must be nonnegative.
Returns
A reference to this SelectionOptionsControl.

Default value

HPS.SelectionOptionsControl 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).

Parameters
in_limitLimit on the number of items that will be returned as selected when performing a selection.
Returns
A reference to this SelectionOptionsControl.

Default value

HPS.SelectionOptionsControl HPS.SelectionOptionsControl.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).

Parameters
in_sortedWhether to sort selection results by relevance.
Returns
A reference to this SelectionOptionsControl.

Default value

HPS.SelectionOptionsControl 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 CullingControl) will be ignored.

Parameters
in_stateWhether to respect the vector culling option during selection.
Returns
A reference to this SelectionOptionsControl.

Default value

bool HPS.SelectionOptionsControl.ShowAlgorithm ( out HPS.Selection.Algorithm  out_algorithm)

Shows the selection algorithm for the associated window.

Parameters
out_algorithmThe selection algorithm for the associated window.
Returns
true if the selection algorithm is valid, false otherwise.
bool HPS.SelectionOptionsControl.ShowDeferralExtentCullingRespected ( out bool  out_state)

Shows the deferral extent culling respected state for the associated window.

Parameters
out_stateThe deferral extent culling respected state.
Returns
true if the deferral extent culling respected state is valid, false otherwise.
bool HPS.SelectionOptionsControl.ShowExtentCullingRespected ( out bool  out_state)

Shows the extent culling respected state for the associated window.

Parameters
out_stateThe extent culling respected state.
Returns
true if the extent culling respected state is valid, false otherwise.
bool HPS.SelectionOptionsControl.ShowFrustumCullingRespected ( out bool  out_state)

Shows the frustum culling respected state for the associated window.

Parameters
out_stateThe frustum culling respected state.
Returns
true if the frustum culling respected state is valid, false otherwise.
bool HPS.SelectionOptionsControl.ShowGranularity ( out HPS.Selection.Granularity  out_granularity)

Shows the selection granularity for the associated window.

Parameters
out_granularityThe selection granularity for the associated window.
Returns
true if the selection granularity is valid, false otherwise.
bool HPS.SelectionOptionsControl.ShowInternalLimit ( out ulong  out_limit)

Shows the internal selection limit for the associated window.

Parameters
out_limitThe internal selection limit for the associated window.
Returns
true if the internal selection limit is valid, false otherwise.
bool HPS.SelectionOptionsControl.ShowLevel ( out HPS.Selection.Level  out_level)

Shows the selection level for the associated window.

Parameters
out_levelThe selection level for the associated window.
Returns
true if the level is valid, false otherwise.
bool HPS.SelectionOptionsControl.ShowProximity ( out float  out_proximity)

Shows the selection proximity for the associated window.

Parameters
out_proximityThe selection proximity for the associated window.
Returns
true if the proximity is valid, false otherwise.
bool HPS.SelectionOptionsControl.ShowRelatedLimit ( out ulong  out_limit)

Shows the related selection limit for the associated window.

Parameters
out_limitThe related selection limit for the associated window.
Returns
true if the related selection limit is valid, false otherwise.
bool HPS.SelectionOptionsControl.ShowSorting ( out bool  out_sorted)

Shows whether selection sorting is enabled for the associated window.

Parameters
out_sortedwhether selection sorting is enabled for the associated window.
Returns
true if the flag is valid, false otherwise.
bool HPS.SelectionOptionsControl.ShowVectorCullingRespected ( out bool  out_state)

Shows the vector culling respected state for the associated window.

Parameters
out_stateThe vector culling respected state.
Returns
true if the vector culling respected state is valid, false otherwise.

The documentation for this class was generated from the following file: