API Search || Global Search

More...

Inheritance diagram for HPS.Exchange.ExportIGESOptionsKit:
HPS.SprocketKit HPS.Sprocket HPS.Object

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 Indicates whether this ExportIGESOptionsKit has any values set on it. More...
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Exchange.ExportIGESOptionsKit in_kit)
 Check if the source ExportIGESOptionsKit is equivalent to this ExportIGESOptionsKit. More...
 
 ExportIGESOptionsKit ()
 The default constructor creates an empty ExportIGESOptionsKit object. More...
 
 ExportIGESOptionsKit (HPS.Exchange.ExportIGESOptionsKit in_kit)
 The copy constructor creates a new ExportIGESOptionsKit object that contains the same settings as the source ExportIGESOptionsKit. More...
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 
void Set (HPS.Exchange.ExportIGESOptionsKit in_kit)
 Copies the source ExportIGESOptionsKit into this ExportIGESOptionsKit. More...
 
HPS.Exchange.ExportIGESOptionsKit SetAnalyticsAsNURBS (bool in_state)
 Sets whether to convert analytic surfaces (planes, cones, cylinder, etc.) to NURBS surfaces for export. This corresponds to the value that will be passed to A3DRWParamsExportIgesData::m_bSaveAnalyticsToNurbs. More...
 
HPS.Exchange.ExportIGESOptionsKit SetApplication (string in_name)
 Sets the application name to put in the IGES data. This corresponds to the value that will be passed to A3DRWParamsExportIgesData::m_pcApplication. More...
 
HPS.Exchange.ExportIGESOptionsKit SetFacetedAsWireframe (bool in_state)
 Sets whether to convert polyhedrics to wireframe data for export. This corresponds to the value that will be passed to A3DRWParamsExportIgesData::m_bSaveFacetedToWireframe. More...
 
HPS.Exchange.ExportIGESOptionsKit SetHiddenObjects (bool in_state)
 Sets whether to export hidden objects. This corresponds to the value that will be passed to A3DRWParamsExportIgesData::m_bWriteHiddenObjects. More...
 
HPS.Exchange.ExportIGESOptionsKit 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.ExportIGESOptionsKit SetTessellation (bool in_state)
 Sets whether to export tessellation data. This corresponds to the value that will be passed to A3DRWParamsExportIgesData::m_bWriteTessellation. More...
 
HPS.Exchange.ExportIGESOptionsKit SetVersion (string in_version)
 Sets the version string to put in the IGES data. This corresponds to the value that will be passed to A3DRWParamsExportIgesData::m_pcVersion. More...
 
void Show (out HPS.Exchange.ExportIGESOptionsKit out_kit)
 Copies this ExportIGESOptionsKit into the given ExportIGESOptionsKit. More...
 
bool ShowAnalyticsAsNURBS (out bool out_state)
 Shows the analytics to NURBS conversion setting. More...
 
bool ShowApplication (out string out_name)
 Shows the application name setting. More...
 
bool ShowFacetedAsWireframe (out bool out_state)
 Shows the faceted to wireframe conversion 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.ExportIGESOptionsKit UnsetAnalyticsAsNURBS ()
 Removes the analytics to NURBS conversion setting. More...
 
HPS.Exchange.ExportIGESOptionsKit UnsetApplication ()
 Removes the application name setting. More...
 
HPS.Exchange.ExportIGESOptionsKit UnsetEverything ()
 Removes all settings from this ExportIGESOptionsKit. More...
 
HPS.Exchange.ExportIGESOptionsKit UnsetFacetedAsWireframe ()
 Removes the faceted to wireframe conversion setting. More...
 
HPS.Exchange.ExportIGESOptionsKit UnsetHiddenObjects ()
 Removes the hidden objects export setting. More...
 
HPS.Exchange.ExportIGESOptionsKit UnsetSolidsAsFaces ()
 Removes the solids to faces conversion setting. More...
 
HPS.Exchange.ExportIGESOptionsKit UnsetTessellation ()
 Removes the tessellation export setting. More...
 
HPS.Exchange.ExportIGESOptionsKit 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 the object's database handle, which can be used to determine which instance of a class the object is. For example, controls are simply aliases for segment keys that group related functions. Therefore, a SegmentKey and all of its controls would return the same instance id. 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.ExportIGESOptionsKit 
GetDefault ()
 Creates an ExportIGESOptionsKit 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.ExportIGES. More...
 
static bool operator!= (HPS.Exchange.ExportIGESOptionsKit a, HPS.Exchange.ExportIGESOptionsKit b)
 
