< Home

< Table of Contents

REFERENCE MANUAL

HPS.ShellOptimizationOptionsKit Class Reference

The ShellOptimizationOptionsKit class is a user space object. More...

Inheritance diagram for HPS.ShellOptimizationOptionsKit:
HPS.Object

Public Member Functions

void Consume (HPS.ShellOptimizationOptionsKit in_kit)
 Copies the source ShellOptimizationOptionsKit into this ShellOptimizationOptionsKit and resets the source kit. More...
 
override void Dispose ()
 
override bool Empty ()
 Indicates whether this ShellOptimizationOptionsKit has any values set on it. More...
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.ShellOptimizationOptionsKit in_kit)
 Check if the source ShellOptimizationOptionsKit is equivalent to this ShellOptimizationOptionsKit. More...
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. More...
 
void Set (HPS.ShellOptimizationOptionsKit in_kit)
 Copies the source ShellOptimizationOptionsKit into this ShellOptimizationOptionsKit. More...
 
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. More...
 
HPS.ShellOptimizationOptionsKit SetNormalTolerance (float in_normal_tolerance)
 Sets the tolerance to use when deciding if two normals can be merged. More...
 
HPS.ShellOptimizationOptionsKit SetOrphanElimination (bool in_orphan_elimination)
 Sets whether orphan elimination can be used during optimization. More...
 
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. More...
 
 ShellOptimizationOptionsKit ()
 The default constructor creates an empty ShellOptimizationOptionsKit object. More...
 
 ShellOptimizationOptionsKit (HPS.ShellOptimizationOptionsKit in_kit)
 The copy constructor creates a new ShellOptimizationOptionsKit object that contains the same settings as the source ShellOptimizationOptionsKit. More...
 
void Show (out HPS.ShellOptimizationOptionsKit out_kit)
 Copies this ShellOptimizationOptionsKit into the given ShellOptimizationOptionsKit. More...
 
bool ShowHandednessOptimization (out HPS.Shell.HandednessOptimization out_handedness_option)
 Shows the value of the handedness options for this ShellOptimizationOptionsKit. More...
 
bool ShowNormalTolerance (out float out_normal_tolerance)
 Shows the value of the normal tolerance for this ShellOptimizationOptionsKit. More...
 
bool ShowOrphanElimination (out bool out_orphan_elimination)
 Shows the value of orphan elimination for this ShellOptimizationOptionsKit. More...
 
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. More...
 
HPS.ShellOptimizationOptionsKit UnsetEverything ()
 Removes all settings from this ShellOptimizationOptionsKit. More...
 
HPS.ShellOptimizationOptionsKit UnsetHandednessOptimization ()
 Removes the fix handedness value for this ShellOptimizationOptionsKit. More...
 
HPS.ShellOptimizationOptionsKit UnsetNormalTolerance ()
 Removes the normal tolerance value for this ShellOptimizationOptionsKit. More...
 
HPS.ShellOptimizationOptionsKit UnsetOrphanElimination ()
 Removes the orphan elimination value for this ShellOptimizationOptionsKit. More...
 
HPS.ShellOptimizationOptionsKit UnsetTolerance ()
 Removes the tolerance value for this ShellOptimizationOptionsKit. More...
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 Returns an identifier that can be used to identify which instance of a class an object is. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object in_that)
 The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More...
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
HPS.Type Type ()
 This function returns the true type of the underlying object. More...
 

Static Public Member Functions

static
HPS.ShellOptimizationOptionsKit 
GetDefault ()
 Creates a ShellOptimizationOptionsKit which contains the default settings. More...
 
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
 
HandleRef scptr
 

Detailed Description

The ShellOptimizationOptionsKit class is a user space object.

It is used for setting options for a shell optimization operation. Calling ShellOptimizationOptionsKit::GetDefault() will return an options kit with values found in this table.

Constructor & Destructor Documentation

HPS.ShellOptimizationOptionsKit.ShellOptimizationOptionsKit ( )

The default constructor creates an empty ShellOptimizationOptionsKit object.

HPS.ShellOptimizationOptionsKit.ShellOptimizationOptionsKit ( HPS.ShellOptimizationOptionsKit  in_kit)

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

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_shell_optimization_options_kit" kindref="compound">ShellOptimizationOptionsKit</ref> to copy.

Member Function Documentation

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

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

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_shell_optimization_options_kit" kindref="compound">ShellOptimizationOptionsKit</ref> to consume.
override bool HPS.ShellOptimizationOptionsKit.Empty ( )
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.

bool HPS.ShellOptimizationOptionsKit.Equals ( HPS.ShellOptimizationOptionsKit  in_kit)

