#include <hps.h>
The ImportOptionsKit class contains any settings controlling the import of STL files.
STL::ImportOptionsKit::ImportOptionsKit |
( |
| ) |
|
The move constructor creates an ImportOptionsKit by transferring the underlying impl of the rvalue reference to this ImportOptionsKit thereby avoiding a copy and allocation.
- Parameters
-
bool STL::ImportOptionsKit::Empty |
( |
| ) |
const |
|
virtual |
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.
Type STL::ImportOptionsKit::ObjectType |
( |
| ) |
const |
|
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 Object.
The move assignment operator transfers the underlying impl of the rvalue reference to this ImportOptionsKit thereby avoiding a copy.
- Parameters
-
- Returns
- A reference to this ImportOptionsKit.
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.
Turning optimization on increases the load time at the expense of visual fidelity but increases performance, based on the options chosen. The tolerances set as part of the optimization kit are particularly responsible for downgrading the visual fidelity. Supplying an empty optimization kit will disable optimization.
- Parameters
-
in_state | Whether the optimization should be enabled. |
in_optimization_kit | The optimization options for this import |
- Returns
- A reference to this ImportOptionsKit.
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.
Turning optimization on increases the load time at the expense of visual fidelity but increases performance, based on the options chosen. The tolerances set as part of the optimization kit are particularly responsible for downgrading the visual fidelity. Supplying an empty optimization kit will disable optimization.
- Parameters
-
in_optimization_kit | The optimization options for this import |
- Returns
- A reference to this ImportOptionsKit.
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.
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.
bool STL::ImportOptionsKit::ShowSegment |
( |
SegmentKey & |
out_segment | ) |
const |
Shows the root segment where the STL data will be imported into.
- Parameters
-
out_segment | Segment the STL data will be imported into. |
- Returns
- true if a root segment was specified, false otherwise.
Removes the optimization options for this import
- Returns
- A reference to this ImportOptionsKit.
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: