API Search || Global Search
HPS.Exchange.ExportParasolidOptionsKit Class Reference

More...

Inheritance diagram for HPS.Exchange.ExportParasolidOptionsKit:
HPS.SprocketKit 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 ()
 
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. This corresponds to the value that will be passed to A3DRWParamsExportParasolidData::m_pcApplication. More...
 
HPS.Exchange.ExportParasolidOptionsKit SetExplodeMultiBodies (bool in_state)
 Sets whether to explode multi-connexes B-reps into multiple bodies. This corresponds to the value that will be passed to A3DRWParamsExportParasolidData::m_bExplodeMultiBodies. More...
 
HPS.Exchange.ExportParasolidOptionsKit SetHiddenObjects (bool in_state)
 Sets whether to export hidden objects. This corresponds to the value that will be passed to A3DRWParamsExportParasolidData::m_bWriteBlankedEntities. More...
 
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 A3DRWParamsExportIgesData::m_bSaveSolidsAsFaces. More...
 
HPS.Exchange.ExportParasolidOptionsKit SetTessellation (bool in_state)
 Sets whether to export tessellation data. This corresponds to the value that will be passed to A3DRWParamsExportParasolidData::m_bWriteTessellation. More...
 
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 A3DRWParamsExportParasolidData::m_pcVersion. 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 ShowExplodeMultiBodies (out bool out_state)
 Shows the explode multi bodies 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 UnsetExplodeMultiBodies ()
 Removes the explode multi bodies setting. 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.SprocketKit
 SprocketKit (HPS.SprocketKit in_that)
 
- 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. 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.ExportParasolidOptionsKit 
GetDefault ()
 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. 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

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

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

Constructor & Destructor Documentation

HPS.Exchange.ExportParasolidOptionsKit.ExportParasolidOptionsKit ( )
inline

The default constructor creates an empty ExportParasolidOptionsKit object.

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

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

Parameters
in_kitThe source ExportParasolidOptionsKit to copy.

Member Function Documentation

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

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)
inline

Check if the source ExportParasolidOptionsKit is equivalent to this ExportParasolidOptionsKit.

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

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

Copies the source ExportParasolidOptionsKit into this ExportParasolidOptionsKit.

Parameters
in_kitThe source ExportParasolidOptionsKit to copy.
HPS.Exchange.ExportParasolidOptionsKit HPS.Exchange.ExportParasolidOptionsKit.SetApplication ( string  in_name)
inline

Sets the application name to put in the Parasolid data. This corresponds to the value that will be passed to A3DRWParamsExportParasolidData::m_pcApplication.

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

Sets whether to explode multi-connexes B-reps into multiple bodies. This corresponds to the value that will be passed to A3DRWParamsExportParasolidData::m_bExplodeMultiBodies.

Parameters
in_stateWhether to explode multi-connexes B-reps into multiple bodies.
Returns
A reference to this ExportParasolidOptionsKit.

Default value

HPS.Exchange.ExportParasolidOptionsKit HPS.Exchange.ExportParasolidOptionsKit.SetHiddenObjects ( bool  in_state)
inline

Sets whether to export hidden objects. This corresponds to the value that will be passed to A3DRWParamsExportParasolidData::m_bWriteBlankedEntities.

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)
inline

Sets whether to convert solids to a set of independent faces for export. This corresponds to the value that will be passed to A3DRWParamsExportIgesData::m_bSaveSolidsAsFaces.

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)
inline

Sets whether to export tessellation data. This corresponds to the value that will be passed to A3DRWParamsExportParasolidData::m_bWriteTessellation.

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)
inline

Sets the version string to put in the Parasolid data. This corresponds to the value that will be passed to A3DRWParamsExportParasolidData::m_pcVersion.

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)
inline

Copies this ExportParasolidOptionsKit into the given ExportParasolidOptionsKit.

Parameters
out_kitThe ExportParasolidOptionsKit to populate with the contents of this ExportParasolidOptionsKit.
bool HPS.Exchange.ExportParasolidOptionsKit.ShowApplication ( out string  out_name)
inline

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.ShowExplodeMultiBodies ( out bool  out_state)
inline

Shows the explode multi bodies setting.

Parameters
out_stateThe explode multi bodies setting to put in the Parasolid data.
Returns
true if a explode multi bodies setting was specified, false otherwise.
bool HPS.Exchange.ExportParasolidOptionsKit.ShowHiddenObjects ( out bool  out_state)
inline

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)
inline

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)
inline

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)
inline

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 ( )
inline

Removes the application name setting.

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

Removes all settings from this ExportParasolidOptionsKit.

Returns
A reference to this ExportParasolidOptionsKit.
HPS.Exchange.ExportParasolidOptionsKit HPS.Exchange.ExportParasolidOptionsKit.UnsetExplodeMultiBodies ( )
inline

Removes the explode multi bodies setting.

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

Removes the hidden objects export setting.

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

Removes the solids to faces conversion setting.

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

Removes the tessellation export setting.

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

Removes the version string setting.

Returns
A reference to this ExportParasolidOptionsKit.

The documentation for this class was generated from the following file:
  • internals/hps_sprk_exchange/source/cs/HPS.Exchange.cs