ShellRelationOptionsKit

class ShellRelationOptionsKit : public HPS::Kit

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.

Public Functions

void Consume(ShellRelationOptionsKit &in_kit)

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

Parameters:

in_kit – The source ShellRelationOptionsKit to consume.

virtual bool Empty() const

Indicates whether this ShellRelationOptionsKit has any values set on it.

Returns:

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

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

inline virtual HPS::Type ObjectType() const

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.

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

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.

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.

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

void Set(ShellRelationOptionsKit const &in_kit)

Copies the source ShellRelationOptionsKit into this ShellRelationOptionsKit.

Parameters:

in_kit – The source ShellRelationOptionsKit to copy.

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.

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.

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.

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.

ShellRelationOptionsKit()

The default constructor creates an empty ShellRelationOptionsKit object.

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

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

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

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

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

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

ShellRelationOptionsKit &UnsetEverything()

Removes all settings from this ShellRelationOptionsKit.

Returns:

A reference to this object.

ShellRelationOptionsKit &UnsetNearestFaceCalculation()

Removes the nearest face calculation setting from this ShellRelationOptionsKit.

Returns:

A reference to this object.

ShellRelationOptionsKit &UnsetTest()

Removes the test value from this ShellRelationOptionsKit.

Returns:

A reference to this object.

ShellRelationOptionsKit &UnsetTolerance()

Removes the tolerance value from this ShellRelationOptionsKit.

Returns:

A reference to this object.

ShellRelationOptionsKit &UnsetTreeContext()

Removes the tree context from this ShellRelationOptionsKit.

Returns:

A reference to this object.

virtual ~ShellRelationOptionsKit()

Public Static Functions

static ShellRelationOptionsKit GetDefault()

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.

Public Static Attributes

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