Inheritance diagram for HPS.Exchange.TessellationOptionsKit:
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.TessellationOptionsKit in_kit)
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 
void Set (HPS.Exchange.TessellationOptionsKit in_kit)
 
HPS.Exchange.TessellationOptionsKit SetAccuracy (HPS.Exchange.Tessellation.Accuracy in_type, bool in_accurate_normals, bool in_accurate_surface_curvatures, double in_accurate_grid_maximum_stitch_length)
 
HPS.Exchange.TessellationOptionsKit SetAccuracy (HPS.Exchange.Tessellation.Accuracy in_type, bool in_accurate_normals, bool in_accurate_surface_curvatures)
 
HPS.Exchange.TessellationOptionsKit SetAccuracy (HPS.Exchange.Tessellation.Accuracy in_type, bool in_accurate_normals)
 
HPS.Exchange.TessellationOptionsKit SetAccuracy (HPS.Exchange.Tessellation.Accuracy in_type)
 
HPS.Exchange.TessellationOptionsKit SetLevel (HPS.Exchange.Tessellation.Level in_level)
 
HPS.Exchange.TessellationOptionsKit SetLevel (HPS.Exchange.Tessellation.Chord.Limit in_limit_type, double in_limit, double in_angle_tolerance)
 
HPS.Exchange.TessellationOptionsKit SetMaximumEdgeLength (double in_length)
 
HPS.Exchange.TessellationOptionsKit SetUVPointPreservation (bool in_state)
 
void Show (out HPS.Exchange.TessellationOptionsKit out_kit)
 
bool ShowAccuracy (out HPS.Exchange.Tessellation.Accuracy out_type, out bool out_accurate_normals, out bool out_accurate_surface_curvatures, out double out_accurate_grid_maximum_stitch_length)
 
bool ShowLevel (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 ShowMaximumEdgeLength (out double out_length)
 
bool ShowUVPointPreservation (out bool out_state)
 
 TessellationOptionsKit ()
 
 TessellationOptionsKit (HPS.Exchange.TessellationOptionsKit in_kit)
 
HPS.Exchange.TessellationOptionsKit UnsetAccuracy ()
 
HPS.Exchange.TessellationOptionsKit UnsetEverything ()
 
HPS.Exchange.TessellationOptionsKit UnsetLevel ()
 
HPS.Exchange.TessellationOptionsKit UnsetMaximumEdgeLength ()
 
HPS.Exchange.TessellationOptionsKit UnsetUVPointPreservation ()
 
- 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.TessellationOptionsKit GetDefault ()
 
static bool operator!= (HPS.Exchange.TessellationOptionsKit a, HPS.Exchange.TessellationOptionsKit b)
 
static bool operator== (HPS.Exchange.TessellationOptionsKit a, HPS.Exchange.TessellationOptionsKit 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 TessellationOptionsKit class is a user space object. It contains settings controlling how STL data is exported via Exchange.

Constructor & Destructor Documentation

◆ TessellationOptionsKit() [1/2]

HPS.Exchange.TessellationOptionsKit.TessellationOptionsKit ( )
inline

The default constructor creates an empty TessellationOptionsKit object.

◆ TessellationOptionsKit() [2/2]

HPS.Exchange.TessellationOptionsKit.TessellationOptionsKit ( HPS.Exchange.TessellationOptionsKit  in_kit)
inline

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

Parameters
in_kitThe source TessellationOptionsKit to copy.

Member Function Documentation

◆ Empty()

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

Indicates whether this TessellationOptionsKit has any values set on it.

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

Reimplemented from HPS.Object.

◆ Equals()

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

Check if the source TessellationOptionsKit is equivalent to this TessellationOptionsKit.

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

◆ GetDefault()

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

Creates an TessellationOptionsKit 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.Tessellation.

Returns
An TessellationOptionsKit with the default settings.

◆ ObjectType()

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

Copies the source TessellationOptionsKit into this TessellationOptionsKit.

Parameters
in_kitThe source TessellationOptionsKit to copy.

◆ SetAccuracy() [1/4]

HPS.Exchange.TessellationOptionsKit HPS.Exchange.TessellationOptionsKit.SetAccuracy ( HPS.Exchange.Tessellation.Accuracy  in_type,
bool  in_accurate_normals,
bool  in_accurate_surface_curvatures,
double  in_accurate_grid_maximum_stitch_length 
)
inline

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

Parameters
in_typeThe accuracy to use for tessellation generation.
in_accurate_normalsWhether to compute surface normals when performing accurate tessellation. This only applies if in_type is set to Tessellation.Accuracy.Accurate or Tessellation.GridAccuracy.GridAccurate. This correspond to the (negated) value that will be passed to A3DRWParamsTessellationData::m_bDoNotComputeNormalsInAccurateTessellation.
in_accurate_surface_curvaturesWhether to take into account surfaces curvature in accurate tessellation to controle triangles elongation directions. This only applies if in_type is set to Tessellation.Accuracy.Accurate or Tessellation.GridAccuracy.GridAccurate. This correspond to the value that will be passed to A3DRWParamsTessellationData::m_bAccurateSurfaceCurvatures.
in_accurate_grid_maximum_stitch_lengthMaximal grid stitch length. Disabled if value is 0. Be careful, a too small value can generate a huge tessellation. This only applies if in_type is set to Tessellation.GridAccuracy.GridAccurate. This correspond to the value that will be passed to A3DRWParamsTessellationData::m_dAccurateTessellationWithGridMaximumStitchLength.
Returns
A reference to this TessellationOptionsKit.

◆ SetAccuracy() [2/4]

HPS.Exchange.TessellationOptionsKit HPS.Exchange.TessellationOptionsKit.SetAccuracy ( HPS.Exchange.Tessellation.Accuracy  in_type,
bool  in_accurate_normals,
bool  in_accurate_surface_curvatures 
)
inline

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

Parameters
in_typeThe accuracy to use for tessellation generation.
in_accurate_normalsWhether to compute surface normals when performing accurate tessellation. This only applies if in_type is set to Tessellation.Accuracy.Accurate or Tessellation.GridAccuracy.GridAccurate. This correspond to the (negated) value that will be passed to A3DRWParamsTessellationData::m_bDoNotComputeNormalsInAccurateTessellation.
in_accurate_surface_curvaturesWhether to take into account surfaces curvature in accurate tessellation to controle triangles elongation directions. This only applies if in_type is set to Tessellation.Accuracy.Accurate or Tessellation.GridAccuracy.GridAccurate. This correspond to the value that will be passed to A3DRWParamsTessellationData::m_bAccurateSurfaceCurvatures.
Returns
A reference to this TessellationOptionsKit.

◆ SetAccuracy() [3/4]

HPS.Exchange.TessellationOptionsKit HPS.Exchange.TessellationOptionsKit.SetAccuracy ( HPS.Exchange.Tessellation.Accuracy  in_type,
bool  in_accurate_normals 
)
inline

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

Parameters
in_typeThe accuracy to use for tessellation generation.
in_accurate_normalsWhether to compute surface normals when performing accurate tessellation. This only applies if in_type is set to Tessellation.Accuracy.Accurate or Tessellation.GridAccuracy.GridAccurate. This correspond to the (negated) value that will be passed to A3DRWParamsTessellationData::m_bDoNotComputeNormalsInAccurateTessellation.
Returns
A reference to this TessellationOptionsKit.

◆ SetAccuracy() [4/4]

HPS.Exchange.TessellationOptionsKit HPS.Exchange.TessellationOptionsKit.SetAccuracy ( 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 TessellationOptionsKit.

◆ SetLevel() [1/2]

HPS.Exchange.TessellationOptionsKit HPS.Exchange.TessellationOptionsKit.SetLevel ( HPS.Exchange.Tessellation.Level  in_level)
inline

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

Parameters
in_levelThe predefined quality of the tessellation that will be generated for BRep data.
Returns
A reference to this TessellationOptionsKit.

◆ SetLevel() [2/2]

HPS.Exchange.TessellationOptionsKit HPS.Exchange.TessellationOptionsKit.SetLevel ( 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. This implicitly sets A3DRWParamsTessellationData::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 A3DRWParamsTessellationData::m_dAngleToleranceDeg.
Returns
A reference to this TessellationOptionsKit.

◆ SetMaximumEdgeLength()

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

Sets the maximum length of triangle edges in the tessellation generated for BRep data. This corresponds to the value that will be passed to A3DRWParamsTessellationData::m_dMaximalTriangleEdgeLength.

Parameters
in_lengthThe maximum length of triangle edges in the tessellation generated for BRep data. The value must be non-negative, and if set to 0.0, the length will not be used when generating the tessellation.
Returns
A reference to this TessellationOptionsKit.

◆ SetUVPointPreservation()

HPS.Exchange.TessellationOptionsKit HPS.Exchange.TessellationOptionsKit.SetUVPointPreservation ( bool  in_state)
inline

Sets whether to keep parametric points as texture coordinates when generating the tessellation for BRep data. This corresponds to the value that will be passed to A3DRWParamsTessellationData::m_bKeepUVPoints.

Parameters
in_stateWhether to keep parametric points as texture coordinates when generating the tessellation for BRep data.
Returns
A reference to this TessellationOptionsKit.

◆ Show()

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

Copies this TessellationOptionsKit into the given TessellationOptionsKit.

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

◆ ShowAccuracy()

bool HPS.Exchange.TessellationOptionsKit.ShowAccuracy ( out HPS.Exchange.Tessellation.Accuracy  out_type,
out bool  out_accurate_normals,
out bool  out_accurate_surface_curvatures,
out double  out_accurate_grid_maximum_stitch_length 
)
inline

Shows the accuracy setting.

Parameters
out_typeThe type of the accuracy which was specified.
out_accurate_normalsWhether to compute surface normals when performing accurate tessellation. This only applies if out_type is different than Tessellation.Accuracy.Standard.
out_accurate_surface_curvaturesWhether to take into account surfaces curvature in accurate tessellation to controle triangles elongation directions. This only applies if out_type is different than Tessellation.Accuracy.Standard.
out_accurate_grid_maximum_stitch_lengthMaximal grid stitch length. Disabled if value is 0. Be careful, a too small value can generate a huge tessellation. This only applies if out_type is Tessellation.Accuracy.GridAccurate.
Returns
true if an accuracy setting was specified, false otherwise.

◆ ShowLevel()

bool HPS.Exchange.TessellationOptionsKit.ShowLevel ( 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 level setting.

Parameters
out_typeThe type of the level setting which was specified.
out_levelThe predefined quality of the tessellation that will be generated for BRep data. 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 level setting was specified, false otherwise.

◆ ShowMaximumEdgeLength()

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

Shows the maximum edge length setting.

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

◆ ShowUVPointPreservation()

bool HPS.Exchange.TessellationOptionsKit.ShowUVPointPreservation ( out bool  out_state)
inline

Shows the UV preservation setting.

Parameters
out_stateWhether to keep parametric points as texture coordinates when generating the tessellation for BRep data.
Returns
true if a UV preservation setting was specified, false otherwise.

◆ UnsetAccuracy()

HPS.Exchange.TessellationOptionsKit HPS.Exchange.TessellationOptionsKit.UnsetAccuracy ( )
inline

Removes the accuracy setting.

Returns
A reference to this TessellationOptionsKit.

◆ UnsetEverything()

HPS.Exchange.TessellationOptionsKit HPS.Exchange.TessellationOptionsKit.UnsetEverything ( )
inline

Removes all settings from this TessellationOptionsKit.

Returns
A reference to this TessellationOptionsKit.

◆ UnsetLevel()

HPS.Exchange.TessellationOptionsKit HPS.Exchange.TessellationOptionsKit.UnsetLevel ( )
inline

Removes the level setting.

Returns
A reference to this TessellationOptionsKit.

◆ UnsetMaximumEdgeLength()

HPS.Exchange.TessellationOptionsKit HPS.Exchange.TessellationOptionsKit.UnsetMaximumEdgeLength ( )
inline

Removes the maximum edge length setting.

Returns
A reference to this TessellationOptionsKit.

◆ UnsetUVPointPreservation()

HPS.Exchange.TessellationOptionsKit HPS.Exchange.TessellationOptionsKit.UnsetUVPointPreservation ( )
inline

Removes the UV preservation setting.

Returns
A reference to this TessellationOptionsKit.

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