#include <sprk_exchange.h>

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

Public Member Functions

bool Empty () const
 
bool Equals (ExportIGESOptionsKit const &in_kit) const
 
 ExportIGESOptionsKit ()
 
 ExportIGESOptionsKit (ExportIGESOptionsKit const &in_kit)
 
 ExportIGESOptionsKit (ExportIGESOptionsKit &&in_that)
 
HPS::Type ObjectType () const
 
bool operator!= (ExportIGESOptionsKit const &in_kit) const
 
ExportIGESOptionsKitoperator= (ExportIGESOptionsKit const &in_kit)
 
ExportIGESOptionsKitoperator= (ExportIGESOptionsKit &&in_that)
 
bool operator== (ExportIGESOptionsKit const &in_kit) const
 
void Set (ExportIGESOptionsKit const &in_kit)
 
ExportIGESOptionsKitSetAnalyticsAsNURBS (bool in_state)
 
ExportIGESOptionsKitSetApplication (char const *in_name)
 
ExportIGESOptionsKitSetFacetedAsWireframe (bool in_state)
 
ExportIGESOptionsKitSetHiddenObjects (bool in_state)
 
ExportIGESOptionsKitSetSolidsAsFaces (bool in_state)
 
ExportIGESOptionsKitSetTessellation (bool in_state)
 
ExportIGESOptionsKitSetVersion (char const *in_version)
 
void Show (ExportIGESOptionsKit &out_kit) const
 
bool ShowAnalyticsAsNURBS (bool &out_state) const
 
bool ShowApplication (UTF8 &out_name) const
 
bool ShowFacetedAsWireframe (bool &out_state) const
 
bool ShowHiddenObjects (bool &out_state) const
 
bool ShowSolidsAsFaces (bool &out_state) const
 
bool ShowTessellation (bool &out_state) const
 
bool ShowVersion (UTF8 &out_version) const
 
ExportIGESOptionsKitUnsetAnalyticsAsNURBS ()
 
ExportIGESOptionsKitUnsetApplication ()
 
ExportIGESOptionsKitUnsetEverything ()
 
ExportIGESOptionsKitUnsetFacetedAsWireframe ()
 
ExportIGESOptionsKitUnsetHiddenObjects ()
 
ExportIGESOptionsKitUnsetSolidsAsFaces ()
 
ExportIGESOptionsKitUnsetTessellation ()
 
ExportIGESOptionsKitUnsetVersion ()
 
- 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 ExportIGESOptionsKit 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::ExchangeExportIGESOptionsKit
 
- 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::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.

Constructor & Destructor Documentation

◆ ExportIGESOptionsKit() [1/3]

HPS::Exchange::ExportIGESOptionsKit::ExportIGESOptionsKit ( )

The default constructor creates an empty ExportIGESOptionsKit object.

◆ ExportIGESOptionsKit() [2/3]

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

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

Parameters
in_kitThe source ExportIGESOptionsKit to copy.

◆ ExportIGESOptionsKit() [3/3]

HPS::Exchange::ExportIGESOptionsKit::ExportIGESOptionsKit ( ExportIGESOptionsKit &&  in_that)

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

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

Member Function Documentation

◆ Empty()

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

Indicates whether this ExportIGESOptionsKit has any values set on it.

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

Reimplemented from HPS::Object.

◆ Equals()

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

Check if the source ExportIGESOptionsKit is equivalent to this ExportIGESOptionsKit.

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

◆ GetDefault()

static ExportIGESOptionsKit HPS::Exchange::ExportIGESOptionsKit::GetDefault ( )
static

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.

◆ ObjectType()

HPS::Type HPS::Exchange::ExportIGESOptionsKit::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::ExportIGESOptionsKit::operator!= ( ExportIGESOptionsKit const &  in_kit) const

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

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

◆ operator=() [1/2]

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

Copies the source ExportIGESOptionsKit into this ExportIGESOptionsKit.

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

◆ operator=() [2/2]

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

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

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

◆ operator==()

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

Check if the source ExportIGESOptionsKit is equivalent to this ExportIGESOptionsKit.

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

◆ Set()

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

Copies the source ExportIGESOptionsKit into this ExportIGESOptionsKit.

Parameters
in_kitThe source ExportIGESOptionsKit to copy.

◆ SetAnalyticsAsNURBS()

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

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

◆ SetApplication()

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

◆ SetFacetedAsWireframe()

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

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

