
Public Member Functions | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this Export3MFOptionsKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.Exchange.Export3MFOptionsKit in_kit) |
Check if the source Export3MFOptionsKit is equivalent to this Export3MFOptionsKit. More... | |
Export3MFOptionsKit () | |
The default constructor creates an empty Export3MFOptionsKit object. More... | |
Export3MFOptionsKit (HPS.Exchange.Export3MFOptionsKit in_kit) | |
The copy constructor creates a new Export3MFOptionsKit object that contains the same settings as the source Export3MFOptionsKit. More... | |
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). More... | |
void | Set (HPS.Exchange.Export3MFOptionsKit in_kit) |
Copies the source Export3MFOptionsKit into this Export3MFOptionsKit. More... | |
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. More... | |
HPS.Exchange.Export3MFOptionsKit | SetCopyright (string in_state) |
Sets the copyright metadata. More... | |
HPS.Exchange.Export3MFOptionsKit | SetCurrentTessellationRetention (bool in_state, HPS.Exchange.TessellationOptionsKit in_tessellation_kit) |
Sets whether to retain the current tessellation during export. More... | |
HPS.Exchange.Export3MFOptionsKit | SetCurrentTessellationRetention (bool in_state) |
Sets whether to retain the current tessellation during export. More... | |
HPS.Exchange.Export3MFOptionsKit | SetDescription (string in_description) |
Sets a description. This will be reported in the output file as metadata. More... | |
HPS.Exchange.Export3MFOptionsKit | SetLicenseTerms (string in_license) |
Sets license terms metadata. More... | |
void | Show (out HPS.Exchange.Export3MFOptionsKit out_kit) |
Copies this Export3MFOptionsKit into the given Export3MFOptionsKit. More... | |
bool | ShowAdditionalKeyPaths (out HPS.KeyPath[] out_additional_key_paths) |
Shows the additional key paths setting. More... | |
bool | ShowCopyright (out string out_state) |
Shows the copyright setting. More... | |
bool | ShowCurrentTessellationRetention (out bool out_state, out HPS.Exchange.TessellationOptionsKit out_tessellation_kit) |
Shows the KeepCurrentTessellation setting. More... | |
bool | ShowDescription (out string out_state) |
Shows the description setting. More... | |
bool | ShowLicenseTerms (out string out_license) |
Shows the license setting. More... | |
HPS.Exchange.Export3MFOptionsKit | UnsetAdditionalKeyPaths () |
Removes the additional key paths setting. More... | |
HPS.Exchange.Export3MFOptionsKit | UnsetCopyright () |
Removes the Copyright setting. More... | |
HPS.Exchange.Export3MFOptionsKit | UnsetCurrentTessellationRetention () |
Removes the KeepCurrentTessellation setting. More... | |
HPS.Exchange.Export3MFOptionsKit | UnsetDescription () |
Removes the description setting. More... | |
HPS.Exchange.Export3MFOptionsKit | UnsetEverything () |
Removes all settings from this Export3MFOptionsKit. More... | |
HPS.Exchange.Export3MFOptionsKit | UnsetLicenseTerms () |
Removes the license setting. More... | |
![]() | |
SprocketKit (HPS.SprocketKit in_that) | |
![]() | |
Sprocket (HPS.Sprocket in_that) | |
![]() | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns the object's database handle, which can be used to determine which instance of a class the object is. For example, controls are simply aliases for segment keys that group related functions. Therefore, a SegmentKey and all of its controls would return the same instance id. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object that) | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
virtual HPS.Type | Type () |
This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More... | |
Static Public Member Functions | |
static 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. More... | |
static bool | operator!= (HPS.Exchange.Export3MFOptionsKit a, HPS.Exchange.Export3MFOptionsKit b) |
static bool | operator== (HPS.Exchange.Export3MFOptionsKit a, HPS.Exchange.Export3MFOptionsKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
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]
|
inline |
The default constructor creates an empty Export3MFOptionsKit object.
◆ Export3MFOptionsKit() [2/2]
|
inline |
The copy constructor creates a new Export3MFOptionsKit object that contains the same settings as the source Export3MFOptionsKit.
- Parameters
-
in_kit The source Export3MFOptionsKit to copy.
Member Function Documentation
◆ 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()
|
inline |
Check if the source Export3MFOptionsKit is equivalent to this Export3MFOptionsKit.
- Parameters
-
in_kit The source Export3MFOptionsKit to compare to this Export3MFOptionsKit.
- Returns
- true if the objects are equivalent, false otherwise.
◆ 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()
|
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()
|
inline |
Copies the source Export3MFOptionsKit into this Export3MFOptionsKit.
- Parameters
-
in_kit The source Export3MFOptionsKit to copy.
◆ SetAdditionalKeyPaths()
|
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_paths The key paths to be exported.
- Returns
- A reference to this Export3MFOptionsKit.
◆ SetCopyright()
|
inline |
Sets the copyright metadata.
- Returns
- A reference to this Export3MFOptionsKit.
◆ SetCurrentTessellationRetention() [1/2]
|
inline |
Sets whether to retain the current tessellation during export.
- Parameters
-
in_state Whether to retain the current tessellation during export. in_tessellation_kit The 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]
|
inline |
Sets whether to retain the current tessellation during export.
- Parameters
-
in_state Whether to retain the current tessellation during export.
- Returns
- A reference to this Export3MFOptionsKit.
◆ SetDescription()
|
inline |
Sets a description. This will be reported in the output file as metadata.
- Parameters
-
in_description The description.
- Returns
- A reference to this Export3MFOptionsKit .
◆ SetLicenseTerms()
|
inline |
Sets license terms metadata.
- Parameters
-
in_license The license terms metadata.
- Returns
- A reference to this Export3MFOptionsKit.
◆ Show()
|
inline |
Copies this Export3MFOptionsKit into the given Export3MFOptionsKit.
- Parameters
-
out_kit The Export3MFOptionsKit to populate with the contents of this Export3MFOptionsKit.
◆ ShowAdditionalKeyPaths()
|
inline |
Shows the additional key paths setting.
- Parameters
-
out_additional_key_paths The key paths which will be added to the model
- Returns
- true if an additional key paths setting was specified, false otherwise.
◆ ShowCopyright()
|
inline |
Shows the copyright setting.
- Returns
- true if a copyright setting was specified, false otherwise.
◆ ShowCurrentTessellationRetention()
|
inline |
Shows the KeepCurrentTessellation setting.
- Parameters
-
out_state Whether to retain the current tessellation during export. out_tessellation_kit The 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()
|
inline |
Shows the description setting.
- Returns
- true if a description setting was specified, false otherwise.
◆ ShowLicenseTerms()
|
inline |
Shows the license setting.
- Parameters
-
out_license The license metadata
- Returns
- true if a license setting was specified, false otherwise.
◆ UnsetAdditionalKeyPaths()
|
inline |
Removes the additional key paths setting.
- Returns
- A reference to this Export3MFOptionsKit.
◆ UnsetCopyright()
|
inline |
Removes the Copyright setting.
- Returns
- A reference to this Export3MFOptionsKit.
◆ UnsetCurrentTessellationRetention()
|
inline |
Removes the KeepCurrentTessellation setting.
- Returns
- A reference to this Export3MFOptionsKit.
◆ UnsetDescription()
|
inline |
Removes the description setting.
- Returns
- A reference to this Export3MFOptionsKit.
◆ UnsetEverything()
|
inline |
Removes all settings from this Export3MFOptionsKit.
- Returns
- A reference to this 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