#include <hps.h>

Inheritance diagram for HPS::ShellRelationOptionsKit:
HPS::Kit HPS::Object

Public Member Functions

void Consume (ShellRelationOptionsKit &in_kit)
 
bool Empty () const
 
bool Equals (ShellRelationOptionsKit const &in_kit) const
 
HPS::Type ObjectType () const
 
bool operator!= (ShellRelationOptionsKit const &in_kit) const
 
ShellRelationOptionsKitoperator= (ShellRelationOptionsKit &&in_that)
 
ShellRelationOptionsKitoperator= (ShellRelationOptionsKit const &in_kit)
 
bool operator== (ShellRelationOptionsKit const &in_kit) const
 
void Set (ShellRelationOptionsKit const &in_kit)
 
ShellRelationOptionsKitSetNearestFaceCalculation (bool in_state)
 
ShellRelationOptionsKitSetTest (Shell::RelationTest in_test)
 
ShellRelationOptionsKitSetTolerance (float in_tolerance)
 
ShellRelationOptionsKitSetTreeContext (TreeContext const &in_tree_context)
 
 ShellRelationOptionsKit ()
 
 ShellRelationOptionsKit (ShellRelationOptionsKit const &in_kit)
 
 ShellRelationOptionsKit (ShellRelationOptionsKit &&in_that)
 
void Show (ShellRelationOptionsKit &out_kit) const
 
bool ShowNearestFaceCalculation (bool &out_state) const
 
bool ShowTest (Shell::RelationTest &out_test) const
 
bool ShowTolerance (float &out_tolerance) const
 
bool ShowTreeContext (TreeContext &out_tree_context) const
 
ShellRelationOptionsKitUnsetEverything ()
 
ShellRelationOptionsKitUnsetNearestFaceCalculation ()
 
ShellRelationOptionsKitUnsetTest ()
 
ShellRelationOptionsKitUnsetTolerance ()
 
ShellRelationOptionsKitUnsetTreeContext ()
 
- 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 ShellRelationOptionsKit 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::ShellRelationOptionsKit
 
- 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 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_kitThe 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_thatAn rvalue reference to a ShellRelationOptionsKit to take the impl from.

Member Function Documentation

◆ Consume()

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

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

Parameters
in_kitThe 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_kitThe source ShellRelationOptionsKit to compare to this ShellRelationOptionsKit.
Returns
true if the objects are equivalent, false otherwise.

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

◆ ObjectType()

HPS::Type HPS::ShellRelationOptionsKit::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::ShellRelationOptionsKit::operator!= ( ShellRelationOptionsKit const &  in_kit) const

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

Parameters
in_kitThe 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_thatAn 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_kitThe 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_kitThe source ShellRelationOptionsKit to compare to this ShellRelationOptionsKit.
Returns
true if the objects are equivalent, false otherwise.

◆ Set()

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

Copies the source ShellRelationOptionsKit into this ShellRelationOptionsKit.

Parameters
in_kitThe 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_stateWhether 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_testThe 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_toleranceThe 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_contextThe 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_kitThe 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_stateWhether 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_testThe 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_toleranceThe 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_contextThe tree context to use for this relation test.
Returns
true if a tree context was set, false otherwise.

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

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