Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
HPS.Exchange.ExportACISOptionsKit Class Reference

The HPS::Exchange::ExportACISOptionsKit class is a user space object. It contains settings controlling how ACIS data is exported via the Exchange interface. Calling HPS::Exchange::ExportACISOptionsKit::GetDefault() will return an options kit with values found in here. More...

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

Public Member Functions

override void Dispose ()
 
 ExportACISOptionsKit ()
 The default constructor creates an empty ExportACISOptionsKit object. More...
 
 ExportACISOptionsKit (HPS.Exchange.ExportACISOptionsKit in_kit)
 The copy constructor creates a new ExportACISOptionsKit object that contains the same settings as the source ExportACISOptionsKit. More...
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More...
 
void Set (HPS.Exchange.ExportACISOptionsKit in_kit)
 Copies the source ExportACISOptionsKit into this ExportACISOptionsKit. More...
 
void Show (out HPS.Exchange.ExportACISOptionsKit out_kit)
 Copies this ExportACISOptionsKit into the given ExportACISOptionsKit. More...
 
override bool Empty ()
 Indicates whether this ExportACISOptionsKit has any values set on it. More...
 
override bool Equals (System.Object obj)
 
override int GetHashCode ()
 
bool Equals (HPS.Exchange.ExportACISOptionsKit in_kit)
 Check if the source ExportACISOptionsKit is equivalent to this ExportACISOptionsKit. More...
 
HPS.Exchange.ExportACISOptionsKit SetMillimeterUnits (bool in_state)
 Sets whether to write ACIS data in millimeter units instead of the native units of the CADModel. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/build/api_ref/struct_a3_d_r_w_params_export_acis_data.html#ac5e79d97a322f3b0ed1737f7a7d470a2">A3DRWParamsExportAcisData::m_bSaveAsMillimeter</ulink>. More...
 
HPS.Exchange.ExportACISOptionsKit SetBinary (bool in_state)
 Sets whether to write ACIS data in binary form. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/build/api_ref/struct_a3_d_r_w_params_export_acis_data.html#ad1c0225f67ae2be437fb22859cd06f24">A3DRWParamsExportAcisData::m_bSaveAsBinary</ulink>. More...
 
HPS.Exchange.ExportACISOptionsKit UnsetMillimeterUnits ()
 Removes the millimeter unit export setting. More...
 
HPS.Exchange.ExportACISOptionsKit UnsetBinary ()
 Removes the binary export setting. More...
 
HPS.Exchange.ExportACISOptionsKit UnsetEverything ()
 Removes all settings from this ExportACISOptionsKit. More...
 
bool ShowMillimeterUnits (out bool out_state)
 Shows the millimeter unit export setting. More...
 
bool ShowBinary (out bool out_state)
 Shows the binary export setting. More...
 
- Public Member Functions inherited from HPS.Sprocket
 Sprocket (HPS.Sprocket in_that)
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
 Object (HPS.Object that)
 
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...
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
IntPtr GetInstanceID ()
 Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More...
 

Static Public Member Functions

static
HPS.Exchange.ExportACISOptionsKit 
GetDefault ()
 Creates an ExportACISOptionsKit 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::ExportACIS. More...
 
static bool operator== (HPS.Exchange.ExportACISOptionsKit a, HPS.Exchange.ExportACISOptionsKit b)
 
static bool operator!= (HPS.Exchange.ExportACISOptionsKit a, HPS.Exchange.ExportACISOptionsKit 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 }
 The type of update to perform, either synchronous or asynchronous. More...
 
- Protected Attributes inherited from HPS.Object
HandleRef cptr
 
HandleRef scptr
 
bool cMemOwn
 

Detailed Description

The HPS::Exchange::ExportACISOptionsKit class is a user space object. It contains settings controlling how ACIS data is exported via the Exchange interface. Calling HPS::Exchange::ExportACISOptionsKit::GetDefault() will return an options kit with values found in here.

Constructor & Destructor Documentation

HPS.Exchange.ExportACISOptionsKit.ExportACISOptionsKit ( )
inline

