#include <sprk_exchange.h>
|
static const HPS::Type | staticType = HPS::Type::ExchangeExport3MFOptionsKit |
|
static const HPS::Type | staticType = HPS::Type::SprocketKit |
|
static const HPS::Type | staticType = HPS::Type::None |
|
The HPS::Exchange::Export3MFOptionsKit class is a user space object. It contains settings controlling how 3MF data is exported via the Exchange interface.
◆ Export3MFOptionsKit() [1/3]
HPS::Exchange::Export3MFOptionsKit::Export3MFOptionsKit |
( |
| ) |
|
◆ Export3MFOptionsKit() [2/3]
◆ Export3MFOptionsKit() [3/3]
◆ Empty()
bool HPS::Exchange::Export3MFOptionsKit::Empty |
( |
| ) |
const |
|
virtual |
◆ Equals()
◆ GetDefault()
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.
◆ ObjectType()
HPS::Type HPS::Exchange::Export3MFOptionsKit::ObjectType |
( |
| ) |
const |
|
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::SprocketKit.
◆ operator!=()
bool HPS::Exchange::Export3MFOptionsKit::operator!= |
( |
Export3MFOptionsKit const & |
in_kit | ) |
const |
◆ operator=() [1/2]
◆ operator=() [2/2]
◆ operator==()
bool HPS::Exchange::Export3MFOptionsKit::operator== |
( |
Export3MFOptionsKit const & |
in_kit | ) |
const |
◆ Set()
◆ SetAdditionalKeyPaths() [1/2]
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.
◆ SetAdditionalKeyPaths() [2/2]
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.
◆ SetCopyright()
Sets the copyright metadata.
- Parameters
-
in_copyright | The copyright metadata. |
- Returns
- A reference to this Export3MFOptionsKit.
◆ SetCurrentTessellationRetention()
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.
◆ SetDescription()
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 .
◆ SetLicenseTerms()
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.
◆ Show()
◆ ShowAdditionalKeyPaths()
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.
◆ ShowCopyright()
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.
◆ ShowCurrentTessellationRetention()
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.
◆ ShowDescription()
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.
◆ ShowLicenseTerms()
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.
◆ UnsetAdditionalKeyPaths()
◆ UnsetCopyright()
◆ UnsetCurrentTessellationRetention()
◆ UnsetDescription()
◆ UnsetEverything()
◆ UnsetLicenseTerms()
The documentation for this class was generated from the following file: