#include <hps.h>

Inheritance diagram for HPS::SelectionOptionsKit:
HPS::Kit HPS::Object

Public Member Functions

bool Empty () const
 
bool Equals (SelectionOptionsKit const &in_kit) const
 
HPS::Type ObjectType () const
 
bool operator!= (SelectionOptionsKit const &in_kit) const
 
SelectionOptionsKitoperator= (SelectionOptionsKit &&in_that)
 
SelectionOptionsKitoperator= (SelectionOptionsKit const &in_kit)
 
bool operator== (SelectionOptionsKit const &in_kit) const
 
 SelectionOptionsKit ()
 
 SelectionOptionsKit (SelectionOptionsKit const &in_kit)
 
 SelectionOptionsKit (SelectionOptionsKit &&in_that)
 
void Set (SelectionOptionsKit const &in_kit)
 
SelectionOptionsKitSetAlgorithm (Selection::Algorithm in_algorithm)
 
SelectionOptionsKitSetCondition (char const *in_condition)
 
SelectionOptionsKitSetConditions (UTF8Array const &in_conditions)
 
SelectionOptionsKitSetConditions (size_t in_count, UTF8 const in_conditions[])
 
SelectionOptionsKitSetDeferralExtentCullingRespected (bool in_state)
 
SelectionOptionsKitSetDistanceCullingRespected (bool in_state)
 
SelectionOptionsKitSetExtentCullingRespected (bool in_state)
 
SelectionOptionsKitSetFrustumCullingRespected (bool in_state)
 
SelectionOptionsKitSetGranularity (Selection::Granularity in_granularity)
 
SelectionOptionsKitSetInternalLimit (size_t in_limit)
 
SelectionOptionsKitSetLevel (Selection::Level in_level)
 
SelectionOptionsKitSetProximity (float in_proximity)
 
SelectionOptionsKitSetRelatedLimit (size_t in_limit)
 
SelectionOptionsKitSetScope (SegmentKey const &in_start_segment, bool in_scope_only=false)
 
SelectionOptionsKitSetScope (KeyPath const &in_start_path, bool in_scope_only=false)
 
SelectionOptionsKitSetSelectability (SelectabilityKit const &in_selectability)
 
SelectionOptionsKitSetSorting (bool in_sorting)
 
SelectionOptionsKitSetSorting (Selection::Sorting in_sorting)
 
SelectionOptionsKitSetTreeContext (TreeContext const &in_tree_context)
 
SelectionOptionsKitSetVectorCullingRespected (bool in_state)
 
SelectionOptionsKitSetVolumeCullingRespected (bool in_state)
 
void Show (SelectionOptionsKit &out_kit) const
 
bool ShowAlgorithm (Selection::Algorithm &out_algorithm) const
 
bool ShowConditions (UTF8Array &out_conditions) const
 
bool ShowDeferralExtentCullingRespected (bool &out_state) const
 
bool ShowDistanceCullingRespected (bool &out_state) const
 
bool ShowExtentCullingRespected (bool &out_state) const
 
bool ShowFrustumCullingRespected (bool &out_state) const
 
bool ShowGranularity (Selection::Granularity &out_granularity) const
 
bool ShowInternalLimit (size_t &out_limit) const
 
bool ShowLevel (Selection::Level &out_level) const
 
bool ShowProximity (float &out_proximity) const
 
bool ShowRelatedLimit (size_t &out_limit) const
 
bool ShowScope (KeyPath &out_start_path, bool &out_scope_only) const
 
bool ShowSelectability (HPS::SelectabilityKit &out_selectability) const
 
bool ShowSorting (Selection::Sorting &out_sorting) const
 
bool ShowTreeContext (TreeContext &out_tree_context) const
 
bool ShowVectorCullingRespected (bool &out_state) const
 
bool ShowVolumeCullingRespected (bool &out_state) const
 
SelectionOptionsKitUnsetAlgorithm ()
 
SelectionOptionsKitUnsetConditions ()
 
SelectionOptionsKitUnsetDeferralExtentCullingRespected ()
 