The default constructor creates an empty ExportACISOptionsKit object.

HPS.Exchange.ExportACISOptionsKit.ExportACISOptionsKit ( HPS.Exchange.ExportACISOptionsKit  in_kit)
inline

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

Parameters
in_kitThe source ExportACISOptionsKit to copy.

Member Function Documentation

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

Indicates whether this ExportACISOptionsKit has any values set on it.

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

Reimplemented from HPS.Object.

bool HPS.Exchange.ExportACISOptionsKit.Equals ( HPS.Exchange.ExportACISOptionsKit  in_kit)
inline

Check if the source ExportACISOptionsKit is equivalent to this ExportACISOptionsKit.

Parameters
in_kitThe source ExportACISOptionsKit to compare to this ExportACISOptionsKit.
Returns
true if the objects are equivalent, false otherwise.
static HPS.Exchange.ExportACISOptionsKit HPS.Exchange.ExportACISOptionsKit.GetDefault ( )
inlinestatic

Creates an ExportACISOptionsKit 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::ExportACIS.

Returns
An ExportACISOptionsKit with the default settings.
override HPS.Type HPS.Exchange.ExportACISOptionsKit.ObjectType ( )
inlinevirtual

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

Copies the source ExportACISOptionsKit into this ExportACISOptionsKit.

Parameters
in_kitThe source ExportACISOptionsKit to copy.
HPS.Exchange.ExportACISOptionsKit HPS.Exchange.ExportACISOptionsKit.SetBinary ( bool  in_state)
inline

Sets whether to write ACIS data in binary form. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/build/api_ref/struct_a3_d_r_w_params_export_acis_data.html#ad1c0225f67ae2be437fb22859cd06f24">A3DRWParamsExportAcisData::m_bSaveAsBinary</ulink>.

Parameters
in_stateWhether to write ACIS data in binary form.
Returns
A reference to this ExportACISOptionsKit.

Default value

HPS.Exchange.ExportACISOptionsKit HPS.Exchange.ExportACISOptionsKit.SetMillimeterUnits ( bool  in_state)
inline

Sets whether to write ACIS data in millimeter units instead of the native units of the CADModel. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/build/api_ref/struct_a3_d_r_w_params_export_acis_data.html#ac5e79d97a322f3b0ed1737f7a7d470a2">A3DRWParamsExportAcisData::m_bSaveAsMillimeter</ulink>.

Parameters
in_stateWhether to write ACIS data in millimeter units instead of the native units of the CADModel.
Returns
A reference to this ExportACISOptionsKit.

Default value

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

Copies this ExportACISOptionsKit into the given ExportACISOptionsKit.

Parameters
out_kitThe ExportACISOptionsKit to populate with the contents of this ExportACISOptionsKit.
bool HPS.Exchange.ExportACISOptionsKit.ShowBinary ( out bool  out_state)
inline

Shows the binary export setting.

Parameters
out_stateWhether to write ACIS data in binary form.
Returns
true if a binary export setting was specified, false otherwise.
bool HPS.Exchange.ExportACISOptionsKit.ShowMillimeterUnits ( out bool  out_state)
inline

Shows the millimeter unit export setting.

Parameters
out_stateWhether to write ACIS data in millimeter units instead of the native units of the CADModel.
Returns
true if a millimeter unit export setting was specified, false otherwise.
HPS.Exchange.ExportACISOptionsKit HPS.Exchange.ExportACISOptionsKit.UnsetBinary ( )
inline

Removes the binary export setting.

Returns
A reference to this ExportACISOptionsKit.
HPS.Exchange.ExportACISOptionsKit HPS.Exchange.ExportACISOptionsKit.UnsetEverything ( )
inline

Removes all settings from this ExportACISOptionsKit.

Returns
A reference to this ExportACISOptionsKit.
HPS.Exchange.ExportACISOptionsKit HPS.Exchange.ExportACISOptionsKit.UnsetMillimeterUnits ( )
inline

Removes the millimeter unit export setting.

Returns
A reference to this ExportACISOptionsKit.

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