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

Public Member Functions

void Consume (HPS.ShellOptimizationOptionsKit in_kit)
 
override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.ShellOptimizationOptionsKit in_kit)
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 
void Set (HPS.ShellOptimizationOptionsKit in_kit)
 
HPS.ShellOptimizationOptionsKit SetHandednessOptimization (HPS.Shell.HandednessOptimization in_handedness_option)
 
HPS.ShellOptimizationOptionsKit SetNormalTolerance (float in_normal_tolerance)
 
HPS.ShellOptimizationOptionsKit SetOrphanElimination (bool in_orphan_elimination)
 
HPS.ShellOptimizationOptionsKit SetTolerance (float in_tolerance, HPS.Shell.ToleranceUnits in_tolerance_units)
 
 ShellOptimizationOptionsKit ()
 
 ShellOptimizationOptionsKit (HPS.ShellOptimizationOptionsKit in_kit)
 
void Show (out HPS.ShellOptimizationOptionsKit out_kit)
 
bool ShowHandednessOptimization (out HPS.Shell.HandednessOptimization out_handedness_option)
 
bool ShowNormalTolerance (out float out_normal_tolerance)
 
bool ShowOrphanElimination (out bool out_orphan_elimination)
 
bool ShowTolerance (out float out_tolerance, out HPS.Shell.ToleranceUnits out_tolerance_units)
 
HPS.ShellOptimizationOptionsKit UnsetEverything ()
 
HPS.ShellOptimizationOptionsKit UnsetHandednessOptimization ()
 
HPS.ShellOptimizationOptionsKit UnsetNormalTolerance ()
 
HPS.ShellOptimizationOptionsKit UnsetOrphanElimination ()
 
HPS.ShellOptimizationOptionsKit UnsetTolerance ()
 
- Public Member Functions inherited from HPS.Kit
 Kit (HPS.Kit in_that)
 
override HPS.Type Type ()
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 

Static Public Member Functions

static HPS.ShellOptimizationOptionsKit GetDefault ()
 
static bool operator!= (HPS.ShellOptimizationOptionsKit a, HPS.ShellOptimizationOptionsKit b)
 
static bool operator== (HPS.ShellOptimizationOptionsKit a, HPS.ShellOptimizationOptionsKit b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

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/2]

HPS.ShellOptimizationOptionsKit.ShellOptimizationOptionsKit ( )
inline

The default constructor creates an empty ShellOptimizationOptionsKit object.

◆ ShellOptimizationOptionsKit() [2/2]

HPS.ShellOptimizationOptionsKit.ShellOptimizationOptionsKit ( HPS.ShellOptimizationOptionsKit  in_kit)
inline

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

Parameters
in_kitThe source ShellOptimizationOptionsKit to copy.

Member Function Documentation

◆ Consume()

void HPS.ShellOptimizationOptionsKit.Consume ( HPS.ShellOptimizationOptionsKit  in_kit)
inline

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

Parameters
in_kitThe source ShellOptimizationOptionsKit to consume.

◆ Empty()

override bool HPS.ShellOptimizationOptionsKit.Empty ( )
inlinevirtual

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 ( HPS.ShellOptimizationOptionsKit  in_kit)
inline

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 HPS.ShellOptimizationOptionsKit HPS.ShellOptimizationOptionsKit.GetDefault ( )
inlinestatic

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

override HPS.Type HPS.ShellOptimizationOptionsKit.ObjectType ( )
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.

◆ Set()

void HPS.ShellOptimizationOptionsKit.Set ( HPS.ShellOptimizationOptionsKit  in_kit)
inline

Copies the source ShellOptimizationOptionsKit into this ShellOptimizationOptionsKit.

Parameters
in_kitThe source ShellOptimizationOptionsKit to copy.

◆ SetHandednessOptimization()

HPS.ShellOptimizationOptionsKit HPS.ShellOptimizationOptionsKit.SetHandednessOptimization ( HPS.Shell.HandednessOptimization  in_handedness_option)
inline

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

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

◆ SetNormalTolerance()

HPS.ShellOptimizationOptionsKit HPS.ShellOptimizationOptionsKit.SetNormalTolerance ( float  in_normal_tolerance)
inline

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

HPS.ShellOptimizationOptionsKit HPS.ShellOptimizationOptionsKit.SetOrphanElimination ( bool  in_orphan_elimination)
inline

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

HPS.ShellOptimizationOptionsKit HPS.ShellOptimizationOptionsKit.SetTolerance ( float  in_tolerance,
HPS.Shell.ToleranceUnits  in_tolerance_units 
)
inline

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 ( out HPS.ShellOptimizationOptionsKit  out_kit)
inline

Copies this ShellOptimizationOptionsKit into the given ShellOptimizationOptionsKit.

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

◆ ShowHandednessOptimization()

bool HPS.ShellOptimizationOptionsKit.ShowHandednessOptimization ( out HPS.Shell.HandednessOptimization  out_handedness_option)
inline

Shows the value of the handedness options for this ShellOptimizationOptionsKit.

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

◆ ShowNormalTolerance()

bool HPS.ShellOptimizationOptionsKit.ShowNormalTolerance ( out float  out_normal_tolerance)
inline

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 ( out bool  out_orphan_elimination)
inline

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 ( out float  out_tolerance,
out HPS.Shell.ToleranceUnits  out_tolerance_units 
)
inline

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

HPS.ShellOptimizationOptionsKit HPS.ShellOptimizationOptionsKit.UnsetEverything ( )
inline

Removes all settings from this ShellOptimizationOptionsKit.

Returns
A reference to this ShellOptimizationOptionsKit.

◆ UnsetHandednessOptimization()

HPS.ShellOptimizationOptionsKit HPS.ShellOptimizationOptionsKit.UnsetHandednessOptimization ( )
inline

Removes the fix handedness value for this ShellOptimizationOptionsKit.

Returns
A reference to this object.

◆ UnsetNormalTolerance()

HPS.ShellOptimizationOptionsKit HPS.ShellOptimizationOptionsKit.UnsetNormalTolerance ( )
inline

Removes the normal tolerance value for this ShellOptimizationOptionsKit.

Returns
A reference to this object.

◆ UnsetOrphanElimination()

HPS.ShellOptimizationOptionsKit HPS.ShellOptimizationOptionsKit.UnsetOrphanElimination ( )
inline

Removes the orphan elimination value for this ShellOptimizationOptionsKit.

Returns
A reference to this object.

◆ UnsetTolerance()

HPS.ShellOptimizationOptionsKit HPS.ShellOptimizationOptionsKit.UnsetTolerance ( )
inline

Removes the tolerance value for this ShellOptimizationOptionsKit.

Returns
A reference to this object.

The documentation for this class was generated from the following file:
  • internals/hps_core/source/cs/HPS.ShellOptimizationOptionsKit.cs