#include <hps.h>

Inheritance diagram for HPS::ShellRelationOptionsKit:

Collaboration diagram for HPS::ShellRelationOptionsKit:

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

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

	ShellRelationOptionsKit (ShellRelationOptionsKit &&in_that)
	The move constructor creates a ShellRelationOptionsKit by transferring the underlying impl of the rvalue reference to this ShellRelationOptionsKit thereby avoiding a copy and allocation. More...

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

virtual	~ShellRelationOptionsKit ()

HPS::Type	ObjectType () const

void	Consume (ShellRelationOptionsKit &in_kit)
	Copies the source ShellRelationOptionsKit into this ShellRelationOptionsKit and resets the source kit. More...

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

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

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

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

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

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

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

ShellRelationOptionsKit &	SetTolerance (float in_tolerance)
	Sets the tolerance within which points will be considered on the shell. More...

ShellRelationOptionsKit &	SetTest (Shell::RelationTest in_test)
	Sets the type of relation test that should be performed. More...

ShellRelationOptionsKit &	SetTreeContext (TreeContext const &in_tree_context)
	Sets a TreeContext to be used for this relation test. More...

ShellRelationOptionsKit &	SetNearestFaceCalculation (bool in_state)
	Sets whether the nearest face should be calculated in addition to the primary relation test. More...

ShellRelationOptionsKit &	UnsetTolerance ()
	Removes the tolerance value from this ShellRelationOptionsKit. More...

ShellRelationOptionsKit &	UnsetTest ()
	Removes the test value from this ShellRelationOptionsKit. More...

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

ShellRelationOptionsKit &	UnsetNearestFaceCalculation ()
	Removes the nearest face calculation setting from this ShellRelationOptionsKit. More...

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

bool	ShowTolerance (float &out_tolerance) const
	Shows the value of the tolerance for this ShellRelationOptionsKit. More...

bool	ShowTest (Shell::RelationTest &out_test) const
	Shows the relation test for this ShellRelationOptionsKit. More...

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

bool	ShowNearestFaceCalculation (bool &out_state) const
	Shows the nearest face calculation setting for this ShellRelationOptionsKit. 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 ShellRelationOptionsKit	GetDefault ()
	Creates a ShellRelationOptionsKit 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::ShellRelationOptionsKit

Detailed Description

The HPS::ShellRelationOptionsKit class is a user space object. It is used for setting options for a shell relation operation. Calling HPS::ShellRelationOptionsKit::GetDefault() will return an options kit with values found in this table.

Constructor & Destructor Documentation

◆ ShellRelationOptionsKit() [1/3]

HPS::ShellRelationOptionsKit::ShellRelationOptionsKit ( )

The default constructor creates an empty ShellRelationOptionsKit object.

◆ ShellRelationOptionsKit() [2/3]

HPS::ShellRelationOptionsKit::ShellRelationOptionsKit ( ShellRelationOptionsKit const & in_kit )

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

Parameters

in_kit The source ShellRelationOptionsKit to copy.

◆ ShellRelationOptionsKit() [3/3]

HPS::ShellRelationOptionsKit::ShellRelationOptionsKit ( ShellRelationOptionsKit && in_that )

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

Parameters

in_that An rvalue reference to a ShellRelationOptionsKit to take the impl from.

◆ ~ShellRelationOptionsKit()

virtual HPS::ShellRelationOptionsKit::~ShellRelationOptionsKit ( )

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.

◆ Consume()

void HPS::ShellRelationOptionsKit::Consume ( ShellRelationOptionsKit & in_kit )

Copies the source ShellRelationOptionsKit into this ShellRelationOptionsKit and resets the source kit.

Parameters

in_kit The source ShellRelationOptionsKit to consume.

◆ Empty()

bool HPS::ShellRelationOptionsKit::Empty ( ) const

virtual

Indicates whether this ShellRelationOptionsKit has any values set on it.

Returns: true if no values are set on this ShellRelationOptionsKit, false otherwise.

Reimplemented from HPS::Object.

◆ Equals()

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

Check if the source ShellRelationOptionsKit is equivalent to this ShellRelationOptionsKit.

Parameters

in_kit The source ShellRelationOptionsKit to compare to this ShellRelationOptionsKit.

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 ShellRelationOptionsKit HPS::ShellRelationOptionsKit::GetDefault ( )

static

Creates a ShellRelationOptionsKit 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 ShellRelationOptionsKit 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::ShellRelationOptionsKit::ObjectType ( ) const

inlinevirtual

Reimplemented from HPS::Kit.

Here is the call graph for this function:

◆ operator!=()

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

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

Parameters

in_kit The source ShellRelationOptionsKit to compare to this ShellRelationOptionsKit.

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

◆ operator=() [1/2]

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

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

Parameters

in_that An rvalue reference to a ShellRelationOptionsKit to take the impl from.

Returns: A reference to this ShellRelationOptionsKit.

◆ operator=() [2/2]

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

Copies the source ShellRelationOptionsKit into this ShellRelationOptionsKit.

Parameters

in_kit The source ShellRelationOptionsKit to copy.

Returns: A reference to this ShellRelationOptionsKit.

◆ operator==()

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

Check if the source ShellRelationOptionsKit is equivalent to this ShellRelationOptionsKit.

Parameters

