The HPS::Exchange::ModelFileImportOptionsKit class is a user space object. More...

#include <sprk_exchange.h>

Inheritance diagram for HPS::Exchange::ModelFileImportOptionsKit:

Collaboration diagram for HPS::Exchange::ModelFileImportOptionsKit:

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

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

	ModelFileImportOptionsKit (ModelFileImportOptionsKit &&in_that)
	The move constructor creates an ModelFileImportOptionsKit by transferring the underlying impl of the rvalue reference to this ModelFileImportOptionsKit thereby avoiding a copy and allocation. More...

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

virtual	~ModelFileImportOptionsKit ()

HPS::Type	ObjectType () const

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

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

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

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

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

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

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

ModelFileImportOptionsKit &	SetPMIFlipping (bool in_flip)

ModelFileImportOptionsKit &	SetTessellationLevel (Tessellation::Level in_level)
	Sets the predefined quality of the tessellation that will be generated for BRep data. More...

ModelFileImportOptionsKit &	SetTessellationLevel (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. More...

ModelFileImportOptionsKit &	SetTessellationAccuracy (Tessellation::Accuracy in_type, bool in_accurate_normals=true)
	Sets the accuracy of the tessellation that will be generated for BRep data. More...

ModelFileImportOptionsKit &	SetTessellationCleanup (bool in_cleanup)

ModelFileImportOptionsKit &	SetTessellationPreservesUVPoints (bool in_state)
	Sets whether to keep parametric points as texture coordinates when generating the tessellation for BRep data. More...

ModelFileImportOptionsKit &	SetTessellationMaximumEdgeLength (double in_length)
	Sets the maximum length of triangle edges in the tessellation generated for BRep data. More...

ModelFileImportOptionsKit &	SetIFCEdges (bool in_state)
	Sets whether to import edges for IFC files When this is set to false the import time will decrease. More...

ModelFileImportOptionsKit &	SetAnnotationCaptureFitting (AnnotationCaptureFitting in_fitting)
	Sets the type of data that should be used to generate the camera for annotation captures. More...

ModelFileImportOptionsKit &	SetLocation (ComponentPath const &in_path, MatrixKit const &in_transform=MatrixKit())
	Sets where to insert the imported file in an existing Component hieararchy. More...

ModelFileImportOptionsKit &	SetSewingTolerance (double in_tolerance)
	The sewing tolerance to use on the A3DAsmModelFile prior to generating the scene graph. More...

ModelFileImportOptionsKit &	SetNURBSConversion (HPS::Exchange::NURBSConversionOptionsKit const &in_nurbs_conversion_options)
	Converts the curves and surfaces of the model file according to the options specified. More...

ModelFileImportOptionsKit &	SetGeometryDefaultColor (RGBAColor const &in_color)
	Sets the color to use for non-PMI geometry in the CAD file if none is specified. More...

ModelFileImportOptionsKit &	UnsetTessellationLevel ()
	Removes the tessellation level setting. More...

ModelFileImportOptionsKit &	UnsetTessellationAccuracy ()
	Removes the tessellation accuracy setting. More...

ModelFileImportOptionsKit &	UnsetTessellationCleanup ()
	Removes the tessellation cleanup setting. More...

ModelFileImportOptionsKit &	UnsetPMIFlipping ()
	Removes the pmi flipping setting. More...

ModelFileImportOptionsKit &	UnsetTessellationPreservesUVPoints ()
	Removes the tessellation UV preservation setting. More...

ModelFileImportOptionsKit &	UnsetTessellationMaximumEdgeLength ()
	Removes the tessellation maximum edge length setting. More...

ModelFileImportOptionsKit &	UnsetIFCEdges ()
	Removes the IFC edges setting. More...

ModelFileImportOptionsKit &	UnsetAnnotationCaptureFitting ()
	Removes the annotation capture fitting setting. More...

ModelFileImportOptionsKit &	UnsetLocation ()
	Removes the location setting. More...

ModelFileImportOptionsKit &	UnsetSewingTolerance ()
	Removes the sewing tolerance setting. More...

ModelFileImportOptionsKit &	UnsetNURBSConversion ()
	Removes the NURBS conversion setting. More...

ModelFileImportOptionsKit &	UnsetGeometryDefaultColor ()
	Removes the geometry default color setting. More...

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

bool	ShowTessellationLevel (Tessellation::Type &out_type, Tessellation::Level &out_level, Tessellation::Chord::Limit &out_limit_type, double &out_limit, double &out_angle_tolerance) const
	Shows the tessellation level setting. More...

bool	ShowTessellationAccuracy (Tessellation::Accuracy &out_type, bool &out_accurate_normals) const
	Shows the tessellation accuracy setting. More...

bool	ShowTessellationCleanup (bool &out_cleanup) const
	Shows the tessellation cleanup setting. More...

bool	ShowPMIFlipping (bool &out_pmi_flipping) const
	Shows the pmi flipping setting. More...

bool	ShowTessellationPreservesUVPoints (bool &out_state) const
	Shows the tessellation UV preservation setting. More...

bool	ShowTessellationMaximumEdgeLength (double &out_length) const
	Shows the tessellation maximum edge length setting. More...

bool	ShowIFCEdges (bool &out_state) const
	Shows the IFC edges setting. More...

bool	ShowAnnotationCaptureFitting (AnnotationCaptureFitting &out_fitting) const
	Shows the annotation capture fitting setting. More...

bool	ShowLocation (ComponentPath &out_path, MatrixKit &out_transform) const
	Shows the location setting. More...

bool	ShowSewingTolerance (double &out_tolerance) const
	Shows the sewing tolerance setting. More...

bool	ShowNURBSConversion (HPS::Exchange::NURBSConversionOptionsKit &out_nurbs_conversion_options) const
	Shows the NURBS conversion setting. More...

bool	ShowGeometryDefaultColor (RGBAColor &out_color) const
	Shows the geometry default color 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 ModelFileImportOptionsKit	GetDefault ()
	Creates an ModelFileImportOptionsKit 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::ExchangeModelFileImportOptionsKit

Detailed Description

The HPS::Exchange::ModelFileImportOptionsKit class is a user space object.

It contains settings (potentially) controlling how data is imported via Exchange. This particular options kit is used when importing an A3DAsmModelFile directly (see Exchange::File::Import(void*,const ModelFileImportOptionsKit&)) and as such the options will only be used if the A3DAsmModelFile permits (e.g., tessellation options will only be used if tessellation needs to be generated and the A3DAsmModelFile has BRep data). Calling HPS::Exchange::ModelFileImportOptionsKit::GetDefault() will return an options kit with values found in here.

Constructor & Destructor Documentation

◆ ModelFileImportOptionsKit() [1/3]

HPS::Exchange::ModelFileImportOptionsKit::ModelFileImportOptionsKit ( )

The default constructor creates an empty ModelFileImportOptionsKit object.

◆ ModelFileImportOptionsKit() [2/3]

HPS::Exchange::ModelFileImportOptionsKit::ModelFileImportOptionsKit ( ModelFileImportOptionsKit const & in_kit )

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

Parameters

in_kit The source ModelFileImportOptionsKit to copy.

◆ ModelFileImportOptionsKit() [3/3]

HPS::Exchange::ModelFileImportOptionsKit::ModelFileImportOptionsKit ( ModelFileImportOptionsKit && in_that )

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

Parameters

in_that An rvalue reference to an ModelFileImportOptionsKit to take the impl from.

◆ ~ModelFileImportOptionsKit()

virtual HPS::Exchange::ModelFileImportOptionsKit::~ModelFileImportOptionsKit ( )

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::Exchange::ModelFileImportOptionsKit::Empty ( ) const

virtual

Indicates whether this ModelFileImportOptionsKit has any values set on it.

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

Reimplemented from HPS::Object.

◆ Equals()

bool HPS::Exchange::ModelFileImportOptionsKit::Equals ( ModelFileImportOptionsKit const & in_kit ) const

Check if the source ModelFileImportOptionsKit is equivalent to this ModelFileImportOptionsKit.

Parameters

in_kit The source ModelFileImportOptionsKit to compare to this ModelFileImportOptionsKit.

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 ModelFileImportOptionsKit HPS::Exchange::ModelFileImportOptionsKit::GetDefault ( )

static

Creates an ModelFileImportOptionsKit 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::Import(void*,const ModelFileImportOptionsKit&).

Returns: A ModelFileImportOptionsKit 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::Exchange::ModelFileImportOptionsKit::ObjectType ( ) const

inlinevirtual

Reimplemented from HPS::SprocketKit.

Here is the call graph for this function:

◆ operator!=()

bool HPS::Exchange::ModelFileImportOptionsKit::operator!= ( ModelFileImportOptionsKit const & in_kit ) const

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

Parameters

in_kit The source ModelFileImportOptionsKit to compare to this ModelFileImportOptionsKit.

Returns: true if the objects are not equivalent, false otherwise.

◆ operator=() [1/2]

ModelFileImportOptionsKit& HPS::Exchange::ModelFileImportOptionsKit::operator= ( ModelFileImportOptionsKit && in_that )

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

Parameters

in_that An rvalue reference to an ModelFileImportOptionsKit to take the impl from.

Returns: A reference to this ModelFileImportOptionsKit.

◆ operator=() [2/2]

ModelFileImportOptionsKit& HPS::Exchange::ModelFileImportOptionsKit::operator= ( ModelFileImportOptionsKit const & in_kit )

Copies the source ModelFileImportOptionsKit into this ModelFileImportOptionsKit.

Parameters

in_kit The source ModelFileImportOptionsKit to copy.

Returns: A reference to this ModelFileImportOptionsKit.

◆ operator==()

bool HPS::Exchange::ModelFileImportOptionsKit::operator== ( ModelFileImportOptionsKit const & in_kit ) const

Check if the source ModelFileImportOptionsKit is equivalent to this ModelFileImportOptionsKit.

Parameters

in_kit The source ModelFileImportOptionsKit to compare to this ModelFileImportOptionsKit.

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::Exchange::ModelFileImportOptionsKit::Set ( ModelFileImportOptionsKit const & in_kit )

Copies the source ModelFileImportOptionsKit into this ModelFileImportOptionsKit.

Parameters

in_kit The source ModelFileImportOptionsKit to copy.

◆ SetAnnotationCaptureFitting()

ModelFileImportOptionsKit& HPS::Exchange::ModelFileImportOptionsKit::SetAnnotationCaptureFitting ( AnnotationCaptureFitting in_fitting )

Sets the type of data that should be used to generate the camera for annotation captures.

Parameters

in_fitting The type of fitting to use for annotation captures.

Returns: A reference to this ModelFileImportOptionsKit.

◆ SetGeometryDefaultColor()

ModelFileImportOptionsKit& HPS::Exchange::ModelFileImportOptionsKit::SetGeometryDefaultColor ( RGBAColor const & in_color )

Sets the color to use for non-PMI geometry in the CAD file if none is specified.

Parameters

in_color The color to use for non-PMI geometry in the CAD file if none is specified.

Returns: A reference to this ModelFileImportOptionsKit.

See also: SetPMIDefaultColor

◆ SetIFCEdges()

ModelFileImportOptionsKit& HPS::Exchange::ModelFileImportOptionsKit::SetIFCEdges ( bool in_state )

Sets whether to import edges for IFC files When this is set to false the import time will decrease.

It is still possible to achieve visual fidelity by turning on hard edge visibility.

Parameters

in_state Whether to import edges for an IFC file.

Returns: A reference to this ModelFileImportOptionsKit.

See also: Default value

◆ SetLocation()

ModelFileImportOptionsKit& HPS::Exchange::ModelFileImportOptionsKit::SetLocation	(	ComponentPath const &	in_path,
		MatrixKit const &	in_transform = `MatrixKit()`
	)

Sets where to insert the imported file in an existing Component hieararchy.

If this option is not set, a new CADModel will be created for the imported file. If this option is specified, the underlying PRC data of the existing CADModel will be modified to include the imported file and the data will be imported into the specified location in the existing Component hierarchy and its corresponding scene graph.

Parameters

in_path The path describing the location to insert the imported file into. This path must either terminate at a CADModel or a Component corresponding to an A3DAsmProductOccurrence. Note that if the imported file is added along a component path with attributes specified in the PRC data, the components added to the existing PRC data will also inherit those attributes. Note also that if the path is just a CADModel, a new A3DAsmModelFile underyling the CADModel must be created to include both the existing product occurrences and the new product occurrences. This new A3DAsmModelFile will be owned by the CADModel being imported into (see CADModel::GetEntityOwnership), but the existing A3DAsmModelFile will still need to be cleaned up via A3DAsmModelFileDelete since it was not owned by the CADModel.

in_transform A transform to apply to the components being added to the existing CADModel. This transform will also be added to the underlying PRC data. Defaults to an identity transform.

Returns: A reference to this ImportOptionsKit.

◆ SetNURBSConversion()

ModelFileImportOptionsKit& HPS::Exchange::ModelFileImportOptionsKit::SetNURBSConversion ( HPS::Exchange::NURBSConversionOptionsKit const & in_nurbs_conversion_options )

Converts the curves and surfaces of the model file according to the options specified.

Parameters

in_nurbs_conversion_options The options to use during conversion

Returns: A reference to this ModelFileImportOptionsKit.

◆ SetPMIFlipping()

ModelFileImportOptionsKit& HPS::Exchange::ModelFileImportOptionsKit::SetPMIFlipping ( bool in_flip )

◆ SetSewingTolerance()

ModelFileImportOptionsKit& HPS::Exchange::ModelFileImportOptionsKit::SetSewingTolerance ( double in_tolerance )

The sewing tolerance to use on the A3DAsmModelFile prior to generating the scene graph.

If this option is set, prior to generating the scene graph, the A3DAsmModelFile will be passed to A3DAsmModelFileSew with this tolerance.

Parameters

in_tolerance The sewing tolerance to use on the A3DAsmModelFile.

Returns: A reference to this ModelFileImportOptionsKit.

◆ SetTessellationAccuracy()

ModelFileImportOptionsKit& HPS::Exchange::ModelFileImportOptionsKit::SetTessellationAccuracy	(	Tessellation::Accuracy	in_type,
		bool	in_accurate_normals = `true`
	)

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. This correspond to the (negated) value that will be passed to A3DRWParamsTessellationData::m_bDoNotComputeNormalsInAccurateTessellation.

Returns: A reference to this ModelFileImportOptionsKit.

See also: Default value

◆ SetTessellationCleanup()

ModelFileImportOptionsKit& HPS::Exchange::ModelFileImportOptionsKit::SetTessellationCleanup ( bool in_cleanup )

◆ SetTessellationLevel() [1/2]

ModelFileImportOptionsKit& HPS::Exchange::ModelFileImportOptionsKit::SetTessellationLevel ( 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 ModelFileImportOptionsKit.

See also: Default value

◆ SetTessellationLevel() [2/2]

ModelFileImportOptionsKit& HPS::Exchange::ModelFileImportOptionsKit::SetTessellationLevel	(	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 ModelFileImportOptionsKit.

◆ SetTessellationMaximumEdgeLength()

ModelFileImportOptionsKit& HPS::Exchange::ModelFileImportOptionsKit::SetTessellationMaximumEdgeLength ( 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 ModelFileImportOptionsKit.

See also: Default value

◆ SetTessellationPreservesUVPoints()

ModelFileImportOptionsKit& HPS::Exchange::ModelFileImportOptionsKit::SetTessellationPreservesUVPoints ( 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 ModelFileImportOptionsKit.

See also: Default value

◆ Show()

void HPS::Exchange::ModelFileImportOptionsKit::Show ( ModelFileImportOptionsKit & out_kit ) const

Copies this ModelFileImportOptionsKit into the given ModelFileImportOptionsKit.

Parameters

out_kit The ModelFileImportOptionsKit to populate with the contents of this ModelFileImportOptionsKit.

◆ ShowAnnotationCaptureFitting()

bool HPS::Exchange::ModelFileImportOptionsKit::ShowAnnotationCaptureFitting ( AnnotationCaptureFitting & out_fitting ) const

Shows the annotation capture fitting setting.

Parameters

out_fitting The type of fitting to use for annotation captures.

Returns: true if an annotation capture fitting setting was specified, false otherwise.

◆ ShowGeometryDefaultColor()

bool HPS::Exchange::ModelFileImportOptionsKit::ShowGeometryDefaultColor ( RGBAColor & out_color ) const

Shows the geometry default color setting.

Parameters

out_color The geometry default color setting.

Returns: true if a geometry default color setting was specified, false otherwise.

◆ ShowIFCEdges()

bool HPS::Exchange::ModelFileImportOptionsKit::ShowIFCEdges ( bool & out_state ) const

Shows the IFC edges setting.

Parameters

out_state Whether to import edges for an IFC file.

Returns: true if an IFC edge setting was specified, false otherwise.

◆ ShowLocation()

bool HPS::Exchange::ModelFileImportOptionsKit::ShowLocation	(	ComponentPath &	out_path,
		MatrixKit &	out_transform
	)		const

Shows the location setting.

Parameters

out_path	The path describing the location to insert the imported file into.
out_transform	The transform to apply to the components being added to the existing CADModel.

Returns: true if a location setting was specified, false otherwise.

◆ ShowNURBSConversion()

bool HPS::Exchange::ModelFileImportOptionsKit::ShowNURBSConversion ( HPS::Exchange::NURBSConversionOptionsKit & out_nurbs_conversion_options ) const

Shows the NURBS conversion setting.

Parameters

out_nurbs_conversion_options The options to be used during the conversion.

Returns: true if NURBS conversion setting was specified, false otherwise.

◆ ShowPMIFlipping()

bool HPS::Exchange::ModelFileImportOptionsKit::ShowPMIFlipping ( bool & out_pmi_flipping ) const

Shows the pmi flipping setting.

Parameters

out_pmi_flipping The pmi flipping setting that was specified.

Returns: true if a pmi flipping setting was specified, false otherwise.

◆ ShowSewingTolerance()

bool HPS::Exchange::ModelFileImportOptionsKit::ShowSewingTolerance ( double & out_tolerance ) const

Shows the sewing tolerance setting.

Parameters

out_tolerance The sewing tolerance to use on the A3DAsmModelFile prior to generating the scene graph.

Returns: true if a sewing tolerance setting was specified, false otherwise.

◆ ShowTessellationAccuracy()

bool HPS::Exchange::ModelFileImportOptionsKit::ShowTessellationAccuracy	(	Tessellation::Accuracy &	out_type,
		bool &	out_accurate_normals
	)		const

Shows the tessellation accuracy setting.

Parameters

out_type	The type of the tessellation accuracy which was specified.
out_accurate_normals	Whether to compute surface normals when performing accurate tessellation. This only applies if out_type is Tessellation::Accuracy::Accurate.

Returns: true if a tessellation accuracy setting was specified, false otherwise.

◆ ShowTessellationCleanup()

bool HPS::Exchange::ModelFileImportOptionsKit::ShowTessellationCleanup ( bool & out_cleanup ) const

Shows the tessellation cleanup setting.

Parameters

out_cleanup The tesselation cleanup setting that was specified.

Returns: true if a tessellation cleanup setting was specified, false otherwise.

◆ ShowTessellationLevel()

bool HPS::Exchange::ModelFileImportOptionsKit::ShowTessellationLevel	(	Tessellation::Type &	out_type,
		Tessellation::Level &	out_level,
		Tessellation::Chord::Limit &	out_limit_type,
		double &	out_limit,
		double &	out_angle_tolerance
	)		const

Shows the tessellation level setting.

Parameters

out_type	The type of the tessellation 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 tessellation level setting was specified, false otherwise.

◆ ShowTessellationMaximumEdgeLength()

bool HPS::Exchange::ModelFileImportOptionsKit::ShowTessellationMaximumEdgeLength ( double & out_length ) const

Shows the tessellation maximum edge length setting.

Parameters

out_length The tessellation maximum edge length setting.

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

◆ ShowTessellationPreservesUVPoints()

bool HPS::Exchange::ModelFileImportOptionsKit::ShowTessellationPreservesUVPoints ( bool & out_state ) const

Shows the tessellation 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 tessellation UV preservation 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.

◆ UnsetAnnotationCaptureFitting()

ModelFileImportOptionsKit& HPS::Exchange::ModelFileImportOptionsKit::UnsetAnnotationCaptureFitting ( )

Removes the annotation capture fitting setting.

Returns: A reference to this ModelFileImportOptionsKit.

◆ UnsetEverything()

ModelFileImportOptionsKit& HPS::Exchange::ModelFileImportOptionsKit::UnsetEverything ( )

Removes all settings from this ModelFileImportOptionsKit.

Returns: A reference to this ModelFileImportOptionsKit.

◆ UnsetGeometryDefaultColor()

ModelFileImportOptionsKit& HPS::Exchange::ModelFileImportOptionsKit::UnsetGeometryDefaultColor ( )

Removes the geometry default color setting.

Returns: A reference to this ModelFileImportOptionsKit.

◆ UnsetIFCEdges()

ModelFileImportOptionsKit& HPS::Exchange::ModelFileImportOptionsKit::UnsetIFCEdges ( )

Removes the IFC edges setting.

Returns: A reference to this ModelFileImportOptionsKit.

◆ UnsetLocation()

ModelFileImportOptionsKit& HPS::Exchange::ModelFileImportOptionsKit::UnsetLocation ( )

Removes the location setting.

Returns: A reference to this ModelFileImportOptionsKit.

◆ UnsetNURBSConversion()

ModelFileImportOptionsKit& HPS::Exchange::ModelFileImportOptionsKit::UnsetNURBSConversion ( )

Removes the NURBS conversion setting.

Returns: A reference to this ModelFileImportOptionsKit.

◆ UnsetPMIFlipping()

ModelFileImportOptionsKit& HPS::Exchange::ModelFileImportOptionsKit::UnsetPMIFlipping ( )

Removes the pmi flipping setting.

Returns: A reference to this ImportOptionsKit.

◆ UnsetSewingTolerance()

ModelFileImportOptionsKit& HPS::Exchange::ModelFileImportOptionsKit::UnsetSewingTolerance ( )

Removes the sewing tolerance setting.

Returns: A reference to this ModelFileImportOptionsKit.

◆ UnsetTessellationAccuracy()

ModelFileImportOptionsKit& HPS::Exchange::ModelFileImportOptionsKit::UnsetTessellationAccuracy ( )

Removes the tessellation accuracy setting.

Returns: A reference to this ModelFileImportOptionsKit.

◆ UnsetTessellationCleanup()

ModelFileImportOptionsKit& HPS::Exchange::ModelFileImportOptionsKit::UnsetTessellationCleanup ( )

Removes the tessellation cleanup setting.

Returns: A reference to this ImportOptionsKit.

◆ UnsetTessellationLevel()

ModelFileImportOptionsKit& HPS::Exchange::ModelFileImportOptionsKit::UnsetTessellationLevel ( )

Removes the tessellation level setting.

Returns: A reference to this ModelFileImportOptionsKit.

◆ UnsetTessellationMaximumEdgeLength()

ModelFileImportOptionsKit& HPS::Exchange::ModelFileImportOptionsKit::UnsetTessellationMaximumEdgeLength ( )

Removes the tessellation maximum edge length setting.

Returns: A reference to this ModelFileImportOptionsKit.

◆ UnsetTessellationPreservesUVPoints()

ModelFileImportOptionsKit& HPS::Exchange::ModelFileImportOptionsKit::UnsetTessellationPreservesUVPoints ( )

Removes the tessellation UV preservation setting.

Returns: A reference to this ModelFileImportOptionsKit.

Member Data Documentation

◆ staticType

const HPS::Type HPS::Exchange::ModelFileImportOptionsKit::staticType = HPS::Type::ExchangeModelFileImportOptionsKit

static

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

sprk_exchange.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ModelFileImportOptionsKit() [1/3]

◆ ModelFileImportOptionsKit() [2/3]

◆ ModelFileImportOptionsKit() [3/3]

◆ ~ModelFileImportOptionsKit()

Member Function Documentation

◆ ClassID()

◆ Empty()

◆ Equals()

◆ GetClassID()

◆ GetDefault()

◆ GetInstanceID()

◆ HasType()

◆ ObjectType()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ Reset()

◆ Set()

◆ SetAnnotationCaptureFitting()

◆ SetGeometryDefaultColor()

◆ SetIFCEdges()

◆ SetLocation()

◆ SetNURBSConversion()

◆ SetPMIFlipping()

◆ SetSewingTolerance()

◆ SetTessellationAccuracy()

◆ SetTessellationCleanup()

◆ SetTessellationLevel() [1/2]

◆ SetTessellationLevel() [2/2]

◆ SetTessellationMaximumEdgeLength()

◆ SetTessellationPreservesUVPoints()

◆ Show()

◆ ShowAnnotationCaptureFitting()

◆ ShowGeometryDefaultColor()

◆ ShowIFCEdges()

◆ ShowLocation()

◆ ShowNURBSConversion()

◆ ShowPMIFlipping()

◆ ShowSewingTolerance()

◆ ShowTessellationAccuracy()

◆ ShowTessellationCleanup()

◆ ShowTessellationLevel()

◆ ShowTessellationMaximumEdgeLength()

◆ ShowTessellationPreservesUVPoints()

◆ Type()

◆ UnsetAnnotationCaptureFitting()

◆ UnsetEverything()

◆ UnsetGeometryDefaultColor()

◆ UnsetIFCEdges()

◆ UnsetLocation()

◆ UnsetNURBSConversion()

◆ UnsetPMIFlipping()

◆ UnsetSewingTolerance()

◆ UnsetTessellationAccuracy()

◆ UnsetTessellationCleanup()

◆ UnsetTessellationLevel()

◆ UnsetTessellationMaximumEdgeLength()

◆ UnsetTessellationPreservesUVPoints()

Member Data Documentation

◆ staticType