API Search || Global Search

More...

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

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 Indicates whether this ExportSTEPOptionsKit has any values set on it. More...
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Exchange.ExportSTEPOptionsKit in_kit)
 Check if the source ExportSTEPOptionsKit is equivalent to this ExportSTEPOptionsKit. More...
 
 ExportSTEPOptionsKit ()
 The default constructor creates an empty ExportSTEPOptionsKit object. More...
 
 ExportSTEPOptionsKit (HPS.Exchange.ExportSTEPOptionsKit in_kit)
 The copy constructor creates a new ExportSTEPOptionsKit object that contains the same settings as the source ExportSTEPOptionsKit. More...
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 
void Set (HPS.Exchange.ExportSTEPOptionsKit in_kit)
 Copies the source ExportSTEPOptionsKit into this ExportSTEPOptionsKit. More...
 
HPS.Exchange.ExportSTEPOptionsKit 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 A3DRWParamsExportStepData::m_bSaveAnalyticsToNurbs. More...
 
HPS.Exchange.ExportSTEPOptionsKit SetApplication (string in_name)
 Sets the application name to put in the STEP data. This corresponds to the value that will be passed to A3DRWParamsExportStepData::m_pcApplication. More...
 
HPS.Exchange.ExportSTEPOptionsKit SetAttributes (bool in_state)
 Sets whether to export attributes. This corresponds to the value that will be passed to A3DRWParamsExportStepData::m_bWriteAttributes. More...
 
HPS.Exchange.ExportSTEPOptionsKit SetCurves (bool in_state)
 Sets whether to export curves. This corresponds to the value that will be passed to A3DRWParamsExportStepData::m_bWriteUVCurves. More...
 
HPS.Exchange.ExportSTEPOptionsKit SetFacetedAsWireframe (bool in_state)
 Sets whether to convert polyhedrics to wireframe data for export. This corresponds to the value that will be passed to A3DRWParamsExportStepData::m_bSaveFacetedToWireframe. More...
 
HPS.Exchange.ExportSTEPOptionsKit SetFormat (HPS.Exchange.STEP.Format in_format)
 Sets the format of the STEP data to export. This corresponds to the value that will be passed to A3DRWParamsExportStepData::m_eStepFormat. More...
 
HPS.Exchange.ExportSTEPOptionsKit SetNameShortening (bool in_state)
 Sets whether to shorten names in the STEP data for export. This corresponds to the value that will be passed to A3DRWParamsExportStepData::m_bUseShortNames. More...
 
HPS.Exchange.ExportSTEPOptionsKit SetPMI (bool in_state)
 Sets whether to export PMI. This corresponds to the value that will be passed to A3DRWParamsExportStepData::m_bWritePMI. More...
 
HPS.Exchange.ExportSTEPOptionsKit SetVersion (string in_version)
 Sets the version string to put in the STEP data. This corresponds to the value that will be passed to A3DRWParamsExportStepData::m_pcVersion. More...
 
void Show (out HPS.Exchange.ExportSTEPOptionsKit out_kit)
 Copies this ExportSTEPOptionsKit into the given ExportSTEPOptionsKit. 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 ShowAttributes (out bool out_state)
 Shows the attributes setting. More...
 
bool ShowCurves (out bool out_state)
 Shows the curves setting. More...
 
bool ShowFacetedAsWireframe (out bool out_state)
 Shows the faceted to wireframe conversion setting. More...
 
bool ShowFormat (out HPS.Exchange.STEP.Format out_format)
 Shows the format setting. More...
 
bool ShowNameShortening (out bool out_state)
 Shows the name shortening setting. More...
 
bool ShowPMI (out bool out_state)
 Shows the pmi setting. More...
 
bool ShowVersion (out string out_version)
 Shows the version string setting. More...
 
HPS.Exchange.ExportSTEPOptionsKit UnsetAnalyticsAsNURBS ()
 Removes the analytics to NURBS conversion setting. More...
 
HPS.Exchange.ExportSTEPOptionsKit UnsetApplication ()
 Removes the application name setting. More...
 
HPS.Exchange.ExportSTEPOptionsKit UnsetAttributes ()
 Removes the attributes setting. More...
 
HPS.Exchange.ExportSTEPOptionsKit UnsetCurves ()
 Removes the curves setting. More...
 
HPS.Exchange.ExportSTEPOptionsKit UnsetEverything ()
 Removes all settings from this ExportSTEPOptionsKit. More...
 
HPS.Exchange.ExportSTEPOptionsKit UnsetFacetedAsWireframe ()
 Removes the faceted to wireframe conversion setting. More...
 
HPS.Exchange.ExportSTEPOptionsKit UnsetFormat ()
 Removes the format setting. More...
 
HPS.Exchange.ExportSTEPOptionsKit UnsetNameShortening ()
 Removes the name shortening setting. More...
 
HPS.Exchange.ExportSTEPOptionsKit UnsetPMI ()
 Removes the PMI setting. More...
 
HPS.Exchange.ExportSTEPOptionsKit 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.ExportSTEPOptionsKit 
GetDefault ()
 Creates an ExportSTEPOptionsKit 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.ExportSTEP. More...
 
static bool operator!= (HPS.Exchange.ExportSTEPOptionsKit a, HPS.Exchange.ExportSTEPOptionsKit b)
 
static bool operator== (HPS.Exchange.ExportSTEPOptionsKit a, HPS.Exchange.ExportSTEPOptionsKit 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.ExportSTEPOptionsKit class is a user space object. It contains settings controlling how STEP data is exported via Exchange. Calling HPS.Exchange.ExportSTEPOptionsKit.GetDefault() will return an options kit with values found in here.

Constructor & Destructor Documentation

HPS.Exchange.ExportSTEPOptionsKit.ExportSTEPOptionsKit ( )
inline

The default constructor creates an empty ExportSTEPOptionsKit object.

HPS.Exchange.ExportSTEPOptionsKit.ExportSTEPOptionsKit ( HPS.Exchange.ExportSTEPOptionsKit  in_kit)
inline

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

Parameters
in_kitThe source ExportSTEPOptionsKit to copy.

Member Function Documentation

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

Indicates whether this ExportSTEPOptionsKit has any values set on it.

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

Reimplemented from HPS.Object.

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

Check if the source ExportSTEPOptionsKit is equivalent to this ExportSTEPOptionsKit.

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

Creates an ExportSTEPOptionsKit 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.ExportSTEP.

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

Copies the source ExportSTEPOptionsKit into this ExportSTEPOptionsKit.

Parameters
in_kitThe source ExportSTEPOptionsKit to copy.
HPS.Exchange.ExportSTEPOptionsKit HPS.Exchange.ExportSTEPOptionsKit.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 A3DRWParamsExportStepData::m_bSaveAnalyticsToNurbs.

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

Default value

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

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

Parameters
in_nameUTF8-encoded application name to put in the STEP data.
Returns
    A reference to this ExportSTEPOptionsKit.
HPS.Exchange.ExportSTEPOptionsKit HPS.Exchange.ExportSTEPOptionsKit.SetAttributes ( bool  in_state)
inline

Sets whether to export attributes. This corresponds to the value that will be passed to A3DRWParamsExportStepData::m_bWriteAttributes.

Parameters
in_stateWhether to export attributes.
Returns
    A reference to this ExportSTEPOptionsKit.
HPS.Exchange.ExportSTEPOptionsKit HPS.Exchange.ExportSTEPOptionsKit.SetCurves ( bool  in_state)
inline

Sets whether to export curves. This corresponds to the value that will be passed to A3DRWParamsExportStepData::m_bWriteUVCurves.

Parameters
in_stateWhether to export curves.
Returns
    A reference to this ExportSTEPOptionsKit.
HPS.Exchange.ExportSTEPOptionsKit HPS.Exchange.ExportSTEPOptionsKit.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 A3DRWParamsExportStepData::m_bSaveFacetedToWireframe.

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

Default value

HPS.Exchange.ExportSTEPOptionsKit HPS.Exchange.ExportSTEPOptionsKit.SetFormat ( HPS.Exchange.STEP.Format  in_format)
inline

Sets the format of the STEP data to export. This corresponds to the value that will be passed to A3DRWParamsExportStepData::m_eStepFormat.

Parameters
in_formatThe format of the STEP data to export.
Returns
    A reference to this ExportSTEPOptionsKit.

Default value

HPS.Exchange.ExportSTEPOptionsKit HPS.Exchange.ExportSTEPOptionsKit.SetNameShortening ( bool  in_state)
inline

Sets whether to shorten names in the STEP data for export. This corresponds to the value that will be passed to A3DRWParamsExportStepData::m_bUseShortNames.

Parameters
in_stateWhether to shorten names in the STEP data for export.
Returns
    A reference to this ExportSTEPOptionsKit.

Default value

HPS.Exchange.ExportSTEPOptionsKit HPS.Exchange.ExportSTEPOptionsKit.SetPMI ( bool  in_state)
inline

Sets whether to export PMI. This corresponds to the value that will be passed to A3DRWParamsExportStepData::m_bWritePMI.

Parameters
in_stateWhether to export PMI.
Returns
    A reference to this ExportSTEPOptionsKit.
HPS.Exchange.ExportSTEPOptionsKit HPS.Exchange.ExportSTEPOptionsKit.SetVersion ( string  in_version)
inline

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

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

Copies this ExportSTEPOptionsKit into the given ExportSTEPOptionsKit.

Parameters
out_kitThe ExportSTEPOptionsKit to populate with the contents of this ExportSTEPOptionsKit.
bool HPS.Exchange.ExportSTEPOptionsKit.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.ExportSTEPOptionsKit.ShowApplication ( out string  out_name)
inline

Shows the application name setting.

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

Shows the attributes setting.

Parameters
out_stateWhether to export attributes.
Returns
    true if an attributes setting was specified, false otherwise.
bool HPS.Exchange.ExportSTEPOptionsKit.ShowCurves ( out bool  out_state)
inline

Shows the curves setting.

Parameters
out_stateWhether to export curves.
Returns
    true if a curves setting was specified, false otherwise.
bool HPS.Exchange.ExportSTEPOptionsKit.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.ExportSTEPOptionsKit.ShowFormat ( out HPS.Exchange.STEP.Format  out_format)
inline

Shows the format setting.

Parameters
out_formatThe format of the STEP data to export.
Returns
    true if a format setting was specified, false otherwise.
bool HPS.Exchange.ExportSTEPOptionsKit.ShowNameShortening ( out bool  out_state)
inline

Shows the name shortening setting.

Parameters
out_stateWhether to shorten names in the STEP data for export.
Returns
    true if a name shortening setting was specified, false otherwise.
bool HPS.Exchange.ExportSTEPOptionsKit.ShowPMI ( out bool  out_state)
inline

Shows the pmi setting.

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

Shows the version string setting.

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

Removes the analytics to NURBS conversion setting.

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

Removes the application name setting.

Returns
    A reference to this ExportSTEPOptionsKit.
HPS.Exchange.ExportSTEPOptionsKit HPS.Exchange.ExportSTEPOptionsKit.UnsetAttributes ( )
inline

Removes the attributes setting.

Returns
    A reference to this ExportSTEPOptionsKit.
HPS.Exchange.ExportSTEPOptionsKit HPS.Exchange.ExportSTEPOptionsKit.UnsetCurves ( )
inline

Removes the curves setting.

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

Removes all settings from this ExportSTEPOptionsKit.

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

Removes the faceted to wireframe conversion setting.

Returns
    A reference to this ExportSTEPOptionsKit.
HPS.Exchange.ExportSTEPOptionsKit HPS.Exchange.ExportSTEPOptionsKit.UnsetFormat ( )
inline

Removes the format setting.

Returns
    A reference to this ExportSTEPOptionsKit.
HPS.Exchange.ExportSTEPOptionsKit HPS.Exchange.ExportSTEPOptionsKit.UnsetNameShortening ( )
inline

Removes the name shortening setting.

Returns
    A reference to this ExportSTEPOptionsKit.
HPS.Exchange.ExportSTEPOptionsKit HPS.Exchange.ExportSTEPOptionsKit.UnsetPMI ( )
inline

Removes the PMI setting.

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

Removes the version string setting.

Returns
    A reference to this ExportSTEPOptionsKit.

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