< Home

< Table of Contents

REFERENCE MANUAL

SelectionOptionsKit Class Reference

#include <hps.h>

Inheritance diagram for SelectionOptionsKit:
Object

Public Member Functions

bool Empty () const
 
bool Equals (SelectionOptionsKit const &in_kit) const
 
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)
 
SelectionOptionsKitSetDeferralExtentCullingRespected (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)
 
SelectionOptionsKitSetScope (KeyPath const &in_start_path)
 
SelectionOptionsKitSetSorting (bool in_sorted)
 
SelectionOptionsKitSetTreeContext (TreeContext const &in_tree_context)
 
SelectionOptionsKitSetVectorCullingRespected (bool in_state)
 
void Show (SelectionOptionsKit &out_kit) const
 
bool ShowAlgorithm (Selection::Algorithm &out_algorithm) const
 
bool ShowDeferralExtentCullingRespected (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) const
 
bool ShowSorting (bool &out_sorted) const
 
bool ShowTreeContext (TreeContext &out_tree_context) const
 
bool ShowVectorCullingRespected (bool &out_state) const
 
SelectionOptionsKitUnsetAlgorithm ()
 
SelectionOptionsKitUnsetDeferralExtentCullingRespected ()
 
SelectionOptionsKitUnsetEverything ()
 
SelectionOptionsKitUnsetExtentCullingRespected ()
 
SelectionOptionsKitUnsetFrustumCullingRespected ()
 
SelectionOptionsKitUnsetGranularity ()
 
SelectionOptionsKitUnsetInternalLimit ()
 
SelectionOptionsKitUnsetLevel ()
 
SelectionOptionsKitUnsetProximity ()
 
SelectionOptionsKitUnsetRelatedLimit ()
 
SelectionOptionsKitUnsetScope ()
 
SelectionOptionsKitUnsetSorting ()
 
SelectionOptionsKitUnsetTreeContext ()
 
SelectionOptionsKitUnsetVectorCullingRespected ()
 
- Public Member Functions inherited from Object
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (Type in_mask) const
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 
Type Type () const
 

Static Public Member Functions

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

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::SelectionOptionsKit ( )

The default constructor creates an empty SelectionOptionsKit object.

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

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

bool 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.
static SelectionOptionsKit 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.
Type SelectionOptionsKit::ObjectType ( ) const
inlinevirtual

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

bool 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.
SelectionOptionsKit& 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.
SelectionOptionsKit& 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.
bool 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.
void SelectionOptionsKit::Set ( SelectionOptionsKit const &  in_kit)

Copies the source SelectionOptionsKit into this SelectionOptionsKit.

Parameters
in_kitThe source SelectionOptionsKit to copy.
SelectionOptionsKit& 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
SelectionOptionsKit& 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.
See also
Default value
SelectionOptionsKit& 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.
See also
Default value
SelectionOptionsKit& 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.
See also
Default value
SelectionOptionsKit& 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
SelectionOptionsKit& 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.
SelectionOptionsKit& 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
SelectionOptionsKit& 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.
See also
Default value
SelectionOptionsKit& 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
SelectionOptionsKit& SelectionOptionsKit::SetScope ( SegmentKey const &  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.
SelectionOptionsKit& SelectionOptionsKit::SetScope ( KeyPath const &  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.
SelectionOptionsKit& 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.
See also
Default value
SelectionOptionsKit& SelectionOptionsKit::SetTreeContext ( TreeContext const &  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.
SelectionOptionsKit& 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.
See also
Default value Default value
void 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.
bool 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.
bool 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.
bool 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.
bool 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.
bool 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.
bool 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.
bool 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.
bool SelectionOptionsKit::ShowProximity ( float &  out_proximity) const

Shows the selection proximity.

Parameters
out_proximityThe selection proximity.
Returns
true if the proximity is valid, false otherwise.
bool 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.
bool SelectionOptionsKit::ShowScope ( KeyPath out_start_path) 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.
Returns
true if a selection scope was set, false otherwise.
bool SelectionOptionsKit::ShowSorting ( bool &  out_sorted) const

Shows whether selection sorting is enabled.

Parameters
out_sortedwhether selection sorting is enabled.
Returns
true if the flag is valid, false otherwise.
bool 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.
bool 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.
SelectionOptionsKit& SelectionOptionsKit::UnsetAlgorithm ( )

Removes the selection algorithm.

Returns
A reference to this SelectionOptionsKit.
SelectionOptionsKit& SelectionOptionsKit::UnsetDeferralExtentCullingRespected ( )

Removes the deferral extent culling respected option.

Returns
A reference to this SelectionOptionsKit.
SelectionOptionsKit& SelectionOptionsKit::UnsetEverything ( )

Removes all settings from this SelectionOptionsKit.

Returns
A reference to this SelectionOptionsKit.
SelectionOptionsKit& SelectionOptionsKit::UnsetExtentCullingRespected ( )

Removes the extent culling respected option.

Returns
A reference to this SelectionOptionsKit.
SelectionOptionsKit& SelectionOptionsKit::UnsetFrustumCullingRespected ( )

Removes the frustum culling respected option.

Returns
A reference to this SelectionOptionsKit.
SelectionOptionsKit& SelectionOptionsKit::UnsetGranularity ( )

Removes the selection granularity.

Returns
A reference to this SelectionOptionsKit.
SelectionOptionsKit& SelectionOptionsKit::UnsetInternalLimit ( )

Removes the internal selection limit.

Returns
A reference to this SelectionOptionsKit.
SelectionOptionsKit& SelectionOptionsKit::UnsetLevel ( )

Removes the selection level.

Returns
A reference to this SelectionOptionsKit.
SelectionOptionsKit& SelectionOptionsKit::UnsetProximity ( )

Removes the selection proximity.

Returns
A reference to this SelectionOptionsKit.
SelectionOptionsKit& SelectionOptionsKit::UnsetRelatedLimit ( )

Removes the related selection limit.

Returns
A reference to this SelectionOptionsKit.
SelectionOptionsKit& SelectionOptionsKit::UnsetScope ( )

Removes the selection scope setting from this SelectionOptionsKit.

Returns
A reference to this object.
SelectionOptionsKit& SelectionOptionsKit::UnsetSorting ( )

Removes whether selection sorting is enabled.

Returns
A reference to this SelectionOptionsKit.
SelectionOptionsKit& SelectionOptionsKit::UnsetTreeContext ( )

Removes the tree context from this SelectionOptionsKit.

Returns
A reference to this object.
SelectionOptionsKit& 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: