#include <hps.h>

Inheritance diagram for HPS::ShellOptimizationOptionsKit:
HPS::Kit HPS::Object

Public Member Functions

void Consume (ShellOptimizationOptionsKit &in_kit)
 
bool Empty () const
 
bool Equals (ShellOptimizationOptionsKit const &in_kit) const
 
HPS::Type ObjectType () const
 
bool operator!= (ShellOptimizationOptionsKit const &in_kit) const
 
ShellOptimizationOptionsKitoperator= (ShellOptimizationOptionsKit const &in_kit)
 
ShellOptimizationOptionsKitoperator= (ShellOptimizationOptionsKit &&in_that)
 
bool operator== (ShellOptimizationOptionsKit const &in_kit) const
 
void Set (ShellOptimizationOptionsKit const &in_kit)
 
ShellOptimizationOptionsKitSetHandednessOptimization (Shell::HandednessOptimization in_handedness_option)
 
ShellOptimizationOptionsKitSetNormalTolerance (float in_normal_tolerance)
 
ShellOptimizationOptionsKitSetOrphanElimination (bool in_orphan_elimination)
 
ShellOptimizationOptionsKitSetTolerance (float in_tolerance, Shell::ToleranceUnits in_tolerance_units)
 
 ShellOptimizationOptionsKit ()
 
 ShellOptimizationOptionsKit (ShellOptimizationOptionsKit const &in_kit)
 
 ShellOptimizationOptionsKit (ShellOptimizationOptionsKit &&in_that)
 
void Show (ShellOptimizationOptionsKit &out_kit) const
 
bool ShowHandednessOptimization (Shell::HandednessOptimization &out_handedness_option) const
 
bool ShowNormalTolerance (float &out_normal_tolerance) const
 
bool ShowOrphanElimination (bool &out_orphan_elimination) const
 
bool ShowTolerance (float &out_tolerance, Shell::ToleranceUnits &out_tolerance_units) const
 
ShellOptimizationOptionsKitUnsetEverything ()
 
ShellOptimizationOptionsKitUnsetHandednessOptimization ()
 
ShellOptimizationOptionsKitUnsetNormalTolerance ()
 
ShellOptimizationOptionsKitUnsetOrphanElimination ()
 
ShellOptimizationOptionsKitUnsetTolerance ()
 
- 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 ShellOptimizationOptionsKit 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::ShellOptimizationOptionsKit
 
- 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 ShellOptimizationOptionsKit class is a user space object. It is used for setting options for a shell optimization operation. Calling HPS::ShellOptimizationOptionsKit::GetDefault() will return an options kit with values found in this table.

Constructor & Destructor Documentation

◆ ShellOptimizationOptionsKit() [1/3]

HPS::ShellOptimizationOptionsKit::ShellOptimizationOptionsKit ( )

The default constructor creates an empty ShellOptimizationOptionsKit object.

◆ ShellOptimizationOptionsKit() [2/3]

HPS::ShellOptimizationOptionsKit::ShellOptimizationOptionsKit ( ShellOptimizationOptionsKit const &  in_kit)

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

Parameters
in_kitThe source ShellOptimizationOptionsKit to copy.

◆ ShellOptimizationOptionsKit() [3/3]

HPS::ShellOptimizationOptionsKit::ShellOptimizationOptionsKit ( ShellOptimizationOptionsKit &&  in_that)

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

Parameters
in_thatAn rvalue reference to a ShellOptimizationOptionsKit to take the impl from.

Member Function Documentation

◆ Consume()

void HPS::ShellOptimizationOptionsKit::Consume ( ShellOptimizationOptionsKit in_kit)

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

Parameters
in_kitThe source ShellOptimizationOptionsKit to consume.

◆ Empty()

bool HPS::ShellOptimizationOptionsKit::Empty ( ) const
virtual

Indicates whether this ShellOptimizationOptionsKit has any values set on it.

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

Reimplemented from HPS::Object.

◆ Equals()

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

Check if the source ShellOptimizationOptionsKit is equivalent to this ShellOptimizationOptionsKit.

Parameters
in_kitThe source ShellOptimizationOptionsKit to compare to this ShellOptimizationOptionsKit.
Returns
true if the objects are equivalent, false otherwise.

◆ GetDefault()

static ShellOptimizationOptionsKit HPS::ShellOptimizationOptionsKit::GetDefault ( )
static

Creates a ShellOptimizationOptionsKit 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 ShellOptimizationOptionsKit with the default settings.

◆ ObjectType()

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

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

Parameters
in_kitThe source ShellOptimizationOptionsKit to compare to this ShellOptimizationOptionsKit.
Returns
true if the objects are not equivalent, false otherwise.

◆ operator=() [1/2]

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

Copies the source ShellOptimizationOptionsKit into this ShellOptimizationOptionsKit.

Parameters
in_kitThe source ShellOptimizationOptionsKit to copy.
Returns
A reference to this ShellOptimizationOptionsKit.

◆ operator=() [2/2]

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

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

Parameters
in_thatAn rvalue reference to a ShellOptimizationOptionsKit to take the impl from.
Returns
A reference to this ShellOptimizationOptionsKit.

◆ operator==()

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

Check if the source ShellOptimizationOptionsKit is equivalent to this ShellOptimizationOptionsKit.

Parameters
in_kitThe source ShellOptimizationOptionsKit to compare to this ShellOptimizationOptionsKit.
Returns
true if the objects are equivalent, false otherwise.