SelectionOptionsKitUnsetDistanceCullingRespected ()
 
SelectionOptionsKitUnsetEverything ()
 
SelectionOptionsKitUnsetExtentCullingRespected ()
 
SelectionOptionsKitUnsetFrustumCullingRespected ()
 
SelectionOptionsKitUnsetGranularity ()
 
SelectionOptionsKitUnsetInternalLimit ()
 
SelectionOptionsKitUnsetLevel ()
 
SelectionOptionsKitUnsetProximity ()
 
SelectionOptionsKitUnsetRelatedLimit ()
 
SelectionOptionsKitUnsetScope ()
 
SelectionOptionsKitUnsetSelectability ()
 
SelectionOptionsKitUnsetSorting ()
 
SelectionOptionsKitUnsetTreeContext ()
 
SelectionOptionsKitUnsetVectorCullingRespected ()
 
SelectionOptionsKitUnsetVolumeCullingRespected ()
 
- Public Member Functions inherited from HPS::Kit
virtual HPS::Type Type () const
 
- Public Member Functions inherited from HPS::Object
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
 Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 

Static Public Member Functions

static SelectionOptionsKit GetDefault ()
 
- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::SelectionOptionsKit
 
- Static Public Attributes inherited from HPS::Kit
static const HPS::Type staticType = HPS::Type::Kit
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Protected Member Functions inherited from HPS::Kit
 Kit (Kit &&in_that)
 
Kitoperator= (Kit &&in_that)
 

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

◆ SelectionOptionsKit() [1/3]

HPS::SelectionOptionsKit::SelectionOptionsKit ( )

The default constructor creates an empty SelectionOptionsKit object.

◆ SelectionOptionsKit() [2/3]

HPS::SelectionOptionsKit::SelectionOptionsKit ( SelectionOptionsKit const &  in_kit)

The copy constructor creates a new SelectionOptionsKit object that contains the same settings as the source SelectionOptionsKit.

Parameters
in_kitThe source SelectionOptionsKit to copy.

◆ SelectionOptionsKit() [3/3]

HPS::SelectionOptionsKit::SelectionOptionsKit ( SelectionOptionsKit &&  in_that)

The move constructor creates a SelectionOptionsKit by transferring the underlying impl of the rvalue reference to this SelectionOptionsKit thereby avoiding a copy and allocation.

Parameters
in_thatAn rvalue reference to a SelectionOptionsKit to take the impl from.

Member Function Documentation

◆ Empty()

bool HPS::SelectionOptionsKit::Empty ( ) const
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.

◆ Equals()

bool HPS::SelectionOptionsKit::Equals ( SelectionOptionsKit const &  in_kit) const

Check if the source SelectionOptionsKit is equivalent to this SelectionOptionsKit.

Parameters
in_kitThe source SelectionOptionsKit to compare to this SelectionOptionsKit.
Returns
true if the objects are equivalent, false otherwise.

◆ GetDefault()

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

◆ ObjectType()

HPS::Type HPS::SelectionOptionsKit::ObjectType ( ) const
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::Kit.

◆ operator!=()

bool HPS::SelectionOptionsKit::operator!= ( SelectionOptionsKit const &  in_kit) const

Check if the source SelectionOptionsKit is not equivalent to this SelectionOptionsKit.

Parameters
in_kitThe source SelectionOptionsKit to compare to this SelectionOptionsKit.
Returns
true if the objects are not equivalent, false otherwise.

◆ operator=() [1/2]

SelectionOptionsKit& HPS::SelectionOptionsKit::operator= ( SelectionOptionsKit &&  in_that)

The move assignment operator transfers the underlying impl of the rvalue reference to this SelectionOptionsKit thereby avoiding a copy.

Parameters
in_thatAn rvalue reference to a SelectionOptionsKit to take the impl from.
Returns
A reference to this SelectionOptionsKit.

◆ operator=() [2/2]

SelectionOptionsKit& HPS::SelectionOptionsKit::operator= ( SelectionOptionsKit const &  in_kit)

