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

virtual bool Empty() const

Indicates whether this ExportIGESOptionsKit has any values set on it.

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

bool Equals(ExportIGESOptionsKit const &in_kit) const

Check if the source ExportIGESOptionsKit is equivalent to this ExportIGESOptionsKit.

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

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

ExportIGESOptionsKit(ExportIGESOptionsKit &&in_that)

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

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

ExportIGESOptionsKit(ExportIGESOptionsKit const &in_kit)

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

Parameters: in_kit – The source ExportIGESOptionsKit 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!=(ExportIGESOptionsKit const &in_kit) const

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

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

ExportIGESOptionsKit &operator=(ExportIGESOptionsKit &&in_that)

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

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

ExportIGESOptionsKit &operator=(ExportIGESOptionsKit const &in_kit)

Copies the source ExportIGESOptionsKit into this ExportIGESOptionsKit.

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

bool operator==(ExportIGESOptionsKit const &in_kit) const

Check if the source ExportIGESOptionsKit is equivalent to this ExportIGESOptionsKit.

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

void Set(ExportIGESOptionsKit const &in_kit)

Copies the source ExportIGESOptionsKit into this ExportIGESOptionsKit.

Parameters: in_kit – The source ExportIGESOptionsKit to copy.

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

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

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

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

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

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

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

Parameters: in_state – Whether to export hidden objects.
Returns: A reference to this ExportIGESOptionsKit.

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

Parameters: in_state – Whether to convert solids to a set of independent faces for export.
Returns: A reference to this ExportIGESOptionsKit.

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

Parameters: in_state – Whether to export tessellation data.
Returns: A reference to this ExportIGESOptionsKit.

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

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

void Show(ExportIGESOptionsKit &out_kit) const

Copies this ExportIGESOptionsKit into the given ExportIGESOptionsKit.

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

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 IGES data.
Returns: true if an application name 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 ShowHiddenObjects(bool &out_state) const

Shows the hidden object export setting.

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

bool ShowSolidsAsFaces(bool &out_state) const

Shows the solids to faces conversion setting.

Parameters: out_state – Whether to convert solids to a set of independent faces for export.
Returns: true if a solids to faces conversion setting was specified, false otherwise.

bool ShowTessellation(bool &out_state) const

Shows the tessellation export setting.

Parameters: out_state – Whether to export tessellation data.
Returns: true if a tessellation export 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 IGES data.
Returns: true if a version string setting was specified, false otherwise.

ExportIGESOptionsKit &UnsetAnalyticsAsNURBS()

Removes the analytics to NURBS conversion setting.

Returns: A reference to this ExportIGESOptionsKit.

ExportIGESOptionsKit &UnsetApplication()

Removes the application name setting.

Returns: A reference to this ExportIGESOptionsKit.

ExportIGESOptionsKit &UnsetEverything()

Removes all settings from this ExportIGESOptionsKit.

Returns: A reference to this ExportIGESOptionsKit.

ExportIGESOptionsKit &UnsetFacetedAsWireframe()

Removes the faceted to wireframe conversion setting.

Returns: A reference to this ExportIGESOptionsKit.

ExportIGESOptionsKit &UnsetHiddenObjects()

Removes the hidden objects export setting.

Returns: A reference to this ExportIGESOptionsKit.

ExportIGESOptionsKit &UnsetSolidsAsFaces()

Removes the solids to faces conversion setting.

Returns: A reference to this ExportIGESOptionsKit.

ExportIGESOptionsKit &UnsetTessellation()

Removes the tessellation export setting.

Returns: A reference to this ExportIGESOptionsKit.

ExportIGESOptionsKit &UnsetVersion()

Removes the version string setting.

Returns: A reference to this ExportIGESOptionsKit.

virtual ~ExportIGESOptionsKit()

Public Static Functions

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

Returns: An ExportIGESOptionsKit with the default settings.

Public Static Attributes

static const HPS::Type staticType = HPS::Type::ExchangeExportIGESOptionsKit