#include <sprk_parasolid.h>

Inheritance diagram for HPS::Parasolid::ImportOptionsKit:

Public Member Functions
bool	Empty () const

bool	Equals (ImportOptionsKit const &in_kit) const

	ImportOptionsKit ()

	ImportOptionsKit (ImportOptionsKit const &in_kit)

	ImportOptionsKit (ImportOptionsKit &&in_that)

HPS::Type	ObjectType () const

bool	operator!= (ImportOptionsKit const &in_kit) const

ImportOptionsKit &	operator= (ImportOptionsKit &&in_that)

ImportOptionsKit &	operator= (ImportOptionsKit const &in_kit)

bool	operator== (ImportOptionsKit const &in_kit) const

void	Set (ImportOptionsKit const &in_kit)

ImportOptionsKit &	SetAttributeMismatchBehavior (Parasolid::MismatchBehavior in_behavior)

ImportOptionsKit &	SetCompoundBodyBehavior (Parasolid::CompoundBodyBehavior in_behavior)

ImportOptionsKit &	SetFacetTessellation (Parasolid::FacetTessellationKit const &in_facet_tessellation_kit)

ImportOptionsKit &	SetFormat (Parasolid::Format in_format)

ImportOptionsKit &	SetLineTessellation (Parasolid::LineTessellationKit const &in_line_tessellation_kit)

ImportOptionsKit &	SetLocation (ComponentPath const &in_path, MatrixKit const &in_transform=MatrixKit())

ImportOptionsKit &	SetUserFields (bool in_import_user_fields)

void	Show (ImportOptionsKit &out_kit) const

bool	ShowAttributeMismatchBehavior (Parasolid::MismatchBehavior &out_behavior) const

bool	ShowCompoundBodyBehavior (Parasolid::CompoundBodyBehavior &out_behavior) const

bool	ShowFacetTessellation (Parasolid::FacetTessellationKit &out_facet_tessellation) const

bool	ShowFormat (Parasolid::Format &out_format) const

bool	ShowLineTessellation (Parasolid::LineTessellationKit &out_line_tessellation) const

bool	ShowLocation (ComponentPath &out_path, MatrixKit &out_transformation) const

bool	ShowUserFields (bool &out_user_fields) const

ImportOptionsKit &	UnsetAttributeMismatchBehavior ()

ImportOptionsKit &	UnsetCompoundBodyBehavior ()

ImportOptionsKit &	UnsetEverything ()

ImportOptionsKit &	UnsetFacetTessellation ()

ImportOptionsKit &	UnsetFormat ()

ImportOptionsKit &	UnsetLineTessellation ()

ImportOptionsKit &	UnsetLocation ()

ImportOptionsKit &	UnsetUserFields ()

Public Member Functions inherited from HPS::Sprocket
	Sprocket (Sprocket &&in_that)

Public Member Functions inherited from HPS::Object
intptr_t	GetClassID () const

intptr_t	GetInstanceID () const

bool	HasType (HPS::Type in_mask) const

	Object (Object const &that)

	Object (Object &&in_that)

Object &	operator= (Object const &other_object)

Object &	operator= (Object &&in_that)

virtual void	Reset ()

virtual HPS::Type	Type () const

Static Public Member Functions
static ImportOptionsKit	GetDefault ()

Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t	ClassID ()

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

Static Public Attributes inherited from HPS::SprocketKit
static const HPS::Type	staticType = HPS::Type::SprocketKit

Static Public Attributes inherited from HPS::Object
static const HPS::Type	staticType = HPS::Type::None

Additional Inherited Members
Protected Member Functions inherited from HPS::SprocketKit
SprocketKit &	operator= (SprocketKit &&in_that)

	SprocketKit (SprocketKit &&in_that)

Detailed Description

The ImportOptionsKit class is a user space object. It contains settings controlling what and how data is imported via the Parasolid interface. Calling HPS::Parasolid::ImportOptionsKit::GetDefault() will return an options kit with values found in here.

Constructor & Destructor Documentation

◆ ImportOptionsKit() [1/3]

HPS::Parasolid::ImportOptionsKit::ImportOptionsKit ( )

The default constructor creates an empty ImportOptionsKit object.

◆ ImportOptionsKit() [2/3]

HPS::Parasolid::ImportOptionsKit::ImportOptionsKit ( ImportOptionsKit const & in_kit )

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

Parameters

in_kit The source ImportOptionsKit to copy.

◆ ImportOptionsKit() [3/3]

HPS::Parasolid::ImportOptionsKit::ImportOptionsKit ( ImportOptionsKit && in_that )

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

Parameters

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

Member Function Documentation

◆ Empty()

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

virtual

Indicates whether this ImportOptionsKit has any values set on it.

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

Reimplemented from HPS::Object.

◆ Equals()

bool HPS::Parasolid::ImportOptionsKit::Equals ( ImportOptionsKit const & in_kit ) const

Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit.

Parameters

in_kit The source ImportOptionsKit to compare to this ImportOptionsKit.

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

◆ GetDefault()

static ImportOptionsKit HPS::Parasolid::ImportOptionsKit::GetDefault ( )

