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. More...

Public Member Functions | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this TranslationOptionsKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.Exchange.TranslationOptionsKit in_kit) |
Check if the source TranslationOptionsKit is equivalent to this TranslationOptionsKit. More... | |
override int | GetHashCode () |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More... | |
void | Set (HPS.Exchange.TranslationOptionsKit in_kit) |
Copies the source TranslationOptionsKit into this TranslationOptionsKit. More... | |
HPS.Exchange.TranslationOptionsKit | SetAccurateEdges (HPS.Exchange.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 <ulink url="http://docs.techsoft3d.com/exchange/latest/index.html#build/api_ref/struct_a3_d_r_w_params_translate_to_pk_parts_data.html#a28d5d381ab7d0f2d16861e2e567cb72a">A3DRWParamsTranslateToPkPartsData::m_eComputeAccurateEdges</ulink>. More... | |
HPS.Exchange.TranslationOptionsKit | SetApplication (string in_name) |
Sets the application name to put in the Parasolid data. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/build/api_ref/struct_a3_d_r_w_params_export_parasolid_data.html#aaf34910e2c76bc91ffce06955671597d">A3DRWParamsExportParasolidData::m_pcApplication</ulink>. More... | |
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 <ulink url="http://docs.techsoft3d.com/exchange/latest/index.html#build/api_ref/struct_a3_d_r_w_params_translate_to_pk_parts_data.html#ga45fd82ccead86ee8770d926596016c4b">A3DRWParamsTranslateToPkPartsData::m_bDisjoinIfFaceFaceError</ulink>. More... | |
HPS.Exchange.TranslationOptionsKit | SetEntityMerging (HPS.Exchange.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 <ulink url="http://docs.techsoft3d.com/exchange/latest/index.html#build/api_ref/struct_a3_d_r_w_params_translate_to_pk_parts_data.html#a4e280982be9046d0a499d4d028f30e48">A3DRWParamsTranslateToPkPartsData::m_eMergeEntities</ulink>. More... | |
HPS.Exchange.TranslationOptionsKit | SetHealing (HPS.Exchange.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 <ulink url="http://docs.techsoft3d.com/exchange/latest/index.html#build/api_ref/struct_a3_d_r_w_params_translate_to_pk_parts_data.html#a6c3c03d071137f85b1f993cb223129fb">A3DRWParamsTranslateToPkPartsData::m_eHealing</ulink>. More... | |
HPS.Exchange.TranslationOptionsKit | SetHiddenObjects (bool in_state) |
Sets whether to export hidden objects. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/build/api_ref/struct_a3_d_r_w_params_export_parasolid_data.html#a435f5a402a4e769a90105c312e75af3f">A3DRWParamsExportParasolidData::m_bWriteBlankedEntities</ulink>. More... | |
HPS.Exchange.TranslationOptionsKit | SetSewing (bool in_state, double in_tolerance) |
Sets whether perform sewing as part of the translation. More... | |
HPS.Exchange.TranslationOptionsKit | SetSewing (bool in_state) |
Sets whether perform sewing as part of the translation. More... | |
HPS.Exchange.TranslationOptionsKit | SetSimplification (HPS.Exchange.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 <ulink url="http://docs.techsoft3d.com/exchange/latest/index.html#build/api_ref/struct_a3_d_r_w_params_translate_to_pk_parts_data.html#ga968b12c118770ae30f80fd2cc6d71f22">A3DRWParamsTranslateToPkPartsData::m_eSimplifyGeometry</ulink>. More... | |
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 <ulink url="http://docs.techsoft3d.com/exchange/latest/build/api_ref/struct_a3_d_r_w_params_export_parasolid_data.html#a67ec36338dcfaa92d331c294d63ac94d">A3DRWParamsExportIgesData::m_bSaveSolidsAsFaces</ulink>. More... | |
HPS.Exchange.TranslationOptionsKit | SetTessellation (bool in_state) |
Sets whether to export tessellation data. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/build/api_ref/struct_a3_d_r_w_params_export_parasolid_data.html#a9fc3ea289436ec57dcdbce78ddc57a97">A3DRWParamsExportParasolidData::m_bWriteTessellation</ulink>. More... | |
HPS.Exchange.TranslationOptionsKit | SetVersion (string in_version) |
Sets the version string to put in the Parasolid data. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/build/api_ref/struct_a3_d_r_w_params_export_parasolid_data.html#ae2cbff6b7cde472c983810da1d9ea0a2">A3DRWParamsExportParasolidData::m_pcVersion</ulink>. More... | |
void | Show (out HPS.Exchange.TranslationOptionsKit out_kit) |
Copies this TranslationOptionsKit into the given TranslationOptionsKit. More... | |
bool | ShowAccurateEdges (out HPS.Exchange.Translation.AccurateEdges out_accurate_edges) |
Shows the accurate edges setting. More... | |
bool | ShowApplication (out string out_name) |
Shows the application name setting. More... | |
bool | ShowDisjointFaces (out bool out_state) |
Shows the disjoin faces setting. More... | |
bool | ShowEntityMerging (out HPS.Exchange.Translation.Merging out_merging) |
Shows the merging setting. More... | |
bool | ShowHealing (out HPS.Exchange.Translation.Healing out_healing) |
Shows the healing setting. More... | |
bool | ShowHiddenObjects (out bool out_state) |
Shows the hidden object translation setting. More... | |
bool | ShowSewing (out bool out_state, out double out_tolerance) |
Shows the sewing setting. More... | |
bool | ShowSimplification (out HPS.Exchange.Translation.Simplification out_simplification) |
Shows the simplification setting. More... | |
bool | ShowSolidsAsFaces (out bool out_state) |
Shows the solids to faces conversion setting. More... | |
bool | ShowTessellation (out bool out_state) |
Shows the tessellation translation setting. More... | |
bool | ShowVersion (out string out_version) |
Shows the version string setting. More... | |
TranslationOptionsKit () | |
The default constructor creates an empty TranslationOptionsKit object. More... | |
TranslationOptionsKit (HPS.Exchange.TranslationOptionsKit in_kit) | |
The copy constructor creates a new TranslationOptionsKit object that contains the same settings as the source TranslationOptionsKit. More... | |
HPS.Exchange.TranslationOptionsKit | UnsetAccurateEdges () |
Removes the accurate edges setting. More... | |
HPS.Exchange.TranslationOptionsKit | UnsetApplication () |
Removes the application name setting. More... | |
HPS.Exchange.TranslationOptionsKit | UnsetDisjointFaces () |
Removes the disjoin faces setting. More... | |
HPS.Exchange.TranslationOptionsKit | UnsetEntityMerging () |
Removes the merging setting. More... | |
HPS.Exchange.TranslationOptionsKit | UnsetEverything () |
Removes all settings from this TranslationOptionsKit. More... | |
HPS.Exchange.TranslationOptionsKit | UnsetHealing () |
Removes the healing setting. More... | |
HPS.Exchange.TranslationOptionsKit | UnsetHiddenObjects () |
Removes the hidden objects export setting. More... | |
HPS.Exchange.TranslationOptionsKit | UnsetSewing () |
Removes the sewing setting. More... | |
HPS.Exchange.TranslationOptionsKit | UnsetSimplification () |
Removes the simplification setting. More... | |
HPS.Exchange.TranslationOptionsKit | UnsetSolidsAsFaces () |
Removes the solids to faces conversion setting. More... | |
HPS.Exchange.TranslationOptionsKit | UnsetTessellation () |
Removes the tessellation export setting. More... | |
HPS.Exchange.TranslationOptionsKit | UnsetVersion () |
Removes the version string setting. More... | |
![]() | |
Sprocket (HPS.Sprocket in_that) | |
![]() | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object that) | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
HPS.Type | Type () |
This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More... | |
Static Public Member Functions | |
static HPS.Exchange.TranslationOptionsKit | GetDefault () |
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. More... | |
static bool | operator!= (HPS.Exchange.TranslationOptionsKit a, HPS.Exchange.TranslationOptionsKit b) |
static bool | operator== (HPS.Exchange.TranslationOptionsKit a, HPS.Exchange.TranslationOptionsKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
Detailed Description
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.
Constructor & Destructor Documentation
|
inline |
The default constructor creates an empty TranslationOptionsKit object.
|
inline |
The copy constructor creates a new TranslationOptionsKit object that contains the same settings as the source TranslationOptionsKit.
- Parameters
-
in_kit The source TranslationOptionsKit to copy.
Member Function Documentation
|
inlinevirtual |
Indicates whether this TranslationOptionsKit has any values set on it.
- Returns
- true if no values are set on this TranslationOptionsKit, false otherwise.
Reimplemented from HPS.Object.
|
inline |
Check if the source TranslationOptionsKit is equivalent to this TranslationOptionsKit.
- Parameters
-
in_kit The source TranslationOptionsKit to compare to this TranslationOptionsKit.
- Returns
- true if the objects are equivalent, false otherwise.
|
inlinestatic |
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.
- Returns
- A TranslationOptionsKit with the default settings.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS.Object.
|
inline |
Copies the source TranslationOptionsKit into this TranslationOptionsKit.
- Parameters
-
in_kit The source TranslationOptionsKit to copy.
|
inline |
Sets whether accurate edges will be computed as part of the translation. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/index.html#build/api_ref/struct_a3_d_r_w_params_translate_to_pk_parts_data.html#a28d5d381ab7d0f2d16861e2e567cb72a">A3DRWParamsTranslateToPkPartsData::m_eComputeAccurateEdges</ulink>.
- Parameters
-
in_accurate_edges Whether to compute accurate edges.
- Returns
- A reference to this TranslationOptionsKit.
|
inline |
Sets the application name to put in the Parasolid data. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/build/api_ref/struct_a3_d_r_w_params_export_parasolid_data.html#aaf34910e2c76bc91ffce06955671597d">A3DRWParamsExportParasolidData::m_pcApplication</ulink>.
- Parameters
-
in_name UTF8-encoded application name to put in the Parasolid data.
- Returns
- A reference to this TranslationOptionsKit.
|
inline |
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 <ulink url="http://docs.techsoft3d.com/exchange/latest/index.html#build/api_ref/struct_a3_d_r_w_params_translate_to_pk_parts_data.html#ga45fd82ccead86ee8770d926596016c4b">A3DRWParamsTranslateToPkPartsData::m_bDisjoinIfFaceFaceError</ulink>.
- Parameters
-
in_state Whether to disjoin erroneous faces from their owning solids.
- Returns
- A reference to this TranslationOptionsKit.
|
inline |
Sets whether entities can be merged as part of the translation. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/index.html#build/api_ref/struct_a3_d_r_w_params_translate_to_pk_parts_data.html#a4e280982be9046d0a499d4d028f30e48">A3DRWParamsTranslateToPkPartsData::m_eMergeEntities</ulink>.
- Parameters
-
in_merging Whether to merge entities.
- Returns
- A reference to this TranslationOptionsKit.
|
inline |
Sets whether healing will be performed as part of the translation. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/index.html#build/api_ref/struct_a3_d_r_w_params_translate_to_pk_parts_data.html#a6c3c03d071137f85b1f993cb223129fb">A3DRWParamsTranslateToPkPartsData::m_eHealing</ulink>.
- Parameters
-
in_healing Whether to perform healing.
- Returns
- A reference to this TranslationOptionsKit.
|
inline |
Sets whether to export hidden objects. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/build/api_ref/struct_a3_d_r_w_params_export_parasolid_data.html#a435f5a402a4e769a90105c312e75af3f">A3DRWParamsExportParasolidData::m_bWriteBlankedEntities</ulink>.
- Parameters
-
in_state Whether to export hidden objects.
- Returns
- A reference to this TranslationOptionsKit.
Default value
|
inline |
Sets whether perform sewing as part of the translation.
- Parameters
-
in_state Whether to perform sewing. in_tolerance The sewing tolerance.
- Returns
- A reference to this TranslationOptionsKit.
|
inline |
Sets whether perform sewing as part of the translation.
- Parameters
-
in_state Whether to perform sewing.
- Returns
- A reference to this TranslationOptionsKit.
|
inline |
Sets whether geometry can be simplified as part of the translation. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/index.html#build/api_ref/struct_a3_d_r_w_params_translate_to_pk_parts_data.html#ga968b12c118770ae30f80fd2cc6d71f22">A3DRWParamsTranslateToPkPartsData::m_eSimplifyGeometry</ulink>.
- Parameters
-
in_simplification Whether to simplify geometry.
- Returns
- A reference to this TranslationOptionsKit.
|
inline |
Sets whether to convert solids to a set of independent faces for export. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/build/api_ref/struct_a3_d_r_w_params_export_parasolid_data.html#a67ec36338dcfaa92d331c294d63ac94d">A3DRWParamsExportIgesData::m_bSaveSolidsAsFaces</ulink>.
- Parameters
-
in_state Whether to convert solids to a set of independent faces for export.
- Returns
- A reference to this TranslationOptionsKit.
Default value
|
inline |
Sets whether to export tessellation data. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/build/api_ref/struct_a3_d_r_w_params_export_parasolid_data.html#a9fc3ea289436ec57dcdbce78ddc57a97">A3DRWParamsExportParasolidData::m_bWriteTessellation</ulink>.
- Parameters
-
in_state Whether to export tessellation data.
- Returns
- A reference to this TranslationOptionsKit.
Default value
|
inline |
Sets the version string to put in the Parasolid data. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/build/api_ref/struct_a3_d_r_w_params_export_parasolid_data.html#ae2cbff6b7cde472c983810da1d9ea0a2">A3DRWParamsExportParasolidData::m_pcVersion</ulink>.
- Parameters
-
in_version UTF8-encoded version string to put in the Parasolid data.
- Returns
- A reference to this TranslationOptionsKit.
|
inline |
Copies this TranslationOptionsKit into the given TranslationOptionsKit.
- Parameters
-
out_kit The TranslationOptionsKit to populate with the contents of this TranslationOptionsKit.
|
inline |
Shows the accurate edges setting.
- Parameters
-
out_accurate_edges Whether to compute accurate edges for translation.
- Returns
- true if an accurate edges setting was specified, false otherwise.
|
inline |
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.
|
inline |
Shows the disjoin faces setting.
- Parameters
-
out_state Whether to disjoin erroneous faces from their owning solids.
- Returns
- true if a disjoin faces setting was specified, false otherwise.
|
inline |
Shows the merging setting.
- Parameters
-
out_merging Whether to merge entities for translation.
- Returns
- true if a merging setting was specified, false otherwise.
|
inline |
Shows the healing setting.
- Parameters
-
out_healing Whether to heal data for translation.
- Returns
- true if a healing setting was specified, false otherwise.
|
inline |
Shows the hidden object translation setting.
- Parameters
-
out_state Whether to translate hidden objects.
- Returns
- true if a hidden object export setting was specified, false otherwise.
|
inline |
Shows the sewing setting.
- Parameters
-
out_state Whether to perform sewing for translation. out_tolerance The sewing tolerance. Only valid if out_state is true.
- Returns
- true if a sewing setting was specified, false otherwise.
|
inline |
Shows the simplification setting.
- Parameters
-
out_simplification Whether to simplify geometry for translation.
- Returns
- true if a simplification setting was specified, false otherwise.
|
inline |
Shows the solids to faces conversion setting.
- Parameters
-
out_state Whether to convert solids to a set of independent faces for translation.
- Returns
- true if a solids to faces conversion setting was specified, false otherwise.
|
inline |
Shows the tessellation translation setting.
- Parameters
-
out_state Whether to export tessellation data.
- Returns
- true if a tessellation export setting was specified, false otherwise.
|
inline |
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.
|
inline |
Removes the accurate edges setting.
- Returns
- A reference to this TranslationOptionsKit.
|
inline |
Removes the application name setting.
- Returns
- A reference to this TranslationOptionsKit.
|
inline |
Removes the disjoin faces setting.
- Returns
- A reference to this TranslationOptionsKit.
|
inline |
Removes the merging setting.
- Returns
- A reference to this TranslationOptionsKit.
|
inline |
Removes all settings from this TranslationOptionsKit.
- Returns
- A reference to this TranslationOptionsKit.
|
inline |
Removes the healing setting.
- Returns
- A reference to this TranslationOptionsKit.
|
inline |
Removes the hidden objects export setting.
- Returns
- A reference to this TranslationOptionsKit.
|
inline |
Removes the sewing setting.
- Returns
- A reference to this TranslationOptionsKit.
|
inline |
Removes the simplification setting.
- Returns
- A reference to this TranslationOptionsKit.
|
inline |
Removes the solids to faces conversion setting.
- Returns
- A reference to this TranslationOptionsKit.
|
inline |
Removes the tessellation export setting.
- Returns
- A reference to this TranslationOptionsKit.
|
inline |
Removes the version string setting.
- Returns
- A reference to this TranslationOptionsKit.
The documentation for this class was generated from the following file:
- internals/hps_sprk_exchange/source/cs/HPS.Exchange.cs