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

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Exchange.Export3MFOptionsKit in_kit)
 
 Export3MFOptionsKit ()
 
 Export3MFOptionsKit (HPS.Exchange.Export3MFOptionsKit in_kit)
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 
void Set (HPS.Exchange.Export3MFOptionsKit in_kit)
 
HPS.Exchange.Export3MFOptionsKit SetAdditionalKeyPaths (HPS.KeyPath[] in_additional_key_paths)
 
HPS.Exchange.Export3MFOptionsKit SetCopyright (string in_state)
 
HPS.Exchange.Export3MFOptionsKit SetCurrentTessellationRetention (bool in_state, HPS.Exchange.TessellationOptionsKit in_tessellation_kit)
 
HPS.Exchange.Export3MFOptionsKit SetCurrentTessellationRetention (bool in_state)
 
HPS.Exchange.Export3MFOptionsKit SetDescription (string in_description)
 
HPS.Exchange.Export3MFOptionsKit SetLicenseTerms (string in_license)
 
void Show (out HPS.Exchange.Export3MFOptionsKit out_kit)
 
bool ShowAdditionalKeyPaths (out HPS.KeyPath[] out_additional_key_paths)
 
bool ShowCopyright (out string out_state)
 
bool ShowCurrentTessellationRetention (out bool out_state, out HPS.Exchange.TessellationOptionsKit out_tessellation_kit)
 
bool ShowDescription (out string out_state)
 
bool ShowLicenseTerms (out string out_license)
 
HPS.Exchange.Export3MFOptionsKit UnsetAdditionalKeyPaths ()
 
HPS.Exchange.Export3MFOptionsKit UnsetCopyright ()
 
HPS.Exchange.Export3MFOptionsKit UnsetCurrentTessellationRetention ()
 
HPS.Exchange.Export3MFOptionsKit UnsetDescription ()
 
HPS.Exchange.Export3MFOptionsKit UnsetEverything ()
 
HPS.Exchange.Export3MFOptionsKit UnsetLicenseTerms ()
 
- Public Member Functions inherited from HPS.SprocketKit
SprocketKit (HPS.SprocketKit in_that)
 
- Public Member Functions inherited from HPS.Sprocket
Sprocket (HPS.Sprocket in_that)
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
Object (HPS.Object that)
 
virtual void Reset ()
 
virtual HPS.Type Type ()
 

Static Public Member Functions

static HPS.Exchange.Export3MFOptionsKit GetDefault ()
 
static bool operator!= (HPS.Exchange.Export3MFOptionsKit a, HPS.Exchange.Export3MFOptionsKit b)
 
static bool operator== (HPS.Exchange.Export3MFOptionsKit a, HPS.Exchange.Export3MFOptionsKit b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

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/2]

HPS.Exchange.Export3MFOptionsKit.Export3MFOptionsKit ( )
inline

The default constructor creates an empty Export3MFOptionsKit object.

◆ Export3MFOptionsKit() [2/2]

HPS.Exchange.Export3MFOptionsKit.Export3MFOptionsKit ( HPS.Exchange.Export3MFOptionsKit  in_kit)
inline

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

Parameters
in_kitThe source Export3MFOptionsKit to copy.

Member Function Documentation

◆ Empty()

override bool HPS.Exchange.Export3MFOptionsKit.Empty ( )
inlinevirtual

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 ( HPS.Exchange.Export3MFOptionsKit  in_kit)
inline

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 HPS.Exchange.Export3MFOptionsKit HPS.Exchange.Export3MFOptionsKit.GetDefault ( )
inlinestatic

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()

override HPS.Type HPS.Exchange.Export3MFOptionsKit.ObjectType ( )
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.

◆ Set()

void HPS.Exchange.Export3MFOptionsKit.Set ( HPS.Exchange.Export3MFOptionsKit  in_kit)
inline

Copies the source Export3MFOptionsKit into this Export3MFOptionsKit.

Parameters
in_kitThe source Export3MFOptionsKit to copy.

◆ SetAdditionalKeyPaths()

HPS.Exchange.Export3MFOptionsKit HPS.Exchange.Export3MFOptionsKit.SetAdditionalKeyPaths ( HPS.KeyPath []  in_additional_key_paths)
inline

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.

