#include <hps.h>
Static Public Member Functions | |
static ShellRelationOptionsKit | GetDefault () |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
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.
HPS::ShellRelationOptionsKit::ShellRelationOptionsKit | ( | ) |
The default constructor creates an empty ShellRelationOptionsKit object.
HPS::ShellRelationOptionsKit::ShellRelationOptionsKit | ( | ShellRelationOptionsKit const & | in_kit | ) |
The copy constructor creates a new ShellRelationOptionsKit object that contains the same settings as the source ShellRelationOptionsKit.
in_kit | The source ShellRelationOptionsKit to copy. |
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.
in_that | An rvalue reference to a ShellRelationOptionsKit to take the impl from. |
void HPS::ShellRelationOptionsKit::Consume | ( | ShellRelationOptionsKit & | in_kit | ) |
Copies the source ShellRelationOptionsKit into this ShellRelationOptionsKit and resets the source kit.
in_kit | The source ShellRelationOptionsKit to consume. |
|
virtual |
Indicates whether this ShellRelationOptionsKit has any values set on it.
Reimplemented from HPS::Object.
bool HPS::ShellRelationOptionsKit::Equals | ( | ShellRelationOptionsKit const & | in_kit | ) | const |
Check if the source ShellRelationOptionsKit is equivalent to this ShellRelationOptionsKit.
in_kit | The source ShellRelationOptionsKit to compare to this ShellRelationOptionsKit. |
|
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.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from HPS::Object.
bool HPS::ShellRelationOptionsKit::operator!= | ( | ShellRelationOptionsKit const & | in_kit | ) | const |
Check if the source ShellRelationOptionsKit is not equivalent to this ShellRelationOptionsKit.
in_kit | The source ShellRelationOptionsKit to compare to this ShellRelationOptionsKit. |
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.
in_that | An rvalue reference to a ShellRelationOptionsKit to take the impl from. |
ShellRelationOptionsKit& HPS::ShellRelationOptionsKit::operator= | ( | ShellRelationOptionsKit const & | in_kit | ) |
Copies the source ShellRelationOptionsKit into this ShellRelationOptionsKit.
in_kit | The source ShellRelationOptionsKit to copy. |
bool HPS::ShellRelationOptionsKit::operator== | ( | ShellRelationOptionsKit const & | in_kit | ) | const |
Check if the source ShellRelationOptionsKit is equivalent to this ShellRelationOptionsKit.
in_kit | The source ShellRelationOptionsKit to compare to this ShellRelationOptionsKit. |
void HPS::ShellRelationOptionsKit::Set | ( | ShellRelationOptionsKit const & | in_kit | ) |
Copies the source ShellRelationOptionsKit into this ShellRelationOptionsKit.
in_kit | The source ShellRelationOptionsKit to copy. |
ShellRelationOptionsKit& HPS::ShellRelationOptionsKit::SetNearestFaceCalculation | ( | bool | in_state | ) |
Sets whether the nearest face should be calculated in addition to the primary relation test.
in_state | Whether to perform nearest face calculation. |
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.
in_test | The relation test to be performed. |
ShellRelationOptionsKit& HPS::ShellRelationOptionsKit::SetTolerance | ( | float | in_tolerance | ) |
Sets the tolerance within which points will be considered on the shell.
in_tolerance | The tolerance, in world space units, to use for this relation test. |
ShellRelationOptionsKit& HPS::ShellRelationOptionsKit::SetTreeContext | ( | TreeContext const & | in_tree_context | ) |
Sets a tree context 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 one is not specified, a new one is computed each time.
in_tree_context | The tree context to use for this relation test. |
void HPS::ShellRelationOptionsKit::Show | ( | ShellRelationOptionsKit & | out_kit | ) | const |
Copies this ShellRelationOptionsKit into the given ShellRelationOptionsKit.
out_kit | The ShellRelationOptionsKit to populate with the contents of this ShellRelationOptionsKit. |
bool HPS::ShellRelationOptionsKit::ShowNearestFaceCalculation | ( | bool & | out_state | ) | const |
Shows the nearest face calculation setting for this ShellRelationOptionsKit.
out_state | Whether to perform nearest face calculation. |
bool HPS::ShellRelationOptionsKit::ShowTest | ( | Shell::RelationTest & | out_test | ) | const |
Shows the relation test for this ShellRelationOptionsKit.
out_test | The relation test to be performed. |
bool HPS::ShellRelationOptionsKit::ShowTolerance | ( | float & | out_tolerance | ) | const |
Shows the value of the tolerance for this ShellRelationOptionsKit.
out_tolerance | The tolerance, in world units, for this ShellOptimizationOptionsKit. |
bool HPS::ShellRelationOptionsKit::ShowTreeContext | ( | TreeContext & | out_tree_context | ) | const |
Shows the tree context for this ShellRelationOptionsKit.
out_tree_context | The tree context to use for this relation test. |
ShellRelationOptionsKit& HPS::ShellRelationOptionsKit::UnsetEverything | ( | ) |
Removes all settings from this ShellRelationOptionsKit.
ShellRelationOptionsKit& HPS::ShellRelationOptionsKit::UnsetNearestFaceCalculation | ( | ) |
Removes the nearest face calculation setting from this ShellRelationOptionsKit.
ShellRelationOptionsKit& HPS::ShellRelationOptionsKit::UnsetTest | ( | ) |
Removes the test value from this ShellRelationOptionsKit.
ShellRelationOptionsKit& HPS::ShellRelationOptionsKit::UnsetTolerance | ( | ) |
Removes the tolerance value from this ShellRelationOptionsKit.
ShellRelationOptionsKit& HPS::ShellRelationOptionsKit::UnsetTreeContext | ( | ) |
Removes the tree context from this ShellRelationOptionsKit.