< Home

< Table of Contents

REFERENCE MANUAL

HPS.Exchange.ExportParasolidOptionsKit Class Reference

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

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

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 Indicates whether this ExportParasolidOptionsKit has any values set on it. More...
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Exchange.ExportParasolidOptionsKit in_kit)
 Check if the source ExportParasolidOptionsKit is equivalent to this ExportParasolidOptionsKit. More...
 
 ExportParasolidOptionsKit ()
 The default constructor creates an empty ExportParasolidOptionsKit object. More...
 
 ExportParasolidOptionsKit (HPS.Exchange.ExportParasolidOptionsKit in_kit)
 The copy constructor creates a new ExportParasolidOptionsKit object that contains the same settings as the source ExportParasolidOptionsKit. More...
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. More...
 
void Set (HPS.Exchange.ExportParasolidOptionsKit in_kit)
 Copies the source ExportParasolidOptionsKit into this ExportParasolidOptionsKit. More...
 
HPS.Exchange.ExportParasolidOptionsKit SetApplication (string in_name)
 Sets the application name to put in the Parasolid data. More...
 
HPS.Exchange.ExportParasolidOptionsKit SetHiddenObjects (bool in_state)
 Sets whether to export hidden objects. More...
 
HPS.Exchange.ExportParasolidOptionsKit SetSolidsAsFaces (bool in_state)
 Sets whether to convert solids to a set of independent faces for export. More...
 
HPS.Exchange.ExportParasolidOptionsKit SetTessellation (bool in_state)
 Sets whether to export tessellation data. More...
 
HPS.Exchange.ExportParasolidOptionsKit SetVersion (string in_version)
 Sets the version string to put in the Parasolid data. More...
 
void Show (out HPS.Exchange.ExportParasolidOptionsKit out_kit)
 Copies this ExportParasolidOptionsKit into the given ExportParasolidOptionsKit. More...
 
bool ShowApplication (out string out_name)
 Shows the application name setting. More...
 
bool ShowHiddenObjects (out bool out_state)
 Shows the hidden object export setting. More...
 
bool ShowSolidsAsFaces (out bool out_state)
 Shows the solids to faces conversion setting. More...
 
bool ShowTessellation (out bool out_state)
 Shows the tessellation export setting. More...
 
bool ShowVersion (out string out_version)
 Shows the version string setting. More...
 
HPS.Exchange.ExportParasolidOptionsKit UnsetApplication ()
 Removes the application name setting. More...
 
HPS.Exchange.ExportParasolidOptionsKit UnsetEverything ()
 Removes all settings from this ExportParasolidOptionsKit. More...
 
HPS.Exchange.ExportParasolidOptionsKit UnsetHiddenObjects ()
 Removes the hidden objects export setting. More...
 
HPS.Exchange.ExportParasolidOptionsKit UnsetSolidsAsFaces ()
 Removes the solids to faces conversion setting. More...
 
HPS.Exchange.ExportParasolidOptionsKit UnsetTessellation ()
 Removes the tessellation export setting. More...
 
HPS.Exchange.ExportParasolidOptionsKit UnsetVersion ()
 Removes the version string 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.ExportParasolidOptionsKit 
GetDefault ()
 Creates an ExportParasolidOptionsKit which contains the default settings. More...
 
static bool operator!= (HPS.Exchange.ExportParasolidOptionsKit a, HPS.Exchange.ExportParasolidOptionsKit b)
 
