#include <sprk_exchange.h>

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