#include <sprk_exchange.h>
Static Public Member Functions | |
static TranslationOptionsKit | GetDefault () |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
Additional Inherited Members | |
![]() | |
enum | UpdateType { Synchronous, Asynchronous } |
The HPS::Exchange::TranslationOptionsKit class is a user space object. It contains settings controlling what and how data is translated to Parasolid by Exchange. Calling HPS::Exchange::TranslationOptionsKit::GetDefault() will return an options kit with values found in here.
HPS::Exchange::TranslationOptionsKit::TranslationOptionsKit | ( | ) |
The default constructor creates an empty TranslationOptionsKit object.
HPS::Exchange::TranslationOptionsKit::TranslationOptionsKit | ( | TranslationOptionsKit const & | in_kit | ) |
The copy constructor creates a new TranslationOptionsKit object that contains the same settings as the source TranslationOptionsKit.
in_kit | The source TranslationOptionsKit to copy. |
HPS::Exchange::TranslationOptionsKit::TranslationOptionsKit | ( | TranslationOptionsKit && | in_that | ) |
The move constructor creates a TranslationOptionsKit by transferring the underlying impl of the rvalue reference to this TranslationOptionsKit thereby avoiding a copy and allocation.
in_that | An rvalue reference to an TranslationOptionsKit to take the impl from. |
|
virtual |
Indicates whether this TranslationOptionsKit has any values set on it.
Reimplemented from HPS::Object.
bool HPS::Exchange::TranslationOptionsKit::Equals | ( | TranslationOptionsKit const & | in_kit | ) | const |
Check if the source TranslationOptionsKit is equivalent to this TranslationOptionsKit.
in_kit | The source TranslationOptionsKit to compare to this TranslationOptionsKit. |
|
static |
Creates a TranslationOptionsKit 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 translation unless an option is overridden by the options passed to one of the Translate functions.
|
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::TranslationOptionsKit::operator!= | ( | TranslationOptionsKit const & | in_kit | ) | const |
Check if the source TranslationOptionsKit is not equivalent to this TranslationOptionsKit.
in_kit | The source TranslationOptionsKit to compare to this TranslationOptionsKit. |
TranslationOptionsKit& HPS::Exchange::TranslationOptionsKit::operator= | ( | TranslationOptionsKit && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this TranslationOptionsKit thereby avoiding a copy.
in_that | An rvalue reference to an TranslationOptionsKit to take the impl from. |
TranslationOptionsKit& HPS::Exchange::TranslationOptionsKit::operator= | ( | TranslationOptionsKit const & | in_kit | ) |
Copies the source TranslationOptionsKit into this TranslationOptionsKit.
in_kit | The source TranslationOptionsKit to copy. |
bool HPS::Exchange::TranslationOptionsKit::operator== | ( | TranslationOptionsKit const & | in_kit | ) | const |
Check if the source TranslationOptionsKit is equivalent to this TranslationOptionsKit.
in_kit | The source TranslationOptionsKit to compare to this TranslationOptionsKit. |
void HPS::Exchange::TranslationOptionsKit::Set | ( | TranslationOptionsKit const & | in_kit | ) |
Copies the source TranslationOptionsKit into this TranslationOptionsKit.
in_kit | The source TranslationOptionsKit to copy. |
TranslationOptionsKit& HPS::Exchange::TranslationOptionsKit::SetAccurateEdges | ( | Translation::AccurateEdges | in_accurate_edges | ) |
Sets whether accurate edges will be computed as part of the translation. This corresponds to the value that will be passed to A3DRWParamsTranslateToPkPartsData::m_eComputeAccurateEdges.
in_accurate_edges | Whether to compute accurate edges. |
TranslationOptionsKit& HPS::Exchange::TranslationOptionsKit::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. |
TranslationOptionsKit& HPS::Exchange::TranslationOptionsKit::SetDisjointFaces | ( | bool | in_state | ) |
Sets whether erroneous faces can be disjointed from their solids as part of the translation. This corresponds to the value that will be passed to A3DRWParamsTranslateToPkPartsData::m_bDisjoinIfFaceFaceError.
in_state | Whether to disjoin erroneous faces from their owning solids. |
TranslationOptionsKit& HPS::Exchange::TranslationOptionsKit::SetEntityMerging | ( | Translation::Merging | in_merging | ) |
Sets whether entities can be merged as part of the translation. This corresponds to the value that will be passed to A3DRWParamsTranslateToPkPartsData::m_eMergeEntities.
in_merging | Whether to merge entities. |
TranslationOptionsKit& HPS::Exchange::TranslationOptionsKit::SetHealing | ( | Translation::Healing | in_healing | ) |
Sets whether healing will be performed as part of the translation. This corresponds to the value that will be passed to A3DRWParamsTranslateToPkPartsData::m_eHealing.
in_healing | Whether to perform healing. |
TranslationOptionsKit& HPS::Exchange::TranslationOptionsKit::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. |
TranslationOptionsKit& HPS::Exchange::TranslationOptionsKit::SetSewing | ( | bool | in_state, |
double | in_tolerance = 0.0 |
||
) |
Sets whether perform sewing as part of the translation.
in_state | Whether to perform sewing. |
in_tolerance | The sewing tolerance. |
TranslationOptionsKit& HPS::Exchange::TranslationOptionsKit::SetSimplification | ( | Translation::Simplification | in_simplification | ) |
Sets whether geometry can be simplified as part of the translation. This corresponds to the value that will be passed to A3DRWParamsTranslateToPkPartsData::m_eSimplifyGeometry.
in_simplification | Whether to simplify geometry. |
TranslationOptionsKit& HPS::Exchange::TranslationOptionsKit::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. |
TranslationOptionsKit& HPS::Exchange::TranslationOptionsKit::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. |
TranslationOptionsKit& HPS::Exchange::TranslationOptionsKit::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 HPS::Exchange::TranslationOptionsKit::Show | ( | TranslationOptionsKit & | out_kit | ) | const |
Copies this TranslationOptionsKit into the given TranslationOptionsKit.
out_kit | The TranslationOptionsKit to populate with the contents of this TranslationOptionsKit. |
bool HPS::Exchange::TranslationOptionsKit::ShowAccurateEdges | ( | Translation::AccurateEdges & | out_accurate_edges | ) | const |
Shows the accurate edges setting.
out_accurate_edges | Whether to compute accurate edges for translation. |
bool HPS::Exchange::TranslationOptionsKit::ShowApplication | ( | UTF8 & | out_name | ) | const |
Shows the application name setting.
out_name | The application name to put in the Parasolid data. |
bool HPS::Exchange::TranslationOptionsKit::ShowDisjointFaces | ( | bool & | out_state | ) | const |
Shows the disjoin faces setting.
out_state | Whether to disjoin erroneous faces from their owning solids. |
bool HPS::Exchange::TranslationOptionsKit::ShowEntityMerging | ( | Translation::Merging & | out_merging | ) | const |
Shows the merging setting.
out_merging | Whether to merge entities for translation. |
bool HPS::Exchange::TranslationOptionsKit::ShowHealing | ( | Translation::Healing & | out_healing | ) | const |
Shows the healing setting.
out_healing | Whether to heal data for translation. |
bool HPS::Exchange::TranslationOptionsKit::ShowHiddenObjects | ( | bool & | out_state | ) | const |
Shows the hidden object translation setting.
out_state | Whether to translate hidden objects. |
bool HPS::Exchange::TranslationOptionsKit::ShowSewing | ( | bool & | out_state, |
double & | out_tolerance | ||
) | const |
Shows the sewing setting.
out_state | Whether to perform sewing for translation. |
out_tolerance | The sewing tolerance. Only valid if out_state is true. |
bool HPS::Exchange::TranslationOptionsKit::ShowSimplification | ( | Translation::Simplification & | out_simplification | ) | const |
Shows the simplification setting.
out_simplification | Whether to simplify geometry for translation. |
bool HPS::Exchange::TranslationOptionsKit::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 translation. |
bool HPS::Exchange::TranslationOptionsKit::ShowTessellation | ( | bool & | out_state | ) | const |
Shows the tessellation translation setting.
out_state | Whether to export tessellation data. |
bool HPS::Exchange::TranslationOptionsKit::ShowVersion | ( | UTF8 & | out_version | ) | const |
Shows the version string setting.
out_version | The version string to put in the Parasolid data. |
TranslationOptionsKit& HPS::Exchange::TranslationOptionsKit::UnsetAccurateEdges | ( | ) |
Removes the accurate edges setting.
TranslationOptionsKit& HPS::Exchange::TranslationOptionsKit::UnsetApplication | ( | ) |
Removes the application name setting.
TranslationOptionsKit& HPS::Exchange::TranslationOptionsKit::UnsetDisjointFaces | ( | ) |
Removes the disjoin faces setting.
TranslationOptionsKit& HPS::Exchange::TranslationOptionsKit::UnsetEntityMerging | ( | ) |
Removes the merging setting.
TranslationOptionsKit& HPS::Exchange::TranslationOptionsKit::UnsetEverything | ( | ) |
Removes all settings from this TranslationOptionsKit.
TranslationOptionsKit& HPS::Exchange::TranslationOptionsKit::UnsetHealing | ( | ) |
Removes the healing setting.
TranslationOptionsKit& HPS::Exchange::TranslationOptionsKit::UnsetHiddenObjects | ( | ) |
Removes the hidden objects export setting.
TranslationOptionsKit& HPS::Exchange::TranslationOptionsKit::UnsetSewing | ( | ) |
Removes the sewing setting.
TranslationOptionsKit& HPS::Exchange::TranslationOptionsKit::UnsetSimplification | ( | ) |
Removes the simplification setting.
TranslationOptionsKit& HPS::Exchange::TranslationOptionsKit::UnsetSolidsAsFaces | ( | ) |
Removes the solids to faces conversion setting.
TranslationOptionsKit& HPS::Exchange::TranslationOptionsKit::UnsetTessellation | ( | ) |
Removes the tessellation export setting.
TranslationOptionsKit& HPS::Exchange::TranslationOptionsKit::UnsetVersion | ( | ) |
Removes the version string setting.