HPS::Exchange::Export3MFOptionsKit
- class HPS.Exchange.Export3MFOptionsKit : public HPS.SprocketKit
The HPS.Exchange.Export3MFOptionsKit class is a user space object. It contains settings controlling how 3MF data is exported via the Exchange interface.
Public Functions
- override void Dispose ()
- override bool Empty ()
Indicates whether this Export3MFOptionsKit has any values set on it.
- Return
true if no values are set on this Export3MFOptionsKit, false otherwise.
- bool Equals (HPS.Exchange.Export3MFOptionsKit in_kit)
Check if the source Export3MFOptionsKit is equivalent to this Export3MFOptionsKit.
- Param in_kit
The source Export3MFOptionsKit to compare to this Export3MFOptionsKit.
- Return
true if the objects are equivalent, false otherwise.
- override bool Equals (Object obj)
- Export3MFOptionsKit ()
The default constructor creates an empty Export3MFOptionsKit object.
- Export3MFOptionsKit (HPS.Exchange.Export3MFOptionsKit in_kit)
The copy constructor creates a new Export3MFOptionsKit object that contains the same settings as the source Export3MFOptionsKit.
- Param in_kit
The source Export3MFOptionsKit to copy.
- override int GetHashCode ()
- override HPS.Type ObjectType ()
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).
- Return
The declared type of the object in question, which may differ from the true, underlying type.
- void Set (HPS.Exchange.Export3MFOptionsKit in_kit)
Copies the source Export3MFOptionsKit into this Export3MFOptionsKit.
- Param in_kit
The source Export3MFOptionsKit to copy.
- HPS.Exchange.Export3MFOptionsKit SetAdditionalKeyPaths (HPS.KeyPath[] 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.
- Param in_additional_key_paths
The key paths to be exported.
- Return
A reference to this Export3MFOptionsKit.
- HPS.Exchange.Export3MFOptionsKit SetCopyright (string in_copyright)
Sets the copyright metadata.
- Param in_copyright
The copyright metadata.
- Return
A reference to this Export3MFOptionsKit.
- HPS.Exchange.Export3MFOptionsKit SetCurrentTessellationRetention (bool in_state)
Sets whether to retain the current tessellation during export.
- Param in_state
Whether to retain the current tessellation during export.
- Return
A reference to this Export3MFOptionsKit.
- HPS.Exchange.Export3MFOptionsKit SetCurrentTessellationRetention (bool in_state, HPS.Exchange.TessellationOptionsKit in_tessellation_kit)
Sets whether to retain the current tessellation during export.
- Param in_state
Whether to retain the current tessellation during export.
- Param in_tessellation_kit
The tessellation to use during export. Only used if in_state is false, or if no tessellation is present.
- Return
A reference to this Export3MFOptionsKit.
- HPS.Exchange.Export3MFOptionsKit SetDescription (string in_description)
Sets a description. This will be reported in the output file as metadata.
- Param in_description
The description.
- Return
A reference to this Export3MFOptionsKit .
- HPS.Exchange.Export3MFOptionsKit SetLicenseTerms (string in_license)
Sets license terms metadata.
- Param in_license
The license terms metadata.
- Return
A reference to this Export3MFOptionsKit.
- void Show (out HPS.Exchange.Export3MFOptionsKit out_kit)
Copies this Export3MFOptionsKit into the given Export3MFOptionsKit.
- Param out_kit
The Export3MFOptionsKit to populate with the contents of this Export3MFOptionsKit.
- bool ShowAdditionalKeyPaths (out HPS.KeyPath[] out_additional_key_paths)
Shows the additional key paths setting.
- Param out_additional_key_paths
The key paths which will be added to the model
- Return
true if an additional key paths setting was specified, false otherwise.
- bool ShowCopyright (out string out_copyright)
Shows the copyright setting.
- Param out_copyright
The copyright metadata.
- Return
true if a copyright setting was specified, false otherwise.
- bool ShowCurrentTessellationRetention (out bool out_state, out HPS.Exchange.TessellationOptionsKit out_tessellation_kit)
Shows the KeepCurrentTessellation setting.
- Param out_state
Whether to retain the current tessellation during export.
- Param out_tessellation_kit
The tessellation options to use during export. Only valid if out_state is false.
- Return
true if a tessellation retention setting was specified, false otherwise.
- bool ShowDescription (out string out_description)
Shows the description setting.
- Param out_description
The description.
- Return
true if a description setting was specified, false otherwise.
- bool ShowLicenseTerms (out string out_license)
Shows the license setting.
- Param out_license
The license metadata
- Return
true if a license setting was specified, false otherwise.
- HPS.Exchange.Export3MFOptionsKit UnsetAdditionalKeyPaths ()
Removes the additional key paths setting.
- Return
A reference to this Export3MFOptionsKit.
- HPS.Exchange.Export3MFOptionsKit UnsetCopyright ()
Removes the Copyright setting.
- Return
A reference to this Export3MFOptionsKit.
- HPS.Exchange.Export3MFOptionsKit UnsetCurrentTessellationRetention ()
Removes the KeepCurrentTessellation setting.
- Return
A reference to this Export3MFOptionsKit.
- HPS.Exchange.Export3MFOptionsKit UnsetDescription ()
Removes the description setting.
- Return
A reference to this Export3MFOptionsKit.
- HPS.Exchange.Export3MFOptionsKit UnsetEverything ()
Removes all settings from this Export3MFOptionsKit.
- Return
A reference to this Export3MFOptionsKit.
- HPS.Exchange.Export3MFOptionsKit UnsetLicenseTerms ()
Removes the license setting.
- Return
A reference to this Export3MFOptionsKit.
Public Static Functions
- HPS.Exchange.Export3MFOptionsKit GetDefault ()
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.
- Return
An Export3MFOptionsKit with the default settings.
- bool operator!= (HPS.Exchange.Export3MFOptionsKit a, HPS.Exchange.Export3MFOptionsKit b)
- bool operator== (HPS.Exchange.Export3MFOptionsKit a, HPS.Exchange.Export3MFOptionsKit b)
