#include <sprk_exchange.h>

Static Public Member Functions | |
static ExportIGESOptionsKit | GetDefault () |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
Static Public Attributes | |
static const HPS::Type | staticType = HPS::Type::ExchangeExportIGESOptionsKit |
![]() | |
static const HPS::Type | staticType = HPS::Type::SprocketKit |
![]() | |
static const HPS::Type | staticType = HPS::Type::None |
Additional Inherited Members | |
![]() | |
SprocketKit & | operator= (SprocketKit &&in_that) |
SprocketKit (SprocketKit &&in_that) | |
Detailed Description
The HPS::Exchange::ExportIGESOptionsKit class is a user space object. It contains settings controlling how IGES data is exported via Exchange. Calling HPS::Exchange::ExportIGESOptionsKit::GetDefault() will return an options kit with values found in here.
Constructor & Destructor Documentation
◆ ExportIGESOptionsKit() [1/3]
HPS::Exchange::ExportIGESOptionsKit::ExportIGESOptionsKit | ( | ) |
The default constructor creates an empty ExportIGESOptionsKit object.
◆ ExportIGESOptionsKit() [2/3]
HPS::Exchange::ExportIGESOptionsKit::ExportIGESOptionsKit | ( | ExportIGESOptionsKit const & | in_kit | ) |
The copy constructor creates a new ExportIGESOptionsKit object that contains the same settings as the source ExportIGESOptionsKit.
- Parameters
-
in_kit The source ExportIGESOptionsKit to copy.
◆ ExportIGESOptionsKit() [3/3]
HPS::Exchange::ExportIGESOptionsKit::ExportIGESOptionsKit | ( | ExportIGESOptionsKit && | in_that | ) |
The move constructor creates an ExportIGESOptionsKit by transferring the underlying object of the rvalue reference to this ExportIGESOptionsKit.
- Parameters
-
in_that An rvalue reference to an ExportIGESOptionsKit to take the underlying object from.
Member Function Documentation
◆ Empty()
|
virtual |
Indicates whether this ExportIGESOptionsKit has any values set on it.
- Returns
- true if no values are set on this ExportIGESOptionsKit, false otherwise.
Reimplemented from HPS::Object.
◆ Equals()
bool HPS::Exchange::ExportIGESOptionsKit::Equals | ( | ExportIGESOptionsKit const & | in_kit | ) | const |
Check if the source ExportIGESOptionsKit is equivalent to this ExportIGESOptionsKit.
- Parameters
-
in_kit The source ExportIGESOptionsKit to compare to this ExportIGESOptionsKit.
- Returns
- true if the objects are equivalent, false otherwise.
◆ GetDefault()
|
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.
- Returns
- An ExportIGESOptionsKit with the default settings.
◆ ObjectType()
|
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::ExportIGESOptionsKit::operator!= | ( | ExportIGESOptionsKit const & | in_kit | ) | const |
Check if the source ExportIGESOptionsKit is not equivalent to this ExportIGESOptionsKit.
- Parameters
-
in_kit The source ExportIGESOptionsKit to compare to this ExportIGESOptionsKit.
- Returns
- true if the objects are not equivalent, false otherwise.
◆ operator=() [1/2]
ExportIGESOptionsKit& HPS::Exchange::ExportIGESOptionsKit::operator= | ( | ExportIGESOptionsKit const & | in_kit | ) |
Copies the source ExportIGESOptionsKit into this ExportIGESOptionsKit.
- Parameters
-
in_kit The source ExportIGESOptionsKit to copy.
- Returns
- A reference to this ExportIGESOptionsKit.
◆ operator=() [2/2]
ExportIGESOptionsKit& HPS::Exchange::ExportIGESOptionsKit::operator= | ( | ExportIGESOptionsKit && | in_that | ) |
The move assignment operator transfers the underlying object of the rvalue reference to this ExportIGESOptionsKit.
- Parameters
-
in_that An rvalue reference to an ExportIGESOptionsKit to take the underlying object from.
- Returns
- A reference to this ExportIGESOptionsKit.
◆ operator==()
bool HPS::Exchange::ExportIGESOptionsKit::operator== | ( | ExportIGESOptionsKit const & | in_kit | ) | const |
Check if the source ExportIGESOptionsKit is equivalent to this ExportIGESOptionsKit.
- Parameters
-
in_kit The source ExportIGESOptionsKit to compare to this ExportIGESOptionsKit.
- Returns
- true if the objects are equivalent, false otherwise.
◆ Set()
void HPS::Exchange::ExportIGESOptionsKit::Set | ( | ExportIGESOptionsKit const & | in_kit | ) |
Copies the source ExportIGESOptionsKit into this ExportIGESOptionsKit.
- Parameters
-
in_kit The source ExportIGESOptionsKit to copy.
◆ SetAnalyticsAsNURBS()
ExportIGESOptionsKit& HPS::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.
- Parameters
-
in_state Whether to convert analytic surfaces to NURBS surfaces for export.
- Returns
- A reference to this ExportIGESOptionsKit.
- See also
- Default value
◆ SetApplication()
ExportIGESOptionsKit& HPS::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.
- Parameters
-
in_name UTF8-encoded application name to put in the IGES data.
- Returns
- A reference to this ExportIGESOptionsKit.
◆ SetFacetedAsWireframe()
ExportIGESOptionsKit& HPS::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.
- Parameters
-
in_state Whether to convert polyhedrics to wireframe data for export.
- Returns
- A reference to this ExportIGESOptionsKit.
- See also
- Default value
◆ SetHiddenObjects()
ExportIGESOptionsKit& HPS::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.
- Parameters
-
in_state Whether to export hidden objects.
- Returns
- A reference to this ExportIGESOptionsKit.
- See also
- Default value
◆ SetSolidsAsFaces()
ExportIGESOptionsKit& HPS::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.
- Parameters
-
in_state Whether to convert solids to a set of independent faces for export.
- Returns
- A reference to this ExportIGESOptionsKit.
- See also
- Default value
◆ SetTessellation()
ExportIGESOptionsKit& HPS::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.
- Parameters
-
in_state Whether to export tessellation data.
- Returns
- A reference to this ExportIGESOptionsKit.
- See also
- Default value
◆ SetVersion()
ExportIGESOptionsKit& HPS::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.
- Parameters
-
in_version UTF8-encoded version string to put in the IGES data.
- Returns
- A reference to this ExportIGESOptionsKit.
◆ Show()
void HPS::Exchange::ExportIGESOptionsKit::Show | ( | ExportIGESOptionsKit & | out_kit | ) | const |
Copies this ExportIGESOptionsKit into the given ExportIGESOptionsKit.
- Parameters
-
out_kit The ExportIGESOptionsKit to populate with the contents of this ExportIGESOptionsKit.
◆ ShowAnalyticsAsNURBS()
bool HPS::Exchange::ExportIGESOptionsKit::ShowAnalyticsAsNURBS | ( | bool & | out_state | ) | const |
Shows the analytics to NURBS conversion setting.
- Parameters
-
out_state Whether to convert analytic surfaces to NURBS surfaces for export.
- Returns
- true if an analytics to NURBS conversion setting was specified, false otherwise.
◆ ShowApplication()
bool HPS::Exchange::ExportIGESOptionsKit::ShowApplication | ( | UTF8 & | out_name | ) | const |
Shows the application name setting.
- Parameters
-
out_name The application name to put in the IGES data.
- Returns
- true if an application name setting was specified, false otherwise.
◆ ShowFacetedAsWireframe()
bool HPS::Exchange::ExportIGESOptionsKit::ShowFacetedAsWireframe | ( | bool & | out_state | ) | const |
Shows the faceted to wireframe conversion setting.
- Parameters
-
out_state Whether to convert polyhedrics to wireframe data for export.
- Returns
- true if a faceted to wireframe conversion setting was specified, false otherwise.
◆ ShowHiddenObjects()
bool HPS::Exchange::ExportIGESOptionsKit::ShowHiddenObjects | ( | bool & | out_state | ) | const |
Shows the hidden object export setting.
- Parameters
-
out_state Whether to export hidden objects.
- Returns
- true if a hidden object export setting was specified, false otherwise.
◆ ShowSolidsAsFaces()
bool HPS::Exchange::ExportIGESOptionsKit::ShowSolidsAsFaces | ( | bool & | out_state | ) | const |
Shows the solids to faces conversion setting.
- Parameters
-
out_state Whether to convert solids to a set of independent faces for export.
- Returns
- true if a solids to faces conversion setting was specified, false otherwise.
◆ ShowTessellation()
bool HPS::Exchange::ExportIGESOptionsKit::ShowTessellation | ( | bool & | out_state | ) | const |
Shows the tessellation export setting.
- Parameters
-
out_state Whether to export tessellation data.
- Returns
- true if a tessellation export setting was specified, false otherwise.
◆ ShowVersion()
bool HPS::Exchange::ExportIGESOptionsKit::ShowVersion | ( | UTF8 & | out_version | ) | const |
Shows the version string setting.
- Parameters
-
out_version The version string to put in the IGES data.
- Returns
- true if a version string setting was specified, false otherwise.
◆ UnsetAnalyticsAsNURBS()
ExportIGESOptionsKit& HPS::Exchange::ExportIGESOptionsKit::UnsetAnalyticsAsNURBS | ( | ) |
Removes the analytics to NURBS conversion setting.
- Returns
- A reference to this ExportIGESOptionsKit.
◆ UnsetApplication()
ExportIGESOptionsKit& HPS::Exchange::ExportIGESOptionsKit::UnsetApplication | ( | ) |
Removes the application name setting.
- Returns
- A reference to this ExportIGESOptionsKit.
◆ UnsetEverything()
ExportIGESOptionsKit& HPS::Exchange::ExportIGESOptionsKit::UnsetEverything | ( | ) |
Removes all settings from this ExportIGESOptionsKit.
- Returns
- A reference to this ExportIGESOptionsKit.
◆ UnsetFacetedAsWireframe()
ExportIGESOptionsKit& HPS::Exchange::ExportIGESOptionsKit::UnsetFacetedAsWireframe | ( | ) |
Removes the faceted to wireframe conversion setting.
- Returns
- A reference to this ExportIGESOptionsKit.
◆ UnsetHiddenObjects()
ExportIGESOptionsKit& HPS::Exchange::ExportIGESOptionsKit::UnsetHiddenObjects | ( | ) |
Removes the hidden objects export setting.
- Returns
- A reference to this ExportIGESOptionsKit.
◆ UnsetSolidsAsFaces()
ExportIGESOptionsKit& HPS::Exchange::ExportIGESOptionsKit::UnsetSolidsAsFaces | ( | ) |
Removes the solids to faces conversion setting.
- Returns
- A reference to this ExportIGESOptionsKit.
◆ UnsetTessellation()
ExportIGESOptionsKit& HPS::Exchange::ExportIGESOptionsKit::UnsetTessellation | ( | ) |
Removes the tessellation export setting.
- Returns
- A reference to this ExportIGESOptionsKit.
◆ UnsetVersion()
ExportIGESOptionsKit& HPS::Exchange::ExportIGESOptionsKit::UnsetVersion | ( | ) |
Removes the version string setting.
- Returns
- A reference to this ExportIGESOptionsKit.
The documentation for this class was generated from the following file:
- include/sprk_exchange.h