The FacetTessellationKit class is a user space object. More...

#include <sprk_parasolid.h>

Inheritance diagram for HPS::Parasolid::FacetTessellationKit:

Collaboration diagram for HPS::Parasolid::FacetTessellationKit:

Public Member Functions
	FacetTessellationKit ()
	The default constructor creates an empty FacetTessellationKit object. More...

	FacetTessellationKit (FacetTessellationKit const &in_kit)
	The copy constructor creates a new FacetTessellationKit object that contains the same settings as the source FacetTessellationKit. More...

	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. More...

FacetTessellationKit &	operator= (FacetTessellationKit &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this FacetTessellationKit thereby avoiding a copy. More...

virtual	~FacetTessellationKit ()

HPS::Type	ObjectType () const

void	Set (FacetTessellationKit const &in_kit)
	Copies the source FacetTessellationKit into this FacetTessellationKit. More...

void	Show (FacetTessellationKit &out_kit) const
	Copies this FacetTessellationKit into the given FacetTessellationKit. More...

FacetTessellationKit &	operator= (FacetTessellationKit const &in_kit)
	Copies the source FacetTessellationKit into this FacetTessellationKit. More...

bool	Empty () const
	Indicates whether this FacetTessellationKit has any values set on it. More...

bool	Equals (FacetTessellationKit const &in_kit) const
	Check if the source FacetTessellationKit is equivalent to this FacetTessellationKit. More...

bool	operator== (FacetTessellationKit const &in_kit) const
	Check if the source FacetTessellationKit is equivalent to this FacetTessellationKit. More...

bool	operator!= (FacetTessellationKit const &in_kit) const
	Check if the source FacetTessellationKit is not equivalent to this FacetTessellationKit. More...

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. More...

FacetTessellationKit &	SetShapeGeneration (Facet::Shape in_shape)
	Sets constraints on the facet generation. More...

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. More...

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. More...

FacetTessellationKit &	SetIgnoredLoops (IntArray &in_ignored_loops)
	Sets which loops should be ignored while faceting. More...

FacetTessellationKit &	SetFacetSize (double in_minimum_width, double in_maximum_width, int in_maximum_sides)
	Sets face size constraints. More...

FacetTessellationKit &	SetChordTolerance (double in_chord_tolerance, double in_maximum_chord_length, double in_maximum_chord_angle)
	Sets chord tolerance. More...

FacetTessellationKit &	SetSurfacePlaneTolerance (double in_plane_tolerance, double in_max_plane_angle)
	Sets tolerance between surfaces and corresponding facets. More...

FacetTessellationKit &	SetFacetPlaneTolerance (double in_plane_tolerance, double in_max_plane_angle)
	Sets tolerance between facet and mid-plane. More...

FacetTessellationKit &	SetDegeneracyBehavior (Facet::Degeneracy in_degeneracy_behavior)
	Sets the behavior the import assumes during tessellation when encountering a degeneracy. More...

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. More...

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. More...

FacetTessellationKit &	SetWireEdges (bool in_wire_edges)
	Sets whether wire edges should be taken into account while faceting. More...

FacetTessellationKit &	SetIncrementalFaceting (Facet::IncrementalFaceting in_faceting, bool refine_tessellation=false)
	Sets whether incremental faceting should be used. More...

FacetTessellationKit &	SetInflection (bool in_refine)
	Sets whether facets around points of inflections may be further refined. More...

FacetTessellationKit &	SetImprovedFacetQuality (bool in_improved_quality)
	Sets whether extra checks should be performed to improve the quality of facets. More...

FacetTessellationKit &	SetFlattenVertices (bool in_flatten_vertices)
	Sets whether vertices should be forced against tolerance edges. More...

FacetTessellationKit &	SetOffsetFaces (bool in_offset_faces)
	Sets whether to take into account faces which are offsets of one another. More...

FacetTessellationKit &	SetNormals (bool in_normals)
	Sets whether to output surface normals. More...

FacetTessellationKit &	SetParameters (bool in_parameters)
	Sets whether to output surface parameters. More...

FacetTessellationKit &	SetEdges (bool in_edges)
	Sets whether to output edges. More...

FacetTessellationKit &	SetStrips (bool in_strips, int in_max_facets_per_strip, bool in_split_strips)
	Sets output settings for strips. More...

FacetTessellationKit &	UnsetTessellationLevel ()
	Removes the tessellation level state. More...

FacetTessellationKit &	UnsetShapeGeneration ()
	Removes the shape generation tessellation state. More...

FacetTessellationKit &	UnsetVertexMatching ()
	Removes the vertex matching tessellation state. More...

FacetTessellationKit &	UnsetDensity ()
	Removes the density tessellation state. More...

FacetTessellationKit &	UnsetIgnoredLoops ()
	Removes the ignored loops tessellation state. More...

FacetTessellationKit &	UnsetFacetSize ()
	Removes the facet size tessellation state. More...

FacetTessellationKit &	UnsetChordTolerance ()
	Removes the chord tolerance tessellation state. More...

FacetTessellationKit &	UnsetSurfacePlaneTolerance ()
	Removes the plane tolerance tessellation state. More...

FacetTessellationKit &	UnsetFacetPlaneTolerance ()
	Removes the facet plane tolerance tessellation state. More...

FacetTessellationKit &	UnsetDegeneracyBehavior ()
	Removes the degeneracy tessellation state. More...

FacetTessellationKit &	UnsetLocalTolerances ()
	Removes the local tolerances tessellation state. More...

FacetTessellationKit &	UnsetIgnoreCriteria ()
	Removes the ignore criteria tessellation state. More...

FacetTessellationKit &	UnsetWireEdges ()
	Removes the wire edges tessellation state. More...

FacetTessellationKit &	UnsetIncrementalFaceting ()
	Removes the incremental faceting tessellation state. More...

FacetTessellationKit &	UnsetInflection ()
	Removes the inflection tessellation state. More...

FacetTessellationKit &	UnsetImprovedFacetQuality ()
	Removes the facet quality tessellation state. More...

FacetTessellationKit &	UnsetFlattenVertices ()
	Removes the vertex flattening tessellation state. More...

FacetTessellationKit &	UnsetOffsetFaces ()
	Removes the offset faces tessellation state. More...

FacetTessellationKit &	UnsetNormals ()
	Removes the normals tessellation state. More...

FacetTessellationKit &	UnsetParameters ()
	Removes the parameters tessellation state. More...

FacetTessellationKit &	UnsetEdges ()
	Removes the edges tessellation state. More...

FacetTessellationKit &	UnsetStrips ()
	Removes the strip tessellation state. More...

FacetTessellationKit &	UnsetEverything ()
	Removes all settings from this FacetTessellationKit. More...

bool	ShowTessellationLevel (TessellationLevel &out_tessellation_level, double &out_chord, double &out_angle, bool &out_generate_line_tessellation) const
	Shows the shape generation tessellation setting. More...

bool	ShowShapeGeneration (Facet::Shape &out_shape) const
	Shows the shape generation tessellation setting. More...

bool	ShowVertexMatching (Facet::Match &out_vertex_matching) const
	Shows the vertex matching tessellation setting. More...

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. More...

bool	ShowIgnoredLoops (IntArray &out_ignored_loops) const
	Shows the ignored loops tessellation setting. More...

bool	ShowFacetSize (double &out_minimum_width, double &out_maximum_width, int &out_maximum_sides) const
	Shows the facet size tessellation setting. More...

bool	ShowChordTolerance (double &out_chord_tolerance, double &out_maximum_chord_length, double &out_maximum_chord_angle) const
	Shows the chord tolerance tessellation setting. More...

bool	ShowSurfacePlaneTolerance (double &out_plane_tolerance, double &out_max_plane_angle) const
	Shows the surface plane tolerance tessellation setting. More...

bool	ShowFacetPlaneTolerance (double &out_plane_tolerance, double &out_max_plane_angle) const
	Shows the facet plane tolerance tessellation setting. More...

bool	ShowDegeneracyBehavior (Facet::Degeneracy &out_degeneracy_behavior) const
	Shows the degeneracy tessellation setting. More...

bool	ShowLocalTolerances (ToleranceArray &out_tolerance_array, IntArray &out_topology_array, IntArray &out_tolerance_for_tolopoly) const
	Shows the local tolerance tessellation setting. More...

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. More...

bool	ShowWireEdges (bool &out_wire_edges) const
	Shows the wire edges tessellation setting. More...

bool	ShowIncrementalFaceting (Facet::IncrementalFaceting &out_faceting, bool &out_refine_tessellation) const
	Shows the incremental faceting tessellation setting. More...

bool	ShowInflection (bool &out_refine) const
	Shows the inflection tessellation setting. More...

bool	ShowImprovedFacetQuality (bool &out_improved_quality) const
	Shows the improved facet quality tessellation setting. More...

bool	ShowFlattenVertices (bool &out_flatten_vertices) const
	Shows the flatten faces tessellation setting. More...

bool	ShowOffsetFaces (bool &out_offset_faces) const
	Shows the offset faces tessellation setting. More...

bool	ShowNormals (bool &out_normals) const
	Shows the normals tessellation setting. More...

bool	ShowParameters (bool &out_parameters) const
	Shows the parameters tessellation setting. More...

bool	ShowEdges (bool &out_edges) const
	Shows the edges tessellation setting. More...

bool	ShowStrips (bool &out_strips, int &out_max_facets_per_strip, bool &out_split_strips) const
	Shows the strips tessellation setting. More...

virtual HPS::Type	Type () const
	This function returns the true type of the underlying object. More...

virtual void	Reset ()
	Resets this object to its initial, uninitialized state. More...

bool	HasType (HPS::Type in_mask) const
	This function indicates whether this Object has the given Type mask. More...

intptr_t	GetClassID () const
	Returns a unique identifier that is shared by all objects of the same class. More...

intptr_t	GetInstanceID () const
	Returns an identifier that can be used to identify which instance of a class an object is. More...

Static Public Member Functions
static FacetTessellationKit	GetDefault ()
	Creates an FacetTessellationKit which contains the default settings. More...

template<typename T >
static intptr_t	ClassID ()
	Unique identifier for this class. More...

Static Public Attributes
static const HPS::Type	staticType = HPS::Type::ParasolidFacetTessellationKit

Detailed Description

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.

Constructor & Destructor Documentation

◆ FacetTessellationKit() [1/3]

HPS::Parasolid::FacetTessellationKit::FacetTessellationKit ( )

The default constructor creates an empty FacetTessellationKit object.

◆ FacetTessellationKit() [2/3]

HPS::Parasolid::FacetTessellationKit::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.

◆ FacetTessellationKit() [3/3]

HPS::Parasolid::FacetTessellationKit::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()

virtual HPS::Parasolid::FacetTessellationKit::~FacetTessellationKit ( )

virtual

Member Function Documentation

◆ ClassID()

template<typename T >

static intptr_t HPS::Object::ClassID ( )

inlinestaticinherited

Unique identifier for this class.

Note: this method uses construction of static objects. If used in a constructor, it should be used in the body not the initializer list.

◆ Empty()

bool HPS::Parasolid::FacetTessellationKit::Empty ( ) const

virtual

Indicates whether this FacetTessellationKit has any values set on it.

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

Reimplemented from HPS::Object.

◆ Equals()

bool HPS::Parasolid::FacetTessellationKit::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.

◆ GetClassID()

intptr_t HPS::Object::GetClassID ( ) const

inherited

Returns a unique identifier that is shared by all objects of the same class.

Returns: A unique value shared by all objects of the same class.

◆ GetDefault()

static FacetTessellationKit HPS::Parasolid::FacetTessellationKit::GetDefault ( )

static

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.

◆ GetInstanceID()

intptr_t HPS::Object::GetInstanceID ( ) const

inherited

Returns an identifier that can be used to identify which instance of a class an object is.

Different keys and controls will return the same value if they are backed by the same database resource.

Returns: A value unique to an instance of an object and all objects that are backed by the same database resource.

◆ HasType()

bool HPS::Object::HasType ( HPS::Type in_mask ) const

inherited

This function indicates whether this Object has the given Type mask.

Parameters

in_mask The Type mask to check against this Object.

Returns: true if this Object has the given Type mask, false otherwise.

◆ ObjectType()

HPS::Type HPS::Parasolid::FacetTessellationKit::ObjectType ( ) const

inlinevirtual

Reimplemented from HPS::SprocketKit.

Here is the call graph for this function:

◆ operator!=()

bool HPS::Parasolid::FacetTessellationKit::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.

◆ operator=() [1/2]

FacetTessellationKit& HPS::Parasolid::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.

◆ operator=() [2/2]

FacetTessellationKit& HPS::Parasolid::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.

◆ operator==()

bool HPS::Parasolid::FacetTessellationKit::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.

◆ Reset()

virtual void HPS::Object::Reset ( )

virtualinherited

Resets this object to its initial, uninitialized state.

Reimplemented in HPS::EventHandler, HPS::EventDispatcher, HPS::World, HPS::HighlightSearchResults, HPS::HighlightSearchResultsIterator, HPS::SelectionResults, HPS::SelectionResultsIterator, HPS::FontSearchResults, HPS::FontSearchResultsIterator, HPS::SearchResults, and HPS::SearchResultsIterator.

◆ Set()

void HPS::Parasolid::FacetTessellationKit::Set ( FacetTessellationKit const & in_kit )

Copies the source FacetTessellationKit into this FacetTessellationKit.

Parameters

in_kit The source FacetTessellationKit to copy.

◆ SetChordTolerance()

FacetTessellationKit& HPS::Parasolid::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.

◆ SetDegeneracyBehavior()

FacetTessellationKit& HPS::Parasolid::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.

◆ SetDensity()

FacetTessellationKit& HPS::Parasolid::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.

◆ SetEdges()

FacetTessellationKit& HPS::Parasolid::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.

◆ SetFacetPlaneTolerance()

FacetTessellationKit& HPS::Parasolid::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.

◆ SetFacetSize()

FacetTessellationKit& HPS::Parasolid::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.

◆ SetFlattenVertices()

FacetTessellationKit& HPS::Parasolid::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.

◆ SetIgnoreCriteria()

FacetTessellationKit& HPS::Parasolid::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.

◆ SetIgnoredLoops()

FacetTessellationKit& HPS::Parasolid::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.

◆ SetImprovedFacetQuality()

FacetTessellationKit& HPS::Parasolid::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.

◆ SetIncrementalFaceting()

FacetTessellationKit& HPS::Parasolid::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.

◆ SetInflection()

FacetTessellationKit& HPS::Parasolid::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.

◆ SetLocalTolerances()

FacetTessellationKit& HPS::Parasolid::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.

◆ SetNormals()

FacetTessellationKit& HPS::Parasolid::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.

◆ SetOffsetFaces()

FacetTessellationKit& HPS::Parasolid::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.

◆ SetParameters()

FacetTessellationKit& HPS::Parasolid::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.

◆ SetShapeGeneration()

FacetTessellationKit& HPS::Parasolid::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.

◆ SetStrips()

FacetTessellationKit& HPS::Parasolid::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.

◆ SetSurfacePlaneTolerance()

FacetTessellationKit& HPS::Parasolid::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.

◆ SetTessellationLevel()

FacetTessellationKit& HPS::Parasolid::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.

◆ SetVertexMatching()

FacetTessellationKit& HPS::Parasolid::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.

◆ SetWireEdges()

FacetTessellationKit& HPS::Parasolid::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.

◆ Show()

void HPS::Parasolid::FacetTessellationKit::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.

◆ ShowChordTolerance()

bool HPS::Parasolid::FacetTessellationKit::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.

◆ ShowDegeneracyBehavior()

bool HPS::Parasolid::FacetTessellationKit::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.

◆ ShowDensity()

bool HPS::Parasolid::FacetTessellationKit::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.

◆ ShowEdges()

bool HPS::Parasolid::FacetTessellationKit::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.

◆ ShowFacetPlaneTolerance()

bool HPS::Parasolid::FacetTessellationKit::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.

◆ ShowFacetSize()

bool HPS::Parasolid::FacetTessellationKit::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.

◆ ShowFlattenVertices()

bool HPS::Parasolid::FacetTessellationKit::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.

◆ ShowIgnoreCriteria()

bool HPS::Parasolid::FacetTessellationKit::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.

◆ ShowIgnoredLoops()

bool HPS::Parasolid::FacetTessellationKit::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.

◆ ShowImprovedFacetQuality()

bool HPS::Parasolid::FacetTessellationKit::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.

◆ ShowIncrementalFaceting()

bool HPS::Parasolid::FacetTessellationKit::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.

◆ ShowInflection()

bool HPS::Parasolid::FacetTessellationKit::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.

◆ ShowLocalTolerances()

bool HPS::Parasolid::FacetTessellationKit::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.

◆ ShowNormals()

bool HPS::Parasolid::FacetTessellationKit::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.

◆ ShowOffsetFaces()

bool HPS::Parasolid::FacetTessellationKit::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.

◆ ShowParameters()

bool HPS::Parasolid::FacetTessellationKit::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.

◆ ShowShapeGeneration()

bool HPS::Parasolid::FacetTessellationKit::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.

◆ ShowStrips()

bool HPS::Parasolid::FacetTessellationKit::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.

◆ ShowSurfacePlaneTolerance()

bool HPS::Parasolid::FacetTessellationKit::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.

◆ ShowTessellationLevel()

bool HPS::Parasolid::FacetTessellationKit::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.

◆ ShowVertexMatching()

bool HPS::Parasolid::FacetTessellationKit::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.

◆ ShowWireEdges()

bool HPS::Parasolid::FacetTessellationKit::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.

◆ Type()

virtual HPS::Type HPS::Object::Type ( ) const

virtualinherited

This function returns the true type of the underlying object.

This function is useful for finding the type of smart pointer objects that have been cast to more generic types.

Returns: The true type of the object in question.

◆ UnsetChordTolerance()

FacetTessellationKit& HPS::Parasolid::FacetTessellationKit::UnsetChordTolerance ( )

Removes the chord tolerance tessellation state.

Returns: A reference to this FacetTessellationKit.

◆ UnsetDegeneracyBehavior()

FacetTessellationKit& HPS::Parasolid::FacetTessellationKit::UnsetDegeneracyBehavior ( )

Removes the degeneracy tessellation state.

Returns: A reference to this FacetTessellationKit.

◆ UnsetDensity()

FacetTessellationKit& HPS::Parasolid::FacetTessellationKit::UnsetDensity ( )

Removes the density tessellation state.

Returns: A reference to this FacetTessellationKit.

◆ UnsetEdges()

FacetTessellationKit& HPS::Parasolid::FacetTessellationKit::UnsetEdges ( )

Removes the edges tessellation state.

Returns: A reference to this FacetTessellationKit.

◆ UnsetEverything()

FacetTessellationKit& HPS::Parasolid::FacetTessellationKit::UnsetEverything ( )

Removes all settings from this FacetTessellationKit.

Returns: A reference to this FacetTessellationKit.

◆ UnsetFacetPlaneTolerance()

FacetTessellationKit& HPS::Parasolid::FacetTessellationKit::UnsetFacetPlaneTolerance ( )

Removes the facet plane tolerance tessellation state.

Returns: A reference to this FacetTessellationKit.

◆ UnsetFacetSize()

FacetTessellationKit& HPS::Parasolid::FacetTessellationKit::UnsetFacetSize ( )

Removes the facet size tessellation state.

Returns: A reference to this FacetTessellationKit.

◆ UnsetFlattenVertices()

FacetTessellationKit& HPS::Parasolid::FacetTessellationKit::UnsetFlattenVertices ( )

Removes the vertex flattening tessellation state.

Returns: A reference to this FacetTessellationKit.

◆ UnsetIgnoreCriteria()

FacetTessellationKit& HPS::Parasolid::FacetTessellationKit::UnsetIgnoreCriteria ( )

Removes the ignore criteria tessellation state.

Returns: A reference to this FacetTessellationKit.

◆ UnsetIgnoredLoops()

FacetTessellationKit& HPS::Parasolid::FacetTessellationKit::UnsetIgnoredLoops ( )

Removes the ignored loops tessellation state.

Returns: A reference to this FacetTessellationKit.

◆ UnsetImprovedFacetQuality()

FacetTessellationKit& HPS::Parasolid::FacetTessellationKit::UnsetImprovedFacetQuality ( )

Removes the facet quality tessellation state.

Returns: A reference to this FacetTessellationKit.

◆ UnsetIncrementalFaceting()

FacetTessellationKit& HPS::Parasolid::FacetTessellationKit::UnsetIncrementalFaceting ( )

Removes the incremental faceting tessellation state.

Returns: A reference to this FacetTessellationKit.

◆ UnsetInflection()

FacetTessellationKit& HPS::Parasolid::FacetTessellationKit::UnsetInflection ( )

Removes the inflection tessellation state.

Returns: A reference to this FacetTessellationKit.

◆ UnsetLocalTolerances()

FacetTessellationKit& HPS::Parasolid::FacetTessellationKit::UnsetLocalTolerances ( )

Removes the local tolerances tessellation state.

Returns: A reference to this FacetTessellationKit.

◆ UnsetNormals()

FacetTessellationKit& HPS::Parasolid::FacetTessellationKit::UnsetNormals ( )

Removes the normals tessellation state.

Returns: A reference to this FacetTessellationKit.

◆ UnsetOffsetFaces()

FacetTessellationKit& HPS::Parasolid::FacetTessellationKit::UnsetOffsetFaces ( )

Removes the offset faces tessellation state.

Returns: A reference to this FacetTessellationKit.

◆ UnsetParameters()

FacetTessellationKit& HPS::Parasolid::FacetTessellationKit::UnsetParameters ( )

Removes the parameters tessellation state.

Returns: A reference to this FacetTessellationKit.

◆ UnsetShapeGeneration()

FacetTessellationKit& HPS::Parasolid::FacetTessellationKit::UnsetShapeGeneration ( )

Removes the shape generation tessellation state.

Returns: A reference to this FacetTessellationKit.

◆ UnsetStrips()

FacetTessellationKit& HPS::Parasolid::FacetTessellationKit::UnsetStrips ( )

Removes the strip tessellation state.

Returns: A reference to this FacetTessellationKit.

◆ UnsetSurfacePlaneTolerance()

FacetTessellationKit& HPS::Parasolid::FacetTessellationKit::UnsetSurfacePlaneTolerance ( )

Removes the plane tolerance tessellation state.

Returns: A reference to this FacetTessellationKit.

◆ UnsetTessellationLevel()

FacetTessellationKit& HPS::Parasolid::FacetTessellationKit::UnsetTessellationLevel ( )

Removes the tessellation level state.

Returns: A reference to this FacetTessellationKit.

◆ UnsetVertexMatching()

FacetTessellationKit& HPS::Parasolid::FacetTessellationKit::UnsetVertexMatching ( )

Removes the vertex matching tessellation state.

Returns: A reference to this FacetTessellationKit.

◆ UnsetWireEdges()

FacetTessellationKit& HPS::Parasolid::FacetTessellationKit::UnsetWireEdges ( )

Removes the wire edges tessellation state.

Returns: A reference to this FacetTessellationKit.

Member Data Documentation

◆ staticType

const HPS::Type HPS::Parasolid::FacetTessellationKit::staticType = HPS::Type::ParasolidFacetTessellationKit

static

The documentation for this class was generated from the following file:

sprk_parasolid.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ FacetTessellationKit() [1/3]

◆ FacetTessellationKit() [2/3]

◆ FacetTessellationKit() [3/3]

◆ ~FacetTessellationKit()

Member Function Documentation

◆ ClassID()

◆ Empty()

◆ Equals()

◆ GetClassID()

◆ GetDefault()

◆ GetInstanceID()

◆ HasType()

◆ ObjectType()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ Reset()

◆ Set()

◆ SetChordTolerance()

◆ SetDegeneracyBehavior()

◆ SetDensity()

◆ SetEdges()

◆ SetFacetPlaneTolerance()

◆ SetFacetSize()

◆ SetFlattenVertices()

◆ SetIgnoreCriteria()

◆ SetIgnoredLoops()

◆ SetImprovedFacetQuality()

◆ SetIncrementalFaceting()

◆ SetInflection()

◆ SetLocalTolerances()

◆ SetNormals()

◆ SetOffsetFaces()

◆ SetParameters()

◆ SetShapeGeneration()

◆ SetStrips()

◆ SetSurfacePlaneTolerance()

◆ SetTessellationLevel()

◆ SetVertexMatching()

◆ SetWireEdges()

◆ Show()

◆ ShowChordTolerance()

◆ ShowDegeneracyBehavior()

◆ ShowDensity()

◆ ShowEdges()

◆ ShowFacetPlaneTolerance()

◆ ShowFacetSize()

◆ ShowFlattenVertices()

◆ ShowIgnoreCriteria()

◆ ShowIgnoredLoops()

◆ ShowImprovedFacetQuality()

◆ ShowIncrementalFaceting()

◆ ShowInflection()

◆ ShowLocalTolerances()

◆ ShowNormals()

◆ ShowOffsetFaces()

◆ ShowParameters()

◆ ShowShapeGeneration()

◆ ShowStrips()

◆ ShowSurfacePlaneTolerance()

◆ ShowTessellationLevel()

◆ ShowVertexMatching()

◆ ShowWireEdges()

◆ Type()

◆ UnsetChordTolerance()

◆ UnsetDegeneracyBehavior()

◆ UnsetDensity()

◆ UnsetEdges()

◆ UnsetEverything()

◆ UnsetFacetPlaneTolerance()

◆ UnsetFacetSize()

◆ UnsetFlattenVertices()

◆ UnsetIgnoreCriteria()

◆ UnsetIgnoredLoops()