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

virtual bool Empty() const

Indicates whether this ExportSTEPOptionsKit has any values set on it.

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

bool Equals(ExportSTEPOptionsKit const &in_kit) const

Check if the source ExportSTEPOptionsKit is equivalent to this ExportSTEPOptionsKit.

Parameters: in_kit – The source ExportSTEPOptionsKit to compare to this ExportSTEPOptionsKit.
Returns: true if the objects are equivalent, false otherwise.

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

ExportSTEPOptionsKit(ExportSTEPOptionsKit &&in_that)

The move constructor creates an ExportSTEPOptionsKit by transferring the underlying object of the rvalue reference to this ExportSTEPOptionsKit.

Parameters: in_that – An rvalue reference to an ExportSTEPOptionsKit to take the underlying object from.

ExportSTEPOptionsKit(ExportSTEPOptionsKit const &in_kit)

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

Parameters: in_kit – The source ExportSTEPOptionsKit to copy.

inline virtual HPS::Type ObjectType() const

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.

bool operator!=(ExportSTEPOptionsKit const &in_kit) const

Check if the source ExportSTEPOptionsKit is not equivalent to this ExportSTEPOptionsKit.

Parameters: in_kit – The source ExportSTEPOptionsKit to compare to this ExportSTEPOptionsKit.
Returns: true if the objects are not equivalent, false otherwise.

ExportSTEPOptionsKit &operator=(ExportSTEPOptionsKit &&in_that)

The move assignment operator transfers the underlying object of the rvalue reference to this ExportSTEPOptionsKit.

Parameters: in_that – An rvalue reference to an ExportSTEPOptionsKit to take the underlying object from.
Returns: A reference to this ExportSTEPOptionsKit.

ExportSTEPOptionsKit &operator=(ExportSTEPOptionsKit const &in_kit)

Copies the source ExportSTEPOptionsKit into this ExportSTEPOptionsKit.

Parameters: in_kit – The source ExportSTEPOptionsKit to copy.
Returns: A reference to this ExportSTEPOptionsKit.

bool operator==(ExportSTEPOptionsKit const &in_kit) const

Check if the source ExportSTEPOptionsKit is equivalent to this ExportSTEPOptionsKit.

Parameters: in_kit – The source ExportSTEPOptionsKit to compare to this ExportSTEPOptionsKit.
Returns: true if the objects are equivalent, false otherwise.

void Set(ExportSTEPOptionsKit const &in_kit)

Copies the source ExportSTEPOptionsKit into this ExportSTEPOptionsKit.

Parameters: in_kit – The source ExportSTEPOptionsKit to copy.

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

Parameters: in_state – Whether to convert analytic surfaces to NURBS surfaces for export.
Returns: A reference to this ExportSTEPOptionsKit.

ExportSTEPOptionsKit &SetApplication(char const *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.

Parameters: in_name – UTF8-encoded application name to put in the STEP data.
Returns: A reference to this ExportSTEPOptionsKit.

ExportSTEPOptionsKit &SetAttributes(bool in_state)

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

Parameters: in_state – Whether to export attributes.
Returns: A reference to this ExportSTEPOptionsKit.

ExportSTEPOptionsKit &SetCurves(bool in_state)

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

Parameters: in_state – Whether to export curves.
Returns: A reference to this ExportSTEPOptionsKit.

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

Parameters: in_state – Whether to convert polyhedrics to wireframe data for export.
Returns: A reference to this ExportSTEPOptionsKit.

ExportSTEPOptionsKit &SetFormat(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

Parameters: in_format – The format of the STEP data to export.
Returns: A reference to this ExportSTEPOptionsKit.

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

Parameters: in_state – Whether to shorten names in the STEP data for export.
Returns: A reference to this ExportSTEPOptionsKit.

ExportSTEPOptionsKit &SetPMI(bool in_state)

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

Parameters: in_state – Whether to export PMI.
Returns: A reference to this ExportSTEPOptionsKit.

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.

Parameters: in_state – Whether to export PMI as tessellated.
Returns: A reference to this ExportSTEPOptionsKit.

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.

Parameters: in_state – Whether to export PMI semantic information.
Returns: A reference to this ExportSTEPOptionsKit.

ExportSTEPOptionsKit &SetVersion(char const *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.

Parameters: in_version – UTF8-encoded version string to put in the STEP data.
Returns: A reference to this ExportSTEPOptionsKit.

void Show(ExportSTEPOptionsKit &out_kit) const

Copies this ExportSTEPOptionsKit into the given ExportSTEPOptionsKit.

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

bool ShowAnalyticsAsNURBS(bool &out_state) const

Shows the analytics to NURBS conversion setting.

Parameters: out_state – Whether to convert analytic surfaces to NURBS surfaces for export.
Returns: true if an analytics to NURBS conversion setting was specified, false otherwise.

bool ShowApplication(UTF8 &out_name) const

Shows the application name setting.

Parameters: out_name – The application name to put in the STEP data.
Returns: true if an application name setting was specified, false otherwise.

bool ShowAttributes(bool &out_state) const

Shows the attributes setting.

Parameters: out_state – Whether to export attributes.
Returns: true if an attributes setting was specified, false otherwise.

bool ShowCurves(bool &out_state) const

Shows the curves setting.

Parameters: out_state – Whether to export curves.
Returns: true if a curves setting was specified, false otherwise.

bool ShowFacetedAsWireframe(bool &out_state) const

Shows the faceted to wireframe conversion setting.

Parameters: out_state – Whether to convert polyhedrics to wireframe data for export.
Returns: true if a faceted to wireframe conversion setting was specified, false otherwise.

bool ShowFormat(STEP::Format &out_format) const

Shows the format setting.

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

bool ShowNameShortening(bool &out_state) const

Shows the name shortening setting.

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

bool ShowPMI(bool &out_state) const

Shows the pmi setting.

Parameters: out_state – Whether to export PMI.
Returns: true if a PMI setting was specified, false otherwise.

bool ShowPMIAsTessellated(bool &out_state) const

Shows the pmi as tessellated setting.

Parameters: out_state – Whether to export PMI as tessellated information.
Returns: true if a PMI as tessellated setting was specified, false otherwise.

bool ShowPMIWithSemantic(bool &out_state) const

Shows the pmi with semantic setting.

Parameters: out_state – Whether to export PMI with semantic information.
Returns: true if a PMI with semantic setting was specified, false otherwise.

bool ShowVersion(UTF8 &out_version) const

Shows the version string setting.

Parameters: out_version – The version string to put in the STEP data.
Returns: true if a version string setting was specified, false otherwise.

ExportSTEPOptionsKit &UnsetAnalyticsAsNURBS()

Removes the analytics to NURBS conversion setting.

Returns: A reference to this ExportSTEPOptionsKit.

ExportSTEPOptionsKit &UnsetApplication()

Removes the application name setting.

Returns: A reference to this ExportSTEPOptionsKit.

ExportSTEPOptionsKit &UnsetAttributes()

Removes the attributes setting.

Returns: A reference to this ExportSTEPOptionsKit.

ExportSTEPOptionsKit &UnsetCurves()

Removes the curves setting.

Returns: A reference to this ExportSTEPOptionsKit.

ExportSTEPOptionsKit &UnsetEverything()

Removes all settings from this ExportSTEPOptionsKit.

Returns: A reference to this ExportSTEPOptionsKit.

ExportSTEPOptionsKit &UnsetFacetedAsWireframe()

Removes the faceted to wireframe conversion setting.

Returns: A reference to this ExportSTEPOptionsKit.

ExportSTEPOptionsKit &UnsetFormat()

Removes the format setting.

Returns: A reference to this ExportSTEPOptionsKit.

ExportSTEPOptionsKit &UnsetNameShortening()

Removes the name shortening setting.

Returns: A reference to this ExportSTEPOptionsKit.

ExportSTEPOptionsKit &UnsetPMI()

Removes the PMI setting.

Returns: A reference to this ExportSTEPOptionsKit.

ExportSTEPOptionsKit &UnsetPMIAsTessellated()

Removes the PMI as tessellated setting.

Returns: A reference to this ExportSTEPOptionsKit.

ExportSTEPOptionsKit &UnsetPMIWithSemantic()

Removes the PMI with semantic setting.

Returns: A reference to this ExportSTEPOptionsKit.

ExportSTEPOptionsKit &UnsetVersion()

Removes the version string setting.

Returns: A reference to this ExportSTEPOptionsKit.

Public Static Functions

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

Returns: An ExportSTEPOptionsKit with the default settings.