Inheritance diagram for HPS.Exchange.TranslationOptionsKit:
HPS.SprocketKit HPS.Sprocket HPS.Object

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Exchange.TranslationOptionsKit in_kit)
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 
void Set (HPS.Exchange.TranslationOptionsKit in_kit)
 
HPS.Exchange.TranslationOptionsKit SetAccurateEdges (HPS.Exchange.Translation.AccurateEdges in_accurate_edges)
 
HPS.Exchange.TranslationOptionsKit SetApplication (string in_name)
 
HPS.Exchange.TranslationOptionsKit SetDisjointFaces (bool in_state)
 
HPS.Exchange.TranslationOptionsKit SetEntityMerging (HPS.Exchange.Translation.Merging in_merging)
 
HPS.Exchange.TranslationOptionsKit SetExplodeMultiBodies (bool in_state)
 
HPS.Exchange.TranslationOptionsKit SetHealing (HPS.Exchange.Translation.Healing in_healing)
 
HPS.Exchange.TranslationOptionsKit SetHiddenObjects (bool in_state)
 
HPS.Exchange.TranslationOptionsKit SetMultiProcessCount (uint in_count)
 
HPS.Exchange.TranslationOptionsKit SetSewing (bool in_state, double in_tolerance)
 
HPS.Exchange.TranslationOptionsKit SetSewing (bool in_state)
 
HPS.Exchange.TranslationOptionsKit SetSimplification (HPS.Exchange.Translation.Simplification in_simplification)
 
HPS.Exchange.TranslationOptionsKit SetSolidsAsFaces (bool in_state)
 
HPS.Exchange.TranslationOptionsKit SetTessellation (bool in_state)
 
HPS.Exchange.TranslationOptionsKit SetVersion (string in_version)
 
void Show (out HPS.Exchange.TranslationOptionsKit out_kit)
 
bool ShowAccurateEdges (out HPS.Exchange.Translation.AccurateEdges out_accurate_edges)
 
bool ShowApplication (out string out_name)
 
bool ShowDisjointFaces (out bool out_state)
 
bool ShowEntityMerging (out HPS.Exchange.Translation.Merging out_merging)
 
bool ShowExplodeMultiBodies (out bool out_state)
 
bool ShowHealing (out HPS.Exchange.Translation.Healing out_healing)
 
bool ShowHiddenObjects (out bool out_state)
 
bool ShowMultiProcessCount (out uint out_count)
 
bool ShowSewing (out bool out_state, out double out_tolerance)
 
bool ShowSimplification (out HPS.Exchange.Translation.Simplification out_simplification)
 
bool ShowSolidsAsFaces (out bool out_state)
 
bool ShowTessellation (out bool out_state)
 
bool ShowVersion (out string out_version)
 
 TranslationOptionsKit ()
 
 TranslationOptionsKit (HPS.Exchange.TranslationOptionsKit in_kit)
 
HPS.Exchange.TranslationOptionsKit UnsetAccurateEdges ()
 
HPS.Exchange.TranslationOptionsKit UnsetApplication ()
 
HPS.Exchange.TranslationOptionsKit UnsetDisjointFaces ()
 
HPS.Exchange.TranslationOptionsKit UnsetEntityMerging ()
 
HPS.Exchange.TranslationOptionsKit UnsetEverything ()
 
HPS.Exchange.TranslationOptionsKit UnsetExplodeMultiBodies ()
 
HPS.Exchange.TranslationOptionsKit UnsetHealing ()
 
HPS.Exchange.TranslationOptionsKit UnsetHiddenObjects ()
 
HPS.Exchange.TranslationOptionsKit UnsetMultiProcessCount ()
 
HPS.Exchange.TranslationOptionsKit UnsetSewing ()
 
HPS.Exchange.TranslationOptionsKit UnsetSimplification ()
 
HPS.Exchange.TranslationOptionsKit UnsetSolidsAsFaces ()
 
HPS.Exchange.TranslationOptionsKit UnsetTessellation ()
 
HPS.Exchange.TranslationOptionsKit UnsetVersion ()
 
- Public Member Functions inherited from HPS.SprocketKit
SprocketKit (HPS.SprocketKit in_that)
 
- Public Member Functions inherited from HPS.Sprocket
Sprocket (HPS.Sprocket in_that)
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
Object (HPS.Object that)
 
virtual void Reset ()
 
virtual HPS.Type Type ()
 

Static Public Member Functions

static HPS.Exchange.TranslationOptionsKit GetDefault ()
 
static bool operator!= (HPS.Exchange.TranslationOptionsKit a, HPS.Exchange.TranslationOptionsKit b)
 
static bool operator== (HPS.Exchange.TranslationOptionsKit a, HPS.Exchange.TranslationOptionsKit b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

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

◆ TranslationOptionsKit() [1/2]

HPS.Exchange.TranslationOptionsKit.TranslationOptionsKit ( )
inline

The default constructor creates an empty TranslationOptionsKit object.

◆ TranslationOptionsKit() [2/2]

HPS.Exchange.TranslationOptionsKit.TranslationOptionsKit ( HPS.Exchange.TranslationOptionsKit  in_kit)
inline

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

Parameters
in_kitThe source TranslationOptionsKit to copy.

Member Function Documentation

◆ Empty()

override bool HPS.Exchange.TranslationOptionsKit.Empty ( )
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.

◆ Equals()

bool HPS.Exchange.TranslationOptionsKit.Equals ( HPS.Exchange.TranslationOptionsKit  in_kit)
inline

Check if the source TranslationOptionsKit is equivalent to this TranslationOptionsKit.

Parameters
in_kitThe source TranslationOptionsKit to compare to this TranslationOptionsKit.
Returns
true if the objects are equivalent, false otherwise.

◆ GetDefault()

static HPS.Exchange.TranslationOptionsKit HPS.Exchange.TranslationOptionsKit.GetDefault ( )
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.

◆ ObjectType()

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

◆ Set()

void HPS.Exchange.TranslationOptionsKit.Set ( HPS.Exchange.TranslationOptionsKit  in_kit)
inline

Copies the source TranslationOptionsKit into this TranslationOptionsKit.

Parameters
in_kitThe source TranslationOptionsKit to copy.

◆ SetAccurateEdges()

HPS.Exchange.TranslationOptionsKit HPS.Exchange.TranslationOptionsKit.SetAccurateEdges ( HPS.Exchange.Translation.AccurateEdges  in_accurate_edges)
inline

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.

Parameters
in_accurate_edgesWhether to compute accurate edges.
Returns
A reference to this TranslationOptionsKit.

◆ SetApplication()

HPS.Exchange.TranslationOptionsKit HPS.Exchange.TranslationOptionsKit.SetApplication ( string  in_name)
inline

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_nameUTF8-encoded application name to put in the Parasolid data.
Returns
A reference to this TranslationOptionsKit.

◆ SetDisjointFaces()

HPS.Exchange.TranslationOptionsKit HPS.Exchange.TranslationOptionsKit.SetDisjointFaces ( bool  in_state)
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 A3DRWParamsTranslateToPkPartsData::m_bDisjoinIfFaceFaceError.

Parameters
in_stateWhether to disjoin erroneous faces from their owning solids.
Returns
A reference to this TranslationOptionsKit.

◆ SetEntityMerging()

HPS.Exchange.TranslationOptionsKit HPS.Exchange.TranslationOptionsKit.SetEntityMerging ( HPS.Exchange.Translation.Merging  in_merging)
inline

Sets whether entities can be merged as part of the translation. This corresponds to the value that will be passed to A3DRWParamsTranslateToPkPartsData::m_eMergeEntities.

Parameters
in_mergingWhether to merge entities.
Returns
A reference to this TranslationOptionsKit.

◆ SetExplodeMultiBodies()

HPS.Exchange.TranslationOptionsKit HPS.Exchange.TranslationOptionsKit.SetExplodeMultiBodies ( bool  in_state)
inline

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_stateWhether to explode multi-connexes B-reps into multiple bodies.
Returns
A reference to this TranslationOptionsKit.
See also
Default value

◆ SetHealing()

HPS.Exchange.TranslationOptionsKit HPS.Exchange.TranslationOptionsKit.SetHealing ( HPS.Exchange.Translation.Healing  in_healing)
inline

Sets whether healing will be performed as part of the translation. This corresponds to the value that will be passed to A3DRWParamsTranslateToPkPartsData::m_eHealing.

Parameters
in_healingWhether to perform healing.
Returns
A reference to this TranslationOptionsKit.

◆ SetHiddenObjects()

HPS.Exchange.TranslationOptionsKit HPS.Exchange.TranslationOptionsKit.SetHiddenObjects ( bool  in_state)
inline

Sets whether to export hidden objects. This corresponds to the value that will be passed to A3DRWParamsExportParasolidData::m_bWriteBlankedEntities.

Parameters
in_stateWhether to export hidden objects.
Returns
A reference to this TranslationOptionsKit.
See also
Default value

◆ SetMultiProcessCount()

HPS.Exchange.TranslationOptionsKit HPS.Exchange.TranslationOptionsKit.SetMultiProcessCount ( uint  in_count)
inline

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.
Parameters
in_countThe number of processes to use when performing translation.
Returns
A reference to this TranslationOptionsKit.

◆ SetSewing() [1/2]

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

Sets whether perform sewing as part of the translation.

Parameters
in_stateWhether to perform sewing.
in_toleranceThe sewing tolerance in millimeters.
Returns
A reference to this TranslationOptionsKit.

◆ SetSewing() [2/2]

HPS.Exchange.TranslationOptionsKit HPS.Exchange.TranslationOptionsKit.SetSewing ( bool  in_state)
inline

Sets whether perform sewing as part of the translation.

Parameters
in_stateWhether to perform sewing.
Returns
A reference to this TranslationOptionsKit.

◆ SetSimplification()

HPS.Exchange.TranslationOptionsKit HPS.Exchange.TranslationOptionsKit.SetSimplification ( HPS.Exchange.Translation.Simplification  in_simplification)
inline

Sets whether geometry can be simplified as part of the translation. This corresponds to the value that will be passed to A3DRWParamsTranslateToPkPartsData::m_eSimplifyGeometry.

Parameters
in_simplificationWhether to simplify geometry.
Returns
A reference to this TranslationOptionsKit.

◆ SetSolidsAsFaces()

HPS.Exchange.TranslationOptionsKit HPS.Exchange.TranslationOptionsKit.SetSolidsAsFaces ( bool  in_state)
inline

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_stateWhether to convert solids to a set of independent faces for export.
Returns
A reference to this TranslationOptionsKit.
See also
Default value

◆ SetTessellation()

HPS.Exchange.TranslationOptionsKit HPS.Exchange.TranslationOptionsKit.SetTessellation ( bool  in_state)
inline

Sets whether to export tessellation data. This corresponds to the value that will be passed to A3DRWParamsExportParasolidData::m_bWriteTessellation.

Parameters
in_stateWhether to export tessellation data.
Returns
A reference to this TranslationOptionsKit.
See also
Default value

◆ SetVersion()

HPS.Exchange.TranslationOptionsKit HPS.Exchange.TranslationOptionsKit.SetVersion ( string  in_version)
inline

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_versionUTF8-encoded version string to put in the Parasolid data.
Returns
A reference to this TranslationOptionsKit.

◆ Show()

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

Copies this TranslationOptionsKit into the given TranslationOptionsKit.

Parameters
out_kitThe TranslationOptionsKit to populate with the contents of this TranslationOptionsKit.

◆ ShowAccurateEdges()

bool HPS.Exchange.TranslationOptionsKit.ShowAccurateEdges ( out HPS.Exchange.Translation.AccurateEdges  out_accurate_edges)
inline

Shows the accurate edges setting.

Parameters
out_accurate_edgesWhether to compute accurate edges for translation.
Returns
true if an accurate edges setting was specified, false otherwise.

◆ ShowApplication()

bool HPS.Exchange.TranslationOptionsKit.ShowApplication ( out string  out_name)
inline

Shows the application name setting.

Parameters
out_nameThe application name to put in the Parasolid data.
Returns
true if an application name setting was specified, false otherwise.

◆ ShowDisjointFaces()

bool HPS.Exchange.TranslationOptionsKit.ShowDisjointFaces ( out bool  out_state)
inline

Shows the disjoin faces setting.

Parameters
out_stateWhether to disjoin erroneous faces from their owning solids.
Returns
true if a disjoin faces setting was specified, false otherwise.

◆ ShowEntityMerging()

bool HPS.Exchange.TranslationOptionsKit.ShowEntityMerging ( out HPS.Exchange.Translation.Merging  out_merging)
inline

Shows the merging setting.

Parameters
out_mergingWhether to merge entities for translation.
Returns
true if a merging setting was specified, false otherwise.

◆ ShowExplodeMultiBodies()

bool HPS.Exchange.TranslationOptionsKit.ShowExplodeMultiBodies ( out bool  out_state)
inline

Shows the explode multi bodies setting.

Parameters
out_stateThe explode multi bodies setting to put in the Parasolid data.
Returns
true if a explode multi bodies setting was specified, false otherwise.

◆ ShowHealing()

bool HPS.Exchange.TranslationOptionsKit.ShowHealing ( out HPS.Exchange.Translation.Healing  out_healing)
inline

Shows the healing setting.

Parameters
out_healingWhether to heal data for translation.
Returns
true if a healing setting was specified, false otherwise.

◆ ShowHiddenObjects()

bool HPS.Exchange.TranslationOptionsKit.ShowHiddenObjects ( out bool  out_state)
inline

Shows the hidden object translation setting.

Parameters
out_stateWhether to translate hidden objects.
Returns
true if a hidden object export setting was specified, false otherwise.

◆ ShowMultiProcessCount()

bool HPS.Exchange.TranslationOptionsKit.ShowMultiProcessCount ( out uint  out_count)
inline

Shows the multi-process count setting.

Parameters
out_countThe number of processes to use when performing translation.
Returns
true if a multi-process count setting was specified, false otherwise.

◆ ShowSewing()

bool HPS.Exchange.TranslationOptionsKit.ShowSewing ( out bool  out_state,
out double  out_tolerance 
)
inline

Shows the sewing setting.

Parameters
out_stateWhether to perform sewing for translation.
out_toleranceThe sewing tolerance. Only valid if out_state is true.
Returns
true if a sewing setting was specified, false otherwise.

◆ ShowSimplification()

bool HPS.Exchange.TranslationOptionsKit.ShowSimplification ( out HPS.Exchange.Translation.Simplification  out_simplification)
inline

Shows the simplification setting.

Parameters
out_simplificationWhether to simplify geometry for translation.
Returns
true if a simplification setting was specified, false otherwise.

◆ ShowSolidsAsFaces()

bool HPS.Exchange.TranslationOptionsKit.ShowSolidsAsFaces ( out bool  out_state)
inline

Shows the solids to faces conversion setting.

Parameters
out_stateWhether to convert solids to a set of independent faces for translation.
Returns
true if a solids to faces conversion setting was specified, false otherwise.

◆ ShowTessellation()

bool HPS.Exchange.TranslationOptionsKit.ShowTessellation ( out bool  out_state)
inline

Shows the tessellation translation setting.

Parameters
out_stateWhether to export tessellation data.
Returns
true if a tessellation export setting was specified, false otherwise.

◆ ShowVersion()

bool HPS.Exchange.TranslationOptionsKit.ShowVersion ( out string  out_version)
inline

Shows the version string setting.

Parameters
out_versionThe version string to put in the Parasolid data.
Returns
true if a version string setting was specified, false otherwise.

◆ UnsetAccurateEdges()

HPS.Exchange.TranslationOptionsKit HPS.Exchange.TranslationOptionsKit.UnsetAccurateEdges ( )
inline

Removes the accurate edges setting.

Returns
A reference to this TranslationOptionsKit.

◆ UnsetApplication()

HPS.Exchange.TranslationOptionsKit HPS.Exchange.TranslationOptionsKit.UnsetApplication ( )
inline

Removes the application name setting.

Returns
A reference to this TranslationOptionsKit.

◆ UnsetDisjointFaces()

HPS.Exchange.TranslationOptionsKit HPS.Exchange.TranslationOptionsKit.UnsetDisjointFaces ( )
inline

Removes the disjoin faces setting.

Returns
A reference to this TranslationOptionsKit.

◆ UnsetEntityMerging()

HPS.Exchange.TranslationOptionsKit HPS.Exchange.TranslationOptionsKit.UnsetEntityMerging ( )
inline

Removes the merging setting.

Returns
A reference to this TranslationOptionsKit.

◆ UnsetEverything()

HPS.Exchange.TranslationOptionsKit HPS.Exchange.TranslationOptionsKit.UnsetEverything ( )
inline

Removes all settings from this TranslationOptionsKit.

Returns
A reference to this TranslationOptionsKit.

◆ UnsetExplodeMultiBodies()

HPS.Exchange.TranslationOptionsKit HPS.Exchange.TranslationOptionsKit.UnsetExplodeMultiBodies ( )
inline

Removes the explode multi bodies setting.

Returns
A reference to this TranslationOptionsKit.

◆ UnsetHealing()

HPS.Exchange.TranslationOptionsKit HPS.Exchange.TranslationOptionsKit.UnsetHealing ( )
inline

Removes the healing setting.

Returns
A reference to this TranslationOptionsKit.

◆ UnsetHiddenObjects()

HPS.Exchange.TranslationOptionsKit HPS.Exchange.TranslationOptionsKit.UnsetHiddenObjects ( )
inline

Removes the hidden objects export setting.

Returns
A reference to this TranslationOptionsKit.

◆ UnsetMultiProcessCount()

HPS.Exchange.TranslationOptionsKit HPS.Exchange.TranslationOptionsKit.UnsetMultiProcessCount ( )
inline

Removes the multi-process count setting.

Returns
A reference to this TranslationOptionsKit.

◆ UnsetSewing()

HPS.Exchange.TranslationOptionsKit HPS.Exchange.TranslationOptionsKit.UnsetSewing ( )
inline

Removes the sewing setting.

Returns
A reference to this TranslationOptionsKit.

◆ UnsetSimplification()

HPS.Exchange.TranslationOptionsKit HPS.Exchange.TranslationOptionsKit.UnsetSimplification ( )
inline

Removes the simplification setting.

Returns
A reference to this TranslationOptionsKit.

◆ UnsetSolidsAsFaces()

HPS.Exchange.TranslationOptionsKit HPS.Exchange.TranslationOptionsKit.UnsetSolidsAsFaces ( )
inline

Removes the solids to faces conversion setting.

Returns
A reference to this TranslationOptionsKit.

◆ UnsetTessellation()

HPS.Exchange.TranslationOptionsKit HPS.Exchange.TranslationOptionsKit.UnsetTessellation ( )
inline

Removes the tessellation export setting.

Returns
A reference to this TranslationOptionsKit.

◆ UnsetVersion()

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