Copies the source SelectionOptionsKit into this SelectionOptionsKit.

Parameters
in_kitThe source SelectionOptionsKit to copy.
Returns
A reference to this SelectionOptionsKit.

◆ operator==()

bool HPS::SelectionOptionsKit::operator== ( SelectionOptionsKit const &  in_kit) const

Check if the source SelectionOptionsKit is equivalent to this SelectionOptionsKit.

Parameters
in_kitThe source SelectionOptionsKit to compare to this SelectionOptionsKit.
Returns
true if the objects are equivalent, false otherwise.

◆ Set()

void HPS::SelectionOptionsKit::Set ( SelectionOptionsKit const &  in_kit)

Copies the source SelectionOptionsKit into this SelectionOptionsKit.

Parameters
in_kitThe source SelectionOptionsKit to copy.

◆ SetAlgorithm()

SelectionOptionsKit& HPS::SelectionOptionsKit::SetAlgorithm ( 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.
See also
Default value

◆ SetCondition()

SelectionOptionsKit& HPS::SelectionOptionsKit::SetCondition ( char const *  in_condition)

Sets a condition that is applied during the selection. This allows you to use condition logic during a selection without actually activating those conditions in the scene.

Parameters
in_conditionThe condition to set on this kit, replacing any existing conditions.
Returns
A reference to this SelectionOptionsKit.

◆ SetConditions() [1/2]

SelectionOptionsKit& HPS::SelectionOptionsKit::SetConditions ( UTF8Array const &  in_conditions)

Sets conditions that are applied during the selection. This allows you to use condition logic during a selection without actually activating those conditions in the scene.

Parameters
in_conditionsThe conditions to set on this kit, replacing any existing conditions.
Returns
A reference to this SelectionOptionsKit.

◆ SetConditions() [2/2]

SelectionOptionsKit& HPS::SelectionOptionsKit::SetConditions ( size_t  in_count,
UTF8 const  in_conditions[] 
)

Sets conditions that are applied during the selection. This allows you to use condition logic during a selection without actually activating those conditions in the scene.

Parameters
in_conditionsThe conditions to set on this kit, replacing any existing conditions.
Returns
A reference to this SelectionOptionsKit.

◆ SetDeferralExtentCullingRespected()

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 HPS::CullingKit) will be ignored.

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

◆ SetDistanceCullingRespected()

SelectionOptionsKit& HPS::SelectionOptionsKit::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::CullingKit) will be ignored.

Parameters
in_stateWhether to respect the distance culling option during selection.
Returns
A reference to this SelectionOptionsKit.
See also
Default value Default value

◆ SetExtentCullingRespected()

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 HPS::CullingKit) will be ignored.

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

◆ SetFrustumCullingRespected()

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 HPS::CullingKit) will be ignored.

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

◆ SetGranularity()

SelectionOptionsKit& HPS::SelectionOptionsKit::SetGranularity ( Selection::Granularity  in_granularity)

Sets the selection granularity to use.

Parameters
in_granularityThe selection granularity to use.
Returns
A reference to this SelectionOptionsKit.
See also
Default value

◆ SetInternalLimit()

SelectionOptionsKit& HPS::SelectionOptionsKit::SetInternalLimit ( size_t  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
See also
Internal limit in Programming Guide

◆ SetLevel()

SelectionOptionsKit& HPS::SelectionOptionsKit::SetLevel ( 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.
See also
Default value

◆ SetProximity()

SelectionOptionsKit& HPS::SelectionOptionsKit::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.

For HPS::SelectionControl::SelectByPoint, this specifies the radius in centimeters around the selection within which objects will be returned as selected. The value must be positive.

For HPS::SelectionControl::SelectByShell, this specifies a distance in object-relative-units that determines whether a selection is performed. A positive proximity value will cause the selection algorithm to perform a selection when the distance between the two bodies is <= proximity, which means the bodies do not have to be touching in order for Visualize to perform a selection. If the proximity == 0, the bodies must be coincident or penetrating for a selection to occur. If proximity < 0, the shells must penetrate each other by at least that amount before a selection is performed.

Selection proximity is not relevant for other selection types.

When using HPS::SelectionControl::SelectByShell, false positives or negatives for selection may occur if the proximity and/or selection shells meet any of the following criteria:

  • The absolute value of a negative proximity is much larger than the actual intersection of the shells. An example would be a shell that represents a thin plate or a thinly-walled tube, and the specified proximity is larger than the thickness of the plate or tube.
  • Selection shells ("probes") have vertices with complex intersections
  • Selection shells ("probes") have concavities, especially multiple adjacent concavities.
Parameters
in_proximityThe radius around the selection within which objects will be returned as selected.
Returns
A reference to this SelectionOptionsKit.
See also
Default value
Collision detection proximity

◆ SetRelatedLimit()

SelectionOptionsKit& HPS::SelectionOptionsKit::SetRelatedLimit ( size_t  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.
See also
Default value
Related limit in Programming Guide
SetSorting(Selection::Sorting)

◆ SetScope() [1/2]

SelectionOptionsKit& HPS::SelectionOptionsKit::SetScope ( SegmentKey const &  in_start_segment,
bool  in_scope_only = false 
)

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.
in_scope_onlyIf true selections will only occur in the provided scope segment, otherwise selections will occur in subsegments and includes of in_start_segment as well.
Returns
A reference to this SelectionOptionsKit.

◆ SetScope() [2/2]

SelectionOptionsKit& HPS::SelectionOptionsKit::SetScope ( KeyPath const &  in_start_path,
bool  in_scope_only = false 
)

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.
in_scope_onlyIf true selections will only occur in the leaf segments of in_start_path, otherwise selections will occur in subsegments and includes of the leaf segments of in_start_path as well.
Returns
A reference to this SelectionOptionsKit.

◆ SetSelectability()

SelectionOptionsKit& HPS::SelectionOptionsKit::SetSelectability ( SelectabilityKit const &  in_selectability)

Sets selectability options that are applied during the selection.

Parameters
in_selectabilityA HPS::SelectabilityKit that encapsulates the selectability options to set on this kit.
Returns
A reference to this SelectionOptionsKit.

◆ SetSorting() [1/2]

SelectionOptionsKit& HPS::SelectionOptionsKit::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.

Parameters
in_sortingWhether 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 SelectionOptionsKit.
See also
Default value
Deprecated:
This function exists for compatibility and SetSorting(Selection::Sorting) should be preferred in general usage.

◆ SetSorting() [2/2]

SelectionOptionsKit& HPS::SelectionOptionsKit::SetSorting ( Selection::Sorting  in_sorting)

Sets how selection results will be sorted.

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.

This option has no effect on SelectByShell.

For SelectByPoint, all values of the Selection::Sorting enum apply. Selection::Sorting::Default is an alias for Selection::Sorting::Proximity.

For all other selection types, Selection::Sorting::Proximity does not apply. Selection::Sorting::Default is an alias for Selection::Sorting::ZSorting.

Parameters
in_sortingThe type of selection sorting to use.
Returns
A reference to this SelectionOptionsKit.
See also
Default value
Related limit in Programming Guide
SetRelatedLimit()

◆ SetTreeContext()

SelectionOptionsKit& HPS::SelectionOptionsKit::SetTreeContext ( TreeContext const &  in_tree_context)

Sets a TreeContext to be used for this selection. If many shell 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 a TreeContext 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.

◆ SetVectorCullingRespected()

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 HPS::CullingKit) will be ignored.

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

◆ SetVolumeCullingRespected()

SelectionOptionsKit& HPS::SelectionOptionsKit::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::CullingKit) will be ignored.

Parameters
in_stateWhether to respect the volume culling option during selection.
Returns
A reference to this SelectionOptionsKit.
See also
Default value Default value

◆ Show()

void HPS::SelectionOptionsKit::Show ( SelectionOptionsKit out_kit) const

Copies this SelectionOptionsKit into the given SelectionOptionsKit.

Parameters
out_kitThe SelectionOptionsKit to populate with the contents of this SelectionOptionsKit.

◆ ShowAlgorithm()

bool HPS::SelectionOptionsKit::ShowAlgorithm ( Selection::Algorithm out_algorithm) const

Shows the selection algorithm.

Parameters
out_algorithmThe selection algorithm.
Returns
true if the selection algorithm is valid, false otherwise.

◆ ShowConditions()

bool HPS::SelectionOptionsKit::ShowConditions ( UTF8Array out_conditions) const

Shows all conditions in this kit.

Returns
true if theere are conditions to show, false otherwise.

◆ ShowDeferralExtentCullingRespected()

bool HPS::SelectionOptionsKit::ShowDeferralExtentCullingRespected ( bool &  out_state) const

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.

◆ ShowDistanceCullingRespected()

bool HPS::SelectionOptionsKit::ShowDistanceCullingRespected ( bool &  out_state) const

Shows the distance culling respected state.

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

◆ ShowExtentCullingRespected()

bool HPS::SelectionOptionsKit::ShowExtentCullingRespected ( bool &  out_state) const

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.

◆ ShowFrustumCullingRespected()

bool HPS::SelectionOptionsKit::ShowFrustumCullingRespected ( bool &  out_state) const

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.

◆ ShowGranularity()

bool HPS::SelectionOptionsKit::ShowGranularity ( Selection::Granularity out_granularity) const

Shows the selection granularity.

Parameters
out_granularityThe selection granularity.
Returns
true if the selection granularity is valid, false otherwise.

◆ ShowInternalLimit()

bool HPS::SelectionOptionsKit::ShowInternalLimit ( size_t &  out_limit) const

Shows the internal selection limit.

Parameters
out_limitThe internal selection limit.
Returns
true if the internal selection limit is valid, false otherwise.

◆ ShowLevel()

bool HPS::SelectionOptionsKit::ShowLevel ( Selection::Level out_level) const

Shows the selection level.

Parameters
out_levelThe selection level.
Returns
true if the level is valid, false otherwise.

◆ ShowProximity()

bool HPS::SelectionOptionsKit::ShowProximity ( float &  out_proximity) const

Shows the selection proximity.

Parameters
out_proximityThe selection proximity.
Returns
true if the proximity is valid, false otherwise.

◆ ShowRelatedLimit()

bool HPS::SelectionOptionsKit::ShowRelatedLimit ( size_t &  out_limit) const

Shows the related selection limit.

Parameters
out_limitThe related selection limit.
Returns
true if the related selection limit is valid, false otherwise.

◆ ShowScope()

bool HPS::SelectionOptionsKit::ShowScope ( KeyPath out_start_path,
bool &  out_scope_only 
) const

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.
out_scope_onlyWhether selections will only occur in the leaf segments of out_start_path or if they can occur in subsegments and includes of the leaf segments of out_start_path.
Returns
true if a selection scope was set, false otherwise.

◆ ShowSelectability()

bool HPS::SelectionOptionsKit::ShowSelectability ( HPS::SelectabilityKit out_selectability) const

Shows the selectability settings.

Parameters
out_selectabilityThe selectability settings
Returns
true if the selectability settings are valid, false otherwise.

◆ ShowSorting()

bool HPS::SelectionOptionsKit::ShowSorting ( Selection::Sorting out_sorting) const

Shows the type of selection sorting.

Parameters
out_sortingThe type of selection sorting to use.
Returns
true if the selection sorting type is valid, false otherwise.

◆ ShowTreeContext()

bool HPS::SelectionOptionsKit::ShowTreeContext ( TreeContext out_tree_context) const

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.

◆ ShowVectorCullingRespected()

bool HPS::SelectionOptionsKit::ShowVectorCullingRespected ( bool &  out_state) const

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.

◆ ShowVolumeCullingRespected()

bool HPS::SelectionOptionsKit::ShowVolumeCullingRespected ( bool &  out_state) const

Shows the volume culling respected state.

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

◆ UnsetAlgorithm()

SelectionOptionsKit& HPS::SelectionOptionsKit::UnsetAlgorithm ( )

Removes the selection algorithm.

Returns
A reference to this SelectionOptionsKit.

◆ UnsetConditions()

SelectionOptionsKit& HPS::SelectionOptionsKit::UnsetConditions ( )

Unsets all conditions in this kit.

◆ UnsetDeferralExtentCullingRespected()

SelectionOptionsKit& HPS::SelectionOptionsKit::UnsetDeferralExtentCullingRespected ( )

Removes the deferral extent culling respected option.

Returns
A reference to this SelectionOptionsKit.

◆ UnsetDistanceCullingRespected()

SelectionOptionsKit& HPS::SelectionOptionsKit::UnsetDistanceCullingRespected ( )

Removes the distance culling respected option.

Returns
A reference to this SelectionOptionsKit.

◆ UnsetEverything()

SelectionOptionsKit& HPS::SelectionOptionsKit::UnsetEverything ( )

Removes all settings from this SelectionOptionsKit.

Returns
A reference to this SelectionOptionsKit.

◆ UnsetExtentCullingRespected()

SelectionOptionsKit& HPS::SelectionOptionsKit::UnsetExtentCullingRespected ( )

Removes the extent culling respected option.

Returns
A reference to this SelectionOptionsKit.

◆ UnsetFrustumCullingRespected()

SelectionOptionsKit& HPS::SelectionOptionsKit::UnsetFrustumCullingRespected ( )

Removes the frustum culling respected option.

Returns
A reference to this SelectionOptionsKit.

◆ UnsetGranularity()

SelectionOptionsKit& HPS::SelectionOptionsKit::UnsetGranularity ( )

Removes the selection granularity.

Returns
A reference to this SelectionOptionsKit.

◆ UnsetInternalLimit()

SelectionOptionsKit& HPS::SelectionOptionsKit::UnsetInternalLimit ( )

Removes the internal selection limit.

Returns
A reference to this SelectionOptionsKit.

◆ UnsetLevel()

SelectionOptionsKit& HPS::SelectionOptionsKit::UnsetLevel ( )

Removes the selection level.

Returns
A reference to this SelectionOptionsKit.

◆ UnsetProximity()

SelectionOptionsKit& HPS::SelectionOptionsKit::UnsetProximity ( )

Removes the selection proximity.

Returns
A reference to this SelectionOptionsKit.

◆ UnsetRelatedLimit()

SelectionOptionsKit& HPS::SelectionOptionsKit::UnsetRelatedLimit ( )

Removes the related selection limit.

Returns
A reference to this SelectionOptionsKit.

◆ UnsetScope()

SelectionOptionsKit& HPS::SelectionOptionsKit::UnsetScope ( )

Removes the selection scope setting from this SelectionOptionsKit.

Returns
A reference to this object.

◆ UnsetSelectability()

SelectionOptionsKit& HPS::SelectionOptionsKit::UnsetSelectability ( )

Removes the selectability settings.

Returns
A reference to this SelectionOptionsKit.

◆ UnsetSorting()

SelectionOptionsKit& HPS::SelectionOptionsKit::UnsetSorting ( )

Removes the selection sorting setting.

Returns
A reference to this SelectionOptionsKit.

◆ UnsetTreeContext()

SelectionOptionsKit& HPS::SelectionOptionsKit::UnsetTreeContext ( )

Removes the tree context from this SelectionOptionsKit.

Returns
A reference to this object.

◆ UnsetVectorCullingRespected()

SelectionOptionsKit& HPS::SelectionOptionsKit::UnsetVectorCullingRespected ( )

Removes the vector culling respected option.

Returns
A reference to this SelectionOptionsKit.

◆ UnsetVolumeCullingRespected()

SelectionOptionsKit& HPS::SelectionOptionsKit::UnsetVolumeCullingRespected ( )

Removes the volume culling respected option.

Returns
A reference to this SelectionOptionsKit.

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