HPS::Parasolid::FacetTessellationKit

class HPS::Parasolid::FacetTessellationKit : public HPS::SprocketKit

The FacetTessellationKit class is a user space object. It contains settings controlling facet tessellation for Parasolid. It corresponds to the PK_TOPOL_render_facet_o_t struct.

Public Functions

virtual bool Empty() const

Indicates whether this FacetTessellationKit has any values set on it.

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

bool Equals(FacetTessellationKit const &in_kit) const

Check if the source FacetTessellationKit is equivalent to this FacetTessellationKit.

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

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

FacetTessellationKit(FacetTessellationKit &&in_that)

The move constructor creates an FacetTessellationKit by transferring the underlying impl of the rvalue reference to this FacetTessellationKit thereby avoiding a copy and allocation.

Parameters: in_that – An rvalue reference to an FacetTessellationKit to take the impl from.

FacetTessellationKit(FacetTessellationKit const &in_kit)

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

Parameters: in_kit – The source FacetTessellationKit to copy.

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!=(FacetTessellationKit const &in_kit) const

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

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

FacetTessellationKit &operator=(FacetTessellationKit &&in_that)

The move assignment operator transfers the underlying impl of the rvalue reference to this FacetTessellationKit thereby avoiding a copy.

Parameters: in_that – An rvalue reference to an FacetTessellationKit to take the impl from.
Returns: A reference to this FacetTessellationKit.

FacetTessellationKit &operator=(FacetTessellationKit const &in_kit)

Copies the source FacetTessellationKit into this FacetTessellationKit.

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

bool operator==(FacetTessellationKit const &in_kit) const

Check if the source FacetTessellationKit is equivalent to this FacetTessellationKit.

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

void Set(FacetTessellationKit const &in_kit)

Copies the source FacetTessellationKit into this FacetTessellationKit.

Parameters: in_kit – The source FacetTessellationKit to copy.

FacetTessellationKit &SetChordTolerance(double in_chord_tolerance, double in_maximum_chord_length, double in_maximum_chord_angle)

Sets chord tolerance.

Parameters

in_chord_tolerance – curve chordal tolerance between a curve and its facet edges. Corresponds to the value that will be passed to PK_TOPOL_facet_mesh_o_t.curve_chord_tol.
in_maximum_chord_length – maximum chord length. Corresponds to the value that will be passed to PK_TOPOL_facet_mesh_o_t.curve_chord_max.
in_maximum_chord_angle – maximum chord angle, in radians. Corresponds to the value that will be passed to PK_TOPOL_facet_mesh_o_t.curve_chord_ang.

Returns

A reference to this FacetTessellationKit.

FacetTessellationKit &SetDegeneracyBehavior(Facet::Degeneracy in_degeneracy_behavior)

Sets the behavior the import assumes during tessellation when encountering a degeneracy.

Parameters: in_degeneracy_behavior – describes how vertices are handled at degeneracies. Corresponds to the value that will be passed to PK_TOPOL_facet_mesh_o_t.degen.
Returns: A reference to this FacetTessellationKit.

FacetTessellationKit &SetDensity(Facet::Density in_density, double in_density_tolerance = 0, double in_density_max_angle = 0, DVectorArray const &in_view_directions = DVectorArray())

Sets the density settings.

Parameters

in_density – The density settings. This corresponds to the value that will be passed to PK_TOPOL_facet_mesh_o_t.density.
in_density_tolerance – The density tolerance. Must be specified is in_density is not ViewIndependent. This corresponds to the value that will be passed to PK_TOPOL_facet_mesh_o_t.local_density_tol.
in_density_max_angle – The density tolerance maximum angle. This corresponds to the value that will be passed to PK_TOPOL_facet_mesh_o_t.local_density_ang.
in_view_directions – An array of view directions. Must be specified is in_density is not ViewIndependent. This corresponds to the value that will be passed to PK_TOPOL_facet_mesh_o_t.view_directions.

Returns

A reference to this FacetTessellationKit.

FacetTessellationKit &SetEdges(bool in_edges)

Sets whether to output edges.

