#include <sprk_exchange.h>

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

Public Member Functions

bool Empty () const
 
bool Equals (Export3MFOptionsKit const &in_kit) const
 
 Export3MFOptionsKit ()
 
 Export3MFOptionsKit (Export3MFOptionsKit const &in_kit)
 
 Export3MFOptionsKit (Export3MFOptionsKit &&in_that)
 
HPS::Type ObjectType () const
 
bool operator!= (Export3MFOptionsKit const &in_kit) const
 
Export3MFOptionsKitoperator= (Export3MFOptionsKit const &in_kit)
 
Export3MFOptionsKitoperator= (Export3MFOptionsKit &&in_that)
 
bool operator== (Export3MFOptionsKit const &in_kit) const
 
void Set (Export3MFOptionsKit const &in_kit)
 
Export3MFOptionsKitSetAdditionalKeyPaths (KeyPathArray const &in_additional_key_paths)
 
Export3MFOptionsKitSetAdditionalKeyPaths (size_t in_count, KeyPath const in_additional_key_paths[])
 
Export3MFOptionsKitSetCopyright (char const *in_state)
 
Export3MFOptionsKitSetCurrentTessellationRetention (bool in_state, TessellationOptionsKit const &in_tessellation_kit=TessellationOptionsKit())
 
Export3MFOptionsKitSetDescription (char const *in_description)
 
Export3MFOptionsKitSetLicenseTerms (char const *in_license)
 
void Show (Export3MFOptionsKit &out_kit) const
 
bool ShowAdditionalKeyPaths (KeyPathArray &out_additional_key_paths) const
 
bool ShowCopyright (HPS::UTF8 &out_state) const
 
bool ShowCurrentTessellationRetention (bool &out_state, Exchange::TessellationOptionsKit &out_tessellation_kit) const
 
bool ShowDescription (HPS::UTF8 &out_state) const
 
bool ShowLicenseTerms (HPS::UTF8 &out_license) const
 
Export3MFOptionsKitUnsetAdditionalKeyPaths ()
 
Export3MFOptionsKitUnsetCopyright ()
 
Export3MFOptionsKitUnsetCurrentTessellationRetention ()
 
Export3MFOptionsKitUnsetDescription ()
 
Export3MFOptionsKitUnsetEverything ()
 
Export3MFOptionsKitUnsetLicenseTerms ()
 
- 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 Export3MFOptionsKit 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::ExchangeExport3MFOptionsKit
 
- 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::Export3MFOptionsKit class is a user space object. It contains settings controlling how 3MF data is exported via the Exchange interface.

Constructor & Destructor Documentation

◆ Export3MFOptionsKit() [1/3]

HPS::Exchange::Export3MFOptionsKit::Export3MFOptionsKit ( )

The default constructor creates an empty Export3MFOptionsKit object.

◆ Export3MFOptionsKit() [2/3]

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

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

Parameters
in_kitThe source Export3MFOptionsKit to copy.

◆ Export3MFOptionsKit() [3/3]

HPS::Exchange::Export3MFOptionsKit::Export3MFOptionsKit ( Export3MFOptionsKit &&  in_that)

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

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

Member Function Documentation

◆ Empty()

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

Indicates whether this Export3MFOptionsKit has any values set on it.

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

Reimplemented from HPS::Object.

◆ Equals()

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

Check if the source Export3MFOptionsKit is equivalent to this Export3MFOptionsKit.

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

◆ GetDefault()

static Export3MFOptionsKit HPS::Exchange::Export3MFOptionsKit::GetDefault ( )
static

Creates an Export3MFOptionsKit 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 defaults. These values will be used for export unless an option in overridden by the options passed to File::Export3MF.

Returns
An Export3MFOptionsKit with the default settings.

◆ ObjectType()

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

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

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

◆ operator=() [1/2]

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

Copies the source Export3MFOptionsKit into this Export3MFOptionsKit.

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

◆ operator=() [2/2]

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

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

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

◆ operator==()

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

Check if the source Export3MFOptionsKit is equivalent to this Export3MFOptionsKit.

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

◆ Set()

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

Copies the source Export3MFOptionsKit into this Export3MFOptionsKit.

Parameters
in_kitThe source Export3MFOptionsKit to copy.

◆ SetAdditionalKeyPaths() [1/2]

Export3MFOptionsKit& HPS::Exchange::Export3MFOptionsKit::SetAdditionalKeyPaths ( KeyPathArray const &  in_additional_key_paths)

Sets an array of key paths which will be exported in addition to the model. Use this setting to export Visualize geometry to 3MF.

Parameters
in_additional_key_pathsThe key paths to be exported.
Returns
A reference to this Export3MFOptionsKit.

◆ SetAdditionalKeyPaths() [2/2]

Export3MFOptionsKit& HPS::Exchange::Export3MFOptionsKit::SetAdditionalKeyPaths ( size_t  in_count,
KeyPath const  in_additional_key_paths[] 
)

