ShellOptimizationOptionsKit

class HPS.ShellOptimizationOptionsKit : HPS.Kit

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.

Public Functions

void Consume (HPS.ShellOptimizationOptionsKit in_kit)

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

Param in_kit:The source ShellOptimizationOptionsKit to consume.

override void Dispose ()

override bool Empty ()

Indicates whether this ShellOptimizationOptionsKit has any values set on it.

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

bool Equals (HPS.ShellOptimizationOptionsKit in_kit)

Check if the source ShellOptimizationOptionsKit is equivalent to this ShellOptimizationOptionsKit.

Param in_kit:The source ShellOptimizationOptionsKit to compare to this ShellOptimizationOptionsKit. Return:true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

override int GetHashCode ()

override HPS.Type ObjectType ()

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

Return:The declared type of the object in question, which may differ from the true, underlying type.

void Set (HPS.ShellOptimizationOptionsKit in_kit)

Copies the source ShellOptimizationOptionsKit into this ShellOptimizationOptionsKit.

Param in_kit:The source ShellOptimizationOptionsKit to copy.

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

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

Param in_handedness_option:  Whether the faces’ handedness should be fixed or reversed. Return:A reference to this object.

HPS.ShellOptimizationOptionsKit SetNormalTolerance (float in_normal_tolerance)

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

Param in_normal_tolerance:  The tolerance to use during optimization, specified in degrees. Return:A reference to this object.

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.

Param in_orphan_elimination:  Whether orphaned points can be eliminated during optimization. Return:A reference to this object.

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

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

Param in_tolerance:  The tolerance to use during optimization. Param in_tolerance_units:  The units in_tolerance is specified in. Return:A reference to this object.

ShellOptimizationOptionsKit ()

The default constructor creates an empty ShellOptimizationOptionsKit object.

ShellOptimizationOptionsKit (HPS.ShellOptimizationOptionsKit in_kit)

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

Param in_kit:The source ShellOptimizationOptionsKit to copy.

void Show (out HPS.ShellOptimizationOptionsKit out_kit)

Copies this ShellOptimizationOptionsKit into the given ShellOptimizationOptionsKit.

Param out_kit:The ShellOptimizationOptionsKit to populate with the contents of this ShellOptimizationOptionsKit.

bool ShowHandednessOptimization (out HPS.Shell.HandednessOptimization out_handedness_option)

Shows the value of the handedness options for this ShellOptimizationOptionsKit.

Param out_handedness_option:  The handedness option value for this ShellOptimizationOptionsKit. Return:true if fix handedness was set, false otherwise.

bool ShowNormalTolerance (out float out_normal_tolerance)

Shows the value of the normal tolerance for this ShellOptimizationOptionsKit.

Param out_normal_tolerance:  The normal tolerance for this ShellOptimizationOptionsKit. Return:true if normal tolerance was set, false otherwise.

bool ShowOrphanElimination (out bool out_orphan_elimination)

Shows the value of orphan elimination for this ShellOptimizationOptionsKit.

Param out_orphan_elimination:  The orphan elimination value for this ShellOptimizationOptionsKit. Return:true if orphan elimination was set, false otherwise.

bool ShowTolerance (out float out_tolerance, out HPS.Shell.ToleranceUnits out_tolerance_units)

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

Param out_tolerance:  The tolerance for this ShellOptimizationOptionsKit. Param out_tolerance_units:  The units out_tolerance is specified in. Return:true if tolerance was set, false otherwise.

HPS.ShellOptimizationOptionsKit UnsetEverything ()

Removes all settings from this ShellOptimizationOptionsKit.

Return:A reference to this ShellOptimizationOptionsKit.

HPS.ShellOptimizationOptionsKit UnsetHandednessOptimization ()

Removes the fix handedness value for this ShellOptimizationOptionsKit.

Return:A reference to this object.

HPS.ShellOptimizationOptionsKit UnsetNormalTolerance ()

Removes the normal tolerance value for this ShellOptimizationOptionsKit.

Return:A reference to this object.

HPS.ShellOptimizationOptionsKit UnsetOrphanElimination ()

Removes the orphan elimination value for this ShellOptimizationOptionsKit.

Return:A reference to this object.

HPS.ShellOptimizationOptionsKit UnsetTolerance ()

Removes the tolerance value for this ShellOptimizationOptionsKit.

Return:A reference to this object.

Public Static Functions

HPS.ShellOptimizationOptionsKit GetDefault ()

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.

Return:A ShellOptimizationOptionsKit with the default settings.

bool operator!= (HPS.ShellOptimizationOptionsKit a, HPS.ShellOptimizationOptionsKit b)

bool operator== (HPS.ShellOptimizationOptionsKit a, HPS.ShellOptimizationOptionsKit b)