static bool operator== (HPS.Exchange.ExportParasolidOptionsKit a, HPS.Exchange.ExportParasolidOptionsKit 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::ExportParasolidOptionsKit class is a user space object.

It contains settings controlling how Parasolid data is exported via Exchange. Calling Exchange::ExportParasolidOptionsKit::GetDefault() will return an options kit with values found in here.

Constructor & Destructor Documentation

HPS.Exchange.ExportParasolidOptionsKit.ExportParasolidOptionsKit ( )

The default constructor creates an empty ExportParasolidOptionsKit object.

HPS.Exchange.ExportParasolidOptionsKit.ExportParasolidOptionsKit ( HPS.Exchange.ExportParasolidOptionsKit  in_kit)

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

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_exchange_1_1_export_parasolid_options_kit" kindref="compound">ExportParasolidOptionsKit</ref> to copy.

Member Function Documentation

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

Indicates whether this ExportParasolidOptionsKit has any values set on it.

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

Reimplemented from HPS.Object.

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

Check if the source ExportParasolidOptionsKit is equivalent to this ExportParasolidOptionsKit.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_exchange_1_1_export_parasolid_options_kit" kindref="compound">ExportParasolidOptionsKit</ref> to compare to this <ref refid="class_h_p_s_1_1_exchange_1_1_export_parasolid_options_kit" kindref="compound">ExportParasolidOptionsKit</ref>.
Returns
true if the objects are equivalent, false otherwise.
static HPS.Exchange.ExportParasolidOptionsKit HPS.Exchange.ExportParasolidOptionsKit.GetDefault ( )
static

Creates an ExportParasolidOptionsKit 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::ExportParasolid.

Returns
An ExportParasolidOptionsKit with the default settings.
override HPS.Type HPS.Exchange.ExportParasolidOptionsKit.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.ExportParasolidOptionsKit.Set ( HPS.Exchange.ExportParasolidOptionsKit  in_kit)

Copies the source ExportParasolidOptionsKit into this ExportParasolidOptionsKit.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_exchange_1_1_export_parasolid_options_kit" kindref="compound">ExportParasolidOptionsKit</ref> to copy.
HPS.Exchange.ExportParasolidOptionsKit HPS.Exchange.ExportParasolidOptionsKit.SetApplication ( string  in_name)

Sets the application name to put in the Parasolid data.

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_parasolid_data.html#aaf34910e2c76bc91ffce06955671597d">A3DRWParamsExportParasolidData::m_pcApplication</ulink>.

Parameters
in_nameUTF8-encoded application name to put in the Parasolid data.
Returns
A reference to this ExportParasolidOptionsKit.
HPS.Exchange.ExportParasolidOptionsKit HPS.Exchange.ExportParasolidOptionsKit.SetHiddenObjects ( bool  in_state)

Sets whether to export hidden objects.

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_parasolid_data.html#a435f5a402a4e769a90105c312e75af3f">A3DRWParamsExportParasolidData::m_bWriteBlankedEntities</ulink>.

Parameters
in_stateWhether to export hidden objects.
Returns
A reference to this ExportParasolidOptionsKit.

Default value

HPS.Exchange.ExportParasolidOptionsKit HPS.Exchange.ExportParasolidOptionsKit.SetSolidsAsFaces ( bool  in_state)

Sets whether to convert solids to a set of independent faces for export.

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_parasolid_data.html#a67ec36338dcfaa92d331c294d63ac94d">A3DRWParamsExportIgesData::m_bSaveSolidsAsFaces</ulink>.

Parameters
in_stateWhether to convert solids to a set of independent faces for export.
Returns
A reference to this ExportParasolidOptionsKit.

Default value

HPS.Exchange.ExportParasolidOptionsKit HPS.Exchange.ExportParasolidOptionsKit.SetTessellation ( bool  in_state)

Sets whether to export tessellation data.

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_parasolid_data.html#a9fc3ea289436ec57dcdbce78ddc57a97">A3DRWParamsExportParasolidData::m_bWriteTessellation</ulink>.

Parameters
in_stateWhether to export tessellation data.
Returns
A reference to this ExportParasolidOptionsKit.

Default value

HPS.Exchange.ExportParasolidOptionsKit HPS.Exchange.ExportParasolidOptionsKit.SetVersion ( string  in_version)

Sets the version string to put in the Parasolid data.

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_parasolid_data.html#ae2cbff6b7cde472c983810da1d9ea0a2">A3DRWParamsExportParasolidData::m_pcVersion</ulink>.

Parameters
in_versionUTF8-encoded version string to put in the Parasolid data.
Returns
A reference to this ExportParasolidOptionsKit.
void HPS.Exchange.ExportParasolidOptionsKit.Show ( out HPS.Exchange.ExportParasolidOptionsKit  out_kit)

Copies this ExportParasolidOptionsKit into the given ExportParasolidOptionsKit.

Parameters
out_kitThe <ref refid="class_h_p_s_1_1_exchange_1_1_export_parasolid_options_kit" kindref="compound">ExportParasolidOptionsKit</ref> to populate with the contents of this <ref refid="class_h_p_s_1_1_exchange_1_1_export_parasolid_options_kit" kindref="compound">ExportParasolidOptionsKit</ref>.
bool HPS.Exchange.ExportParasolidOptionsKit.ShowApplication ( out string  out_name)

Shows the application name setting.

Parameters
out_nameThe application name to put in the Parasolid data.
Returns
true if an application name setting was specified, false otherwise.
bool HPS.Exchange.ExportParasolidOptionsKit.ShowHiddenObjects ( out bool  out_state)

Shows the hidden object export setting.

Parameters
out_stateWhether to export hidden objects.
Returns
true if a hidden object export setting was specified, false otherwise.
bool HPS.Exchange.ExportParasolidOptionsKit.ShowSolidsAsFaces ( out bool  out_state)

Shows the solids to faces conversion setting.

Parameters
out_stateWhether to convert solids to a set of independent faces for export.
Returns
true if a solids to faces conversion setting was specified, false otherwise.
bool HPS.Exchange.ExportParasolidOptionsKit.ShowTessellation ( out bool  out_state)

Shows the tessellation export setting.

Parameters
out_stateWhether to export tessellation data.
Returns
true if a tessellation export setting was specified, false otherwise.
bool HPS.Exchange.ExportParasolidOptionsKit.ShowVersion ( out string  out_version)

Shows the version string setting.

Parameters
out_versionThe version string to put in the Parasolid data.
Returns
true if a version string setting was specified, false otherwise.
HPS.Exchange.ExportParasolidOptionsKit HPS.Exchange.ExportParasolidOptionsKit.UnsetApplication ( )

Removes the application name setting.

Returns
A reference to this ExportParasolidOptionsKit.
HPS.Exchange.ExportParasolidOptionsKit HPS.Exchange.ExportParasolidOptionsKit.UnsetEverything ( )

Removes all settings from this ExportParasolidOptionsKit.

Returns
A reference to this ExportParasolidOptionsKit.
HPS.Exchange.ExportParasolidOptionsKit HPS.Exchange.ExportParasolidOptionsKit.UnsetHiddenObjects ( )

Removes the hidden objects export setting.

Returns
A reference to this ExportParasolidOptionsKit.
HPS.Exchange.ExportParasolidOptionsKit HPS.Exchange.ExportParasolidOptionsKit.UnsetSolidsAsFaces ( )

Removes the solids to faces conversion setting.

Returns
A reference to this ExportParasolidOptionsKit.
HPS.Exchange.ExportParasolidOptionsKit HPS.Exchange.ExportParasolidOptionsKit.UnsetTessellation ( )

Removes the tessellation export setting.

Returns
A reference to this ExportParasolidOptionsKit.
HPS.Exchange.ExportParasolidOptionsKit HPS.Exchange.ExportParasolidOptionsKit.UnsetVersion ( )

Removes the version string setting.

Returns
A reference to this ExportParasolidOptionsKit.

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