REFERENCE MANUAL
The Exchange::ExportXMLOptionsKit class is a user space object. More...
Public Member Functions | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this ExportXMLOptionsKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.Exchange.ExportXMLOptionsKit in_kit) |
Check if the source ExportXMLOptionsKit is equivalent to this ExportXMLOptionsKit. More... | |
ExportXMLOptionsKit () | |
The default constructor creates an empty ExportXMLOptionsKit object. More... | |
ExportXMLOptionsKit (HPS.Exchange.ExportXMLOptionsKit in_kit) | |
The copy constructor creates a new ExportXMLOptionsKit object that contains the same settings as the source ExportXMLOptionsKit. More... | |
override int | GetHashCode () |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
void | Set (HPS.Exchange.ExportXMLOptionsKit in_kit) |
Copies the source ExportXMLOptionsKit into this ExportXMLOptionsKit. More... | |
HPS.Exchange.ExportXMLOptionsKit | SetMaterials (bool in_state) |
Sets whether to export materials. More... | |
HPS.Exchange.ExportXMLOptionsKit | SetMetadata (bool in_state) |
Sets whether to export metadata. More... | |
HPS.Exchange.ExportXMLOptionsKit | SetTransformations (bool in_state) |
Sets whether to export transformations. More... | |
void | Show (out HPS.Exchange.ExportXMLOptionsKit out_kit) |
Copies this ExportXMLOptionsKit into the given ExportXMLOptionsKit. More... | |
bool | ShowMaterials (out bool out_state) |
Shows the material export setting. More... | |
bool | ShowMetadata (out bool out_state) |
Shows the metadata export setting. More... | |
bool | ShowTransformations (out bool out_state) |
Shows the transformation export setting. More... | |
HPS.Exchange.ExportXMLOptionsKit | UnsetEverything () |
Removes all settings from this ExportXMLOptionsKit. More... | |
HPS.Exchange.ExportXMLOptionsKit | UnsetMaterials () |
Removes the material export setting. More... | |
HPS.Exchange.ExportXMLOptionsKit | UnsetMetadata () |
Removes the metadata export setting. More... | |
HPS.Exchange.ExportXMLOptionsKit | UnsetTransformations () |
Removes the transformation export setting. More... | |
![]() | |
Sprocket (HPS.Sprocket in_that) | |
![]() | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object in_that) | |
The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
HPS.Type | Type () |
This function returns the true type of the underlying object. More... | |
Static Public Member Functions | |
static HPS.Exchange.ExportXMLOptionsKit | GetDefault () |
Creates an ExportXMLOptionsKit which contains the default settings. More... | |
static bool | operator!= (HPS.Exchange.ExportXMLOptionsKit a, HPS.Exchange.ExportXMLOptionsKit b) |
static bool | operator== (HPS.Exchange.ExportXMLOptionsKit a, HPS.Exchange.ExportXMLOptionsKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
enum | UpdateType { Synchronous = 0, Asynchronous = 1 } |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
The Exchange::ExportXMLOptionsKit class is a user space object.
It contains settings controlling how XML data is exported via Exchange. Calling Exchange::ExportXMLOptionsKit::GetDefault() will return an options kit with values found in here.
HPS.Exchange.ExportXMLOptionsKit.ExportXMLOptionsKit | ( | ) |
The default constructor creates an empty ExportXMLOptionsKit object.
HPS.Exchange.ExportXMLOptionsKit.ExportXMLOptionsKit | ( | HPS.Exchange.ExportXMLOptionsKit | in_kit | ) |
The copy constructor creates a new ExportXMLOptionsKit object that contains the same settings as the source ExportXMLOptionsKit.
in_kit | The source <ref refid="class_h_p_s_1_1_exchange_1_1_export_x_m_l_options_kit" kindref="compound">ExportXMLOptionsKit</ref> to copy. |
|
virtual |
Indicates whether this ExportXMLOptionsKit has any values set on it.
Reimplemented from HPS.Object.
bool HPS.Exchange.ExportXMLOptionsKit.Equals | ( | HPS.Exchange.ExportXMLOptionsKit | in_kit | ) |
Check if the source ExportXMLOptionsKit is equivalent to this ExportXMLOptionsKit.
in_kit | The source <ref refid="class_h_p_s_1_1_exchange_1_1_export_x_m_l_options_kit" kindref="compound">ExportXMLOptionsKit</ref> to compare to this <ref refid="class_h_p_s_1_1_exchange_1_1_export_x_m_l_options_kit" kindref="compound">ExportXMLOptionsKit</ref>. |
|
static |
Creates an ExportXMLOptionsKit 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::ExportXML.
|
virtual |
This function returns the type the object, as declared.
This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.Object.
void HPS.Exchange.ExportXMLOptionsKit.Set | ( | HPS.Exchange.ExportXMLOptionsKit | in_kit | ) |
Copies the source ExportXMLOptionsKit into this ExportXMLOptionsKit.
in_kit | The source <ref refid="class_h_p_s_1_1_exchange_1_1_export_x_m_l_options_kit" kindref="compound">ExportXMLOptionsKit</ref> to copy. |
HPS.Exchange.ExportXMLOptionsKit HPS.Exchange.ExportXMLOptionsKit.SetMaterials | ( | bool | in_state | ) |
Sets whether to export materials.
This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/exchange_ref_manual/struct_a3_d_r_w_params_export_x_m_l_data.html#a5e041e21b0e91ca6cbd2d955bbab8ce3">A3DRWParamsExportXMLData::m_bExportColorMaterial</ulink>.
in_state | Whether to export materials. |
Default value
HPS.Exchange.ExportXMLOptionsKit HPS.Exchange.ExportXMLOptionsKit.SetMetadata | ( | bool | in_state | ) |
Sets whether to export metadata.
This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/exchange_ref_manual/struct_a3_d_r_w_params_export_x_m_l_data.html#a4cb6a30be9204c7b4ba1f328277b698f">A3DRWParamsExportXMLData::m_bExportMetadata</ulink>.
in_state | Whether to export metadata. |
Default value
HPS.Exchange.ExportXMLOptionsKit HPS.Exchange.ExportXMLOptionsKit.SetTransformations | ( | bool | in_state | ) |
Sets whether to export transformations.
This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/exchange_ref_manual/struct_a3_d_r_w_params_export_x_m_l_data.html#acc79c32566fa8af73cead09de81097fd">A3DRWParamsExportXMLData::m_bExportTransformations</ulink>.
in_state | Whether to export transformations. |
Default value
void HPS.Exchange.ExportXMLOptionsKit.Show | ( | out HPS.Exchange.ExportXMLOptionsKit | out_kit | ) |
Copies this ExportXMLOptionsKit into the given ExportXMLOptionsKit.
out_kit | The <ref refid="class_h_p_s_1_1_exchange_1_1_export_x_m_l_options_kit" kindref="compound">ExportXMLOptionsKit</ref> to populate with the contents of this <ref refid="class_h_p_s_1_1_exchange_1_1_export_x_m_l_options_kit" kindref="compound">ExportXMLOptionsKit</ref>. |
bool HPS.Exchange.ExportXMLOptionsKit.ShowMaterials | ( | out bool | out_state | ) |
Shows the material export setting.
out_state | Whether to export materials. |
bool HPS.Exchange.ExportXMLOptionsKit.ShowMetadata | ( | out bool | out_state | ) |
Shows the metadata export setting.
out_state | Whether to export metadata. |
bool HPS.Exchange.ExportXMLOptionsKit.ShowTransformations | ( | out bool | out_state | ) |
Shows the transformation export setting.
out_state | Whether to export transformations. |
HPS.Exchange.ExportXMLOptionsKit HPS.Exchange.ExportXMLOptionsKit.UnsetEverything | ( | ) |
Removes all settings from this ExportXMLOptionsKit.
HPS.Exchange.ExportXMLOptionsKit HPS.Exchange.ExportXMLOptionsKit.UnsetMaterials | ( | ) |
Removes the material export setting.
HPS.Exchange.ExportXMLOptionsKit HPS.Exchange.ExportXMLOptionsKit.UnsetMetadata | ( | ) |
Removes the metadata export setting.
HPS.Exchange.ExportXMLOptionsKit HPS.Exchange.ExportXMLOptionsKit.UnsetTransformations | ( | ) |
Removes the transformation export setting.