#include <sprk_exchange.h>

Inheritance diagram for HPS::Exchange::ExportSTEPOptionsKit:
HPS::SprocketKit HPS::Sprocket HPS::Object

Public Member Functions

bool Empty () const
 
bool Equals (ExportSTEPOptionsKit const &in_kit) const
 
 ExportSTEPOptionsKit ()
 
 ExportSTEPOptionsKit (ExportSTEPOptionsKit const &in_kit)
 
 ExportSTEPOptionsKit (ExportSTEPOptionsKit &&in_that)
 
HPS::Type ObjectType () const
 
bool operator!= (ExportSTEPOptionsKit const &in_kit) const
 
ExportSTEPOptionsKitoperator= (ExportSTEPOptionsKit const &in_kit)
 
ExportSTEPOptionsKitoperator= (ExportSTEPOptionsKit &&in_that)
 
bool operator== (ExportSTEPOptionsKit const &in_kit) const
 
void Set (ExportSTEPOptionsKit const &in_kit)
 
ExportSTEPOptionsKitSetAnalyticsAsNURBS (bool in_state)
 
ExportSTEPOptionsKitSetApplication (char const *in_name)
 
ExportSTEPOptionsKitSetAttributes (bool in_state)
 
ExportSTEPOptionsKitSetCurves (bool in_state)
 
ExportSTEPOptionsKitSetFacetedAsWireframe (bool in_state)
 
ExportSTEPOptionsKitSetFormat (STEP::Format in_format)
 
ExportSTEPOptionsKitSetNameShortening (bool in_state)
 
ExportSTEPOptionsKitSetPMI (bool in_state)
 
ExportSTEPOptionsKitSetPMIAsTessellated (bool in_state)
 
ExportSTEPOptionsKitSetPMIWithSemantic (bool in_state)
 
ExportSTEPOptionsKitSetVersion (char const *in_version)
 
void Show (ExportSTEPOptionsKit &out_kit) const
 
bool ShowAnalyticsAsNURBS (bool &out_state) const
 
bool ShowApplication (UTF8 &out_name) const
 
bool ShowAttributes (bool &out_state) const
 
bool ShowCurves (bool &out_state) const
 
bool ShowFacetedAsWireframe (bool &out_state) const
 
bool ShowFormat (STEP::Format &out_format) const
 
bool ShowNameShortening (bool &out_state) const
 
bool ShowPMI (bool &out_state) const
 
bool ShowPMIAsTessellated (bool &out_state) const
 
bool ShowPMIWithSemantic (bool &out_state) const
 
bool ShowVersion (UTF8 &out_version) const
 
ExportSTEPOptionsKitUnsetAnalyticsAsNURBS ()
 
ExportSTEPOptionsKitUnsetApplication ()
 
ExportSTEPOptionsKitUnsetAttributes ()
 
ExportSTEPOptionsKitUnsetCurves ()
 
ExportSTEPOptionsKitUnsetEverything ()
 
ExportSTEPOptionsKitUnsetFacetedAsWireframe ()
 
ExportSTEPOptionsKitUnsetFormat ()
 
ExportSTEPOptionsKitUnsetNameShortening ()
 
ExportSTEPOptionsKitUnsetPMI ()
 
ExportSTEPOptionsKitUnsetPMIAsTessellated ()
 
ExportSTEPOptionsKitUnsetPMIWithSemantic ()
 
ExportSTEPOptionsKitUnsetVersion ()
 
- Public Member Functions inherited from HPS::Sprocket
 Sprocket (Sprocket &&in_that)
 
- Public Member Functions inherited from HPS::Object
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
 Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 
virtual HPS::Type Type () const
 

Static Public Member Functions

static ExportSTEPOptionsKit GetDefault ()
 
- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::ExchangeExportSTEPOptionsKit
 
- Static Public Attributes inherited from HPS::SprocketKit
static const HPS::Type staticType = HPS::Type::SprocketKit
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Protected Member Functions inherited from HPS::SprocketKit
SprocketKitoperator= (SprocketKit &&in_that)
 
 SprocketKit (SprocketKit &&in_that)
 

