#include <sprk_exchange.h>

Static Public Member Functions | |
static Export3MFOptionsKit | GetDefault () |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
Additional Inherited Members | |
![]() | |
SprocketKit & | operator= (SprocketKit &&in_that) |
SprocketKit (SprocketKit &&in_that) | |
Detailed Description
The HPS::Exchange::Export3MFOptionsKit class is a user space object. It contains settings controlling how 3MF data is exported via the Exchange interface.
Constructor & Destructor Documentation
HPS::Exchange::Export3MFOptionsKit::Export3MFOptionsKit | ( | ) |
The default constructor creates an empty Export3MFOptionsKit object.
HPS::Exchange::Export3MFOptionsKit::Export3MFOptionsKit | ( | Export3MFOptionsKit const & | in_kit | ) |
The copy constructor creates a new Export3MFOptionsKit object that contains the same settings as the source Export3MFOptionsKit.
- Parameters
-
in_kit The source Export3MFOptionsKit to copy.
HPS::Exchange::Export3MFOptionsKit::Export3MFOptionsKit | ( | Export3MFOptionsKit && | in_that | ) |
The move constructor creates an Export3MFOptionsKit by transferring the underlying object of the rvalue reference to this Export3MFOptionsKit.
- Parameters
-
in_that An rvalue reference to an Export3MFOptionsKit to take the underlying object from.
Member Function Documentation
|
virtual |
Indicates whether this Export3MFOptionsKit has any values set on it.
- Returns
- true if no values are set on this Export3MFOptionsKit, false otherwise.
Reimplemented from HPS::Object.
bool HPS::Exchange::Export3MFOptionsKit::Equals | ( | Export3MFOptionsKit const & | in_kit | ) | const |
Check if the source Export3MFOptionsKit is equivalent to this Export3MFOptionsKit.
- Parameters
-
in_kit The source Export3MFOptionsKit to compare to this Export3MFOptionsKit.
- Returns
- true if the objects are equivalent, false otherwise.
|
static |
Creates an Export3MFOptionsKit 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 defaults. These values will be used for export unless an option in overridden by the options passed to File::Export3MF.
- Returns
- An Export3MFOptionsKit 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::SprocketKit.
bool HPS::Exchange::Export3MFOptionsKit::operator!= | ( | Export3MFOptionsKit const & | in_kit | ) | const |
Check if the source Export3MFOptionsKit is not equivalent to this Export3MFOptionsKit.
- Parameters
-
in_kit The source Export3MFOptionsKit to compare to this Export3MFOptionsKit.
- Returns
- true if the objects are not equivalent, false otherwise.
Export3MFOptionsKit& HPS::Exchange::Export3MFOptionsKit::operator= | ( | Export3MFOptionsKit const & | in_kit | ) |
Copies the source Export3MFOptionsKit into this Export3MFOptionsKit.
- Parameters
-
in_kit The source Export3MFOptionsKit to copy.
- Returns
- A reference to this Export3MFOptionsKit.
Export3MFOptionsKit& HPS::Exchange::Export3MFOptionsKit::operator= | ( | Export3MFOptionsKit && | in_that | ) |
The move assignment operator transfers the underlying object of the rvalue reference to this Export3MFOptionsKit.
- Parameters
-
in_that An rvalue reference to an Export3MFOptionsKit to take the underlying object from.
- Returns
- A reference to this Export3MFOptionsKit.
bool HPS::Exchange::Export3MFOptionsKit::operator== | ( | Export3MFOptionsKit const & | in_kit | ) | const |
Check if the source Export3MFOptionsKit is equivalent to this Export3MFOptionsKit.
- Parameters
-
in_kit The source Export3MFOptionsKit to compare to this Export3MFOptionsKit.
- Returns
- true if the objects are equivalent, false otherwise.
void HPS::Exchange::Export3MFOptionsKit::Set | ( | Export3MFOptionsKit const & | in_kit | ) |
Copies the source Export3MFOptionsKit into this Export3MFOptionsKit.
- Parameters
-
in_kit The source Export3MFOptionsKit to copy.
Export3MFOptionsKit& HPS::Exchange::Export3MFOptionsKit::SetAdditionalKeyPaths | ( | KeyPathArray const & | in_additional_key_paths | ) |
Sets an array of key paths which will be exported in addition to the model. Use this setting to export Visualize geometry to 3MF.
- Parameters
-
in_additional_key_paths The key paths to be exported.
- Returns
- A reference to this Export3MFOptionsKit.
Export3MFOptionsKit& HPS::Exchange::Export3MFOptionsKit::SetAdditionalKeyPaths | ( | size_t | in_count, |
KeyPath const | in_additional_key_paths[] | ||
) |
Sets an array of key paths which will be exported in addition to the model. Use this setting to export Visualize geometry to 3MF.
- Parameters
-
in-count The number of key paths contained in in_additional_key_paths. in_additional_key_paths The key paths to be exported.
- Returns
- A reference to this Export3MFOptionsKit.
Export3MFOptionsKit& HPS::Exchange::Export3MFOptionsKit::SetCopyright | ( | char const * | in_state | ) |
Sets the copyright metadata.
- Parameters
-
in_copyright The copyright metadata.
- Returns
- A reference to this Export3MFOptionsKit.
Export3MFOptionsKit& HPS::Exchange::Export3MFOptionsKit::SetCurrentTessellationRetention | ( | bool | in_state, |
TessellationOptionsKit const & | in_tessellation_kit = TessellationOptionsKit() |
||
) |
Sets whether to retain the current tessellation during export.
- Parameters
-
in_state Whether to retain the current tessellation during export. in_tessellation_kit The tessellation to use during export. Only used if in_state is false, or if no tessellation is present.
- Returns
- A reference to this Export3MFOptionsKit.
Export3MFOptionsKit& HPS::Exchange::Export3MFOptionsKit::SetDescription | ( | char const * | in_description | ) |
Sets a description. This will be reported in the output file as metadata.
- Parameters
-
in_description The description.
- Returns
- A reference to this Export3MFOptionsKit .
Export3MFOptionsKit& HPS::Exchange::Export3MFOptionsKit::SetLicenseTerms | ( | char const * | in_license | ) |
Sets license terms metadata.
- Parameters
-
in_license The license terms metadata.
- Returns
- A reference to this Export3MFOptionsKit.
void HPS::Exchange::Export3MFOptionsKit::Show | ( | Export3MFOptionsKit & | out_kit | ) | const |
Copies this Export3MFOptionsKit into the given Export3MFOptionsKit.
- Parameters
-
out_kit The Export3MFOptionsKit to populate with the contents of this Export3MFOptionsKit.
bool HPS::Exchange::Export3MFOptionsKit::ShowAdditionalKeyPaths | ( | KeyPathArray & | out_additional_key_paths | ) | const |
Shows the additional key paths setting.
- Parameters
-
out_additional_key_paths The key paths which will be added to the model
- Returns
- true if an additional key paths setting was specified, false otherwise.
bool HPS::Exchange::Export3MFOptionsKit::ShowCopyright | ( | HPS::UTF8 & | out_state | ) | const |
Shows the copyright setting.
- Parameters
-
out_copyright The copyright metadata.
- Returns
- true if a copyright setting was specified, false otherwise.
bool HPS::Exchange::Export3MFOptionsKit::ShowCurrentTessellationRetention | ( | bool & | out_state, |
Exchange::TessellationOptionsKit & | out_tessellation_kit | ||
) | const |
Shows the KeepCurrentTessellation setting.
- Parameters
-
out_state Whether to retain the current tessellation during export. out_tessellation_kit The tessellation options to use during export. Only valid if out_state is false.
- Returns
- true if a tessellation retention setting was specified, false otherwise.
bool HPS::Exchange::Export3MFOptionsKit::ShowDescription | ( | HPS::UTF8 & | out_state | ) | const |
Shows the description setting.
- Parameters
-
out_description The description.
- Returns
- true if a description setting was specified, false otherwise.
bool HPS::Exchange::Export3MFOptionsKit::ShowLicenseTerms | ( | HPS::UTF8 & | out_license | ) | const |
Shows the license setting.
- Parameters
-
out_license The license metadata
- Returns
- true if a license setting was specified, false otherwise.
Export3MFOptionsKit& HPS::Exchange::Export3MFOptionsKit::UnsetAdditionalKeyPaths | ( | ) |
Removes the additional key paths setting.
- Returns
- A reference to this Export3MFOptionsKit.
Export3MFOptionsKit& HPS::Exchange::Export3MFOptionsKit::UnsetCopyright | ( | ) |
Removes the Copyright setting.
- Returns
- A reference to this Export3MFOptionsKit.
Export3MFOptionsKit& HPS::Exchange::Export3MFOptionsKit::UnsetCurrentTessellationRetention | ( | ) |
Removes the KeepCurrentTessellation setting.
- Returns
- A reference to this Export3MFOptionsKit.
Export3MFOptionsKit& HPS::Exchange::Export3MFOptionsKit::UnsetDescription | ( | ) |
Removes the description setting.
- Returns
- A reference to this Export3MFOptionsKit.
Export3MFOptionsKit& HPS::Exchange::Export3MFOptionsKit::UnsetEverything | ( | ) |
Removes all settings from this Export3MFOptionsKit.
- Returns
- A reference to this Export3MFOptionsKit.
Export3MFOptionsKit& HPS::Exchange::Export3MFOptionsKit::UnsetLicenseTerms | ( | ) |
Removes the license setting.
- Returns
- A reference to this Export3MFOptionsKit.
The documentation for this class was generated from the following file:
- include/sprk_exchange.h