◆ Set()

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

Copies the source ShellOptimizationOptionsKit into this ShellOptimizationOptionsKit.

Parameters
in_kitThe source ShellOptimizationOptionsKit to copy.

◆ SetHandednessOptimization()

ShellOptimizationOptionsKit& HPS::ShellOptimizationOptionsKit::SetHandednessOptimization ( Shell::HandednessOptimization  in_handedness_option)

Sets whether the optimization procedure should impact the shell's face handedness, and if so, in which way.

Parameters
in_handedness_optimizationWhether handedness should be altered during optimization.
in_handedness_optionWhether the faces' handedness should be fixed or reversed.
Returns
A reference to this object.

◆ SetNormalTolerance()

ShellOptimizationOptionsKit& HPS::ShellOptimizationOptionsKit::SetNormalTolerance ( float  in_normal_tolerance)

Sets the tolerance to use when deciding if two normals can be merged.

Parameters
in_normal_toleranceThe tolerance to use during optimization, specified in degrees.
Returns
A reference to this object.

◆ SetOrphanElimination()

ShellOptimizationOptionsKit& HPS::ShellOptimizationOptionsKit::SetOrphanElimination ( bool  in_orphan_elimination)

Sets whether orphan elimination can be used during optimization. Orphan elimination removes points that are not referenced by any face.

Parameters
in_orphan_eliminationWhether orphaned points can be eliminated during optimization.
Returns
A reference to this object.

◆ SetTolerance()

ShellOptimizationOptionsKit& HPS::ShellOptimizationOptionsKit::SetTolerance ( float  in_tolerance,
Shell::ToleranceUnits  in_tolerance_units 
)

Sets the tolerance to use when deciding if two vertices can be merged.

Parameters
in_toleranceThe tolerance to use during optimization.
in_tolerance_unitsThe units in_tolerance is specified in.
Returns
A reference to this object.

◆ Show()

void HPS::ShellOptimizationOptionsKit::Show ( ShellOptimizationOptionsKit out_kit) const

Copies this ShellOptimizationOptionsKit into the given ShellOptimizationOptionsKit.

Parameters
out_kitThe ShellOptimizationOptionsKit to populate with the contents of this ShellOptimizationOptionsKit.

◆ ShowHandednessOptimization()

bool HPS::ShellOptimizationOptionsKit::ShowHandednessOptimization ( Shell::HandednessOptimization out_handedness_option) const

Shows the value of the handedness options for this ShellOptimizationOptionsKit.

Parameters
out_handedness_optimizationThe handedness optimization value for this ShellOptimizationOptionsKit.
out_handedness_optionThe handedness option value for this ShellOptimizationOptionsKit.
Returns
true if fix handedness was set, false otherwise.

◆ ShowNormalTolerance()

bool HPS::ShellOptimizationOptionsKit::ShowNormalTolerance ( float &  out_normal_tolerance) const

Shows the value of the normal tolerance for this ShellOptimizationOptionsKit.

Parameters
out_normal_toleranceThe normal tolerance for this ShellOptimizationOptionsKit.
Returns
true if normal tolerance was set, false otherwise.

◆ ShowOrphanElimination()

bool HPS::ShellOptimizationOptionsKit::ShowOrphanElimination ( bool &  out_orphan_elimination) const

Shows the value of orphan elimination for this ShellOptimizationOptionsKit.

Parameters
out_orphan_eliminationThe orphan elimination value for this ShellOptimizationOptionsKit.
Returns
true if orphan elimination was set, false otherwise.

◆ ShowTolerance()

bool HPS::ShellOptimizationOptionsKit::ShowTolerance ( float &  out_tolerance,
Shell::ToleranceUnits out_tolerance_units 
) const

Shows the value of the tolerance and its units for this ShellOptimizationOptionsKit.

Parameters
out_toleranceThe tolerance for this ShellOptimizationOptionsKit.
out_tolerance_unitsThe units out_tolerance is specified in.
Returns
true if tolerance was set, false otherwise.

◆ UnsetEverything()

ShellOptimizationOptionsKit& HPS::ShellOptimizationOptionsKit::UnsetEverything ( )

Removes all settings from this ShellOptimizationOptionsKit.

Returns
A reference to this ShellOptimizationOptionsKit.

◆ UnsetHandednessOptimization()

ShellOptimizationOptionsKit& HPS::ShellOptimizationOptionsKit::UnsetHandednessOptimization ( )

Removes the fix handedness value for this ShellOptimizationOptionsKit.

Returns
A reference to this object.

◆ UnsetNormalTolerance()

ShellOptimizationOptionsKit& HPS::ShellOptimizationOptionsKit::UnsetNormalTolerance ( )

Removes the normal tolerance value for this ShellOptimizationOptionsKit.

Returns
A reference to this object.

◆ UnsetOrphanElimination()

ShellOptimizationOptionsKit& HPS::ShellOptimizationOptionsKit::UnsetOrphanElimination ( )

Removes the orphan elimination value for this ShellOptimizationOptionsKit.

Returns
A reference to this object.

◆ UnsetTolerance()

ShellOptimizationOptionsKit& HPS::ShellOptimizationOptionsKit::UnsetTolerance ( )

Removes the tolerance value for this ShellOptimizationOptionsKit.

Returns
A reference to this object.

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