Parameters: in_edges – whether to output edges. Corresponds to the value that will be passed to PK_TOPOL_render_facet_go_o_t.go_edges.
Returns: A reference to this FacetTessellationKit.

FacetTessellationKit &SetFacetPlaneTolerance(double in_plane_tolerance, double in_max_plane_angle)

Sets tolerance between facet and mid-plane.

Parameters

in_plane_tolerance – distance tolerance between facet and mid-plane. Corresponds to the value that will be passed to PK_TOPOL_facet_mesh_o_t.facet_plane_tol.
in_max_plane_angle – angular tolerance between facet and mid-plane, in radians. Corresponds to the value that will be passed to PK_TOPOL_facet_mesh_o_t.facet_plane_ang.

Returns

A reference to this FacetTessellationKit.

FacetTessellationKit &SetFacetSize(double in_minimum_width, double in_maximum_width, int in_maximum_sides)

Sets face size constraints.

Parameters

in_minimum_width – minimum facet width. Corresponds to the value that will be passed to PK_TOPOL_facet_mesh_o_t.min_facet_width.
in_maximum_width – minimum facet width. Corresponds to the value that will be passed to PK_TOPOL_facet_mesh_o_t.max_facet_width.
in_maximum_sides – maximum facet sides. Corresponds to the value that will be passed to PK_TOPOL_facet_mesh_o_t.max_facet_sides.

Returns

A reference to this FacetTessellationKit.

FacetTessellationKit &SetFlattenVertices(bool in_flatten_vertices)

Sets whether vertices should be forced against tolerance edges.

Parameters: in_flatten_vertices – whether vertices should be forced against tolerance edges. Corresponds to the value that will be passed to PK_TOPOL_facet_mesh_o_t.vertices_on_planar.
Returns: A reference to this FacetTessellationKit.

FacetTessellationKit &SetIgnoreCriteria(bool in_ignore, Ignore in_ignore_criteria = Ignore::Absolute, double in_minimum_value = 0, bool in_treat_faces_individually = false)

Sets criteria for ignoring facets.

Parameters

in_ignore – whether any facet should be ignored.
in_ignore_criteria – specifies how to interpret the minimum_value parameter. Corresponds to the value that will be passed to PK_TOPOL_facet_mesh_o_t.ignore.
in_minimum_value – minimum value for a facet not to be ignored. Corresponds to the value that will be passed to PK_TOPOL_facet_mesh_o_t.ignore_value.
in_treat_faces_individually – whether facets should be considered individually or as part of the face’s owning body for ignore calculations. Corresponds to the value that will be passed to PK_TOPOL_facet_mesh_o_t.ignore_scope.

Returns

A reference to this FacetTessellationKit.

FacetTessellationKit &SetIgnoredLoops(IntArray &in_ignored_loops)

Sets which loops should be ignored while faceting. This corresponds to the value that will be passed to PK_TOPOL_facet_mesh_o_t.loops.

Parameters: in_ignored_loops – loops ignored during faceting. Each entry in the vector correspond to a PK_LOOP_t object
Returns: A reference to this FacetTessellationKit.

FacetTessellationKit &SetImprovedFacetQuality(bool in_improved_quality)

Sets whether extra checks should be performed to improve the quality of facets.

Parameters: in_improved_quality – whether extra checks should be performed to improve the quality of facets. Corresponds to the value that will be passed to PK_TOPOL_facet_mesh_o_t.quality.
Returns: A reference to this FacetTessellationKit.

FacetTessellationKit &SetIncrementalFaceting(Facet::IncrementalFaceting in_faceting, bool refine_tessellation = false)

Sets whether incremental faceting should be used.

Parameters

in_faceting – sets the incremental faceting behavior. Corresponds to the value that will be passed to PK_TOPOL_facet_mesh_o_t.incremental_facetting.
refine_tessellation – whether to refine facets. Corresponds to the value that will be passed to PK_TOPOL_facet_mesh_o_t.incremental_refinement.

Returns

A reference to this FacetTessellationKit.

FacetTessellationKit &SetInflection(bool in_refine)

