HPS::Exchange::TranslationOptionsKit

class HPS.Exchange.TranslationOptionsKit : public HPS.SprocketKit 

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.

Public Functions

override void Dispose ()

override bool Empty ()

Indicates whether this TranslationOptionsKit has any values set on it.

Return: true if no values are set on this TranslationOptionsKit, false otherwise.

bool Equals (HPS.Exchange.TranslationOptionsKit in_kit)

Check if the source TranslationOptionsKit is equivalent to this TranslationOptionsKit.

Param in_kit: The source TranslationOptionsKit to compare to this TranslationOptionsKit.
Return: true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

override int GetHashCode ()

override HPS.Type ObjectType ()

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

Return: The declared type of the object in question, which may differ from the true, underlying type.

void Set (HPS.Exchange.TranslationOptionsKit in_kit)

Copies the source TranslationOptionsKit into this TranslationOptionsKit.

Param in_kit: The source TranslationOptionsKit to copy.

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 A3DRWParamsTranslateToPkPartsData::m_eComputeAccurateEdges.

Param in_accurate_edges: Whether to compute accurate edges.
Return: A reference to this TranslationOptionsKit.

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 A3DRWParamsExportParasolidData::m_pcApplication.

Param in_name: UTF8-encoded application name to put in the Parasolid data.
Return: A reference to this 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.

Param in_state: Whether to disjoin erroneous faces from their owning solids.
Return: A reference to this TranslationOptionsKit.

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 A3DRWParamsTranslateToPkPartsData::m_eMergeEntities.

Param in_merging: Whether to merge entities.
Return: A reference to this TranslationOptionsKit.

HPS.Exchange.TranslationOptionsKit 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.

See: Default value

Param in_state: Whether to explode multi-connexes B-reps into multiple bodies.
Return: A reference to this TranslationOptionsKit.

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 A3DRWParamsTranslateToPkPartsData::m_eHealing.

Param in_healing: Whether to perform healing.
Return: A reference to this 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.

See: Default value

Param in_state: Whether to export hidden objects.
Return: A reference to this TranslationOptionsKit.

HPS.Exchange.TranslationOptionsKit SetMultiProcessCount (uint in_count)

Sets the number of processes to use when performing translation. This should be a value between 1 and the number of cores on your system.

Note

Presently this option is only used for translations performed when using HPS.ExchangeParsolid.File.Import and HPS.ExchangeParasolid.File.Reload.

Param in_count: The number of processes to use when performing translation.
Return: A reference to this TranslationOptionsKit.

HPS.Exchange.TranslationOptionsKit SetSewing (bool in_state)

Sets whether perform sewing as part of the translation.

Param in_state: Whether to perform sewing.
Return: A reference to this TranslationOptionsKit.

HPS.Exchange.TranslationOptionsKit SetSewing (bool in_state, double in_tolerance)

Sets whether perform sewing as part of the translation.

Param in_state: Whether to perform sewing.
Param in_tolerance: The sewing tolerance in millimeters.
Return: A reference to this TranslationOptionsKit.

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 A3DRWParamsTranslateToPkPartsData::m_eSimplifyGeometry.

Param in_simplification: Whether to simplify geometry.
Return: A reference to this 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.

See: Default value

Param in_state: Whether to convert solids to a set of independent faces for export.
Return: A reference to this 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.

See: Default value

Param in_state: Whether to export tessellation data.
Return: A reference to this TranslationOptionsKit.

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 A3DRWParamsExportParasolidData::m_pcVersion.

Param in_version: UTF8-encoded version string to put in the Parasolid data.
Return: A reference to this TranslationOptionsKit.

void Show (out HPS.Exchange.TranslationOptionsKit out_kit)

Copies this TranslationOptionsKit into the given TranslationOptionsKit.

Param out_kit: The TranslationOptionsKit to populate with the contents of this TranslationOptionsKit.

bool ShowAccurateEdges (out HPS.Exchange.Translation.AccurateEdges out_accurate_edges)

Shows the accurate edges setting.

Param out_accurate_edges: Whether to compute accurate edges for translation.
Return: true if an accurate edges setting was specified, false otherwise.

bool ShowApplication (out string out_name)

Shows the application name setting.

Param out_name: The application name to put in the Parasolid data.
Return: true if an application name setting was specified, false otherwise.

bool ShowDisjointFaces (out bool out_state)

Shows the disjoin faces setting.

Param out_state: Whether to disjoin erroneous faces from their owning solids.
Return: true if a disjoin faces setting was specified, false otherwise.

bool ShowEntityMerging (out HPS.Exchange.Translation.Merging out_merging)

Shows the merging setting.

Param out_merging: Whether to merge entities for translation.
Return: true if a merging setting was specified, false otherwise.

bool ShowExplodeMultiBodies (out bool out_state)