Detailed Description

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.

Constructor & Destructor Documentation

◆ ExportSTEPOptionsKit() [1/3]

HPS::Exchange::ExportSTEPOptionsKit::ExportSTEPOptionsKit ( )

The default constructor creates an empty ExportSTEPOptionsKit object.

◆ ExportSTEPOptionsKit() [2/3]

HPS::Exchange::ExportSTEPOptionsKit::ExportSTEPOptionsKit ( ExportSTEPOptionsKit const &  in_kit)

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

Parameters
in_kitThe source ExportSTEPOptionsKit to copy.

◆ ExportSTEPOptionsKit() [3/3]

HPS::Exchange::ExportSTEPOptionsKit::ExportSTEPOptionsKit ( ExportSTEPOptionsKit &&  in_that)

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

Parameters
in_thatAn rvalue reference to an ExportSTEPOptionsKit to take the underlying object from.

Member Function Documentation

◆ Empty()

bool HPS::Exchange::ExportSTEPOptionsKit::Empty ( ) const
virtual

Indicates whether this ExportSTEPOptionsKit has any values set on it.

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

Reimplemented from HPS::Object.

◆ Equals()

bool HPS::Exchange::ExportSTEPOptionsKit::Equals ( ExportSTEPOptionsKit const &  in_kit) const

Check if the source ExportSTEPOptionsKit is equivalent to this ExportSTEPOptionsKit.

Parameters
in_kitThe source ExportSTEPOptionsKit to compare to this ExportSTEPOptionsKit.
Returns
true if the objects are equivalent, false otherwise.

◆ GetDefault()

static ExportSTEPOptionsKit HPS::Exchange::ExportSTEPOptionsKit::GetDefault ( )
static

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.

◆ ObjectType()

HPS::Type HPS::Exchange::ExportSTEPOptionsKit::ObjectType ( ) const
inlinevirtual

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.

Reimplemented from HPS::SprocketKit.

◆ operator!=()

bool HPS::Exchange::ExportSTEPOptionsKit::operator!= ( ExportSTEPOptionsKit const &  in_kit) const

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

Parameters
in_kitThe source ExportSTEPOptionsKit to compare to this ExportSTEPOptionsKit.
Returns
true if the objects are not equivalent, false otherwise.

◆ operator=() [1/2]

ExportSTEPOptionsKit& HPS::Exchange::ExportSTEPOptionsKit::operator= ( ExportSTEPOptionsKit const &  in_kit)

Copies the source ExportSTEPOptionsKit into this ExportSTEPOptionsKit.

Parameters
in_kitThe source ExportSTEPOptionsKit to copy.
Returns
A reference to this ExportSTEPOptionsKit.

◆ operator=() [2/2]

ExportSTEPOptionsKit& HPS::Exchange::ExportSTEPOptionsKit::operator= ( ExportSTEPOptionsKit &&  in_that)

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

Parameters
in_thatAn rvalue reference to an ExportSTEPOptionsKit to take the underlying object from.
Returns
A reference to this ExportSTEPOptionsKit.

◆ operator==()

bool HPS::Exchange::ExportSTEPOptionsKit::operator== ( ExportSTEPOptionsKit const &  in_kit) const

Check if the source ExportSTEPOptionsKit is equivalent to this ExportSTEPOptionsKit.

Parameters
in_kitThe source ExportSTEPOptionsKit to compare to this ExportSTEPOptionsKit.
Returns
true if the objects are equivalent, false otherwise.

◆ Set()

void HPS::Exchange::ExportSTEPOptionsKit::Set ( ExportSTEPOptionsKit const &  in_kit)

Copies the source ExportSTEPOptionsKit into this ExportSTEPOptionsKit.

Parameters
in_kitThe source ExportSTEPOptionsKit to copy.

◆ SetAnalyticsAsNURBS()

ExportSTEPOptionsKit& 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.