static

Creates an ImportOptionsKit 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.

Returns: An ImportOptionsKit with the default settings.

◆ ObjectType()

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

inlinevirtual

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

Returns: The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from HPS::SprocketKit.

◆ operator!=()

bool HPS::Parasolid::ImportOptionsKit::operator!= ( ImportOptionsKit const & in_kit ) const

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

Parameters

in_kit The source ImportOptionsKit to compare to this ImportOptionsKit.

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

◆ operator=() [1/2]

ImportOptionsKit& HPS::Parasolid::ImportOptionsKit::operator= ( ImportOptionsKit && in_that )

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

Parameters

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

Returns: A reference to this ImportOptionsKit.

◆ operator=() [2/2]

ImportOptionsKit& HPS::Parasolid::ImportOptionsKit::operator= ( ImportOptionsKit const & in_kit )

Copies the source ImportOptionsKit into this ImportOptionsKit.

Parameters

in_kit The source ImportOptionsKit to copy.

Returns: A reference to this ImportOptionsKit.

◆ operator==()

bool HPS::Parasolid::ImportOptionsKit::operator== ( ImportOptionsKit const & in_kit ) const

Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit.

Parameters

in_kit The source ImportOptionsKit to compare to this ImportOptionsKit.

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

◆ Set()

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

Copies the source ImportOptionsKit into this ImportOptionsKit.

Parameters

in_kit The source ImportOptionsKit to copy.

◆ SetAttributeMismatchBehavior()

ImportOptionsKit& HPS::Parasolid::ImportOptionsKit::SetAttributeMismatchBehavior ( Parasolid::MismatchBehavior in_behavior )

Sets the importer behavior for mismatched attributes.
This corresponds to the value that will be passed to PK_PART_receive_o_t.attdef_mismatch.

Parameters

in_behavior The behavior of the importer when mismatched attributes are found.

Returns: A reference to this ImportOptionsKit.

See also: Default value

◆ SetCompoundBodyBehavior()

ImportOptionsKit& HPS::Parasolid::ImportOptionsKit::SetCompoundBodyBehavior ( Parasolid::CompoundBodyBehavior in_behavior )

Sets the importer behavior for compound bodies.
This corresponds to the value that will be passed to PK_PART_receive_o_t.receive_compound.

Parameters

in_behavior The behavior of the importer when compound bodies are found.

Returns: A reference to this ImportOptionsKit.

See also: Default value

◆ SetFacetTessellation()

ImportOptionsKit& HPS::Parasolid::ImportOptionsKit::SetFacetTessellation ( Parasolid::FacetTessellationKit const & in_facet_tessellation_kit )

Sets the facet tessellation settings used during import This corresponds to the PK_TOPOL_render_facet_o_t struct.

Parameters

in_facet_tessellation_kit The facet tessellation settings used during import

Returns: A reference to this ImportOptionsKit.

◆ SetFormat()

ImportOptionsKit& HPS::Parasolid::ImportOptionsKit::SetFormat ( Parasolid::Format in_format )

Sets the format type to be imported.
This corresponds to the value that will be passed to PK_PART_receive_o_t.transmit_format.

Parameters

in_format The format of the file to be imported.

Returns: A reference to this ImportOptionsKit.

See also: Default value

◆ SetLineTessellation()

ImportOptionsKit& HPS::Parasolid::ImportOptionsKit::SetLineTessellation ( Parasolid::LineTessellationKit const & in_line_tessellation_kit )

Sets the line tessellation settings used during import This corresponds to the PK_TOPOL_render_line_o_t struct.

Parameters

in_facet_tessellation_kit The line tessellation settings used during import

Returns: A reference to this ImportOptionsKit.

◆ SetLocation()

ImportOptionsKit& HPS::Parasolid::ImportOptionsKit::SetLocation	(	ComponentPath const &	in_path,
		MatrixKit const &	in_transform = `MatrixKit()`
	)

Sets where to insert the imported file in an existing Component hierarchy. If this option is not set, a new CADModel will be created for the imported file. If this option is specified, the underlying Parasolid 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. The file will be imported in the same PK_PARTITION_t as the one to which entities in in_path belong.

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 a Parasolid Assembly. Note that if the imported file is added along a ComponentPath with attributes specified in the Parasolid data, the components added to the existing Parasolid data will also inherit those attributes.
in_transform	A transform to apply to the components being added to the existing CADModel. This transform will also be added to the underlying Parasolid data. Valid transformations are limited to translations, rotations, uniform scaling and reflection. If the transform does not conform to these limitations it will be ignored. Defaults to an identity transform.

Returns: A reference to this ImportOptionsKit.

◆ SetUserFields()

ImportOptionsKit& HPS::Parasolid::ImportOptionsKit::SetUserFields ( bool in_import_user_fields )

Sets whether to import user fields from the CAD file.
This corresponds to the value that will be passed to PK_PART_receive_o_t.receive_user_fields.

Parameters

in_import_user_fields Whether to import user fields from the CAD file.

Returns: A reference to this ImportOptionsKit.

See also: Default value

◆ Show()

