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