REFERENCE MANUAL
#include <sprk_exchange.h>
Static Public Member Functions | |
static ExportParasolidOptionsKit | GetDefault () |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
Additional Inherited Members | |
![]() | |
enum | UpdateType { Synchronous, Asynchronous } |
The Exchange::ExportParasolidOptionsKit class is a user space object. It contains settings controlling how Parasolid data is exported via Exchange. Calling Exchange::ExportParasolidOptionsKit::GetDefault() will return an options kit with values found in here.
Exchange::ExportParasolidOptionsKit::ExportParasolidOptionsKit | ( | ) |
The default constructor creates an empty ExportParasolidOptionsKit object.
Exchange::ExportParasolidOptionsKit::ExportParasolidOptionsKit | ( | ExportParasolidOptionsKit const & | in_kit | ) |
The copy constructor creates a new ExportParasolidOptionsKit object that contains the same settings as the source ExportParasolidOptionsKit.
in_kit | The source ExportParasolidOptionsKit to copy. |
Exchange::ExportParasolidOptionsKit::ExportParasolidOptionsKit | ( | ExportParasolidOptionsKit && | in_that | ) |
The move constructor creates an ExportParasolidOptionsKit by transferring the underlying object of the rvalue reference to this ExportParasolidOptionsKit.
in_that | An rvalue reference to an ExportParasolidOptionsKit to take the underlying object from. |
|
virtual |
Indicates whether this ExportParasolidOptionsKit has any values set on it.
Reimplemented from Object.
bool Exchange::ExportParasolidOptionsKit::Equals | ( | ExportParasolidOptionsKit const & | in_kit | ) | const |
Check if the source ExportParasolidOptionsKit is equivalent to this ExportParasolidOptionsKit.
in_kit | The source ExportParasolidOptionsKit to compare to this ExportParasolidOptionsKit. |
|
static |
Creates an ExportParasolidOptionsKit 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::ExportParasolid.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from Object.
bool Exchange::ExportParasolidOptionsKit::operator!= | ( | ExportParasolidOptionsKit const & | in_kit | ) | const |
Check if the source ExportParasolidOptionsKit is not equivalent to this ExportParasolidOptionsKit.
in_kit | The source ExportParasolidOptionsKit to compare to this ExportParasolidOptionsKit. |
ExportParasolidOptionsKit& Exchange::ExportParasolidOptionsKit::operator= | ( | ExportParasolidOptionsKit const & | in_kit | ) |
Copies the source ExportParasolidOptionsKit into this ExportParasolidOptionsKit.
in_kit | The source ExportParasolidOptionsKit to copy. |
ExportParasolidOptionsKit& Exchange::ExportParasolidOptionsKit::operator= | ( | ExportParasolidOptionsKit && | in_that | ) |
The move assignment operator transfers the underlying object of the rvalue reference to this ExportParasolidOptionsKit.
in_that | An rvalue reference to an ExportParasolidOptionsKit to take the underlying object from. |
bool Exchange::ExportParasolidOptionsKit::operator== | ( | ExportParasolidOptionsKit const & | in_kit | ) | const |
Check if the source ExportParasolidOptionsKit is equivalent to this ExportParasolidOptionsKit.
in_kit | The source ExportParasolidOptionsKit to compare to this ExportParasolidOptionsKit. |
void Exchange::ExportParasolidOptionsKit::Set | ( | ExportParasolidOptionsKit const & | in_kit | ) |
Copies the source ExportParasolidOptionsKit into this ExportParasolidOptionsKit.
in_kit | The source ExportParasolidOptionsKit to copy. |
ExportParasolidOptionsKit& Exchange::ExportParasolidOptionsKit::SetApplication | ( | char const * | in_name | ) |
Sets the application name to put in the Parasolid data. This corresponds to the value that will be passed to A3DRWParamsExportParasolidData::m_pcApplication.
in_name | UTF8-encoded application name to put in the Parasolid data. |
ExportParasolidOptionsKit& Exchange::ExportParasolidOptionsKit::SetHiddenObjects | ( | bool | in_state | ) |
Sets whether to export hidden objects. This corresponds to the value that will be passed to A3DRWParamsExportParasolidData::m_bWriteBlankedEntities.
in_state | Whether to export hidden objects. |
ExportParasolidOptionsKit& Exchange::ExportParasolidOptionsKit::SetSolidsAsFaces | ( | bool | in_state | ) |
Sets whether to convert solids to a set of independent faces for export. This corresponds to the value that will be passed to A3DRWParamsExportIgesData::m_bSaveSolidsAsFaces.
in_state | Whether to convert solids to a set of independent faces for export. |
ExportParasolidOptionsKit& Exchange::ExportParasolidOptionsKit::SetTessellation | ( | bool | in_state | ) |
Sets whether to export tessellation data. This corresponds to the value that will be passed to A3DRWParamsExportParasolidData::m_bWriteTessellation.
in_state | Whether to export tessellation data. |
ExportParasolidOptionsKit& Exchange::ExportParasolidOptionsKit::SetVersion | ( | char const * | in_version | ) |
Sets the version string to put in the Parasolid data. This corresponds to the value that will be passed to A3DRWParamsExportParasolidData::m_pcVersion.
in_version | UTF8-encoded version string to put in the Parasolid data. |
void Exchange::ExportParasolidOptionsKit::Show | ( | ExportParasolidOptionsKit & | out_kit | ) | const |
Copies this ExportParasolidOptionsKit into the given ExportParasolidOptionsKit.
out_kit | The ExportParasolidOptionsKit to populate with the contents of this ExportParasolidOptionsKit. |
bool Exchange::ExportParasolidOptionsKit::ShowApplication | ( | UTF8 & | out_name | ) | const |
Shows the application name setting.
out_name | The application name to put in the Parasolid data. |
bool Exchange::ExportParasolidOptionsKit::ShowHiddenObjects | ( | bool & | out_state | ) | const |
Shows the hidden object export setting.
out_state | Whether to export hidden objects. |
bool Exchange::ExportParasolidOptionsKit::ShowSolidsAsFaces | ( | bool & | out_state | ) | const |
Shows the solids to faces conversion setting.
out_state | Whether to convert solids to a set of independent faces for export. |
bool Exchange::ExportParasolidOptionsKit::ShowTessellation | ( | bool & | out_state | ) | const |
Shows the tessellation export setting.
out_state | Whether to export tessellation data. |
bool Exchange::ExportParasolidOptionsKit::ShowVersion | ( | UTF8 & | out_version | ) | const |
Shows the version string setting.
out_version | The version string to put in the Parasolid data. |
ExportParasolidOptionsKit& Exchange::ExportParasolidOptionsKit::UnsetApplication | ( | ) |
Removes the application name setting.
ExportParasolidOptionsKit& Exchange::ExportParasolidOptionsKit::UnsetEverything | ( | ) |
Removes all settings from this ExportParasolidOptionsKit.
ExportParasolidOptionsKit& Exchange::ExportParasolidOptionsKit::UnsetHiddenObjects | ( | ) |
Removes the hidden objects export setting.
ExportParasolidOptionsKit& Exchange::ExportParasolidOptionsKit::UnsetSolidsAsFaces | ( | ) |
Removes the solids to faces conversion setting.
ExportParasolidOptionsKit& Exchange::ExportParasolidOptionsKit::UnsetTessellation | ( | ) |
Removes the tessellation export setting.
ExportParasolidOptionsKit& Exchange::ExportParasolidOptionsKit::UnsetVersion | ( | ) |
Removes the version string setting.