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. This does not necessarily give the true type of the underlying object. 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. Turning off optimization generally results in slightly faster load times and better visual fidelity, but has the downside of impacting performance. 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. Turning off optimization generally results in slightly faster load times and better visual fidelity, but has the downside of impacting performance. More... | |
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. 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... | |
![]() | |
Kit (HPS.Kit in_that) | |
override HPS.Type | Type () |
This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More... | |
![]() | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object that) | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
Static Public Member Functions | |
static HPS.STL.ImportOptionsKit | GetDefault () |
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. 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 |
Detailed Description
The ImportOptionsKit class contains any settings controlling the import of STL files.
Constructor & Destructor Documentation
|
inline |
The default constructor creates an empty ImportOptionsKit object.
|
inline |
The copy constructor creates a new ImportOptionsKit object that contains the same settings as the source ImportOptionsKit.
- Parameters
-
in_kit The source ImportOptionsKit to copy.
Member Function Documentation
|
inlinevirtual |
Indicates whether this ImportOptionsKit has any values set on it.
- Returns
- true if no values are set on this ImportOptionsKit, false otherwise.
Reimplemented from HPS.Object.
|
inline |
Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit.
- Parameters
-
in_kit The source ImportOptionsKit to compare to this ImportOptionsKit.
- Returns
- true if the objects are equivalent, false otherwise.
|
inlinestatic |
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.
- Returns
- An ImportOptionsKit with the default settings.
|
inlinevirtual |
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.Kit.
|
inline |
Copies the source ImportOptionsKit into this ImportOptionsKit.
- Parameters
-
in_kit The source ImportOptionsKit to copy.
|
inline |
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.
|
inline |
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.
|
inline |
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.
- Parameters
-
in_segment Segment the STL data will be imported into.
- Returns
- A reference to this ImportOptionsKit.
|
inline |
Copies this ImportOptionsKit into the given ImportOptionsKit.
- Parameters
-
out_kit The ImportOptionsKit to populate with the contents of this ImportOptionsKit.
|
inline |
Shows the optimization options for this import
- Parameters
-
out_state Whether optimization is enabled. out_optimization_options Optimization options for this import.
- Returns
- true if optimization options were specified, false otherwise.
|
inline |
|
inline |
Removes all settings from this ImportOptionsKit.
- Returns
- A reference to this ImportOptionsKit.
|
inline |
Removes the optimization options for this import
- Returns
- A reference to this ImportOptionsKit.
|
inline |
Removes the root segment specifying where the STL data will be imported into.
- Returns
- A reference to this ImportOptionsKit.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.STL.cs