Sets an array of key paths which will be exported in addition to the model. Use this setting to export Visualize geometry to 3MF.

Parameters
in-countThe number of key paths contained in in_additional_key_paths.
in_additional_key_pathsThe key paths to be exported.
Returns
A reference to this Export3MFOptionsKit.

◆ SetCopyright()

Export3MFOptionsKit& HPS::Exchange::Export3MFOptionsKit::SetCopyright ( char const *  in_state)

Sets the copyright metadata.

Parameters
in_copyrightThe copyright metadata.
Returns
A reference to this Export3MFOptionsKit.

◆ SetCurrentTessellationRetention()

Export3MFOptionsKit& HPS::Exchange::Export3MFOptionsKit::SetCurrentTessellationRetention ( bool  in_state,
TessellationOptionsKit const &  in_tessellation_kit = TessellationOptionsKit() 
)

Sets whether to retain the current tessellation during export.

Parameters
in_stateWhether to retain the current tessellation during export.
in_tessellation_kitThe tessellation to use during export. Only used if in_state is false, or if no tessellation is present.
Returns
A reference to this Export3MFOptionsKit.

◆ SetDescription()

Export3MFOptionsKit& HPS::Exchange::Export3MFOptionsKit::SetDescription ( char const *  in_description)

Sets a description. This will be reported in the output file as metadata.

Parameters
in_descriptionThe description.
Returns
A reference to this Export3MFOptionsKit .

◆ SetLicenseTerms()

Export3MFOptionsKit& HPS::Exchange::Export3MFOptionsKit::SetLicenseTerms ( char const *  in_license)

Sets license terms metadata.

Parameters
in_licenseThe license terms metadata.
Returns
A reference to this Export3MFOptionsKit.

◆ Show()

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

Copies this Export3MFOptionsKit into the given Export3MFOptionsKit.

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

◆ ShowAdditionalKeyPaths()

bool HPS::Exchange::Export3MFOptionsKit::ShowAdditionalKeyPaths ( KeyPathArray out_additional_key_paths) const

Shows the additional key paths setting.

Parameters
out_additional_key_pathsThe key paths which will be added to the model
Returns
true if an additional key paths setting was specified, false otherwise.

◆ ShowCopyright()

bool HPS::Exchange::Export3MFOptionsKit::ShowCopyright ( HPS::UTF8 out_state) const

Shows the copyright setting.

Parameters
out_copyrightThe copyright metadata.
Returns
true if a copyright setting was specified, false otherwise.

◆ ShowCurrentTessellationRetention()

bool HPS::Exchange::Export3MFOptionsKit::ShowCurrentTessellationRetention ( bool &  out_state,
Exchange::TessellationOptionsKit out_tessellation_kit 
) const

Shows the KeepCurrentTessellation setting.

Parameters
out_stateWhether to retain the current tessellation during export.
out_tessellation_kitThe tessellation options to use during export. Only valid if out_state is false.
Returns
true if a tessellation retention setting was specified, false otherwise.

◆ ShowDescription()

bool HPS::Exchange::Export3MFOptionsKit::ShowDescription ( HPS::UTF8 out_state) const

Shows the description setting.

Parameters
out_descriptionThe description.
Returns
true if a description setting was specified, false otherwise.

◆ ShowLicenseTerms()

bool HPS::Exchange::Export3MFOptionsKit::ShowLicenseTerms ( HPS::UTF8 out_license) const

Shows the license setting.

Parameters
out_licenseThe license metadata
Returns
true if a license setting was specified, false otherwise.

◆ UnsetAdditionalKeyPaths()

Export3MFOptionsKit& HPS::Exchange::Export3MFOptionsKit::UnsetAdditionalKeyPaths ( )

Removes the additional key paths setting.

Returns
A reference to this Export3MFOptionsKit.

◆ UnsetCopyright()

Export3MFOptionsKit& HPS::Exchange::Export3MFOptionsKit::UnsetCopyright ( )

Removes the Copyright setting.

Returns
A reference to this Export3MFOptionsKit.

◆ UnsetCurrentTessellationRetention()

Export3MFOptionsKit& HPS::Exchange::Export3MFOptionsKit::UnsetCurrentTessellationRetention ( )

Removes the KeepCurrentTessellation setting.

Returns
A reference to this Export3MFOptionsKit.

◆ UnsetDescription()

Export3MFOptionsKit& HPS::Exchange::Export3MFOptionsKit::UnsetDescription ( )

Removes the description setting.

Returns
A reference to this Export3MFOptionsKit.

◆ UnsetEverything()

Export3MFOptionsKit& HPS::Exchange::Export3MFOptionsKit::UnsetEverything ( )

Removes all settings from this Export3MFOptionsKit.

Returns
A reference to this Export3MFOptionsKit.

◆ UnsetLicenseTerms()

Export3MFOptionsKit& HPS::Exchange::Export3MFOptionsKit::UnsetLicenseTerms ( )

Removes the license setting.

Returns
A reference to this Export3MFOptionsKit.

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