HPS::Exchange::TessellationOptionsKit

class HPS::Exchange::TessellationOptionsKit : public HPS::SprocketKit

The TessellationOptionsKit class is a user space object. It contains settings controlling how STL data is exported via Exchange.

Public Functions

virtual bool Empty() const

Indicates whether this TessellationOptionsKit has any values set on it.

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

bool Equals(TessellationOptionsKit const &in_kit) const

Check if the source TessellationOptionsKit is equivalent to this TessellationOptionsKit.

Parameters: in_kit – The source TessellationOptionsKit to compare to this TessellationOptionsKit.
Returns: true if the objects are equivalent, false otherwise.

inline virtual HPS::Type ObjectType() const

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.

bool operator!=(TessellationOptionsKit const &in_kit) const

Check if the source TessellationOptionsKit is not equivalent to this TessellationOptionsKit.

Parameters: in_kit – The source TessellationOptionsKit to compare to this TessellationOptionsKit.
Returns: true if the objects are not equivalent, false otherwise.

TessellationOptionsKit &operator=(TessellationOptionsKit &&in_that)

The move assignment operator transfers the underlying object of the rvalue reference to this TessellationOptionsKit.

Parameters: in_that – An rvalue reference to an TessellationOptionsKit to take the underlying object from.
Returns: A reference to this TessellationOptionsKit.

TessellationOptionsKit &operator=(TessellationOptionsKit const &in_kit)

Copies the source TessellationOptionsKit into this TessellationOptionsKit.

Parameters: in_kit – The source TessellationOptionsKit to copy.
Returns: A reference to this TessellationOptionsKit.

bool operator==(TessellationOptionsKit const &in_kit) const

Check if the source TessellationOptionsKit is equivalent to this TessellationOptionsKit.

Parameters: in_kit – The source TessellationOptionsKit to compare to this TessellationOptionsKit.
Returns: true if the objects are equivalent, false otherwise.

void Set(TessellationOptionsKit const &in_kit)

Copies the source TessellationOptionsKit into this TessellationOptionsKit.

Parameters: in_kit – The source TessellationOptionsKit to copy.

TessellationOptionsKit &SetAccuracy(Tessellation::Accuracy in_type, bool in_accurate_normals = true, bool in_accurate_surface_curvatures = false, double in_accurate_grid_maximum_stitch_length = 0.0)

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

Parameters

in_type – The accuracy to use for tessellation generation.
in_accurate_normals – Whether 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_curvatures – Whether 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_length – Maximal 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.

TessellationOptionsKit &SetLevel(Tessellation::Chord::Limit in_limit_type, double in_limit, double in_angle_tolerance)

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_type – The type of the chord limit to be specified.
in_limit – Either 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_tolerance – The 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.

TessellationOptionsKit &SetLevel(Tessellation::Level in_level)

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_level – The predefined quality of the tessellation that will be generated for BRep data.
Returns: A reference to this TessellationOptionsKit.

TessellationOptionsKit &SetMaximumEdgeLength(double in_length)

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_length – The 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.

TessellationOptionsKit &SetUVPointPreservation(bool in_state)

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_state – Whether to keep parametric points as texture coordinates when generating the tessellation for BRep data.
Returns: A reference to this TessellationOptionsKit.

void Show(TessellationOptionsKit &out_kit) const

Copies this TessellationOptionsKit into the given TessellationOptionsKit.

Parameters: out_kit – The TessellationOptionsKit to populate with the contents of this TessellationOptionsKit.

bool ShowAccuracy(Tessellation::Accuracy &out_type, bool &out_accurate_normals, bool &out_accurate_surface_curvatures, double &out_accurate_grid_maximum_stitch_length) const

Shows the accuracy setting.

Parameters

out_type – The type of the accuracy which was specified.
out_accurate_normals – Whether to compute surface normals when performing accurate tessellation. This only applies if out_type is different than Tessellation::Accuracy::Standard.
out_accurate_surface_curvatures – Whether 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_length – Maximal 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.

bool ShowLevel(Tessellation::Type &out_type, Tessellation::Level &out_level, Tessellation::Chord::Limit &out_limit_type, double &out_limit, double &out_angle_tolerance) const

Shows the level setting.

Parameters

out_type – The type of the level setting which was specified.
out_level – The 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_type – The type of chord limit which was specified. This is only valid if out_type is Tessellation::Type::Custom.
out_limit – The 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_tolerance – The 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.

bool ShowMaximumEdgeLength(double &out_length) const

Shows the maximum edge length setting.

Parameters: out_length – The maximum edge length setting.
Returns: true if a maximum edge length setting was specified, false otherwise.

bool ShowUVPointPreservation(bool &out_state) const

Shows the UV preservation setting.

Parameters: out_state – Whether 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.

TessellationOptionsKit(): The default constructor creates an empty TessellationOptionsKit object.

TessellationOptionsKit(TessellationOptionsKit &&in_that)

The move constructor creates an TessellationOptionsKit by transferring the underlying object of the rvalue reference to this TessellationOptionsKit.

Parameters: in_that – An rvalue reference to an TessellationOptionsKit to take the underlying object from.

TessellationOptionsKit(TessellationOptionsKit const &in_kit)

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

Parameters: in_kit – The source TessellationOptionsKit to copy.

TessellationOptionsKit &UnsetAccuracy()

Removes the accuracy setting.

Returns: A reference to this TessellationOptionsKit.

TessellationOptionsKit &UnsetEverything()

Removes all settings from this TessellationOptionsKit.

Returns: A reference to this TessellationOptionsKit.

TessellationOptionsKit &UnsetLevel()

Removes the level setting.

Returns: A reference to this TessellationOptionsKit.

TessellationOptionsKit &UnsetMaximumEdgeLength()

Removes the maximum edge length setting.

Returns: A reference to this TessellationOptionsKit.

TessellationOptionsKit &UnsetUVPointPreservation()

Removes the UV preservation setting.

Returns: A reference to this TessellationOptionsKit.

virtual ~TessellationOptionsKit()

Public Static Functions

static TessellationOptionsKit GetDefault()

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.

Public Static Attributes

static const HPS::Type staticType = HPS::Type::ExchangeTessellationOptionsKit