Inheritance diagram for HPS.Exchange.ExportSTLOptionsKit:
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.ExportSTLOptionsKit in_kit)
 
 ExportSTLOptionsKit ()
 
 ExportSTLOptionsKit (HPS.Exchange.ExportSTLOptionsKit in_kit)
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 
void Set (HPS.Exchange.ExportSTLOptionsKit in_kit)
 
HPS.Exchange.ExportSTLOptionsKit SetBinary (bool in_state)
 
HPS.Exchange.ExportSTLOptionsKit SetCurrentTessellationRetention (bool in_state)
 
HPS.Exchange.ExportSTLOptionsKit SetMaximumEdgeLength (double in_length)
 
HPS.Exchange.ExportSTLOptionsKit SetTessellationAccuracy (HPS.Exchange.Tessellation.Accuracy in_type)
 
HPS.Exchange.ExportSTLOptionsKit SetTessellationLevel (HPS.Exchange.Tessellation.Level in_level)
 
HPS.Exchange.ExportSTLOptionsKit SetTessellationLevel (HPS.Exchange.Tessellation.Chord.Limit in_limit_type, double in_limit, double in_angle_tolerance)
 
HPS.Exchange.ExportSTLOptionsKit SetUnits (HPS.Exchange.Units in_units)
 
void Show (out HPS.Exchange.ExportSTLOptionsKit out_kit)
 
bool ShowBinary (out bool out_state)
 
bool ShowCurrentTessellationRetention (out bool out_state)
 
bool ShowMaximumEdgeLength (out double out_length)
 
bool ShowTessellationAccuracy (out HPS.Exchange.Tessellation.Accuracy out_type)
 
bool ShowTessellationLevel (out HPS.Exchange.Tessellation.Type out_type, out HPS.Exchange.Tessellation.Level out_level, out HPS.Exchange.Tessellation.Chord.Limit out_limit_type, out double out_limit, out double out_angle_tolerance)
 
bool ShowUnits (out HPS.Exchange.Units out_units)
 
HPS.Exchange.ExportSTLOptionsKit UnsetBinary ()
 
HPS.Exchange.ExportSTLOptionsKit UnsetCurrentTessellationRetention ()
 
HPS.Exchange.ExportSTLOptionsKit UnsetEverything ()
 
HPS.Exchange.ExportSTLOptionsKit UnsetMaximumEdgeLength ()
 
HPS.Exchange.ExportSTLOptionsKit UnsetTessellationAccuracy ()
 
HPS.Exchange.ExportSTLOptionsKit UnsetTessellationLevel ()
 
HPS.Exchange.ExportSTLOptionsKit UnsetUnits ()
 
- 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.ExportSTLOptionsKit GetDefault ()
 
static bool operator!= (HPS.Exchange.ExportSTLOptionsKit a, HPS.Exchange.ExportSTLOptionsKit b)
 
static bool operator== (HPS.Exchange.ExportSTLOptionsKit a, HPS.Exchange.ExportSTLOptionsKit 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.ExportSTLOptionsKit class is a user space object. It contains settings controlling how STL data is exported via Exchange. Calling HPS.Exchange.ExportSTLOptionsKit.GetDefault() will return an options kit with values found in here.

Constructor & Destructor Documentation

◆ ExportSTLOptionsKit() [1/2]

HPS.Exchange.ExportSTLOptionsKit.ExportSTLOptionsKit ( )
inline

The default constructor creates an empty ExportSTLOptionsKit object.

◆ ExportSTLOptionsKit() [2/2]

HPS.Exchange.ExportSTLOptionsKit.ExportSTLOptionsKit ( HPS.Exchange.ExportSTLOptionsKit  in_kit)
inline

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

Parameters
in_kitThe source ExportSTLOptionsKit to copy.

Member Function Documentation

◆ Empty()

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

Indicates whether this ExportSTLOptionsKit has any values set on it.

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

Reimplemented from HPS.Object.

◆ Equals()

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

Check if the source ExportSTLOptionsKit is equivalent to this ExportSTLOptionsKit.

Parameters
in_kitThe source ExportSTLOptionsKit to compare to this ExportSTLOptionsKit.
Returns
true if the objects are equivalent, false otherwise.

◆ GetDefault()

static HPS.Exchange.ExportSTLOptionsKit HPS.Exchange.ExportSTLOptionsKit.GetDefault ( )
inlinestatic

Creates an ExportSTLOptionsKit 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.ExportSTL.

Returns
An ExportSTLOptionsKit with the default settings.

◆ ObjectType()

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

Copies the source ExportSTLOptionsKit into this ExportSTLOptionsKit.

Parameters
in_kitThe source ExportSTLOptionsKit to copy.

◆ SetBinary()

HPS.Exchange.ExportSTLOptionsKit HPS.Exchange.ExportSTLOptionsKit.SetBinary ( bool  in_state)
inline

Sets whether to write STL data in binary form. This corresponds to the value that will be passed to A3DRWParamsExportStlData::m_bBinaryFile.

Parameters
in_stateWhether to write STL data in binary form.
Returns
A reference to this ExportSTLOptionsKit.
See also
Default value

◆ SetCurrentTessellationRetention()

HPS.Exchange.ExportSTLOptionsKit HPS.Exchange.ExportSTLOptionsKit.SetCurrentTessellationRetention ( bool  in_state)
inline

Sets whether to keep the current tessellation. This corresponds to the value that will be passed to A3DRWParamsExportStlData::m_bKeepCurrentTessellation.

Parameters
in_stateWhether to keep the current tessellation.
Returns
A reference to this ExportSTLOptionsKit.
See also
Default value

◆ SetMaximumEdgeLength()

HPS.Exchange.ExportSTLOptionsKit HPS.Exchange.ExportSTLOptionsKit.SetMaximumEdgeLength ( double  in_length)
inline

Sets the maximum length of triangle edges in the tessellation generated for BRep data. This is only relevant if the tessellation level is set to Tessellation.Level.UserDefined. This corresponds to the value that will be passed to A3DRWParamsExportStlData::m_dMaximalTriangleEdgeLength.

Parameters
in_lengthThe maximum length of triangle edges in the tessellation generated for BRep data. The value must be non-negative.
Returns
A reference to this ExportSTLOptionsKit.
See also
Default value

◆ SetTessellationAccuracy()

HPS.Exchange.ExportSTLOptionsKit HPS.Exchange.ExportSTLOptionsKit.SetTessellationAccuracy ( HPS.Exchange.Tessellation.Accuracy  in_type)
inline

Sets the accuracy of the tessellation that will be generated for BRep data.

Parameters
in_typeThe accuracy to use for tessellation generation.
Returns
A reference to this ExportSTLOptionsKit.
See also
Default value

◆ SetTessellationLevel() [1/2]

HPS.Exchange.ExportSTLOptionsKit HPS.Exchange.ExportSTLOptionsKit.SetTessellationLevel ( HPS.Exchange.Tessellation.Level  in_level)
inline

Sets the predefined quality of the tessellation that will be generated for BRep data using the standard tessellation algorithm. This corresponds to the value that will be passed to A3DRWParamsExportStlData::m_eTessellationLevelOfDetail.

Parameters
in_levelThe predefined quality of the tessellation that will be generated for BRep data using the standard tessellation algorithm.
Returns
A reference to this ExportSTLOptionsKit.
See also
Default value

◆ SetTessellationLevel() [2/2]

HPS.Exchange.ExportSTLOptionsKit HPS.Exchange.ExportSTLOptionsKit.SetTessellationLevel ( HPS.Exchange.Tessellation.Chord.Limit  in_limit_type,
double  in_limit,
double  in_angle_tolerance 
)
inline

Sets the user defined quality of the tessellation that will be generated for BRep data using the standard or accurate tessellation algorithm. This implicitly sets A3DRWParamsExportStlData::m_eTessellationLevel to kA3DTessLODUserDefined.

Parameters
in_limit_typeThe type of the chord limit to be specified.
in_limitEither the ratio of the tessellation chord height to the bounding box height which should be in the range [50, 10000], or the maximum distance between the surface definition and the tessellation approximation, depending on the preceding argument.
in_angle_toleranceThe maximum angle in degrees between two consecutive wire elements in the generated tessellation which should be in the range [10, 40]. This corresponds to the value that will be passed to A3DRWParamsExportStlData::m_dAngleToleranceDeg.
Returns
A reference to this ExportSTLOptionsKit.

◆ SetUnits()

HPS.Exchange.ExportSTLOptionsKit HPS.Exchange.ExportSTLOptionsKit.SetUnits ( HPS.Exchange.Units  in_units)
inline

Sets the units to associate with the STL export. This corresponds to the value that will be passed to A3DRWParamsExportStlData::m_eExportUnit. This function will result in a scale being applied to the exported model. The CADModel will NOT have a unit associated with it, since STL is a unit-less format. For example: exporting a cube with a 1mm side with Units set to Meter, will cause the side of the cube to shrink by a factor of 1000, since every unit in the file, which used to correspond to one mm, now corresponds to a meter. This is useful in the case where the STL file needs to be loaded in a scene alongside another model, so that the units of the two models can match.

Parameters
in_unitsThe units to associate with the export. Passing Units.Unknown will preserve the original units.
Returns
A reference to this ExportSTLOptionsKit.
See also
Default value

◆ Show()

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

Copies this ExportSTLOptionsKit into the given ExportSTLOptionsKit.

Parameters
out_kitThe ExportSTLOptionsKit to populate with the contents of this ExportSTLOptionsKit.

◆ ShowBinary()

bool HPS.Exchange.ExportSTLOptionsKit.ShowBinary ( out bool  out_state)
inline

Shows the binary export setting.

Parameters
out_stateWhether to write STL data in binary form.
Returns
true if a binary export setting was specified, false otherwise.

◆ ShowCurrentTessellationRetention()

bool HPS.Exchange.ExportSTLOptionsKit.ShowCurrentTessellationRetention ( out bool  out_state)
inline

Shows the current tessellation retention setting.

Parameters
out_stateWhether to keep the current tessellation.
Returns
true if a current tessellation retention setting was specified, false otherwise.

◆ ShowMaximumEdgeLength()

bool HPS.Exchange.ExportSTLOptionsKit.ShowMaximumEdgeLength ( out double  out_length)
inline

Shows the tessellation maximum edge length setting.

Parameters
out_lengthThe tessellation maximum edge length setting.
Returns
true if a tessellation maximum edge length setting was specified, false otherwise.

◆ ShowTessellationAccuracy()

bool HPS.Exchange.ExportSTLOptionsKit.ShowTessellationAccuracy ( out HPS.Exchange.Tessellation.Accuracy  out_type)
inline

Shows the tessellation accuracy setting.

Parameters
out_typeThe type of the tessellation accuracy which was specified.
Returns
true if a tessellation accuracy setting was specified, false otherwise.

◆ ShowTessellationLevel()

bool HPS.Exchange.ExportSTLOptionsKit.ShowTessellationLevel ( out HPS.Exchange.Tessellation.Type  out_type,
out HPS.Exchange.Tessellation.Level  out_level,
out HPS.Exchange.Tessellation.Chord.Limit  out_limit_type,
out double  out_limit,
out double  out_angle_tolerance 
)
inline

Shows the tessellation level setting.

Parameters
out_typeThe type of the tessellation level setting which was specified.
out_levelThe predefined quality of the tessellation that will be generated for BRep data using the standard tessellaiton algorithm. This is only valid if out_type is Tessellation.Type.Standard.
out_limit_typeThe type of chord limit which was specified. This is only valid if out_type is Tessellation.Type.Custom.
out_limitThe chord limit to use to generate tessellation for BRep data. Its interpretation depends on the preceding argument. This is only valid if out_type is Tessellation.Type.Custom.
out_angle_toleranceThe maximum angle in degrees between two consecutive wire elements in the generated tessellation. This is only valid if out_type is Tessellation.Type.Custom.
Returns
true if a tessellation level setting was specified, false otherwise.

◆ ShowUnits()

bool HPS.Exchange.ExportSTLOptionsKit.ShowUnits ( out HPS.Exchange.Units  out_units)
inline

Shows the binary export setting.

Returns
true if a units export setting was specified, false otherwise.

◆ UnsetBinary()

HPS.Exchange.ExportSTLOptionsKit HPS.Exchange.ExportSTLOptionsKit.UnsetBinary ( )
inline

Removes the binary export setting.

Returns
A reference to this ExportSTLOptionsKit.

◆ UnsetCurrentTessellationRetention()

HPS.Exchange.ExportSTLOptionsKit HPS.Exchange.ExportSTLOptionsKit.UnsetCurrentTessellationRetention ( )
inline

Removes the current tessellation retention setting.

Returns
A reference to this ExportSTLOptionsKit.

◆ UnsetEverything()

HPS.Exchange.ExportSTLOptionsKit HPS.Exchange.ExportSTLOptionsKit.UnsetEverything ( )
inline

Removes all settings from this ExportSTLOptionsKit.

Returns
A reference to this ExportSTLOptionsKit.

◆ UnsetMaximumEdgeLength()

HPS.Exchange.ExportSTLOptionsKit HPS.Exchange.ExportSTLOptionsKit.UnsetMaximumEdgeLength ( )
inline

Removes the tessellation maximum edge length setting.

Returns
A reference to this ExportSTLOptionsKit.

◆ UnsetTessellationAccuracy()

HPS.Exchange.ExportSTLOptionsKit HPS.Exchange.ExportSTLOptionsKit.UnsetTessellationAccuracy ( )
inline

Removes the tessellation accuracy setting.

Returns
A reference to this ExportSTLOptionsKit.

◆ UnsetTessellationLevel()

HPS.Exchange.ExportSTLOptionsKit HPS.Exchange.ExportSTLOptionsKit.UnsetTessellationLevel ( )
inline

Removes the tessellation level setting.

Returns
A reference to this ExportSTLOptionsKit.

◆ UnsetUnits()

HPS.Exchange.ExportSTLOptionsKit HPS.Exchange.ExportSTLOptionsKit.UnsetUnits ( )
inline

Removes the units export setting.

Returns
A reference to this ExportSTLOptionsKit.

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