HPS.Exchange.ExportParasolidOptionsKit

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

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.

Public Functions

override bool Empty ()

Indicates whether this ExportParasolidOptionsKit has any values set on it.

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

bool Equals (HPS.Exchange.ExportParasolidOptionsKit in_kit)

Check if the source ExportParasolidOptionsKit is equivalent to this ExportParasolidOptionsKit.

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

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

ExportParasolidOptionsKit (HPS.Exchange.ExportParasolidOptionsKit in_kit)

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

Param in_kit: The source ExportParasolidOptionsKit to copy.

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.ExportParasolidOptionsKit in_kit)

Copies the source ExportParasolidOptionsKit into this ExportParasolidOptionsKit.

Param in_kit: The source ExportParasolidOptionsKit to copy.

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

See: Default value

Param in_state: Whether to explode multi-connexes B-reps into multiple bodies.
Return: A reference to this 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.

See: Default value

Param in_state: Whether to export hidden objects.
Return: A reference to this 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.

See: Default value

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

See: Default value

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

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

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

Copies this ExportParasolidOptionsKit into the given ExportParasolidOptionsKit.

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

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 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 ShowHiddenObjects (out bool out_state)

Shows the hidden object export setting.

Param out_state: Whether to export hidden objects.
Return: true if a hidden object export 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 export.
Return: true if a solids to faces conversion setting was specified, false otherwise.

bool ShowTessellation (out bool out_state)

Shows the tessellation export 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.

HPS.Exchange.ExportParasolidOptionsKit UnsetApplication ()

Removes the application name setting.

Return: A reference to this ExportParasolidOptionsKit.

HPS.Exchange.ExportParasolidOptionsKit UnsetEverything ()

Removes all settings from this ExportParasolidOptionsKit.

Return: A reference to this ExportParasolidOptionsKit.

HPS.Exchange.ExportParasolidOptionsKit UnsetExplodeMultiBodies ()

Removes the explode multi bodies setting.

Return: A reference to this ExportParasolidOptionsKit.

HPS.Exchange.ExportParasolidOptionsKit UnsetHiddenObjects ()

Removes the hidden objects export setting.

Return: A reference to this ExportParasolidOptionsKit.

HPS.Exchange.ExportParasolidOptionsKit UnsetSolidsAsFaces ()

Removes the solids to faces conversion setting.

Return: A reference to this ExportParasolidOptionsKit.

HPS.Exchange.ExportParasolidOptionsKit UnsetTessellation ()

Removes the tessellation export setting.

Return: A reference to this ExportParasolidOptionsKit.

HPS.Exchange.ExportParasolidOptionsKit UnsetVersion ()

Removes the version string setting.

Return: A reference to this ExportParasolidOptionsKit.

Public Static Functions

HPS.Exchange.ExportParasolidOptionsKit GetDefault ()

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.

Return: An ExportParasolidOptionsKit with the default settings.