Parameters
in_stateWhether to convert analytic surfaces to NURBS surfaces for export.
Returns
A reference to this ExportSTEPOptionsKit.
See also
Default value

◆ SetApplication()

ExportSTEPOptionsKit& HPS::Exchange::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_nameUTF8-encoded application name to put in the STEP data.
Returns
A reference to this ExportSTEPOptionsKit.

◆ SetAttributes()

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.

Parameters
in_stateWhether to export attributes.
Returns
A reference to this ExportSTEPOptionsKit.

◆ SetCurves()

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.

Parameters
in_stateWhether to export curves.
Returns
A reference to this ExportSTEPOptionsKit.

◆ SetFacetedAsWireframe()

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.

Parameters
in_stateWhether to convert polyhedrics to wireframe data for export.
Returns
A reference to this ExportSTEPOptionsKit.
See also
Default value

◆ SetFormat()

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

Parameters
in_formatThe format of the STEP data to export.
Returns
A reference to this ExportSTEPOptionsKit.
See also
Default value

◆ SetNameShortening()

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.

Parameters
in_stateWhether to shorten names in the STEP data for export.
Returns
A reference to this ExportSTEPOptionsKit.
See also
Default value

◆ SetPMI()

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.

Parameters
in_stateWhether to export PMI.
Returns
A reference to this ExportSTEPOptionsKit.

◆ SetPMIAsTessellated()

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.

Parameters
in_stateWhether to export PMI as tessellated.
Returns
A reference to this ExportSTEPOptionsKit.

◆ SetPMIWithSemantic()

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.

Parameters
in_stateWhether to export PMI semantic information.
Returns
A reference to this ExportSTEPOptionsKit.

◆ SetVersion()

ExportSTEPOptionsKit& HPS::Exchange::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_versionUTF8-encoded version string to put in the STEP data.
Returns
A reference to this ExportSTEPOptionsKit.

◆ Show()

void HPS::Exchange::ExportSTEPOptionsKit::Show ( ExportSTEPOptionsKit out_kit) const

Copies this ExportSTEPOptionsKit into the given ExportSTEPOptionsKit.

Parameters
out_kitThe ExportSTEPOptionsKit to populate with the contents of this ExportSTEPOptionsKit.

◆ ShowAnalyticsAsNURBS()

bool HPS::Exchange::ExportSTEPOptionsKit::ShowAnalyticsAsNURBS ( bool &  out_state) const

Shows the analytics to NURBS conversion setting.

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

◆ ShowApplication()

bool HPS::Exchange::ExportSTEPOptionsKit::ShowApplication ( UTF8 out_name) const

Shows the application name setting.

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

◆ ShowAttributes()

bool HPS::Exchange::ExportSTEPOptionsKit::ShowAttributes ( bool &  out_state) const

Shows the attributes setting.

Parameters
out_stateWhether to export attributes.
Returns
true if an attributes setting was specified, false otherwise.

◆ ShowCurves()

bool HPS::Exchange::ExportSTEPOptionsKit::ShowCurves ( bool &  out_state) const

Shows the curves setting.

Parameters
out_stateWhether to export curves.
Returns
true if a curves setting was specified, false otherwise.

◆ ShowFacetedAsWireframe()

bool HPS::Exchange::ExportSTEPOptionsKit::ShowFacetedAsWireframe ( bool &  out_state) const

Shows the faceted to wireframe conversion setting.

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

◆ ShowFormat()

bool HPS::Exchange::ExportSTEPOptionsKit::ShowFormat ( STEP::Format out_format) const

Shows the format setting.

Parameters
out_formatThe format of the STEP data to export.
Returns
true if a format setting was specified, false otherwise.

◆ ShowNameShortening()

bool HPS::Exchange::ExportSTEPOptionsKit::ShowNameShortening ( bool &  out_state) const

Shows the name shortening setting.

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

◆ ShowPMI()

bool HPS::Exchange::ExportSTEPOptionsKit::ShowPMI ( bool &  out_state) const

Shows the pmi setting.

Parameters
out_stateWhether to export PMI.
Returns
true if a PMI setting was specified, false otherwise.

