REFERENCE MANUAL
The ImportOptionsKit class contains any settings controlling the import of STL files. More...
Public Member Functions | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this ImportOptionsKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.STL.ImportOptionsKit in_kit) |
Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit. More... | |
override int | GetHashCode () |
ImportOptionsKit () | |
The default constructor creates an empty ImportOptionsKit object. More... | |
ImportOptionsKit (HPS.STL.ImportOptionsKit in_kit) | |
The copy constructor creates a new ImportOptionsKit object that contains the same settings as the source ImportOptionsKit. More... | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
void | Set (HPS.STL.ImportOptionsKit in_kit) |
Copies the source ImportOptionsKit into this ImportOptionsKit. More... | |
HPS.STL.ImportOptionsKit | SetOptimization (bool in_state, HPS.ShellOptimizationOptionsKit in_optimization_kit) |
Sets the options for the optimization performed on the shells created as a result of this import. More... | |
HPS.STL.ImportOptionsKit | SetOptimization (HPS.ShellOptimizationOptionsKit in_optimization_kit) |
Sets the options for the optimization performed on the shells created as a result of this import. More... | |
HPS.STL.ImportOptionsKit | SetSegment (HPS.SegmentKey in_segment) |
Sets the root segment where the STL data will be imported into. More... | |
void | Show (out HPS.STL.ImportOptionsKit out_kit) |
Copies this ImportOptionsKit into the given ImportOptionsKit. More... | |
bool | ShowOptimization (out bool out_state, out HPS.ShellOptimizationOptionsKit out_optimization_options) |
Shows the optimization options for this import More... | |
bool | ShowSegment (out HPS.SegmentKey out_segment) |
Shows the root segment where the STL data will be imported into. More... | |
HPS.STL.ImportOptionsKit | UnsetEverything () |
Removes all settings from this ImportOptionsKit. More... | |
HPS.STL.ImportOptionsKit | UnsetOptimization () |
Removes the optimization options for this import More... | |
HPS.STL.ImportOptionsKit | UnsetSegment () |
Removes the root segment specifying where the STL data will be imported into. More... | |
![]() | |
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.STL.ImportOptionsKit | GetDefault () |
Creates an ImportOptionsKit which contains the default settings. More... | |
static bool | operator!= (HPS.STL.ImportOptionsKit a, HPS.STL.ImportOptionsKit b) |
static bool | operator== (HPS.STL.ImportOptionsKit a, HPS.STL.ImportOptionsKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
The ImportOptionsKit class contains any settings controlling the import of STL files.
HPS.STL.ImportOptionsKit.ImportOptionsKit | ( | ) |
The default constructor creates an empty ImportOptionsKit object.
HPS.STL.ImportOptionsKit.ImportOptionsKit | ( | HPS.STL.ImportOptionsKit | in_kit | ) |
The copy constructor creates a new ImportOptionsKit object that contains the same settings as the source ImportOptionsKit.
in_kit | The source <ref refid="class_h_p_s_1_1_s_t_l_1_1_import_options_kit" kindref="compound">ImportOptionsKit</ref> to copy. |
|
virtual |
Indicates whether this ImportOptionsKit has any values set on it.
Reimplemented from HPS.Object.
bool HPS.STL.ImportOptionsKit.Equals | ( | HPS.STL.ImportOptionsKit | in_kit | ) |
Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit.
in_kit | The source <ref refid="class_h_p_s_1_1_s_t_l_1_1_import_options_kit" kindref="compound">ImportOptionsKit</ref> to compare to this <ref refid="class_h_p_s_1_1_s_t_l_1_1_import_options_kit" kindref="compound">ImportOptionsKit</ref>. |
|
static |
Creates an ImportOptionsKit 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.
|
virtual |
This function returns the type the object, as declared.
This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.Object.
void HPS.STL.ImportOptionsKit.Set | ( | HPS.STL.ImportOptionsKit | in_kit | ) |
Copies the source ImportOptionsKit into this ImportOptionsKit.
in_kit | The source <ref refid="class_h_p_s_1_1_s_t_l_1_1_import_options_kit" kindref="compound">ImportOptionsKit</ref> to copy. |
HPS.STL.ImportOptionsKit HPS.STL.ImportOptionsKit.SetOptimization | ( | bool | in_state, |
HPS.ShellOptimizationOptionsKit | in_optimization_kit | ||
) |
Sets the options for the optimization performed on the shells created as a result of this import.
Turning off optimization generally results in slightly faster load times and better visual fidelity, but has the downside of impacting performance.
HPS.STL.ImportOptionsKit HPS.STL.ImportOptionsKit.SetOptimization | ( | HPS.ShellOptimizationOptionsKit | in_optimization_kit | ) |
Sets the options for the optimization performed on the shells created as a result of this import.
Turning off optimization generally results in slightly faster load times and better visual fidelity, but has the downside of impacting performance.
HPS.STL.ImportOptionsKit HPS.STL.ImportOptionsKit.SetSegment | ( | HPS.SegmentKey | in_segment | ) |
Sets the root segment where the STL data will be imported into.
If no segment is specified, a root segment will be created for this purpose during import.
in_segment | Segment the <ref refid="class_h_p_s_1_1_s_t_l" kindref="compound">STL</ref> data will be imported into. |
void HPS.STL.ImportOptionsKit.Show | ( | out HPS.STL.ImportOptionsKit | out_kit | ) |
Copies this ImportOptionsKit into the given ImportOptionsKit.
out_kit | The <ref refid="class_h_p_s_1_1_s_t_l_1_1_import_options_kit" kindref="compound">ImportOptionsKit</ref> to populate with the contents of this <ref refid="class_h_p_s_1_1_s_t_l_1_1_import_options_kit" kindref="compound">ImportOptionsKit</ref>. |
bool HPS.STL.ImportOptionsKit.ShowOptimization | ( | out bool | out_state, |
out HPS.ShellOptimizationOptionsKit | out_optimization_options | ||
) |
Shows the optimization options for this import
out_state | Whether optimization is enabled. |
out_optimization_options | Optimization options for this import. |
bool HPS.STL.ImportOptionsKit.ShowSegment | ( | out HPS.SegmentKey | out_segment | ) |
HPS.STL.ImportOptionsKit HPS.STL.ImportOptionsKit.UnsetEverything | ( | ) |
Removes all settings from this ImportOptionsKit.
HPS.STL.ImportOptionsKit HPS.STL.ImportOptionsKit.UnsetOptimization | ( | ) |
Removes the optimization options for this import
HPS.STL.ImportOptionsKit HPS.STL.ImportOptionsKit.UnsetSegment | ( | ) |
Removes the root segment specifying where the STL data will be imported into.