HPS::Exchange::ExportIGESOptionsKit

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

The HPS.Exchange.ExportIGESOptionsKit class is a user space object. It contains settings controlling how IGES data is exported via Exchange. Calling HPS.Exchange.ExportIGESOptionsKit.GetDefault() will return an options kit with values found in here.

Public Functions

override void Dispose ()

override bool Empty ()

Indicates whether this ExportIGESOptionsKit has any values set on it.

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

bool Equals (HPS.Exchange.ExportIGESOptionsKit in_kit)

Check if the source ExportIGESOptionsKit is equivalent to this ExportIGESOptionsKit.

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

override bool Equals (Object obj)

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

ExportIGESOptionsKit (HPS.Exchange.ExportIGESOptionsKit in_kit)

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

Param in_kit: The source ExportIGESOptionsKit to copy.

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

Copies the source ExportIGESOptionsKit into this ExportIGESOptionsKit.

Param in_kit: The source ExportIGESOptionsKit to copy.

HPS.Exchange.ExportIGESOptionsKit SetAnalyticsAsNURBS (bool in_state)

Sets whether to convert analytic surfaces (planes, cones, cylinder, etc.) to NURBS surfaces for export. This corresponds to the value that will be passed to A3DRWParamsExportIgesData::m_bSaveAnalyticsToNurbs.

See: Default value

Param in_state: Whether to convert analytic surfaces to NURBS surfaces for export.
Return: A reference to this ExportIGESOptionsKit.

HPS.Exchange.ExportIGESOptionsKit SetApplication (string in_name)

Sets the application name to put in the IGES data. This corresponds to the value that will be passed to A3DRWParamsExportIgesData::m_pcApplication.

Param in_name: UTF8-encoded application name to put in the IGES data.
Return: A reference to this ExportIGESOptionsKit.

HPS.Exchange.ExportIGESOptionsKit SetFacetedAsWireframe (bool in_state)

Sets whether to convert polyhedrics to wireframe data for export. This corresponds to the value that will be passed to A3DRWParamsExportIgesData::m_bSaveFacetedToWireframe.

See: Default value

Param in_state: Whether to convert polyhedrics to wireframe data for export.
Return: A reference to this ExportIGESOptionsKit.

HPS.Exchange.ExportIGESOptionsKit SetHiddenObjects (bool in_state)

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

See: Default value

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

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

HPS.Exchange.ExportIGESOptionsKit SetTessellation (bool in_state)

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

See: Default value

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

HPS.Exchange.ExportIGESOptionsKit SetVersion (string in_version)

Sets the version string to put in the IGES data. This corresponds to the value that will be passed to A3DRWParamsExportIgesData::m_pcVersion.

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

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

Copies this ExportIGESOptionsKit into the given ExportIGESOptionsKit.

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

bool ShowAnalyticsAsNURBS (out bool out_state)

Shows the analytics to NURBS conversion setting.

Param out_state: Whether to convert analytic surfaces to NURBS surfaces for export.
Return: true if an analytics to NURBS conversion 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 IGES data.
Return: true if an application name setting was specified, false otherwise.

bool ShowFacetedAsWireframe (out bool out_state)

Shows the faceted to wireframe conversion setting.

Param out_state: Whether to convert polyhedrics to wireframe data for export.
Return: true if a faceted to wireframe conversion 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 IGES data.
Return: true if a version string setting was specified, false otherwise.

HPS.Exchange.ExportIGESOptionsKit UnsetAnalyticsAsNURBS ()

Removes the analytics to NURBS conversion setting.

Return: A reference to this ExportIGESOptionsKit.

HPS.Exchange.ExportIGESOptionsKit UnsetApplication ()

Removes the application name setting.

Return: A reference to this ExportIGESOptionsKit.

HPS.Exchange.ExportIGESOptionsKit UnsetEverything ()

Removes all settings from this ExportIGESOptionsKit.

Return: A reference to this ExportIGESOptionsKit.

HPS.Exchange.ExportIGESOptionsKit UnsetFacetedAsWireframe ()

Removes the faceted to wireframe conversion setting.

Return: A reference to this ExportIGESOptionsKit.

HPS.Exchange.ExportIGESOptionsKit UnsetHiddenObjects ()

Removes the hidden objects export setting.

Return: A reference to this ExportIGESOptionsKit.

HPS.Exchange.ExportIGESOptionsKit UnsetSolidsAsFaces ()

Removes the solids to faces conversion setting.

Return: A reference to this ExportIGESOptionsKit.

HPS.Exchange.ExportIGESOptionsKit UnsetTessellation ()

Removes the tessellation export setting.

Return: A reference to this ExportIGESOptionsKit.

HPS.Exchange.ExportIGESOptionsKit UnsetVersion ()

Removes the version string setting.

Return: A reference to this ExportIGESOptionsKit.

Public Static Functions

HPS.Exchange.ExportIGESOptionsKit GetDefault ()

Creates an ExportIGESOptionsKit 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.ExportIGES.

Return: An ExportIGESOptionsKit with the default settings.

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

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