#include <sprk_exchange.h>
Static Public Member Functions | |
static ExportSTEPOptionsKit | GetDefault () |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
Additional Inherited Members | |
![]() | |
enum | UpdateType { Synchronous, Asynchronous } |
The HPS::Exchange::ExportSTEPOptionsKit class is a user space object. It contains settings controlling how STEP data is exported via Exchange. Calling HPS::Exchange::ExportSTEPOptionsKit::GetDefault() will return an options kit with values found in here.
HPS::Exchange::ExportSTEPOptionsKit::ExportSTEPOptionsKit | ( | ) |
The default constructor creates an empty ExportSTEPOptionsKit object.
HPS::Exchange::ExportSTEPOptionsKit::ExportSTEPOptionsKit | ( | ExportSTEPOptionsKit const & | in_kit | ) |
The copy constructor creates a new ExportSTEPOptionsKit object that contains the same settings as the source ExportSTEPOptionsKit.
in_kit | The source ExportSTEPOptionsKit to copy. |
HPS::Exchange::ExportSTEPOptionsKit::ExportSTEPOptionsKit | ( | ExportSTEPOptionsKit && | in_that | ) |
The move constructor creates an ExportSTEPOptionsKit by transferring the underlying object of the rvalue reference to this ExportSTEPOptionsKit.
in_that | An rvalue reference to an ExportSTEPOptionsKit to take the underlying object from. |
|
virtual |
Indicates whether this ExportSTEPOptionsKit has any values set on it.
Reimplemented from HPS::Object.
bool HPS::Exchange::ExportSTEPOptionsKit::Equals | ( | ExportSTEPOptionsKit const & | in_kit | ) | const |
Check if the source ExportSTEPOptionsKit is equivalent to this ExportSTEPOptionsKit.
in_kit | The source ExportSTEPOptionsKit to compare to this ExportSTEPOptionsKit. |
|
static |
Creates an ExportSTEPOptionsKit 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. These values will be used for import unless an option is overridden by the options passed to File::ExportSTEP.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from HPS::Object.
bool HPS::Exchange::ExportSTEPOptionsKit::operator!= | ( | ExportSTEPOptionsKit const & | in_kit | ) | const |
Check if the source ExportSTEPOptionsKit is not equivalent to this ExportSTEPOptionsKit.
in_kit | The source ExportSTEPOptionsKit to compare to this ExportSTEPOptionsKit. |
ExportSTEPOptionsKit& HPS::Exchange::ExportSTEPOptionsKit::operator= | ( | ExportSTEPOptionsKit const & | in_kit | ) |
Copies the source ExportSTEPOptionsKit into this ExportSTEPOptionsKit.
in_kit | The source ExportSTEPOptionsKit to copy. |
ExportSTEPOptionsKit& HPS::Exchange::ExportSTEPOptionsKit::operator= | ( | ExportSTEPOptionsKit && | in_that | ) |
The move assignment operator transfers the underlying object of the rvalue reference to this ExportSTEPOptionsKit.
in_that | An rvalue reference to an ExportSTEPOptionsKit to take the underlying object from. |
bool HPS::Exchange::ExportSTEPOptionsKit::operator== | ( | ExportSTEPOptionsKit const & | in_kit | ) | const |
Check if the source ExportSTEPOptionsKit is equivalent to this ExportSTEPOptionsKit.
in_kit | The source ExportSTEPOptionsKit to compare to this ExportSTEPOptionsKit. |
void HPS::Exchange::ExportSTEPOptionsKit::Set | ( | ExportSTEPOptionsKit const & | in_kit | ) |
Copies the source ExportSTEPOptionsKit into this ExportSTEPOptionsKit.
in_kit | The source ExportSTEPOptionsKit to copy. |
ExportSTEPOptionsKit& HPS::Exchange::ExportSTEPOptionsKit::SetAnalyticsAsNURBS | ( | bool | in_state | ) |
Sets whether to convert analytic surfaces (planes, cones, cylinder, etc.) to NURBS surfaces for export. This corresponds to the value that will be passed to A3DRWParamsExportStepData::m_bSaveAnalyticsToNurbs.
in_state | Whether to convert analytic surfaces to NURBS surfaces for export. |
ExportSTEPOptionsKit& HPS::Exchange::ExportSTEPOptionsKit::SetApplication | ( | char const * | in_name | ) |
Sets the application name to put in the STEP data. This corresponds to the value that will be passed to A3DRWParamsExportStepData::m_pcApplication.
in_name | UTF8-encoded application name to put in the STEP data. |
ExportSTEPOptionsKit& HPS::Exchange::ExportSTEPOptionsKit::SetFacetedAsWireframe | ( | bool | in_state | ) |
Sets whether to convert polyhedrics to wireframe data for export. This corresponds to the value that will be passed to A3DRWParamsExportStepData::m_bSaveFacetedToWireframe.
in_state | Whether to convert polyhedrics to wireframe data for export. |
ExportSTEPOptionsKit& HPS::Exchange::ExportSTEPOptionsKit::SetFormat | ( | STEP::Format | in_format | ) |
Sets the format of the STEP data to export. This corresponds to the value that will be passed to A3DRWParamsExportStepData::m_eStepFormat.
in_format | The format of the STEP data to export. |
ExportSTEPOptionsKit& HPS::Exchange::ExportSTEPOptionsKit::SetNameShortening | ( | bool | in_state | ) |
Sets whether to shorten names in the STEP data for export. This corresponds to the value that will be passed to A3DRWParamsExportStepData::m_bUseShortNames.
in_state | Whether to shorten names in the STEP data for export. |
ExportSTEPOptionsKit& HPS::Exchange::ExportSTEPOptionsKit::SetVersion | ( | char const * | in_version | ) |
Sets the version string to put in the STEP data. This corresponds to the value that will be passed to A3DRWParamsExportStepData::m_pcVersion.
in_version | UTF8-encoded version string to put in the STEP data. |
void HPS::Exchange::ExportSTEPOptionsKit::Show | ( | ExportSTEPOptionsKit & | out_kit | ) | const |
Copies this ExportSTEPOptionsKit into the given ExportSTEPOptionsKit.
out_kit | The ExportSTEPOptionsKit to populate with the contents of this ExportSTEPOptionsKit. |
bool HPS::Exchange::ExportSTEPOptionsKit::ShowAnalyticsAsNURBS | ( | bool & | out_state | ) | const |
Shows the analytics to NURBS conversion setting.
out_state | Whether to convert analytic surfaces to NURBS surfaces for export. |
bool HPS::Exchange::ExportSTEPOptionsKit::ShowApplication | ( | UTF8 & | out_name | ) | const |
Shows the application name setting.
out_name | The application name to put in the STEP data. |
bool HPS::Exchange::ExportSTEPOptionsKit::ShowFacetedAsWireframe | ( | bool & | out_state | ) | const |
Shows the faceted to wireframe conversion setting.
out_state | Whether to convert polyhedrics to wireframe data for export. |
bool HPS::Exchange::ExportSTEPOptionsKit::ShowFormat | ( | STEP::Format & | out_format | ) | const |
Shows the format setting.
out_format | The format of the STEP data to export. |
bool HPS::Exchange::ExportSTEPOptionsKit::ShowNameShortening | ( | bool & | out_state | ) | const |
Shows the name shortening setting.
out_state | Whether to shorten names in the STEP data for export. |
bool HPS::Exchange::ExportSTEPOptionsKit::ShowVersion | ( | UTF8 & | out_version | ) | const |
Shows the version string setting.
out_version | The version string to put in the STEP data. |
ExportSTEPOptionsKit& HPS::Exchange::ExportSTEPOptionsKit::UnsetAnalyticsAsNURBS | ( | ) |
Removes the analytics to NURBS conversion setting.
ExportSTEPOptionsKit& HPS::Exchange::ExportSTEPOptionsKit::UnsetApplication | ( | ) |
Removes the application name setting.
ExportSTEPOptionsKit& HPS::Exchange::ExportSTEPOptionsKit::UnsetEverything | ( | ) |
Removes all settings from this ExportSTEPOptionsKit.
ExportSTEPOptionsKit& HPS::Exchange::ExportSTEPOptionsKit::UnsetFacetedAsWireframe | ( | ) |
Removes the faceted to wireframe conversion setting.
ExportSTEPOptionsKit& HPS::Exchange::ExportSTEPOptionsKit::UnsetFormat | ( | ) |
Removes the format setting.
ExportSTEPOptionsKit& HPS::Exchange::ExportSTEPOptionsKit::UnsetNameShortening | ( | ) |
Removes the name shortening setting.
ExportSTEPOptionsKit& HPS::Exchange::ExportSTEPOptionsKit::UnsetVersion | ( | ) |
Removes the version string setting.