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

virtual bool Empty() const

Indicates whether this ExportParasolidOptionsKit has any values set on it.

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

bool Equals(ExportParasolidOptionsKit const &in_kit) const

Check if the source ExportParasolidOptionsKit is equivalent to this ExportParasolidOptionsKit.

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

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

ExportParasolidOptionsKit(ExportParasolidOptionsKit &&in_that)

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

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

ExportParasolidOptionsKit(ExportParasolidOptionsKit const &in_kit)

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

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

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

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

ExportParasolidOptionsKit &operator=(ExportParasolidOptionsKit &&in_that)

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

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

ExportParasolidOptionsKit &operator=(ExportParasolidOptionsKit const &in_kit)

Copies the source ExportParasolidOptionsKit into this ExportParasolidOptionsKit.

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

bool operator==(ExportParasolidOptionsKit const &in_kit) const

Check if the source ExportParasolidOptionsKit is equivalent to this ExportParasolidOptionsKit.

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

void Set(ExportParasolidOptionsKit const &in_kit)

Copies the source ExportParasolidOptionsKit into this ExportParasolidOptionsKit.

Parameters: in_kit – The source ExportParasolidOptionsKit to copy.

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

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

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

Parameters: in_state – Whether to explode multi-connexes B-reps into multiple bodies.
Returns: A reference to this ExportParasolidOptionsKit.

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

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

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

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

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

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

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

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

void Show(ExportParasolidOptionsKit &out_kit) const

Copies this ExportParasolidOptionsKit into the given ExportParasolidOptionsKit.

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

bool ShowApplication(UTF8 &out_name) const

Shows the application name setting.

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

bool ShowExplodeMultiBodies(bool &out_state) const

Shows the explode multi bodies setting.

Parameters: out_state – The explode multi bodies setting to put in the Parasolid data.
Returns: true if a explode multi bodies 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 Parasolid data.
Returns: true if a version string setting was specified, false otherwise.

ExportParasolidOptionsKit &UnsetApplication()

Removes the application name setting.

Returns: A reference to this ExportParasolidOptionsKit.

ExportParasolidOptionsKit &UnsetEverything()

Removes all settings from this ExportParasolidOptionsKit.

Returns: A reference to this ExportParasolidOptionsKit.

ExportParasolidOptionsKit &UnsetExplodeMultiBodies()

Removes the explode multi bodies setting.

Returns: A reference to this ExportParasolidOptionsKit.

ExportParasolidOptionsKit &UnsetHiddenObjects()

Removes the hidden objects export setting.

Returns: A reference to this ExportParasolidOptionsKit.

ExportParasolidOptionsKit &UnsetSolidsAsFaces()

Removes the solids to faces conversion setting.

Returns: A reference to this ExportParasolidOptionsKit.

ExportParasolidOptionsKit &UnsetTessellation()

Removes the tessellation export setting.

Returns: A reference to this ExportParasolidOptionsKit.

ExportParasolidOptionsKit &UnsetVersion()

Removes the version string setting.

Returns: A reference to this ExportParasolidOptionsKit.

Public Static Functions

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

Returns: An ExportParasolidOptionsKit with the default settings.