#include <hps.h>

Public Member Functions | |
bool | Empty () const |
bool | Equals (ImportOptionsKit const &in_kit) const |
ImportOptionsKit () | |
ImportOptionsKit (ImportOptionsKit const &in_kit) | |
ImportOptionsKit (ImportOptionsKit &&in_that) | |
HPS::Type | ObjectType () const |
bool | operator!= (ImportOptionsKit const &in_kit) const |
ImportOptionsKit & | operator= (ImportOptionsKit &&in_that) |
ImportOptionsKit & | operator= (ImportOptionsKit const &in_kit) |
bool | operator== (ImportOptionsKit const &in_kit) const |
void | Set (ImportOptionsKit const &in_kit) |
ImportOptionsKit & | SetOptimization (bool in_state, ShellOptimizationOptionsKit const &in_optimization_kit) |
ImportOptionsKit & | SetOptimization (ShellOptimizationOptionsKit const &in_optimization_kit) |
ImportOptionsKit & | SetSegment (SegmentKey const &in_segment) |
void | Show (ImportOptionsKit &out_kit) const |
bool | ShowOptimization (bool &out_state, ShellOptimizationOptionsKit &out_optimization_options) const |
bool | ShowSegment (SegmentKey &out_segment) const |
ImportOptionsKit & | UnsetEverything () |
ImportOptionsKit & | UnsetOptimization () |
ImportOptionsKit & | UnsetSegment () |
![]() | |
virtual HPS::Type | Type () const |
![]() | |
intptr_t | GetClassID () const |
intptr_t | GetInstanceID () const |
bool | HasType (HPS::Type in_mask) const |
Object (Object const &that) | |
Object (Object &&in_that) | |
Object & | operator= (Object const &other_object) |
Object & | operator= (Object &&in_that) |
virtual void | Reset () |
Static Public Member Functions | |
static ImportOptionsKit | GetDefault () |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
Static Public Attributes | |
static const HPS::Type | staticType = HPS::Type::STLImportOptionsKit |
![]() | |
static const HPS::Type | staticType = HPS::Type::Kit |
![]() | |
static const HPS::Type | staticType = HPS::Type::None |
Additional Inherited Members | |
![]() | |
Kit (Kit &&in_that) | |
Kit & | operator= (Kit &&in_that) |
Detailed Description
The ImportOptionsKit class contains any settings controlling the import of STL files.
Constructor & Destructor Documentation
◆ ImportOptionsKit() [1/3]
HPS::STL::ImportOptionsKit::ImportOptionsKit | ( | ) |
The default constructor creates an empty ImportOptionsKit object.
◆ ImportOptionsKit() [2/3]
HPS::STL::ImportOptionsKit::ImportOptionsKit | ( | ImportOptionsKit const & | in_kit | ) |
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.
◆ ImportOptionsKit() [3/3]
HPS::STL::ImportOptionsKit::ImportOptionsKit | ( | ImportOptionsKit && | in_that | ) |
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
-
in_that An rvalue reference to an ImportOptionsKit to take the impl from.
Member Function Documentation
◆ Empty()
|
virtual |
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.
◆ Equals()
bool HPS::STL::ImportOptionsKit::Equals | ( | ImportOptionsKit const & | in_kit | ) | const |
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.
◆ GetDefault()
|
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.
- Returns
- An ImportOptionsKit with the default settings.
◆ ObjectType()
|
inlinevirtual |
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).
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS::Kit.
◆ operator!=()
bool HPS::STL::ImportOptionsKit::operator!= | ( | ImportOptionsKit const & | in_kit | ) | const |
Check if the source ImportOptionsKit is not equivalent to this ImportOptionsKit.
- Parameters
-
in_kit The source ImportOptionsKit to compare to this ImportOptionsKit.
- Returns
- true if the objects are not equivalent, false otherwise.
◆ operator=() [1/2]
ImportOptionsKit& HPS::STL::ImportOptionsKit::operator= | ( | ImportOptionsKit && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this ImportOptionsKit thereby avoiding a copy.
- Parameters
-
in_that An rvalue reference to an ImportOptionsKit to take the impl from.
- Returns
- A reference to this ImportOptionsKit.
◆ operator=() [2/2]
ImportOptionsKit& HPS::STL::ImportOptionsKit::operator= | ( | ImportOptionsKit const & | in_kit | ) |
Copies the source ImportOptionsKit into this ImportOptionsKit.
- Parameters
-
in_kit The source ImportOptionsKit to copy.
- Returns
- A reference to this ImportOptionsKit.
◆ operator==()
bool HPS::STL::ImportOptionsKit::operator== | ( | ImportOptionsKit const & | in_kit | ) | const |
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.
◆ Set()
void HPS::STL::ImportOptionsKit::Set | ( | ImportOptionsKit const & | in_kit | ) |
Copies the source ImportOptionsKit into this ImportOptionsKit.
- Parameters
-
in_kit The source ImportOptionsKit to copy.
◆ SetOptimization() [1/2]
ImportOptionsKit& HPS::STL::ImportOptionsKit::SetOptimization | ( | bool | in_state, |
ShellOptimizationOptionsKit const & | 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.
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.
◆ SetOptimization() [2/2]
ImportOptionsKit& HPS::STL::ImportOptionsKit::SetOptimization | ( | ShellOptimizationOptionsKit const & | 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.
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.
◆ SetSegment()
ImportOptionsKit& HPS::STL::ImportOptionsKit::SetSegment | ( | SegmentKey const & | 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.
- Parameters
-
in_segment Segment the STL data will be imported into.
- Returns
- A reference to this ImportOptionsKit.
◆ Show()
void HPS::STL::ImportOptionsKit::Show | ( | ImportOptionsKit & | out_kit | ) | const |
Copies this ImportOptionsKit into the given ImportOptionsKit.
- Parameters
-
out_kit The ImportOptionsKit to populate with the contents of this ImportOptionsKit.
◆ ShowOptimization()
bool HPS::STL::ImportOptionsKit::ShowOptimization | ( | bool & | out_state, |
ShellOptimizationOptionsKit & | out_optimization_options | ||
) | const |
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.
◆ ShowSegment()
bool HPS::STL::ImportOptionsKit::ShowSegment | ( | SegmentKey & | out_segment | ) | const |
◆ UnsetEverything()
ImportOptionsKit& HPS::STL::ImportOptionsKit::UnsetEverything | ( | ) |
Removes all settings from this ImportOptionsKit.
- Returns
- A reference to this ImportOptionsKit.
◆ UnsetOptimization()
ImportOptionsKit& HPS::STL::ImportOptionsKit::UnsetOptimization | ( | ) |
Removes the optimization options for this import
- Returns
- A reference to this ImportOptionsKit.
◆ UnsetSegment()
ImportOptionsKit& HPS::STL::ImportOptionsKit::UnsetSegment | ( | ) |
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:
- include/hps.h