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

#include <hps.h>

Inheritance diagram for HPS::SelectionOptionsKit:

Collaboration diagram for HPS::SelectionOptionsKit:

Public Member Functions
	SelectionOptionsKit ()
	The default constructor creates an empty SelectionOptionsKit object. More...

	SelectionOptionsKit (SelectionOptionsKit const &in_kit)
	The copy constructor creates a new SelectionOptionsKit object that contains the same settings as the source SelectionOptionsKit. More...

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

SelectionOptionsKit &	operator= (SelectionOptionsKit &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this SelectionOptionsKit thereby avoiding a copy. More...

virtual	~SelectionOptionsKit ()

HPS::Type	ObjectType () const

void	Set (SelectionOptionsKit const &in_kit)
	Copies the source SelectionOptionsKit into this SelectionOptionsKit. More...

void	Show (SelectionOptionsKit &out_kit) const
	Copies this SelectionOptionsKit into the given SelectionOptionsKit. More...

SelectionOptionsKit &	operator= (SelectionOptionsKit const &in_kit)
	Copies the source SelectionOptionsKit into this SelectionOptionsKit. More...

bool	Empty () const
	Indicates whether this SelectionOptionsKit has any values set on it. More...

bool	Equals (SelectionOptionsKit const &in_kit) const
	Check if the source SelectionOptionsKit is equivalent to this SelectionOptionsKit. More...

bool	operator== (SelectionOptionsKit const &in_kit) const
	Check if the source SelectionOptionsKit is equivalent to this SelectionOptionsKit. More...

bool	operator!= (SelectionOptionsKit const &in_kit) const
	Check if the source SelectionOptionsKit is not equivalent to this SelectionOptionsKit. More...

SelectionOptionsKit &	SetProximity (float in_proximity)
	Sets the selection proximity in centimeters or object-relative-units (ORU), depending on the selection-routine being utilized. More...

SelectionOptionsKit &	SetLevel (Selection::Level in_level)
	Sets the level at which selection will occur. More...

SelectionOptionsKit &	SetInternalLimit (size_t in_limit)
	Sets the internal selection limit. More...

SelectionOptionsKit &	SetRelatedLimit (size_t in_limit)
	Sets the related selection limit. More...

SelectionOptionsKit &	SetSorting (bool in_sorting)
	Sets whether to sort selection results. More...

SelectionOptionsKit &	SetSorting (Selection::Sorting in_sorting)
	Sets how selection results will be sorted. More...

SelectionOptionsKit &	SetAlgorithm (Selection::Algorithm in_algorithm)
	Sets the type of selection algorithm to use. More...

SelectionOptionsKit &	SetGranularity (Selection::Granularity in_granularity)
	Sets the selection granularity to use. More...

SelectionOptionsKit &	SetScope (SegmentKey const &in_start_segment, bool in_scope_only=false)
	Sets the starting location at which selection testing will begin. More...

SelectionOptionsKit &	SetScope (KeyPath const &in_start_path, bool in_scope_only=false)
	Sets the starting location at which selection testing will begin. More...

SelectionOptionsKit &	SetTreeContext (TreeContext const &in_tree_context)
	Sets a TreeContext to be used for this selection. More...

SelectionOptionsKit &	SetExtentCullingRespected (bool in_state)
	Sets whether to respect the extent culling option during selection. More...

SelectionOptionsKit &	SetDeferralExtentCullingRespected (bool in_state)
	Sets whether to respect the deferral extent culling option during selection. More...

SelectionOptionsKit &	SetFrustumCullingRespected (bool in_state)
	Sets whether to respect the frustum culling option during selection. More...

SelectionOptionsKit &	SetVectorCullingRespected (bool in_state)
	Sets whether to respect the vector culling option during selection. More...

SelectionOptionsKit &	SetSelectability (SelectabilityKit const &in_selectability)
	Sets selectability options that are applied during the selection. More...

SelectionOptionsKit &	SetCondition (char const *in_condition)
	Sets a condition that is applied during the selection. More...

SelectionOptionsKit &	SetConditions (UTF8Array const &in_conditions)
	Sets conditions that are applied during the selection. More...

SelectionOptionsKit &	SetConditions (size_t in_count, UTF8 const in_conditions[])
	Sets conditions that are applied during the selection. More...

SelectionOptionsKit &	UnsetSelectability ()
	Removes the selectability settings. More...

SelectionOptionsKit &	UnsetProximity ()
	Removes the selection proximity. More...

SelectionOptionsKit &	UnsetLevel ()
	Removes the selection level. More...

SelectionOptionsKit &	UnsetInternalLimit ()
	Removes the internal selection limit. More...

SelectionOptionsKit &	UnsetRelatedLimit ()
	Removes the related selection limit. More...

SelectionOptionsKit &	UnsetSorting ()
	Removes the selection sorting setting. More...

SelectionOptionsKit &	UnsetAlgorithm ()
	Removes the selection algorithm. More...

SelectionOptionsKit &	UnsetGranularity ()
	Removes the selection granularity. More...

SelectionOptionsKit &	UnsetScope ()
	Removes the selection scope setting from this SelectionOptionsKit. More...

SelectionOptionsKit &	UnsetTreeContext ()
	Removes the tree context from this SelectionOptionsKit. More...

SelectionOptionsKit &	UnsetExtentCullingRespected ()
	Removes the extent culling respected option. More...

SelectionOptionsKit &	UnsetDeferralExtentCullingRespected ()
	Removes the deferral extent culling respected option. More...

SelectionOptionsKit &	UnsetFrustumCullingRespected ()
	Removes the frustum culling respected option. More...

SelectionOptionsKit &	UnsetVectorCullingRespected ()
	Removes the vector culling respected option. More...

SelectionOptionsKit &	UnsetConditions ()
	Unsets all conditions in this kit. More...

SelectionOptionsKit &	UnsetEverything ()
	Removes all settings from this SelectionOptionsKit. More...

bool	ShowProximity (float &out_proximity) const
	Shows the selection proximity. More...

bool	ShowLevel (Selection::Level &out_level) const
	Shows the selection level. More...

bool	ShowInternalLimit (size_t &out_limit) const
	Shows the internal selection limit. More...

bool	ShowRelatedLimit (size_t &out_limit) const
	Shows the related selection limit. More...

bool	ShowSorting (Selection::Sorting &out_sorting) const
	Shows the type of selection sorting. More...

bool	ShowAlgorithm (Selection::Algorithm &out_algorithm) const
	Shows the selection algorithm. More...

bool	ShowGranularity (Selection::Granularity &out_granularity) const
	Shows the selection granularity. More...

bool	ShowScope (KeyPath &out_start_path, bool &out_scope_only) const
	Shows the starting location at which selection testing will begin. More...

bool	ShowTreeContext (TreeContext &out_tree_context) const
	Shows the tree context for this SelectionOptionsKit. More...

bool	ShowExtentCullingRespected (bool &out_state) const
	Shows the extent culling respected state. More...

bool	ShowDeferralExtentCullingRespected (bool &out_state) const
	Shows the deferral extent culling respected state. More...

bool	ShowFrustumCullingRespected (bool &out_state) const
	Shows the frustum culling respected state. More...

bool	ShowVectorCullingRespected (bool &out_state) const
	Shows the vector culling respected state. More...

bool	ShowSelectability (HPS::SelectabilityKit &out_selectability) const
	Shows the selectability settings. More...

bool	ShowConditions (UTF8Array &out_conditions) const
	Shows all conditions in this kit. More...

virtual HPS::Type	Type () const
	This function returns the true type of the underlying object. More...

virtual void	Reset ()
	Resets this object to its initial, uninitialized state. More...

bool	HasType (HPS::Type in_mask) const
	This function indicates whether this Object has the given Type mask. More...

intptr_t	GetClassID () const
	Returns a unique identifier that is shared by all objects of the same class. More...

intptr_t	GetInstanceID () const
	Returns an identifier that can be used to identify which instance of a class an object is. More...

Static Public Member Functions
static SelectionOptionsKit	GetDefault ()
	Creates a SelectionOptionsKit which contains the default settings. More...

template<typename T >
static intptr_t	ClassID ()
	Unique identifier for this class. More...

Static Public Attributes
static const HPS::Type	staticType = HPS::Type::SelectionOptionsKit

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_kit The 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_that An rvalue reference to a SelectionOptionsKit to take the impl from.

◆ ~SelectionOptionsKit()

virtual HPS::SelectionOptionsKit::~SelectionOptionsKit ( )

virtual

Member Function Documentation

◆ ClassID()

template<typename T >

static intptr_t HPS::Object::ClassID ( )

inlinestaticinherited

Unique identifier for this class.

Note: this method uses construction of static objects. If used in a constructor, it should be used in the body not the initializer list.

◆ 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_kit The source SelectionOptionsKit to compare to this SelectionOptionsKit.

Returns: true if the objects are equivalent, false otherwise.

◆ GetClassID()

intptr_t HPS::Object::GetClassID ( ) const

inherited

Returns a unique identifier that is shared by all objects of the same class.

Returns: A unique value shared by all objects of the same class.

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

◆ GetInstanceID()

intptr_t HPS::Object::GetInstanceID ( ) const

inherited

Returns an identifier that can be used to identify which instance of a class an object is.

Different keys and controls will return the same value if they are backed by the same database resource.

Returns: A value unique to an instance of an object and all objects that are backed by the same database resource.

◆ HasType()

bool HPS::Object::HasType ( HPS::Type in_mask ) const

inherited

This function indicates whether this Object has the given Type mask.

Parameters

in_mask The Type mask to check against this Object.

Returns: true if this Object has the given Type mask, false otherwise.

◆ ObjectType()

HPS::Type HPS::SelectionOptionsKit::ObjectType ( ) const

inlinevirtual

Reimplemented from HPS::Kit.

Here is the call graph for this function:

◆ operator!=()

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

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

Parameters

in_kit The 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_that An 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_kit The 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_kit The source SelectionOptionsKit to compare to this SelectionOptionsKit.

Returns: true if the objects are equivalent, false otherwise.

◆ Reset()

virtual void HPS::Object::Reset ( )

virtualinherited

Resets this object to its initial, uninitialized state.

Reimplemented in HPS::EventHandler, HPS::EventDispatcher, HPS::World, HPS::HighlightSearchResults, HPS::HighlightSearchResultsIterator, HPS::SelectionResults, HPS::SelectionResultsIterator, HPS::FontSearchResults, HPS::FontSearchResultsIterator, HPS::SearchResults, and HPS::SearchResultsIterator.

◆ Set()

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

Copies the source SelectionOptionsKit into this SelectionOptionsKit.

Parameters

in_kit The 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_algorithm The 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_condition The 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_conditions The 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_conditions The 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_state Whether to respect the deferral extent culling option during selection.

Returns: A reference to this SelectionOptionsKit.

See also: 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_state Whether 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_state Whether 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_granularity The 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_limit The 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_level The 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_proximity The 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_limit Limit 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_segment	A segment, that must be a child of the window key, in which to begin selection testing.
in_scope_only	If 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_path	A path of segments and includes, leaf to root, from the segment to begin selection testing to the window key.
in_scope_only	If 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_selectability A 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_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 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_sorting The 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_context The 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_state Whether to respect the vector 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_kit The 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_algorithm The 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_state The deferral extent culling respected state.

Returns: true if the deferral extent culling respected state is valid, false otherwise.

◆ ShowExtentCullingRespected()

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

Shows the extent culling respected state.

Parameters

out_state The 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_state The 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_granularity The 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_limit The 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_level The 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_proximity The 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_limit The 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_path	A segment or collection of segments and includes organized from leaf to root.
out_scope_only	Whether 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_selectability The 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_sorting The 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_context The 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_state The vector culling respected state.

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

◆ Type()

virtual HPS::Type HPS::Kit::Type ( ) const

inlinevirtualinherited

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

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

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

Member Data Documentation

◆ staticType

const HPS::Type HPS::SelectionOptionsKit::staticType = HPS::Type::SelectionOptionsKit

static

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

hps.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SelectionOptionsKit() [1/3]

◆ SelectionOptionsKit() [2/3]

◆ SelectionOptionsKit() [3/3]

◆ ~SelectionOptionsKit()

Member Function Documentation

◆ ClassID()

◆ Empty()

◆ Equals()

◆ GetClassID()

◆ GetDefault()

◆ GetInstanceID()

◆ HasType()

◆ ObjectType()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ Reset()

◆ Set()

◆ SetAlgorithm()

◆ SetCondition()

◆ SetConditions() [1/2]

◆ SetConditions() [2/2]

◆ SetDeferralExtentCullingRespected()

◆ SetExtentCullingRespected()

◆ SetFrustumCullingRespected()

◆ SetGranularity()

◆ SetInternalLimit()

◆ SetLevel()

◆ SetProximity()

◆ SetRelatedLimit()

◆ SetScope() [1/2]

◆ SetScope() [2/2]

◆ SetSelectability()

◆ SetSorting() [1/2]

◆ SetSorting() [2/2]

◆ SetTreeContext()

◆ SetVectorCullingRespected()

◆ Show()

◆ ShowAlgorithm()

◆ ShowConditions()

◆ ShowDeferralExtentCullingRespected()

◆ ShowExtentCullingRespected()

◆ ShowFrustumCullingRespected()

◆ ShowGranularity()

◆ ShowInternalLimit()

◆ ShowLevel()

◆ ShowProximity()

◆ ShowRelatedLimit()

◆ ShowScope()

◆ ShowSelectability()

◆ ShowSorting()

◆ ShowTreeContext()

◆ ShowVectorCullingRespected()

◆ Type()

◆ UnsetAlgorithm()

◆ UnsetConditions()

◆ UnsetDeferralExtentCullingRespected()

◆ UnsetEverything()

◆ UnsetExtentCullingRespected()

◆ UnsetFrustumCullingRespected()

◆ UnsetGranularity()

◆ UnsetInternalLimit()

◆ UnsetLevel()

◆ UnsetProximity()

◆ UnsetRelatedLimit()

◆ UnsetScope()

◆ UnsetSelectability()

◆ UnsetSorting()

◆ UnsetTreeContext()

◆ UnsetVectorCullingRespected()

Member Data Documentation

◆ staticType