Check if the source ShellOptimizationOptionsKit is equivalent to this ShellOptimizationOptionsKit.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_shell_optimization_options_kit" kindref="compound">ShellOptimizationOptionsKit</ref> to compare to this <ref refid="class_h_p_s_1_1_shell_optimization_options_kit" kindref="compound">ShellOptimizationOptionsKit</ref>.
Returns
true if the objects are equivalent, false otherwise.
static HPS.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.
override HPS.Type HPS.ShellOptimizationOptionsKit.ObjectType ( )
virtual

This function returns the type the object, as declared.

This does not necessarily give the true type of the underlying object.

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

Reimplemented from HPS.Object.

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

Copies the source ShellOptimizationOptionsKit into this ShellOptimizationOptionsKit.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_shell_optimization_options_kit" kindref="compound">ShellOptimizationOptionsKit</ref> to copy.
HPS.ShellOptimizationOptionsKit 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.

Parameters
in_handedness_optionWhether the faces' handedness should be fixed or reversed.
Returns
A reference to this object.
HPS.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.
HPS.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.
HPS.ShellOptimizationOptionsKit 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.

Parameters
in_toleranceThe tolerance to use during optimization.
in_tolerance_unitsThe units in_tolerance is specified in.
Returns
A reference to this object.
void HPS.ShellOptimizationOptionsKit.Show ( out HPS.ShellOptimizationOptionsKit  out_kit)

Copies this ShellOptimizationOptionsKit into the given ShellOptimizationOptionsKit.

Parameters
out_kitThe <ref refid="class_h_p_s_1_1_shell_optimization_options_kit" kindref="compound">ShellOptimizationOptionsKit</ref> to populate with the contents of this <ref refid="class_h_p_s_1_1_shell_optimization_options_kit" kindref="compound">ShellOptimizationOptionsKit</ref>.
bool HPS.ShellOptimizationOptionsKit.ShowHandednessOptimization ( out HPS.Shell.HandednessOptimization  out_handedness_option)

Shows the value of the handedness options for this ShellOptimizationOptionsKit.

Parameters
out_handedness_optionThe handedness option value for this <ref refid="class_h_p_s_1_1_shell_optimization_options_kit" kindref="compound">ShellOptimizationOptionsKit</ref>.
Returns
true if fix handedness was set, false otherwise.
bool HPS.ShellOptimizationOptionsKit.ShowNormalTolerance ( out float  out_normal_tolerance)

Shows the value of the normal tolerance for this ShellOptimizationOptionsKit.

Parameters
out_normal_toleranceThe normal tolerance for this <ref refid="class_h_p_s_1_1_shell_optimization_options_kit" kindref="compound">ShellOptimizationOptionsKit</ref>.
Returns
true if normal tolerance was set, false otherwise.
bool HPS.ShellOptimizationOptionsKit.ShowOrphanElimination ( out bool  out_orphan_elimination)

Shows the value of orphan elimination for this ShellOptimizationOptionsKit.

Parameters
out_orphan_eliminationThe orphan elimination value for this <ref refid="class_h_p_s_1_1_shell_optimization_options_kit" kindref="compound">ShellOptimizationOptionsKit</ref>.
Returns
true if orphan elimination was set, false otherwise.
bool HPS.ShellOptimizationOptionsKit.ShowTolerance ( out float  out_tolerance,
out HPS.Shell.ToleranceUnits  out_tolerance_units 
)

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

Parameters
out_toleranceThe tolerance for this <ref refid="class_h_p_s_1_1_shell_optimization_options_kit" kindref="compound">ShellOptimizationOptionsKit</ref>.
out_tolerance_unitsThe units out_tolerance is specified in.
Returns
true if tolerance was set, false otherwise.
HPS.ShellOptimizationOptionsKit HPS.ShellOptimizationOptionsKit.UnsetEverything ( )

Removes all settings from this ShellOptimizationOptionsKit.

Returns
A reference to this ShellOptimizationOptionsKit.
HPS.ShellOptimizationOptionsKit HPS.ShellOptimizationOptionsKit.UnsetHandednessOptimization ( )

Removes the fix handedness value for this ShellOptimizationOptionsKit.

Returns
A reference to this object.
HPS.ShellOptimizationOptionsKit HPS.ShellOptimizationOptionsKit.UnsetNormalTolerance ( )

Removes the normal tolerance value for this ShellOptimizationOptionsKit.

Returns
A reference to this object.
HPS.ShellOptimizationOptionsKit HPS.ShellOptimizationOptionsKit.UnsetOrphanElimination ( )

Removes the orphan elimination value for this ShellOptimizationOptionsKit.

Returns
A reference to this object.
HPS.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: