HPS::Parasolid::ImportOptionsKit

class HPS::Parasolid::ImportOptionsKit : public HPS::SprocketKit

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.

Public Functions

virtual bool Empty() const

Indicates whether this ImportOptionsKit has any values set on it.

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

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

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

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.

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.

inline virtual HPS::Type ObjectType() const

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

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

bool operator!=(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.

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.

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.

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

void Set(ImportOptionsKit const &in_kit)

Copies the source ImportOptionsKit into this ImportOptionsKit.

Parameters: in_kit – The source ImportOptionsKit to copy.

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.

See: Default value

Parameters: in_behavior – The behavior of the importer when mismatched attributes are found.
Returns: A reference to this ImportOptionsKit.

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.

See: Default value

Parameters: in_behavior – The behavior of the importer when compound bodies are found.
Returns: A reference to this ImportOptionsKit.

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.

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.

See: Default value

Parameters: in_format – The format of the file to be imported.
Returns: A reference to this ImportOptionsKit.

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.

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.

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.

See: Default value

Parameters: in_import_user_fields – Whether to import user fields from the CAD file.
Returns: A reference to this ImportOptionsKit.

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

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

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

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

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

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

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

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

ImportOptionsKit &UnsetAttributeMismatchBehavior()

Removes the attribute mismatch behavior state.

Returns: A reference to this ImportOptionsKit.

ImportOptionsKit &UnsetCompoundBodyBehavior()

Removes the compound body behavior state.

Returns: A reference to this ImportOptionsKit.

ImportOptionsKit &UnsetEverything()

Removes all settings from this ImportOptionsKit.

Returns: A reference to this ImportOptionsKit.

ImportOptionsKit &UnsetFacetTessellation()

Removes the facet tessellation state.

Returns: A reference to this ImportOptionsKit.

ImportOptionsKit &UnsetFormat()

Removes the format import state.

Returns: A reference to this ImportOptionsKit.

ImportOptionsKit &UnsetLineTessellation()

Removes the line tessellation state.

Returns: A reference to this ImportOptionsKit.

ImportOptionsKit &UnsetLocation()

Removes the location state.

Returns: A reference to this ImportOptionsKit.

ImportOptionsKit &UnsetUserFields()

Removes the user fields import state.

Returns: A reference to this ImportOptionsKit.

virtual ~ImportOptionsKit()

Public Static Functions

static ImportOptionsKit GetDefault()

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.

Public Static Attributes

static const HPS::Type staticType = HPS::Type::ParasolidImportOptionsKit