< Home

< Table of Contents

REFERENCE MANUAL

HPS.Exchange.ExportXMLOptionsKit Class Reference

The Exchange::ExportXMLOptionsKit class is a user space object. More...

Inheritance diagram for HPS.Exchange.ExportXMLOptionsKit:
HPS.Sprocket HPS.Object

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...
 
- Public Member Functions inherited from HPS.Sprocket
 Sprocket (HPS.Sprocket in_that)
 
- Public Member Functions inherited from HPS.Object
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 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

- Public Types inherited from HPS.Sprocket
enum  UpdateType { Synchronous = 0, Asynchronous = 1 }
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 
HandleRef scptr
 

Detailed Description

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.

Constructor & Destructor Documentation

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.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_exchange_1_1_export_x_m_l_options_kit" kindref="compound">ExportXMLOptionsKit</ref> to copy.

Member Function Documentation

override bool HPS.Exchange.ExportXMLOptionsKit.Empty ( )
virtual

Indicates whether this ExportXMLOptionsKit has any values set on it.

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

Reimplemented from HPS.Object.

bool HPS.Exchange.ExportXMLOptionsKit.Equals ( HPS.Exchange.ExportXMLOptionsKit  in_kit)

Check if the source ExportXMLOptionsKit is equivalent to this ExportXMLOptionsKit.

Parameters
in_kitThe 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>.
Returns
true if the objects are equivalent, false otherwise.
static HPS.Exchange.ExportXMLOptionsKit HPS.Exchange.ExportXMLOptionsKit.GetDefault ( )
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.

Returns
An ExportXMLOptionsKit with the default settings.
override HPS.Type HPS.Exchange.ExportXMLOptionsKit.ObjectType ( )
virtual

This function returns the type the object, as declared.

This does not necessarily give the true type of the underlying object.

Returns
The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from HPS.Object.

void HPS.Exchange.ExportXMLOptionsKit.Set ( HPS.Exchange.ExportXMLOptionsKit  in_kit)

Copies the source ExportXMLOptionsKit into this ExportXMLOptionsKit.

Parameters
in_kitThe 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>.

Parameters
in_stateWhether to export materials.
Returns
A reference to this ExportXMLOptionsKit.

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>.

Parameters
in_stateWhether to export metadata.
Returns
A reference to this ExportXMLOptionsKit.

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>.

Parameters
in_stateWhether to export transformations.
Returns
A reference to this ExportXMLOptionsKit.

Default value

void HPS.Exchange.ExportXMLOptionsKit.Show ( out HPS.Exchange.ExportXMLOptionsKit  out_kit)

Copies this ExportXMLOptionsKit into the given ExportXMLOptionsKit.

Parameters
out_kitThe <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.

Parameters
out_stateWhether to export materials.
Returns
true if a material export setting was specified, false otherwise.
bool HPS.Exchange.ExportXMLOptionsKit.ShowMetadata ( out bool  out_state)

Shows the metadata export setting.

Parameters
out_stateWhether to export metadata.
Returns
true if a metadata export setting was specified, false otherwise.
bool HPS.Exchange.ExportXMLOptionsKit.ShowTransformations ( out bool  out_state)

Shows the transformation export setting.

Parameters
out_stateWhether to export transformations.
Returns
true if a transformation export setting was specified, false otherwise.
HPS.Exchange.ExportXMLOptionsKit HPS.Exchange.ExportXMLOptionsKit.UnsetEverything ( )

Removes all settings from this ExportXMLOptionsKit.

Returns
A reference to this ExportXMLOptionsKit.
HPS.Exchange.ExportXMLOptionsKit HPS.Exchange.ExportXMLOptionsKit.UnsetMaterials ( )

Removes the material export setting.

Returns
A reference to this ExportXMLOptionsKit.
HPS.Exchange.ExportXMLOptionsKit HPS.Exchange.ExportXMLOptionsKit.UnsetMetadata ( )

Removes the metadata export setting.

Returns
A reference to this ExportXMLOptionsKit.
HPS.Exchange.ExportXMLOptionsKit HPS.Exchange.ExportXMLOptionsKit.UnsetTransformations ( )

Removes the transformation export setting.

Returns
A reference to this ExportXMLOptionsKit.

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