in_kit The source ShellRelationOptionsKit to compare to this ShellRelationOptionsKit.

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::ShellRelationOptionsKit::Set ( ShellRelationOptionsKit const & in_kit )

Copies the source ShellRelationOptionsKit into this ShellRelationOptionsKit.

Parameters

in_kit The source ShellRelationOptionsKit to copy.

◆ SetNearestFaceCalculation()

ShellRelationOptionsKit& HPS::ShellRelationOptionsKit::SetNearestFaceCalculation ( bool in_state )

Sets whether the nearest face should be calculated in addition to the primary relation test.

Parameters

in_state Whether to perform nearest face calculation.

Returns: A reference to this object.

◆ SetTest()

ShellRelationOptionsKit& HPS::ShellRelationOptionsKit::SetTest ( Shell::RelationTest in_test )

Sets the type of relation test that should be performed.

This determines what kind of information is available from the results.

Parameters

in_test The relation test to be performed.

Returns: A reference to this object.

◆ SetTolerance()

ShellRelationOptionsKit& HPS::ShellRelationOptionsKit::SetTolerance ( float in_tolerance )

Sets the tolerance within which points will be considered on the shell.

Parameters

in_tolerance The tolerance, in world space units, to use for this relation test.

Returns: A reference to this object.

◆ SetTreeContext()

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

Sets a TreeContext to be used for this relation test.

If many relation or 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.

◆ Show()

void HPS::ShellRelationOptionsKit::Show ( ShellRelationOptionsKit & out_kit ) const

Copies this ShellRelationOptionsKit into the given ShellRelationOptionsKit.

Parameters

out_kit The ShellRelationOptionsKit to populate with the contents of this ShellRelationOptionsKit.

◆ ShowNearestFaceCalculation()

bool HPS::ShellRelationOptionsKit::ShowNearestFaceCalculation ( bool & out_state ) const

Shows the nearest face calculation setting for this ShellRelationOptionsKit.

Parameters

out_state Whether to perform nearest face calculation.

Returns: true if nearest face calculation was specified, false otherwise.

◆ ShowTest()

bool HPS::ShellRelationOptionsKit::ShowTest ( Shell::RelationTest & out_test ) const

Shows the relation test for this ShellRelationOptionsKit.

Parameters

out_test The relation test to be performed.

Returns: true if test was set, false otherwise.

◆ ShowTolerance()

bool HPS::ShellRelationOptionsKit::ShowTolerance ( float & out_tolerance ) const

Shows the value of the tolerance for this ShellRelationOptionsKit.

Parameters

out_tolerance The tolerance, in world units, for this ShellOptimizationOptionsKit.

Returns: true if tolerance was set, false otherwise.

◆ ShowTreeContext()

bool HPS::ShellRelationOptionsKit::ShowTreeContext ( TreeContext & out_tree_context ) const

Shows the tree context for this ShellRelationOptionsKit.

Parameters

out_tree_context The tree context to use for this relation test.

Returns: true if a tree context was set, 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.

◆ UnsetEverything()

ShellRelationOptionsKit& HPS::ShellRelationOptionsKit::UnsetEverything ( )

Removes all settings from this ShellRelationOptionsKit.

Returns: A reference to this object.

◆ UnsetNearestFaceCalculation()

ShellRelationOptionsKit& HPS::ShellRelationOptionsKit::UnsetNearestFaceCalculation ( )

Removes the nearest face calculation setting from this ShellRelationOptionsKit.

Returns: A reference to this object.

◆ UnsetTest()

ShellRelationOptionsKit& HPS::ShellRelationOptionsKit::UnsetTest ( )

Removes the test value from this ShellRelationOptionsKit.

Returns: A reference to this object.

◆ UnsetTolerance()

ShellRelationOptionsKit& HPS::ShellRelationOptionsKit::UnsetTolerance ( )

Removes the tolerance value from this ShellRelationOptionsKit.

Returns: A reference to this object.

◆ UnsetTreeContext()

ShellRelationOptionsKit& HPS::ShellRelationOptionsKit::UnsetTreeContext ( )

Removes the tree context from this ShellRelationOptionsKit.

Returns: A reference to this object.

Member Data Documentation

◆ staticType

const HPS::Type HPS::ShellRelationOptionsKit::staticType = HPS::Type::ShellRelationOptionsKit

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

◆ ShellRelationOptionsKit() [1/3]

◆ ShellRelationOptionsKit() [2/3]

◆ ShellRelationOptionsKit() [3/3]

◆ ~ShellRelationOptionsKit()

Member Function Documentation

◆ ClassID()

◆ Consume()

◆ Empty()

◆ Equals()

◆ GetClassID()

◆ GetDefault()

◆ GetInstanceID()

◆ HasType()

◆ ObjectType()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ Reset()

◆ Set()

◆ SetNearestFaceCalculation()

◆ SetTest()

◆ SetTolerance()

◆ SetTreeContext()

◆ Show()

◆ ShowNearestFaceCalculation()

◆ ShowTest()

◆ ShowTolerance()

◆ ShowTreeContext()

◆ Type()

◆ UnsetEverything()

◆ UnsetNearestFaceCalculation()

◆ UnsetTest()

◆ UnsetTolerance()

◆ UnsetTreeContext()

Member Data Documentation

◆ staticType