< Home

< Table of Contents

REFERENCE MANUAL

HPS.SelectionOptionsKit Class Reference

The SelectionOptionsKit class is a user space object. More...

Inheritance diagram for HPS.SelectionOptionsKit:
HPS.Object

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...
 
- Public Member Functions inherited from HPS.Object
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 Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

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

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 
HandleRef scptr
 

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

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.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_selection_options_kit" kindref="compound">SelectionOptionsKit</ref> to copy.

Member Function Documentation

override bool HPS.SelectionOptionsKit.Empty ( )
virtual

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.

bool HPS.SelectionOptionsKit.Equals ( HPS.SelectionOptionsKit  in_kit)

Check if the source SelectionOptionsKit is equivalent to this SelectionOptionsKit.

Parameters
in_kitThe 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>.
Returns
true if the objects are equivalent, false otherwise.
static HPS.SelectionOptionsKit HPS.SelectionOptionsKit.GetDefault ( )
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.

Returns
A SelectionOptionsKit with the default settings.
override HPS.Type HPS.SelectionOptionsKit.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.

void HPS.SelectionOptionsKit.Set ( HPS.SelectionOptionsKit  in_kit)

Copies the source SelectionOptionsKit into this SelectionOptionsKit.

Parameters
in_kitThe 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).

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

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.

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

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.

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

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.

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

Default value

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

Sets the selection granularity to use.

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

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.

Parameters
in_limitThe internal selection limit.
Returns
A reference to this SelectionOptionsKit.
HPS.SelectionOptionsKit HPS.SelectionOptionsKit.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 SelectionOptionsKit.

Default value

HPS.SelectionOptionsKit HPS.SelectionOptionsKit.SetProximity ( float  in_proximity)

Sets the selection proximity in centimeters.

Parameters
in_proximityThe 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.
Returns
A reference to this SelectionOptionsKit.

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

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

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.

Parameters
in_start_segmentA segment, that must be a child of the window key, in which to begin selection testing.
Returns
A reference to this SelectionOptionsKit.
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.

Parameters
in_start_pathA 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.
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).

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

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.

Parameters
in_tree_contextThe tree context to use for this relation test.
Returns
A reference to this object.
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.

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

Default value Default value

void HPS.SelectionOptionsKit.Show ( out HPS.SelectionOptionsKit  out_kit)

Copies this SelectionOptionsKit into the given SelectionOptionsKit.

Parameters
out_kitThe <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.

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

Shows the deferral extent culling respected state.

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

Shows the extent culling respected state.

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

Shows the frustum culling respected state.

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

Shows the selection granularity.

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

Shows the internal selection limit.

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

Shows the selection level.

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

Shows the selection proximity.

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

Shows the related selection limit.

Parameters
out_limitThe related selection limit.
Returns
true if the related selection limit is valid, false otherwise.
bool HPS.SelectionOptionsKit.ShowScope ( out HPS.KeyPath  out_start_path)

Shows the starting location at which selection testing will begin.

Parameters
out_start_pathA segment or collection of segments and includes organized from leaf to root.
Returns
true if a selection scope was set, false otherwise.
bool HPS.SelectionOptionsKit.ShowSorting ( out bool  out_sorted)

Shows whether selection sorting is enabled.

Parameters
out_sortedwhether selection sorting is enabled.
Returns
true if the flag is valid, false otherwise.
bool HPS.SelectionOptionsKit.ShowTreeContext ( out HPS.TreeContext  out_tree_context)

Shows the tree context for this SelectionOptionsKit.

Parameters
out_tree_contextThe tree context to use for this relation test.
Returns
true if a tree context was set, false otherwise.
bool HPS.SelectionOptionsKit.ShowVectorCullingRespected ( out bool  out_state)

Shows the vector culling respected state.

Parameters
out_stateThe vector culling respected state.
Returns
true if the vector culling respected state is valid, false otherwise.
HPS.SelectionOptionsKit HPS.SelectionOptionsKit.UnsetAlgorithm ( )

Removes the selection algorithm.

Returns
A reference to this SelectionOptionsKit.
HPS.SelectionOptionsKit HPS.SelectionOptionsKit.UnsetDeferralExtentCullingRespected ( )

Removes the deferral extent culling respected option.

Returns
A reference to this SelectionOptionsKit.
HPS.SelectionOptionsKit HPS.SelectionOptionsKit.UnsetEverything ( )

Removes all settings from this SelectionOptionsKit.

Returns
A reference to this SelectionOptionsKit.
HPS.SelectionOptionsKit HPS.SelectionOptionsKit.UnsetExtentCullingRespected ( )

Removes the extent culling respected option.

Returns
A reference to this SelectionOptionsKit.
HPS.SelectionOptionsKit HPS.SelectionOptionsKit.UnsetFrustumCullingRespected ( )

Removes the frustum culling respected option.

Returns
A reference to this SelectionOptionsKit.
HPS.SelectionOptionsKit HPS.SelectionOptionsKit.UnsetGranularity ( )

Removes the selection granularity.

Returns
A reference to this SelectionOptionsKit.
HPS.SelectionOptionsKit HPS.SelectionOptionsKit.UnsetInternalLimit ( )

Removes the internal selection limit.

Returns
A reference to this SelectionOptionsKit.
HPS.SelectionOptionsKit HPS.SelectionOptionsKit.UnsetLevel ( )

Removes the selection level.

Returns
A reference to this SelectionOptionsKit.
HPS.SelectionOptionsKit HPS.SelectionOptionsKit.UnsetProximity ( )

Removes the selection proximity.

Returns
A reference to this SelectionOptionsKit.
HPS.SelectionOptionsKit HPS.SelectionOptionsKit.UnsetRelatedLimit ( )

Removes the related selection limit.

Returns
A reference to this SelectionOptionsKit.
HPS.SelectionOptionsKit HPS.SelectionOptionsKit.UnsetScope ( )

Removes the selection scope setting from this SelectionOptionsKit.

Returns
A reference to this object.
HPS.SelectionOptionsKit HPS.SelectionOptionsKit.UnsetSorting ( )

Removes whether selection sorting is enabled.

Returns
A reference to this SelectionOptionsKit.
HPS.SelectionOptionsKit HPS.SelectionOptionsKit.UnsetTreeContext ( )

Removes the tree context from this SelectionOptionsKit.

Returns
A reference to this object.
HPS.SelectionOptionsKit HPS.SelectionOptionsKit.UnsetVectorCullingRespected ( )

Removes the vector culling respected option.

Returns
A reference to this SelectionOptionsKit.

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