static bool operator== (HPS.Exchange.ExportIGESOptionsKit a, HPS.Exchange.ExportIGESOptionsKit 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.ExportIGESOptionsKit class is a user space object. It contains settings controlling how IGES data is exported via Exchange. Calling HPS.Exchange.ExportIGESOptionsKit.GetDefault() will return an options kit with values found in here.

Constructor & Destructor Documentation

HPS.Exchange.ExportIGESOptionsKit.ExportIGESOptionsKit ( )
inline

The default constructor creates an empty ExportIGESOptionsKit object.

HPS.Exchange.ExportIGESOptionsKit.ExportIGESOptionsKit ( HPS.Exchange.ExportIGESOptionsKit  in_kit)
inline

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

Parameters
in_kitThe source ExportIGESOptionsKit to copy.

Member Function Documentation

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

Indicates whether this ExportIGESOptionsKit has any values set on it.

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

Reimplemented from HPS.Object.

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

Check if the source ExportIGESOptionsKit is equivalent to this ExportIGESOptionsKit.

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

Creates an ExportIGESOptionsKit 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.ExportIGES.

Returns
An ExportIGESOptionsKit with the default settings.
void HPS.Exchange.ExportIGESOptionsKit.Set ( HPS.Exchange.ExportIGESOptionsKit  in_kit)
inline

Copies the source ExportIGESOptionsKit into this ExportIGESOptionsKit.

Parameters
in_kitThe source ExportIGESOptionsKit to copy.
HPS.Exchange.ExportIGESOptionsKit HPS.Exchange.ExportIGESOptionsKit.SetAnalyticsAsNURBS ( bool  in_state)
inline

Sets whether to convert analytic surfaces (planes, cones, cylinder, etc.) to NURBS surfaces for export. This corresponds to the value that will be passed to A3DRWParamsExportIgesData::m_bSaveAnalyticsToNurbs.

Parameters
in_stateWhether to convert analytic surfaces to NURBS surfaces for export.
Returns
A reference to this ExportIGESOptionsKit.

Default value

HPS.Exchange.ExportIGESOptionsKit HPS.Exchange.ExportIGESOptionsKit.SetApplication ( string  in_name)
inline

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

Parameters
in_nameUTF8-encoded application name to put in the IGES data.
Returns
A reference to this ExportIGESOptionsKit.
HPS.Exchange.ExportIGESOptionsKit HPS.Exchange.ExportIGESOptionsKit.SetFacetedAsWireframe ( bool  in_state)
inline

Sets whether to convert polyhedrics to wireframe data for export. This corresponds to the value that will be passed to A3DRWParamsExportIgesData::m_bSaveFacetedToWireframe.

Parameters
in_stateWhether to convert polyhedrics to wireframe data for export.
Returns
A reference to this ExportIGESOptionsKit.

Default value

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

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

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

Default value

HPS.Exchange.ExportIGESOptionsKit HPS.Exchange.ExportIGESOptionsKit.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 ExportIGESOptionsKit.

Default value

HPS.Exchange.ExportIGESOptionsKit HPS.Exchange.ExportIGESOptionsKit.SetTessellation ( bool  in_state)
inline

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

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

Default value

HPS.Exchange.ExportIGESOptionsKit HPS.Exchange.ExportIGESOptionsKit.SetVersion ( string  in_version)
inline

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

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

Copies this ExportIGESOptionsKit into the given ExportIGESOptionsKit.

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

Shows the analytics to NURBS conversion setting.

Parameters
out_stateWhether to convert analytic surfaces to NURBS surfaces for export.
Returns
true if an analytics to NURBS conversion setting was specified, false otherwise.
bool HPS.Exchange.ExportIGESOptionsKit.ShowApplication ( out string  out_name)
inline

Shows the application name setting.

Parameters
out_nameThe application name to put in the IGES data.
Returns
true if an application name setting was specified, false otherwise.
bool HPS.Exchange.ExportIGESOptionsKit.ShowFacetedAsWireframe ( out bool  out_state)
inline

Shows the faceted to wireframe conversion setting.

Parameters
out_stateWhether to convert polyhedrics to wireframe data for export.
Returns
true if a faceted to wireframe conversion setting was specified, false otherwise.
bool HPS.Exchange.ExportIGESOptionsKit.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.ExportIGESOptionsKit.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.ExportIGESOptionsKit.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.ExportIGESOptionsKit.ShowVersion ( out string  out_version)
inline

Shows the version string setting.

Parameters
out_versionThe version string to put in the IGES data.
Returns
true if a version string setting was specified, false otherwise.
HPS.Exchange.ExportIGESOptionsKit HPS.Exchange.ExportIGESOptionsKit.UnsetAnalyticsAsNURBS ( )
inline

Removes the analytics to NURBS conversion setting.

Returns
A reference to this ExportIGESOptionsKit.
HPS.Exchange.ExportIGESOptionsKit HPS.Exchange.ExportIGESOptionsKit.UnsetApplication ( )
inline

Removes the application name setting.

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

Removes all settings from this ExportIGESOptionsKit.

Returns
A reference to this ExportIGESOptionsKit.
HPS.Exchange.ExportIGESOptionsKit HPS.Exchange.ExportIGESOptionsKit.UnsetFacetedAsWireframe ( )
inline

Removes the faceted to wireframe conversion setting.

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

Removes the hidden objects export setting.

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

Removes the solids to faces conversion setting.

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

Removes the tessellation export setting.

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

Removes the version string setting.

Returns
A reference to this ExportIGESOptionsKit.

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