◆ SetHiddenObjects()

ExportIGESOptionsKit& HPS::Exchange::ExportIGESOptionsKit::SetHiddenObjects ( bool  in_state)

Sets whether to export hidden objects. This corresponds to the value that will be passed to A3DRWParamsExportIgesData::m_bWriteHiddenObjects.

Parameters
in_stateWhether to export hidden objects.
Returns
A reference to this ExportIGESOptionsKit.
See also
Default value

◆ SetSolidsAsFaces()

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

Parameters
in_stateWhether to convert solids to a set of independent faces for export.
Returns
A reference to this ExportIGESOptionsKit.
See also
Default value

◆ SetTessellation()

ExportIGESOptionsKit& HPS::Exchange::ExportIGESOptionsKit::SetTessellation ( bool  in_state)

Sets whether to export tessellation data. This corresponds to the value that will be passed to A3DRWParamsExportIgesData::m_bWriteTessellation.

Parameters
in_stateWhether to export tessellation data.
Returns
A reference to this ExportIGESOptionsKit.
See also
Default value

◆ SetVersion()

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

◆ Show()

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

Copies this ExportIGESOptionsKit into the given ExportIGESOptionsKit.

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

◆ ShowAnalyticsAsNURBS()

bool HPS::Exchange::ExportIGESOptionsKit::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::ExportIGESOptionsKit::ShowApplication ( UTF8 out_name) const

Shows the application name setting.

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

◆ ShowFacetedAsWireframe()

bool HPS::Exchange::ExportIGESOptionsKit::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.

◆ ShowHiddenObjects()

bool HPS::Exchange::ExportIGESOptionsKit::ShowHiddenObjects ( bool &  out_state) const

Shows the hidden object export setting.

Parameters
out_stateWhether to export hidden objects.
Returns
true if a hidden object export setting was specified, false otherwise.

◆ ShowSolidsAsFaces()

bool HPS::Exchange::ExportIGESOptionsKit::ShowSolidsAsFaces ( bool &  out_state) const

Shows the solids to faces conversion setting.

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

◆ ShowTessellation()

bool HPS::Exchange::ExportIGESOptionsKit::ShowTessellation ( bool &  out_state) const

Shows the tessellation export setting.

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

◆ ShowVersion()

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

Shows the version string setting.

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

◆ UnsetAnalyticsAsNURBS()

ExportIGESOptionsKit& HPS::Exchange::ExportIGESOptionsKit::UnsetAnalyticsAsNURBS ( )

Removes the analytics to NURBS conversion setting.

Returns
A reference to this ExportIGESOptionsKit.

◆ UnsetApplication()

ExportIGESOptionsKit& HPS::Exchange::ExportIGESOptionsKit::UnsetApplication ( )

Removes the application name setting.

Returns
A reference to this ExportIGESOptionsKit.

◆ UnsetEverything()

ExportIGESOptionsKit& HPS::Exchange::ExportIGESOptionsKit::UnsetEverything ( )

Removes all settings from this ExportIGESOptionsKit.

Returns
A reference to this ExportIGESOptionsKit.

◆ UnsetFacetedAsWireframe()

ExportIGESOptionsKit& HPS::Exchange::ExportIGESOptionsKit::UnsetFacetedAsWireframe ( )

Removes the faceted to wireframe conversion setting.

Returns
A reference to this ExportIGESOptionsKit.

◆ UnsetHiddenObjects()

ExportIGESOptionsKit& HPS::Exchange::ExportIGESOptionsKit::UnsetHiddenObjects ( )

Removes the hidden objects export setting.

Returns
A reference to this ExportIGESOptionsKit.

◆ UnsetSolidsAsFaces()

ExportIGESOptionsKit& HPS::Exchange::ExportIGESOptionsKit::UnsetSolidsAsFaces ( )

Removes the solids to faces conversion setting.

Returns
A reference to this ExportIGESOptionsKit.

◆ UnsetTessellation()

ExportIGESOptionsKit& HPS::Exchange::ExportIGESOptionsKit::UnsetTessellation ( )

Removes the tessellation export setting.

Returns
A reference to this ExportIGESOptionsKit.

◆ UnsetVersion()

ExportIGESOptionsKit& HPS::Exchange::ExportIGESOptionsKit::UnsetVersion ( )

Removes the version string setting.

Returns
A reference to this ExportIGESOptionsKit.

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