Sets whether facets around points of inflections may be further refined.

Parameters: in_refine – whether facets around points of inflections may be further refined. Corresponds to the value that will be passed to PK_TOPOL_facet_mesh_o_t.inflect.
Returns: A reference to this FacetTessellationKit.

FacetTessellationKit &SetLocalTolerances(ToleranceArray const &in_tolerance_array, IntArray const &in_topology_array, IntArray const &in_tolerance_for_tolopoly)

Sets specific tolerances for a set of topologies.

Parameters

in_tolerance_array – array of tolerance specifications. Corresponds to the value that will be passed to PK_TOPOL_facet_mesh_o_t.local_tols.
in_topology_array – array of topologies for which a specific tolerance will be applied. Each entry in the vector correspond to a PK_TOPOL_t object. Corresponds to the value that will be passed to PK_TOPOL_facet_mesh_o_t.topols_with_local_tols.
in_tolerance_for_tolopoly – indexes connecting each element of the topology array to a tolerance. Corresponds to the value that will be passed to PK_TOPOL_facet_mesh_o_t.local_tols_for_topols.

Returns

A reference to this FacetTessellationKit.

FacetTessellationKit &SetNormals(bool in_normals)

Sets whether to output surface normals.

Parameters: in_normals – whether to output surface normals. Corresponds to the value that will be passed to PK_TOPOL_render_facet_go_o_t.go_normals.
Returns: A reference to this FacetTessellationKit.

FacetTessellationKit &SetOffsetFaces(bool in_offset_faces)

Sets whether to take into account faces which are offsets of one another.

Parameters: in_offset_faces – whether to take into account faces which are offsets of one another. Corresponds to the value that will be passed to PK_TOPOL_facet_mesh_o_t.respect_offset.
Returns: A reference to this FacetTessellationKit.

FacetTessellationKit &SetParameters(bool in_parameters)

Sets whether to output surface parameters.

Parameters: in_parameters – whether to output surface parameters. Corresponds to the value that will be passed to PK_TOPOL_render_facet_go_o_t.go_parameters.
Returns: A reference to this FacetTessellationKit.

FacetTessellationKit &SetShapeGeneration(Facet::Shape in_shape)

Sets constraints on the facet generation. This corresponds to the value that will be passed to PK_TOPOL_facet_mesh_o_t.shape.

Parameters: in_shape – The behavior used during tessellation for handling concave, convex and holed entities.
Returns: A reference to this FacetTessellationKit.

FacetTessellationKit &SetStrips(bool in_strips, int in_max_facets_per_strip, bool in_split_strips)

Sets output settings for strips

Parameters

in_strips – whether to output facets in strips. Corresponds to the value that will be passed to PK_TOPOL_render_facet_go_o_t.go_strips.
in_max_facets_per_strip – maximum number of facets per strips. Corresponds to the value that will be passed to PK_TOPOL_render_facet_go_o_t.go_max_facets_per_strip.
in_split_strips – whether to split facet strips. Corresponds to the value that will be passed to PK_TOPOL_render_facet_go_o_t.split_strips.

Returns

A reference to this FacetTessellationKit.

FacetTessellationKit &SetSurfacePlaneTolerance(double in_plane_tolerance, double in_max_plane_angle)

Sets tolerance between surfaces and corresponding facets.

Parameters

in_plane_tolerance – distance tolerance between surface and its facet. Corresponds to the value that will be passed to PK_TOPOL_facet_mesh_o_t.surface_plane_tol.
in_max_plane_angle – angular tolerance between surface and its facet, in radians. Corresponds to the value that will be passed to PK_TOPOL_facet_mesh_o_t.surface_plane_ang.

Returns

A reference to this FacetTessellationKit.

FacetTessellationKit &SetTessellationLevel(HPS::Parasolid::TessellationLevel in_tessellation_level, double in_chord = -1, double in_angle = -1, bool in_generate_line_tessellation = true)

Sets facet tessellation level. This function can optionally compute the best values for line tessellation based on the values passed in. Doing so is enabled by default and will result in lines which smoothly match their respective faces.

Parameters

in_tessellation_level – The tessellation level used for importing facets.
in_chord – The chord tolerance. Only considered if in_tessellation_level is set to Custom.
in_angle – The angle tolerance. Only considered if in_tessellation_level is set to Custom.
in_generate_line_tessellation – Automatically figure out the best parameters for line tessellation based on facet tessellation levels. True by default.

Returns

A reference to this FacetTessellationKit.

FacetTessellationKit &SetVertexMatching(Facet::Match in_vertex_matching)

Sets the vertex matching strategy at edges This corresponds to the value that will be passed to PK_TOPOL_facet_mesh_o_t.match.

Parameters: in_vertex_matching – The behavior used during tessellation for handling facet meshes between neighboring faces.
Returns: A reference to this FacetTessellationKit.

FacetTessellationKit &SetWireEdges(bool in_wire_edges)

Sets whether wire edges should be taken into account while faceting.

Parameters: in_wire_edgeswhether – wire edges should be taken into account while faceting. Corresponds to the value that will be passed to PK_TOPOL_facet_mesh_o_t.wire_edges.
Returns: A reference to this FacetTessellationKit.

void Show(FacetTessellationKit &out_kit) const

Copies this FacetTessellationKit into the given FacetTessellationKit.

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

bool ShowChordTolerance(double &out_chord_tolerance, double &out_maximum_chord_length, double &out_maximum_chord_angle) const

Shows the chord tolerance tessellation setting.

Parameters

out_chord_tolerance – The tolerance setting for this kit.
out_maximum_chord_length – The maximum chord length setting for this kit.
out_maximum_chord_angle – The maximum chord angle setting for this kit.

Returns

true if a chord tolerance setting was specified, false otherwise.

bool ShowDegeneracyBehavior(Facet::Degeneracy &out_degeneracy_behavior) const

Shows the degeneracy tessellation setting.

Parameters: out_degeneracy_behavior – The degeneracy setting for this kit.
Returns: true if a degeneracy setting was specified, false otherwise.

bool ShowDensity(Facet::Density &out_density, double &out_density_tolerance, double &out_density_max_angle, DVectorArray &out_view_directions) const

Shows the density tessellation setting.

Parameters

out_density – The density setting for this kit.
out_density_tolerance – The density tolerance.
out_density_max_angle – The density tolerance maximum angle.
out_view_directions – An array of view directions.

Returns

true if a density setting was specified, false otherwise.

bool ShowEdges(bool &out_edges) const

Shows the edges tessellation setting.

Parameters: out_edges – The edges setting for this kit.
Returns: true if a edges setting was specified, false otherwise.

bool ShowFacetPlaneTolerance(double &out_plane_tolerance, double &out_max_plane_angle) const

Shows the facet plane tolerance tessellation setting.

Parameters

out_plane_tolerance – The tolerance setting for this kit.
out_max_plane_angle – The maximum angle setting for this kit.

Returns

true if a facet plane tolerance setting was specified, false otherwise.

bool ShowFacetSize(double &out_minimum_width, double &out_maximum_width, int &out_maximum_sides) const

Shows the facet size tessellation setting.

Parameters

out_minimum_width – The minimum facet width setting for this kit.
out_maximum_width – The maximum facet width setting for this kit.
out_maximum_sides – The maximum facet side setting for this kit.

Returns

true if a facet size setting was specified, false otherwise.

bool ShowFlattenVertices(bool &out_flatten_vertices) const

Shows the flatten faces tessellation setting.

Parameters: out_flatten_vertices – The flatten faces setting for this kit.
Returns: true if a flatten faces setting was specified, false otherwise.

bool ShowIgnoreCriteria(bool &out_ignore, Ignore &out_ignore_criteria, double &out_minimum_value, bool &out_treat_faces_individually) const

Shows the ignore criteria tessellation setting.

Parameters

out_ignore – Whether facets are ignored in this kit. If this is false the other parameters are meaningless.
out_ignore_criteria – The ignore criteria setting for this kit. Meaningless if out_ignore is false.
out_minimum_value – The minimum value for ignoring a facet for this kit. Meaningless if out_ignore is false.
out_treat_faces_individually – Whether faces are considered individually when deciding if they should be ignored. Meaningless if out_ignore is false.

Returns

true if a ignore criteria were specified, false otherwise.

bool ShowIgnoredLoops(IntArray &out_ignored_loops) const

Shows the ignored loops tessellation setting.

Parameters: out_ignored_loops – The ignored loops setting for this kit.
Returns: true if a ignored loops setting was specified, false otherwise.

bool ShowImprovedFacetQuality(bool &out_improved_quality) const

Shows the improved facet quality tessellation setting.

Parameters: out_improved_quality – The out_improved_quality setting for this kit.
Returns: true if a improved facet quality setting was specified, false otherwise.

bool ShowIncrementalFaceting(Facet::IncrementalFaceting &out_faceting, bool &out_refine_tessellation) const

Shows the incremental faceting tessellation setting.

Parameters

out_faceting – The incremental faceting setting for this kit.
out_refine_tessellation – Whether facets are refined setting for this kit.

Returns

true if an incremental faceting setting was specified, false otherwise.

bool ShowInflection(bool &out_refine) const

Shows the inflection tessellation setting.

Parameters: out_refine – The inflection setting for this kit.
Returns: true if a inflection setting was specified, false otherwise.

bool ShowLocalTolerances(ToleranceArray &out_tolerance_array, IntArray &out_topology_array, IntArray &out_tolerance_for_tolopoly) const

Shows the local tolerance tessellation setting.

Parameters

out_tolerance_array – The local tolerance array for this kit.
out_topology_array – The topology array for this kit.
out_tolerance_for_tolopoly – The index array for this kit.

Returns

true if a local tolerance setting was specified, false otherwise.

bool ShowNormals(bool &out_normals) const

Shows the normals tessellation setting.

Parameters: out_normals – The normals setting for this kit.
Returns: true if a normals setting was specified, false otherwise.

bool ShowOffsetFaces(bool &out_offset_faces) const

Shows the offset faces tessellation setting.

Parameters: out_offset_faces – The offset faces setting for this kit.
Returns: true if a offset faces setting was specified, false otherwise.

bool ShowParameters(bool &out_parameters) const

Shows the parameters tessellation setting.

Parameters: out_parameters – The parameters setting for this kit.
Returns: true if a parameters setting was specified, false otherwise.

bool ShowShapeGeneration(Facet::Shape &out_shape) const

Shows the shape generation tessellation setting.

Parameters: out_shape – The shape generation setting for this kit.
Returns: true if a shape generation setting was specified, false otherwise.

bool ShowStrips(bool &out_strips, int &out_max_facets_per_strip, bool &out_split_strips) const

Shows the strips tessellation setting.

Parameters

out_strips – The strips setting for this kit.
out_max_facets_per_strip – The maximum number of facet per strip setting for this kit.
out_split_strips – Whether strips can be split for this kit.

Returns

true if a strips setting was specified, false otherwise.

bool ShowSurfacePlaneTolerance(double &out_plane_tolerance, double &out_max_plane_angle) const

Shows the surface plane tolerance tessellation setting.

Parameters

out_plane_tolerance – The tolerance setting for this kit.
out_max_plane_angle – The maximum angle setting for this kit.

Returns

true if a surface plane tolerance setting was specified, false otherwise.

bool ShowTessellationLevel(TessellationLevel &out_tessellation_level, double &out_chord, double &out_angle, bool &out_generate_line_tessellation) const

Shows the shape generation tessellation setting.

Parameters

out_tessellation_level – The tessellation level used for this import
out_chord – The chord tolerance. Only relevant if out_tessellation_level is Custom.
out_angle – The angle tolerance. Only relevant if out_tessellation_level is Custom.
out_generate_line_tessellation – Whether line tessellation levels are automatically generated based on facet tessellation level.

Returns

true if a shape generation setting was specified, false otherwise.

bool ShowVertexMatching(Facet::Match &out_vertex_matching) const

Shows the vertex matching tessellation setting.

Parameters: out_vertex_matching – The vertex matching tessellation setting for this kit.
Returns: true if a vertex matching tessellation setting was specified, false otherwise.

bool ShowWireEdges(bool &out_wire_edges) const

Shows the wire edges tessellation setting.

Parameters: out_wire_edges – The wire edge setting for this kit.
Returns: true if a wire edge setting was specified, false otherwise.

FacetTessellationKit &UnsetChordTolerance()

Removes the chord tolerance tessellation state.

Returns: A reference to this FacetTessellationKit.

FacetTessellationKit &UnsetDegeneracyBehavior()

Removes the degeneracy tessellation state.

Returns: A reference to this FacetTessellationKit.

FacetTessellationKit &UnsetDensity()

Removes the density tessellation state.

Returns: A reference to this FacetTessellationKit.

FacetTessellationKit &UnsetEdges()

Removes the edges tessellation state.

Returns: A reference to this FacetTessellationKit.

FacetTessellationKit &UnsetEverything()

Removes all settings from this FacetTessellationKit.

Returns: A reference to this FacetTessellationKit.

FacetTessellationKit &UnsetFacetPlaneTolerance()

Removes the facet plane tolerance tessellation state.

Returns: A reference to this FacetTessellationKit.

FacetTessellationKit &UnsetFacetSize()

Removes the facet size tessellation state.

Returns: A reference to this FacetTessellationKit.

FacetTessellationKit &UnsetFlattenVertices()

Removes the vertex flattening tessellation state.

Returns: A reference to this FacetTessellationKit.

FacetTessellationKit &UnsetIgnoreCriteria()

Removes the ignore criteria tessellation state.

Returns: A reference to this FacetTessellationKit.

FacetTessellationKit &UnsetIgnoredLoops()

Removes the ignored loops tessellation state.

Returns: A reference to this FacetTessellationKit.

FacetTessellationKit &UnsetImprovedFacetQuality()

Removes the facet quality tessellation state.

Returns: A reference to this FacetTessellationKit.

FacetTessellationKit &UnsetIncrementalFaceting()

Removes the incremental faceting tessellation state.

Returns: A reference to this FacetTessellationKit.

FacetTessellationKit &UnsetInflection()

Removes the inflection tessellation state.

Returns: A reference to this FacetTessellationKit.

FacetTessellationKit &UnsetLocalTolerances()

Removes the local tolerances tessellation state.

Returns: A reference to this FacetTessellationKit.

FacetTessellationKit &UnsetNormals()

Removes the normals tessellation state.

Returns: A reference to this FacetTessellationKit.

FacetTessellationKit &UnsetOffsetFaces()

Removes the offset faces tessellation state.

Returns: A reference to this FacetTessellationKit.

FacetTessellationKit &UnsetParameters()

Removes the parameters tessellation state.

Returns: A reference to this FacetTessellationKit.

FacetTessellationKit &UnsetShapeGeneration()

Removes the shape generation tessellation state.

Returns: A reference to this FacetTessellationKit.

FacetTessellationKit &UnsetStrips()

Removes the strip tessellation state.

Returns: A reference to this FacetTessellationKit.

FacetTessellationKit &UnsetSurfacePlaneTolerance()

Removes the plane tolerance tessellation state.

Returns: A reference to this FacetTessellationKit.

FacetTessellationKit &UnsetTessellationLevel()

Removes the tessellation level state.

Returns: A reference to this FacetTessellationKit.

FacetTessellationKit &UnsetVertexMatching()

Removes the vertex matching tessellation state.

Returns: A reference to this FacetTessellationKit.

FacetTessellationKit &UnsetWireEdges()

Removes the wire edges tessellation state.

Returns: A reference to this FacetTessellationKit.

virtual ~FacetTessellationKit()

Public Static Functions

static FacetTessellationKit GetDefault()

Creates an FacetTessellationKit 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 facet tessellation unless an option is overridden by the options passed to File::Import.

Returns: An FacetTessellationKit with the default settings.

Public Static Attributes

static const HPS::Type staticType = HPS::Type::ParasolidFacetTessellationKit