void HPS::Parasolid::ImportOptionsKit::Show ( ImportOptionsKit & out_kit ) const

Copies this ImportOptionsKit into the given ImportOptionsKit.

Parameters

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

◆ ShowAttributeMismatchBehavior()

bool HPS::Parasolid::ImportOptionsKit::ShowAttributeMismatchBehavior ( Parasolid::MismatchBehavior & out_behavior ) const

Shows the attribute mismatch behavior import setting.

Parameters

out_behavior The attribute mismatch behavior setting for this import.

Returns: true if an attribute mismatch behavior setting was specified, false otherwise.

◆ ShowCompoundBodyBehavior()

bool HPS::Parasolid::ImportOptionsKit::ShowCompoundBodyBehavior ( Parasolid::CompoundBodyBehavior & out_behavior ) const

Shows the compound body behavior import setting.

Parameters

out_behavior The compound body behavior setting for this import.

Returns: true if a compound body behavior setting was specified, false otherwise.

◆ ShowFacetTessellation()

bool HPS::Parasolid::ImportOptionsKit::ShowFacetTessellation ( Parasolid::FacetTessellationKit & out_facet_tessellation ) const

Shows the facet tessellation import setting.

Parameters

out_facet_tessellation The facet tessellation setting for this import.

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

◆ ShowFormat()

bool HPS::Parasolid::ImportOptionsKit::ShowFormat ( Parasolid::Format & out_format ) const

Shows the format import setting.

Parameters

out_format The format setting for this import.

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

◆ ShowLineTessellation()

bool HPS::Parasolid::ImportOptionsKit::ShowLineTessellation ( Parasolid::LineTessellationKit & out_line_tessellation ) const

Shows the line tessellation import setting.

Parameters

out_line_tessellation The line tessellation setting for this import.

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

◆ ShowLocation()

bool HPS::Parasolid::ImportOptionsKit::ShowLocation	(	ComponentPath &	out_path,
		MatrixKit &	out_transformation
	)		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.

◆ ShowUserFields()

bool HPS::Parasolid::ImportOptionsKit::ShowUserFields ( bool & out_user_fields ) const

Shows the user fields import setting.

Parameters

out_user_fields The user fields setting for this import.

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

◆ UnsetAttributeMismatchBehavior()

ImportOptionsKit& HPS::Parasolid::ImportOptionsKit::UnsetAttributeMismatchBehavior ( )

Removes the attribute mismatch behavior state.

Returns: A reference to this ImportOptionsKit.

◆ UnsetCompoundBodyBehavior()

ImportOptionsKit& HPS::Parasolid::ImportOptionsKit::UnsetCompoundBodyBehavior ( )

Removes the compound body behavior state.

Returns: A reference to this ImportOptionsKit.

◆ UnsetEverything()

ImportOptionsKit& HPS::Parasolid::ImportOptionsKit::UnsetEverything ( )

Removes all settings from this ImportOptionsKit.

Returns: A reference to this ImportOptionsKit.

◆ UnsetFacetTessellation()

ImportOptionsKit& HPS::Parasolid::ImportOptionsKit::UnsetFacetTessellation ( )

Removes the facet tessellation state.

Returns: A reference to this ImportOptionsKit.

◆ UnsetFormat()

ImportOptionsKit& HPS::Parasolid::ImportOptionsKit::UnsetFormat ( )

Removes the format import state.

Returns: A reference to this ImportOptionsKit.

◆ UnsetLineTessellation()

ImportOptionsKit& HPS::Parasolid::ImportOptionsKit::UnsetLineTessellation ( )

Removes the line tessellation state.

Returns: A reference to this ImportOptionsKit.

◆ UnsetLocation()

ImportOptionsKit& HPS::Parasolid::ImportOptionsKit::UnsetLocation ( )

Removes the location state.

Returns: A reference to this ImportOptionsKit.

◆ UnsetUserFields()

ImportOptionsKit& HPS::Parasolid::ImportOptionsKit::UnsetUserFields ( )

Removes the user fields import state.

Returns: A reference to this ImportOptionsKit.

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

include/sprk_parasolid.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ImportOptionsKit() [1/3]

◆ ImportOptionsKit() [2/3]

◆ ImportOptionsKit() [3/3]

Member Function Documentation

◆ Empty()

◆ Equals()

◆ GetDefault()

◆ ObjectType()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ Set()

◆ SetAttributeMismatchBehavior()

◆ SetCompoundBodyBehavior()

◆ SetFacetTessellation()

◆ SetFormat()

◆ SetLineTessellation()

◆ SetLocation()

◆ SetUserFields()

◆ Show()

◆ ShowAttributeMismatchBehavior()

◆ ShowCompoundBodyBehavior()

◆ ShowFacetTessellation()

◆ ShowFormat()

◆ ShowLineTessellation()

◆ ShowLocation()

◆ ShowUserFields()

◆ UnsetAttributeMismatchBehavior()

◆ UnsetCompoundBodyBehavior()

◆ UnsetEverything()

◆ UnsetFacetTessellation()

◆ UnsetFormat()

◆ UnsetLineTessellation()

◆ UnsetLocation()

◆ UnsetUserFields()