◆ ShowPMIAsTessellated()

bool HPS::Exchange::ExportSTEPOptionsKit::ShowPMIAsTessellated ( bool &  out_state) const

Shows the pmi as tessellated setting.

Parameters
out_stateWhether to export PMI as tessellated information.
Returns
true if a PMI as tessellated setting was specified, false otherwise.

◆ ShowPMIWithSemantic()

bool HPS::Exchange::ExportSTEPOptionsKit::ShowPMIWithSemantic ( bool &  out_state) const

Shows the pmi with semantic setting.

Parameters
out_stateWhether to export PMI with semantic information.
Returns
true if a PMI with semantic setting was specified, false otherwise.

◆ ShowVersion()

bool HPS::Exchange::ExportSTEPOptionsKit::ShowVersion ( UTF8 out_version) const

Shows the version string setting.

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

◆ UnsetAnalyticsAsNURBS()

ExportSTEPOptionsKit& HPS::Exchange::ExportSTEPOptionsKit::UnsetAnalyticsAsNURBS ( )

Removes the analytics to NURBS conversion setting.

Returns
A reference to this ExportSTEPOptionsKit.

◆ UnsetApplication()

ExportSTEPOptionsKit& HPS::Exchange::ExportSTEPOptionsKit::UnsetApplication ( )

Removes the application name setting.

Returns
A reference to this ExportSTEPOptionsKit.

◆ UnsetAttributes()

ExportSTEPOptionsKit& HPS::Exchange::ExportSTEPOptionsKit::UnsetAttributes ( )

Removes the attributes setting.

Returns
A reference to this ExportSTEPOptionsKit.

◆ UnsetCurves()

ExportSTEPOptionsKit& HPS::Exchange::ExportSTEPOptionsKit::UnsetCurves ( )

Removes the curves setting.

Returns
A reference to this ExportSTEPOptionsKit.

◆ UnsetEverything()

ExportSTEPOptionsKit& HPS::Exchange::ExportSTEPOptionsKit::UnsetEverything ( )

Removes all settings from this ExportSTEPOptionsKit.

Returns
A reference to this ExportSTEPOptionsKit.

◆ UnsetFacetedAsWireframe()

ExportSTEPOptionsKit& HPS::Exchange::ExportSTEPOptionsKit::UnsetFacetedAsWireframe ( )

Removes the faceted to wireframe conversion setting.

Returns
A reference to this ExportSTEPOptionsKit.

◆ UnsetFormat()

ExportSTEPOptionsKit& HPS::Exchange::ExportSTEPOptionsKit::UnsetFormat ( )

Removes the format setting.

Returns
A reference to this ExportSTEPOptionsKit.

◆ UnsetNameShortening()

ExportSTEPOptionsKit& HPS::Exchange::ExportSTEPOptionsKit::UnsetNameShortening ( )

Removes the name shortening setting.

Returns
A reference to this ExportSTEPOptionsKit.

◆ UnsetPMI()

ExportSTEPOptionsKit& HPS::Exchange::ExportSTEPOptionsKit::UnsetPMI ( )

Removes the PMI setting.

Returns
A reference to this ExportSTEPOptionsKit.

◆ UnsetPMIAsTessellated()

ExportSTEPOptionsKit& HPS::Exchange::ExportSTEPOptionsKit::UnsetPMIAsTessellated ( )

Removes the PMI as tessellated setting.

Returns
A reference to this ExportSTEPOptionsKit.

◆ UnsetPMIWithSemantic()

ExportSTEPOptionsKit& HPS::Exchange::ExportSTEPOptionsKit::UnsetPMIWithSemantic ( )

Removes the PMI with semantic setting.

Returns
A reference to this ExportSTEPOptionsKit.

◆ UnsetVersion()

ExportSTEPOptionsKit& HPS::Exchange::ExportSTEPOptionsKit::UnsetVersion ( )

Removes the version string setting.

Returns
A reference to this ExportSTEPOptionsKit.

The documentation for this class was generated from the following file: