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

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Exchange.ExportSTEPOptionsKit in_kit)
 
 ExportSTEPOptionsKit ()
 
 ExportSTEPOptionsKit (HPS.Exchange.ExportSTEPOptionsKit in_kit)
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 
void Set (HPS.Exchange.ExportSTEPOptionsKit in_kit)
 
HPS.Exchange.ExportSTEPOptionsKit SetAnalyticsAsNURBS (bool in_state)
 
HPS.Exchange.ExportSTEPOptionsKit SetApplication (string in_name)
 
HPS.Exchange.ExportSTEPOptionsKit SetAttributes (bool in_state)
 
HPS.Exchange.ExportSTEPOptionsKit SetCurves (bool in_state)
 
HPS.Exchange.ExportSTEPOptionsKit SetFacetedAsWireframe (bool in_state)
 
HPS.Exchange.ExportSTEPOptionsKit SetFormat (HPS.Exchange.STEP.Format in_format)
 
HPS.Exchange.ExportSTEPOptionsKit SetNameShortening (bool in_state)
 
HPS.Exchange.ExportSTEPOptionsKit SetPMI (bool in_state)
 
HPS.Exchange.ExportSTEPOptionsKit SetPMIAsTessellated (bool in_state)
 
HPS.Exchange.ExportSTEPOptionsKit SetPMIWithSemantic (bool in_state)
 
HPS.Exchange.ExportSTEPOptionsKit SetVersion (string in_version)
 
void Show (out HPS.Exchange.ExportSTEPOptionsKit out_kit)
 
bool ShowAnalyticsAsNURBS (out bool out_state)
 
bool ShowApplication (out string out_name)
 
bool ShowAttributes (out bool out_state)
 
bool ShowCurves (out bool out_state)
 
bool ShowFacetedAsWireframe (out bool out_state)
 
bool ShowFormat (out HPS.Exchange.STEP.Format out_format)
 
bool ShowNameShortening (out bool out_state)
 
bool ShowPMI (out bool out_state)
 
bool ShowPMIAsTessellated (out bool out_state)
 
bool ShowPMIWithSemantic (out bool out_state)
 
bool ShowVersion (out string out_version)
 
HPS.Exchange.ExportSTEPOptionsKit UnsetAnalyticsAsNURBS ()
 
HPS.Exchange.ExportSTEPOptionsKit UnsetApplication ()
 
HPS.Exchange.ExportSTEPOptionsKit UnsetAttributes ()
 
HPS.Exchange.ExportSTEPOptionsKit UnsetCurves ()
 
HPS.Exchange.ExportSTEPOptionsKit UnsetEverything ()
 
HPS.Exchange.ExportSTEPOptionsKit UnsetFacetedAsWireframe ()
 
HPS.Exchange.ExportSTEPOptionsKit UnsetFormat ()
 
HPS.Exchange.ExportSTEPOptionsKit UnsetNameShortening ()
 
HPS.Exchange.ExportSTEPOptionsKit UnsetPMI ()
 
HPS.Exchange.ExportSTEPOptionsKit UnsetPMIAsTessellated ()
 
HPS.Exchange.ExportSTEPOptionsKit UnsetPMIWithSemantic ()
 
HPS.Exchange.ExportSTEPOptionsKit UnsetVersion ()
 
- 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 ()
 
bool HasType (HPS.Type in_mask)
 
Object (HPS.Object that)
 
virtual void Reset ()
 
virtual HPS.Type Type ()
 

Static Public Member Functions

static HPS.Exchange.ExportSTEPOptionsKit GetDefault ()
 
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

◆ ExportSTEPOptionsKit() [1/2]

HPS.Exchange.ExportSTEPOptionsKit.ExportSTEPOptionsKit ( )
inline

The default constructor creates an empty ExportSTEPOptionsKit object.

◆ ExportSTEPOptionsKit() [2/2]

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

◆ Empty()

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.

◆ Equals()

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.

◆ GetDefault()

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.

◆ ObjectType()

override HPS.Type HPS.Exchange.ExportSTEPOptionsKit.ObjectType ( )
inlinevirtual

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

Returns
The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from HPS.SprocketKit.

◆ Set()

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.

◆ SetAnalyticsAsNURBS()

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.
See also
Default value

◆ SetApplication()

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.

◆ SetAttributes()

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.

◆ SetCurves()

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.

◆ SetFacetedAsWireframe()

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.
See also
Default value

◆ SetFormat()

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.
See also
Default value

◆ SetNameShortening()

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.
See also
Default value

◆ SetPMI()

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.

◆ SetPMIAsTessellated()

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

Sets whether to export PMI as tessellated rather than polyline. This corresponds to the value that will be passed to A3DRWParamsExportStepData::m_bWritePMIAsTessellated.

Parameters
in_stateWhether to export PMI as tessellated.
Returns
A reference to this ExportSTEPOptionsKit.

◆ SetPMIWithSemantic()

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

Sets whether to export PMI with semantic information. This corresponds to the value that will be passed to A3DRWParamsExportStepData::m_bWritePMIWithSemantic.

Parameters
in_stateWhether to export PMI semantic information.
Returns
A reference to this ExportSTEPOptionsKit.

◆ SetVersion()

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.

◆ Show()

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.

◆ ShowAnalyticsAsNURBS()

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.

◆ ShowApplication()

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.

◆ ShowAttributes()

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.

◆ ShowCurves()

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.

◆ ShowFacetedAsWireframe()

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.

◆ ShowFormat()

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.

◆ ShowNameShortening()

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.

◆ ShowPMI()

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.

◆ ShowPMIAsTessellated()

bool HPS.Exchange.ExportSTEPOptionsKit.ShowPMIAsTessellated ( out bool  out_state)
inline

Shows the pmi as tessellated setting.

Parameters
out_stateWhether to export PMI as tessellated information.
Returns
true if a PMI as tessellated setting was specified, false otherwise.

◆ ShowPMIWithSemantic()

bool HPS.Exchange.ExportSTEPOptionsKit.ShowPMIWithSemantic ( out bool  out_state)
inline

Shows the pmi with semantic setting.

Parameters
out_stateWhether to export PMI with semantic information.
Returns
true if a PMI with semantic setting was specified, false otherwise.

◆ ShowVersion()

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.

◆ UnsetAnalyticsAsNURBS()

HPS.Exchange.ExportSTEPOptionsKit HPS.Exchange.ExportSTEPOptionsKit.UnsetAnalyticsAsNURBS ( )
inline

Removes the analytics to NURBS conversion setting.

Returns
A reference to this ExportSTEPOptionsKit.

◆ UnsetApplication()

HPS.Exchange.ExportSTEPOptionsKit HPS.Exchange.ExportSTEPOptionsKit.UnsetApplication ( )
inline

Removes the application name setting.

Returns
A reference to this ExportSTEPOptionsKit.

◆ UnsetAttributes()

HPS.Exchange.ExportSTEPOptionsKit HPS.Exchange.ExportSTEPOptionsKit.UnsetAttributes ( )
inline

Removes the attributes setting.

Returns
A reference to this ExportSTEPOptionsKit.

◆ UnsetCurves()

HPS.Exchange.ExportSTEPOptionsKit HPS.Exchange.ExportSTEPOptionsKit.UnsetCurves ( )
inline

Removes the curves setting.

Returns
A reference to this ExportSTEPOptionsKit.

◆ UnsetEverything()

HPS.Exchange.ExportSTEPOptionsKit HPS.Exchange.ExportSTEPOptionsKit.UnsetEverything ( )
inline

Removes all settings from this ExportSTEPOptionsKit.

Returns
A reference to this ExportSTEPOptionsKit.

◆ UnsetFacetedAsWireframe()

HPS.Exchange.ExportSTEPOptionsKit HPS.Exchange.ExportSTEPOptionsKit.UnsetFacetedAsWireframe ( )
inline

Removes the faceted to wireframe conversion setting.

Returns
A reference to this ExportSTEPOptionsKit.

◆ UnsetFormat()

HPS.Exchange.ExportSTEPOptionsKit HPS.Exchange.ExportSTEPOptionsKit.UnsetFormat ( )
inline

Removes the format setting.

Returns
A reference to this ExportSTEPOptionsKit.

◆ UnsetNameShortening()

HPS.Exchange.ExportSTEPOptionsKit HPS.Exchange.ExportSTEPOptionsKit.UnsetNameShortening ( )
inline

Removes the name shortening setting.

Returns
A reference to this ExportSTEPOptionsKit.

◆ UnsetPMI()

HPS.Exchange.ExportSTEPOptionsKit HPS.Exchange.ExportSTEPOptionsKit.UnsetPMI ( )
inline

Removes the PMI setting.

Returns
A reference to this ExportSTEPOptionsKit.

◆ UnsetPMIAsTessellated()

HPS.Exchange.ExportSTEPOptionsKit HPS.Exchange.ExportSTEPOptionsKit.UnsetPMIAsTessellated ( )
inline

Removes the PMI as tessellated setting.

Returns
A reference to this ExportSTEPOptionsKit.

◆ UnsetPMIWithSemantic()

HPS.Exchange.ExportSTEPOptionsKit HPS.Exchange.ExportSTEPOptionsKit.UnsetPMIWithSemantic ( )
inline

Removes the PMI with semantic setting.

Returns
A reference to this ExportSTEPOptionsKit.

◆ UnsetVersion()

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