◆ SetCopyright()

HPS.Exchange.Export3MFOptionsKit HPS.Exchange.Export3MFOptionsKit.SetCopyright ( string  in_state)
inline

Sets the copyright metadata.

Returns
A reference to this Export3MFOptionsKit.

◆ SetCurrentTessellationRetention() [1/2]

HPS.Exchange.Export3MFOptionsKit HPS.Exchange.Export3MFOptionsKit.SetCurrentTessellationRetention ( bool  in_state,
HPS.Exchange.TessellationOptionsKit  in_tessellation_kit 
)
inline

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.

◆ SetCurrentTessellationRetention() [2/2]

HPS.Exchange.Export3MFOptionsKit HPS.Exchange.Export3MFOptionsKit.SetCurrentTessellationRetention ( bool  in_state)
inline

Sets whether to retain the current tessellation during export.

Parameters
in_stateWhether to retain the current tessellation during export.
Returns
A reference to this Export3MFOptionsKit.

◆ SetDescription()

HPS.Exchange.Export3MFOptionsKit HPS.Exchange.Export3MFOptionsKit.SetDescription ( string  in_description)
inline

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

Parameters
in_descriptionThe description.
Returns
A reference to this Export3MFOptionsKit .

◆ SetLicenseTerms()

HPS.Exchange.Export3MFOptionsKit HPS.Exchange.Export3MFOptionsKit.SetLicenseTerms ( string  in_license)
inline

Sets license terms metadata.

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

◆ Show()

void HPS.Exchange.Export3MFOptionsKit.Show ( out HPS.Exchange.Export3MFOptionsKit  out_kit)
inline

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 ( out HPS.KeyPath []  out_additional_key_paths)
inline

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 ( out string  out_state)
inline

Shows the copyright setting.

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

◆ ShowCurrentTessellationRetention()

bool HPS.Exchange.Export3MFOptionsKit.ShowCurrentTessellationRetention ( out bool  out_state,
out HPS.Exchange.TessellationOptionsKit  out_tessellation_kit 
)
inline

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 ( out string  out_state)
inline

Shows the description setting.

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

◆ ShowLicenseTerms()

bool HPS.Exchange.Export3MFOptionsKit.ShowLicenseTerms ( out string  out_license)
inline

Shows the license setting.

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

◆ UnsetAdditionalKeyPaths()

HPS.Exchange.Export3MFOptionsKit HPS.Exchange.Export3MFOptionsKit.UnsetAdditionalKeyPaths ( )
inline

Removes the additional key paths setting.

Returns
A reference to this Export3MFOptionsKit.

◆ UnsetCopyright()

HPS.Exchange.Export3MFOptionsKit HPS.Exchange.Export3MFOptionsKit.UnsetCopyright ( )
inline

Removes the Copyright setting.

Returns
A reference to this Export3MFOptionsKit.

◆ UnsetCurrentTessellationRetention()

HPS.Exchange.Export3MFOptionsKit HPS.Exchange.Export3MFOptionsKit.UnsetCurrentTessellationRetention ( )
inline

Removes the KeepCurrentTessellation setting.

Returns
A reference to this Export3MFOptionsKit.

◆ UnsetDescription()

HPS.Exchange.Export3MFOptionsKit HPS.Exchange.Export3MFOptionsKit.UnsetDescription ( )
inline

Removes the description setting.

Returns
A reference to this Export3MFOptionsKit.

◆ UnsetEverything()

HPS.Exchange.Export3MFOptionsKit HPS.Exchange.Export3MFOptionsKit.UnsetEverything ( )
inline

Removes all settings from this Export3MFOptionsKit.

Returns
A reference to this Export3MFOptionsKit.

◆ UnsetLicenseTerms()

HPS.Exchange.Export3MFOptionsKit HPS.Exchange.Export3MFOptionsKit.UnsetLicenseTerms ( )
inline

Removes the license setting.

Returns
A reference to this Export3MFOptionsKit.

The documentation for this class was generated from the following file:
  • internals/hps_sprk_exchange/source/cs/HPS.Exchange.cs