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

override void Dispose ()

override bool Empty ()

Indicates whether this ImportOptionsKit has any values set on it.

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

bool Equals (HPS.Parasolid.ImportOptionsKit in_kit)

Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit.

Param in_kit: The source ImportOptionsKit to compare to this ImportOptionsKit.
Return: true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

override int GetHashCode ()

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

ImportOptionsKit (HPS.Parasolid.ImportOptionsKit in_kit)

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

Param in_kit: The source ImportOptionsKit to copy.

override HPS.Type ObjectType ()

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

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

void Set (HPS.Parasolid.ImportOptionsKit in_kit)

Copies the source ImportOptionsKit into this ImportOptionsKit.

Param in_kit: The source ImportOptionsKit to copy.

HPS.Parasolid.ImportOptionsKit SetAttributeMismatchBehavior (HPS.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

Param in_behavior: The behavior of the importer when mismatched attributes are found.
Return: A reference to this ImportOptionsKit.

HPS.Parasolid.ImportOptionsKit SetCompoundBodyBehavior (HPS.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

Param in_behavior: The behavior of the importer when compound bodies are found.
Return: A reference to this ImportOptionsKit.

HPS.Parasolid.ImportOptionsKit SetFacetTessellation (HPS.Parasolid.FacetTessellationKit in_facet_tessellation_kit)

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

Param in_facet_tessellation_kit: The facet tessellation settings used during import
Return: A reference to this ImportOptionsKit.

HPS.Parasolid.ImportOptionsKit SetFormat (HPS.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

Param in_format: The format of the file to be imported.
Return: A reference to this ImportOptionsKit.

HPS.Parasolid.ImportOptionsKit SetLineTessellation (HPS.Parasolid.LineTessellationKit in_line_tessellation_kit)

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

Return: A reference to this ImportOptionsKit.

HPS.Parasolid.ImportOptionsKit SetLocation (HPS.ComponentPath in_path)

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.

Param 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.
Return: A reference to this ImportOptionsKit.

HPS.Parasolid.ImportOptionsKit SetLocation (HPS.ComponentPath in_path, HPS.MatrixKit in_transform)

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.

Param 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.
Param 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.
Return: A reference to this 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.

See: Default value

Param in_import_user_fields: Whether to import user fields from the CAD file.
Return: A reference to this ImportOptionsKit.

void Show (out HPS.Parasolid.ImportOptionsKit out_kit)

Copies this ImportOptionsKit into the given ImportOptionsKit.

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

bool ShowAttributeMismatchBehavior (out HPS.Parasolid.MismatchBehavior out_behavior)

Shows the attribute mismatch behavior import setting.

Param out_behavior: The attribute mismatch behavior setting for this import.
Return: true if an attribute mismatch behavior setting was specified, false otherwise.

bool ShowCompoundBodyBehavior (out HPS.Parasolid.CompoundBodyBehavior out_behavior)

Shows the compound body behavior import setting.

Param out_behavior: The compound body behavior setting for this import.
Return: true if a compound body behavior setting was specified, false otherwise.

bool ShowFacetTessellation (out HPS.Parasolid.FacetTessellationKit out_facet_tessellation)

Shows the facet tessellation import setting.

Param out_facet_tessellation: The facet tessellation setting for this import.
Return: true if a facet tessellation setting was specified, false otherwise.

bool ShowFormat (out HPS.Parasolid.Format out_format)

Shows the format import setting.

Param out_format: The format setting for this import.
Return: true if a format setting was specified, false otherwise.

bool ShowLineTessellation (out HPS.Parasolid.LineTessellationKit out_line_tessellation)

Shows the line tessellation import setting.

Param out_line_tessellation: The line tessellation setting for this import.
Return: true if a line tessellation setting was specified, false otherwise.

bool ShowLocation (out HPS.ComponentPath out_path, out HPS.MatrixKit out_transformation)

Shows the location setting.

Param out_path: The path describing the location to insert the imported file into.
Return: true if a location setting was specified, false otherwise.

bool ShowUserFields (out bool out_user_fields)

Shows the user fields import setting.

Param out_user_fields: The user fields setting for this import.
Return: true if a user fields setting was specified, false otherwise.

HPS.Parasolid.ImportOptionsKit UnsetAttributeMismatchBehavior ()

Removes the attribute mismatch behavior state.

Return: A reference to this ImportOptionsKit.

HPS.Parasolid.ImportOptionsKit UnsetCompoundBodyBehavior ()

Removes the compound body behavior state.

Return: A reference to this ImportOptionsKit.

HPS.Parasolid.ImportOptionsKit UnsetEverything ()

Removes all settings from this ImportOptionsKit.

Return: A reference to this ImportOptionsKit.

HPS.Parasolid.ImportOptionsKit UnsetFacetTessellation ()

Removes the facet tessellation state.

Return: A reference to this ImportOptionsKit.

HPS.Parasolid.ImportOptionsKit UnsetFormat ()

Removes the format import state.

Return: A reference to this ImportOptionsKit.

HPS.Parasolid.ImportOptionsKit UnsetLineTessellation ()

Removes the line tessellation state.

Return: A reference to this ImportOptionsKit.

HPS.Parasolid.ImportOptionsKit UnsetLocation ()

Removes the location state.

Return: A reference to this ImportOptionsKit.

HPS.Parasolid.ImportOptionsKit UnsetUserFields ()

Removes the user fields import state.

Return: A reference to this ImportOptionsKit.

Public Static Functions

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

Return: An ImportOptionsKit with the default settings.

bool operator!= (HPS.Parasolid.ImportOptionsKit a, HPS.Parasolid.ImportOptionsKit b)

bool operator== (HPS.Parasolid.ImportOptionsKit a, HPS.Parasolid.ImportOptionsKit b)