Shows the explode multi bodies setting.

Param out_state: The explode multi bodies setting to put in the Parasolid data.
Return: true if a explode multi bodies setting was specified, false otherwise.

bool ShowHealing (out HPS.Exchange.Translation.Healing out_healing)

Shows the healing setting.

Param out_healing: Whether to heal data for translation.
Return: true if a healing setting was specified, false otherwise.

bool ShowHiddenObjects (out bool out_state)

Shows the hidden object translation setting.

Param out_state: Whether to translate hidden objects.
Return: true if a hidden object export setting was specified, false otherwise.

bool ShowMultiProcessCount (out uint out_count)

Shows the multi-process count setting.

Param out_count: The number of processes to use when performing translation.
Return: true if a multi-process count setting was specified, false otherwise.

bool ShowSewing (out bool out_state, out double out_tolerance)

Shows the sewing setting.

Param out_state: Whether to perform sewing for translation.
Param out_tolerance: The sewing tolerance. Only valid if out_state is true.
Return: true if a sewing setting was specified, false otherwise.

bool ShowSimplification (out HPS.Exchange.Translation.Simplification out_simplification)

Shows the simplification setting.

Param out_simplification: Whether to simplify geometry for translation.
Return: true if a simplification setting was specified, false otherwise.

bool ShowSolidsAsFaces (out bool out_state)

Shows the solids to faces conversion setting.

Param out_state: Whether to convert solids to a set of independent faces for translation.
Return: true if a solids to faces conversion setting was specified, false otherwise.

bool ShowTessellation (out bool out_state)

Shows the tessellation translation setting.

Param out_state: Whether to export tessellation data.
Return: true if a tessellation export setting was specified, false otherwise.

bool ShowVersion (out string out_version)

Shows the version string setting.

Param out_version: The version string to put in the Parasolid data.
Return: true if a version string setting was specified, false otherwise.

TranslationOptionsKit (): The default constructor creates an empty TranslationOptionsKit object.

TranslationOptionsKit (HPS.Exchange.TranslationOptionsKit in_kit)

The copy constructor creates a new TranslationOptionsKit object that contains the same settings as the source TranslationOptionsKit.

Param in_kit: The source TranslationOptionsKit to copy.

HPS.Exchange.TranslationOptionsKit UnsetAccurateEdges ()

Removes the accurate edges setting.

Return: A reference to this TranslationOptionsKit.

HPS.Exchange.TranslationOptionsKit UnsetApplication ()

Removes the application name setting.

Return: A reference to this TranslationOptionsKit.

HPS.Exchange.TranslationOptionsKit UnsetDisjointFaces ()

Removes the disjoin faces setting.

Return: A reference to this TranslationOptionsKit.

HPS.Exchange.TranslationOptionsKit UnsetEntityMerging ()

Removes the merging setting.

Return: A reference to this TranslationOptionsKit.

HPS.Exchange.TranslationOptionsKit UnsetEverything ()

Removes all settings from this TranslationOptionsKit.

Return: A reference to this TranslationOptionsKit.

HPS.Exchange.TranslationOptionsKit UnsetExplodeMultiBodies ()

Removes the explode multi bodies setting.

Return: A reference to this TranslationOptionsKit.

HPS.Exchange.TranslationOptionsKit UnsetHealing ()

Removes the healing setting.

Return: A reference to this TranslationOptionsKit.

HPS.Exchange.TranslationOptionsKit UnsetHiddenObjects ()

Removes the hidden objects export setting.

Return: A reference to this TranslationOptionsKit.

HPS.Exchange.TranslationOptionsKit UnsetMultiProcessCount ()

Removes the multi-process count setting.

Return: A reference to this TranslationOptionsKit.

HPS.Exchange.TranslationOptionsKit UnsetSewing ()

Removes the sewing setting.

Return: A reference to this TranslationOptionsKit.

HPS.Exchange.TranslationOptionsKit UnsetSimplification ()

Removes the simplification setting.

Return: A reference to this TranslationOptionsKit.

HPS.Exchange.TranslationOptionsKit UnsetSolidsAsFaces ()

Removes the solids to faces conversion setting.

Return: A reference to this TranslationOptionsKit.

HPS.Exchange.TranslationOptionsKit UnsetTessellation ()

Removes the tessellation export setting.

Return: A reference to this TranslationOptionsKit.

HPS.Exchange.TranslationOptionsKit UnsetVersion ()

Removes the version string setting.

Return: A reference to this TranslationOptionsKit.

Public Static Functions

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.

Return: A TranslationOptionsKit with the default settings.

bool operator!= (HPS.Exchange.TranslationOptionsKit a, HPS.Exchange.TranslationOptionsKit b)

bool operator== (HPS.Exchange.TranslationOptionsKit a, HPS.Exchange.TranslationOptionsKit b)