HPS.Exchange.ExportSTEPOptionsKit

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

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

Public Functions

override bool Empty ()

Indicates whether this ExportSTEPOptionsKit has any values set on it.

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

bool Equals (HPS.Exchange.ExportSTEPOptionsKit in_kit)

Check if the source ExportSTEPOptionsKit is equivalent to this ExportSTEPOptionsKit.

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

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

ExportSTEPOptionsKit (HPS.Exchange.ExportSTEPOptionsKit in_kit)

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

Param in_kit: The source ExportSTEPOptionsKit 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.ExportSTEPOptionsKit in_kit)

Copies the source ExportSTEPOptionsKit into this ExportSTEPOptionsKit.

Param in_kit: The source ExportSTEPOptionsKit to copy.

HPS.Exchange.ExportSTEPOptionsKit 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 A3DRWParamsExportStepData::m_bSaveAnalyticsToNurbs.

See: Default value

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

HPS.Exchange.ExportSTEPOptionsKit SetApplication (string in_name)

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

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

HPS.Exchange.ExportSTEPOptionsKit SetAttributes (bool in_state)

Sets whether to export attributes. This corresponds to the value that will be passed to A3DRWParamsExportStepData::m_bWriteAttributes.

Param in_state: Whether to export attributes.
Return: A reference to this ExportSTEPOptionsKit.

HPS.Exchange.ExportSTEPOptionsKit SetCurves (bool in_state)

Sets whether to export curves. This corresponds to the value that will be passed to A3DRWParamsExportStepData::m_bWriteUVCurves.

Param in_state: Whether to export curves.
Return: A reference to this ExportSTEPOptionsKit.

HPS.Exchange.ExportSTEPOptionsKit SetFacetedAsWireframe (bool in_state)

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

See: Default value

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

HPS.Exchange.ExportSTEPOptionsKit SetFormat (HPS.Exchange.STEP.Format in_format)

Sets the format of the STEP data to export. This corresponds to the value that will be passed to A3DRWParamsExportStepData::m_eStepFormat.

See: Default value

Param in_format: The format of the STEP data to export.
Return: A reference to this ExportSTEPOptionsKit.

HPS.Exchange.ExportSTEPOptionsKit SetNameShortening (bool in_state)

Sets whether to shorten names in the STEP data for export. This corresponds to the value that will be passed to A3DRWParamsExportStepData::m_bUseShortNames.

See: Default value

Param in_state: Whether to shorten names in the STEP data for export.
Return: A reference to this ExportSTEPOptionsKit.

HPS.Exchange.ExportSTEPOptionsKit SetPMI (bool in_state)

Sets whether to export PMI. This corresponds to the value that will be passed to A3DRWParamsExportStepData::m_bWritePMI.

Param in_state: Whether to export PMI.
Return: A reference to this ExportSTEPOptionsKit.

HPS.Exchange.ExportSTEPOptionsKit SetPMIAsTessellated (bool in_state)

Sets whether to export PMI as tessellated rather than polyline. This corresponds to the value that will be passed to A3DRWParamsExportStepData::m_bWritePMIAsTessellated.

Param in_state: Whether to export PMI as tessellated.
Return: A reference to this ExportSTEPOptionsKit.

HPS.Exchange.ExportSTEPOptionsKit SetPMIWithSemantic (bool in_state)

Sets whether to export PMI with semantic information. This corresponds to the value that will be passed to A3DRWParamsExportStepData::m_bWritePMIWithSemantic.

Param in_state: Whether to export PMI semantic information.
Return: A reference to this ExportSTEPOptionsKit.

HPS.Exchange.ExportSTEPOptionsKit SetVersion (string in_version)

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

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

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

Copies this ExportSTEPOptionsKit into the given ExportSTEPOptionsKit.

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

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 STEP data.
Return: true if an application name setting was specified, false otherwise.

bool ShowAttributes (out bool out_state)

Shows the attributes setting.

Param out_state: Whether to export attributes.
Return: true if an attributes setting was specified, false otherwise.

bool ShowCurves (out bool out_state)

Shows the curves setting.

Param out_state: Whether to export curves.
Return: true if a curves 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 ShowFormat (out HPS.Exchange.STEP.Format out_format)

Shows the format setting.

Param out_format: The format of the STEP data to export.
Return: true if a format setting was specified, false otherwise.

bool ShowNameShortening (out bool out_state)

Shows the name shortening setting.

Param out_state: Whether to shorten names in the STEP data for export.
Return: true if a name shortening setting was specified, false otherwise.

bool ShowPMI (out bool out_state)

Shows the pmi setting.

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

bool ShowPMIAsTessellated (out bool out_state)

Shows the pmi as tessellated setting.

Param out_state: Whether to export PMI as tessellated information.
Return: true if a PMI as tessellated setting was specified, false otherwise.

bool ShowPMIWithSemantic (out bool out_state)

Shows the pmi with semantic setting.

Param out_state: Whether to export PMI with semantic information.
Return: true if a PMI with semantic 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 STEP data.
Return: true if a version string setting was specified, false otherwise.

HPS.Exchange.ExportSTEPOptionsKit UnsetAnalyticsAsNURBS ()

Removes the analytics to NURBS conversion setting.

Return: A reference to this ExportSTEPOptionsKit.

HPS.Exchange.ExportSTEPOptionsKit UnsetApplication ()

Removes the application name setting.

Return: A reference to this ExportSTEPOptionsKit.

HPS.Exchange.ExportSTEPOptionsKit UnsetAttributes ()

Removes the attributes setting.

Return: A reference to this ExportSTEPOptionsKit.

HPS.Exchange.ExportSTEPOptionsKit UnsetCurves ()

Removes the curves setting.

Return: A reference to this ExportSTEPOptionsKit.

HPS.Exchange.ExportSTEPOptionsKit UnsetEverything ()

Removes all settings from this ExportSTEPOptionsKit.

Return: A reference to this ExportSTEPOptionsKit.

HPS.Exchange.ExportSTEPOptionsKit UnsetFacetedAsWireframe ()

Removes the faceted to wireframe conversion setting.

Return: A reference to this ExportSTEPOptionsKit.

HPS.Exchange.ExportSTEPOptionsKit UnsetFormat ()

Removes the format setting.

Return: A reference to this ExportSTEPOptionsKit.

HPS.Exchange.ExportSTEPOptionsKit UnsetNameShortening ()

Removes the name shortening setting.

Return: A reference to this ExportSTEPOptionsKit.

HPS.Exchange.ExportSTEPOptionsKit UnsetPMI ()

Removes the PMI setting.

Return: A reference to this ExportSTEPOptionsKit.

HPS.Exchange.ExportSTEPOptionsKit UnsetPMIAsTessellated ()

Removes the PMI as tessellated setting.

Return: A reference to this ExportSTEPOptionsKit.

HPS.Exchange.ExportSTEPOptionsKit UnsetPMIWithSemantic ()

Removes the PMI with semantic setting.

Return: A reference to this ExportSTEPOptionsKit.

HPS.Exchange.ExportSTEPOptionsKit UnsetVersion ()

Removes the version string setting.

Return: A reference to this ExportSTEPOptionsKit.

Public Static Functions

HPS.Exchange.ExportSTEPOptionsKit GetDefault ()

Creates an ExportSTEPOptionsKit 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.ExportSTEP.

Return: An ExportSTEPOptionsKit with the default settings.