Inheritance diagram for HPS.Parasolid.ImportOptionsKit:
HPS.SprocketKit HPS.Sprocket HPS.Object

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Parasolid.ImportOptionsKit in_kit)
 
override int GetHashCode ()
 
 ImportOptionsKit ()
 
 ImportOptionsKit (HPS.Parasolid.ImportOptionsKit in_kit)
 
override HPS.Type ObjectType ()
 
void Set (HPS.Parasolid.ImportOptionsKit in_kit)
 
HPS.Parasolid.ImportOptionsKit SetAttributeMismatchBehavior (HPS.Parasolid.MismatchBehavior in_behavior)
 
HPS.Parasolid.ImportOptionsKit SetCompoundBodyBehavior (HPS.Parasolid.CompoundBodyBehavior in_behavior)
 
HPS.Parasolid.ImportOptionsKit SetFacetTessellation (HPS.Parasolid.FacetTessellationKit in_facet_tessellation_kit)
 
HPS.Parasolid.ImportOptionsKit SetFormat (HPS.Parasolid.Format in_format)
 
HPS.Parasolid.ImportOptionsKit SetLineTessellation (HPS.Parasolid.LineTessellationKit in_line_tessellation_kit)
 
HPS.Parasolid.ImportOptionsKit SetLocation (HPS.ComponentPath in_path, HPS.MatrixKit in_transform)
 
HPS.Parasolid.ImportOptionsKit SetLocation (HPS.ComponentPath in_path)
 
HPS.Parasolid.ImportOptionsKit SetUserFields (bool in_import_user_fields)
 
void Show (out HPS.Parasolid.ImportOptionsKit out_kit)
 
bool ShowAttributeMismatchBehavior (out HPS.Parasolid.MismatchBehavior out_behavior)
 
bool ShowCompoundBodyBehavior (out HPS.Parasolid.CompoundBodyBehavior out_behavior)
 
bool ShowFacetTessellation (out HPS.Parasolid.FacetTessellationKit out_facet_tessellation)
 
bool ShowFormat (out HPS.Parasolid.Format out_format)
 
bool ShowLineTessellation (out HPS.Parasolid.LineTessellationKit out_line_tessellation)
 
bool ShowLocation (out HPS.ComponentPath out_path, out HPS.MatrixKit out_transformation)
 
bool ShowUserFields (out bool out_user_fields)
 
HPS.Parasolid.ImportOptionsKit UnsetAttributeMismatchBehavior ()
 
HPS.Parasolid.ImportOptionsKit UnsetCompoundBodyBehavior ()
 
HPS.Parasolid.ImportOptionsKit UnsetEverything ()
 
HPS.Parasolid.ImportOptionsKit UnsetFacetTessellation ()
 
HPS.Parasolid.ImportOptionsKit UnsetFormat ()
 
HPS.Parasolid.ImportOptionsKit UnsetLineTessellation ()
 
HPS.Parasolid.ImportOptionsKit UnsetLocation ()
 
HPS.Parasolid.ImportOptionsKit UnsetUserFields ()
 
- Public Member Functions inherited from HPS.SprocketKit
SprocketKit (HPS.SprocketKit in_that)
 
- Public Member Functions inherited from HPS.Sprocket
Sprocket (HPS.Sprocket in_that)
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
Object (HPS.Object that)
 
virtual void Reset ()
 
virtual HPS.Type Type ()
 

Static Public Member Functions

static HPS.Parasolid.ImportOptionsKit GetDefault ()
 
static bool operator!= (HPS.Parasolid.ImportOptionsKit a, HPS.Parasolid.ImportOptionsKit b)
 
static bool operator== (HPS.Parasolid.ImportOptionsKit a, HPS.Parasolid.ImportOptionsKit b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

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/2]

HPS.Parasolid.ImportOptionsKit.ImportOptionsKit ( )
inline

The default constructor creates an empty ImportOptionsKit object.

◆ ImportOptionsKit() [2/2]

HPS.Parasolid.ImportOptionsKit.ImportOptionsKit ( HPS.Parasolid.ImportOptionsKit  in_kit)
inline

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

Parameters
in_kitThe source ImportOptionsKit to copy.

Member Function Documentation

◆ Empty()

override bool HPS.Parasolid.ImportOptionsKit.Empty ( )
inlinevirtual

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 ( HPS.Parasolid.ImportOptionsKit  in_kit)
inline

Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit.

Parameters
in_kitThe source ImportOptionsKit to compare to this ImportOptionsKit.
Returns
true if the objects are equivalent, false otherwise.

◆ GetDefault()

static HPS.Parasolid.ImportOptionsKit HPS.Parasolid.ImportOptionsKit.GetDefault ( )
inlinestatic

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

override HPS.Type HPS.Parasolid.ImportOptionsKit.ObjectType ( )
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.

◆ Set()

void HPS.Parasolid.ImportOptionsKit.Set ( HPS.Parasolid.ImportOptionsKit  in_kit)
inline

Copies the source ImportOptionsKit into this ImportOptionsKit.

Parameters
in_kitThe source ImportOptionsKit to copy.

◆ SetAttributeMismatchBehavior()

HPS.Parasolid.ImportOptionsKit HPS.Parasolid.ImportOptionsKit.SetAttributeMismatchBehavior ( HPS.Parasolid.MismatchBehavior  in_behavior)
inline

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_behaviorThe behavior of the importer when mismatched attributes are found.
Returns
A reference to this ImportOptionsKit.
See also
Default value

◆ SetCompoundBodyBehavior()

HPS.Parasolid.ImportOptionsKit HPS.Parasolid.ImportOptionsKit.SetCompoundBodyBehavior ( HPS.Parasolid.CompoundBodyBehavior  in_behavior)
inline

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_behaviorThe behavior of the importer when compound bodies are found.
Returns
A reference to this ImportOptionsKit.
See also
Default value

◆ SetFacetTessellation()

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

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

Parameters
in_facet_tessellation_kitThe facet tessellation settings used during import
Returns
A reference to this ImportOptionsKit.

◆ SetFormat()

HPS.Parasolid.ImportOptionsKit HPS.Parasolid.ImportOptionsKit.SetFormat ( HPS.Parasolid.Format  in_format)
inline

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_formatThe format of the file to be imported.
Returns
A reference to this ImportOptionsKit.
See also
Default value

◆ SetLineTessellation()

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

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

Returns
A reference to this ImportOptionsKit.

◆ SetLocation() [1/2]

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

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_pathThe 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_transformA 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.

◆ SetLocation() [2/2]

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

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_pathThe 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.
Returns
A reference to this ImportOptionsKit.

◆ SetUserFields()

HPS.Parasolid.ImportOptionsKit HPS.Parasolid.ImportOptionsKit.SetUserFields ( bool  in_import_user_fields)
inline

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_fieldsWhether to import user fields from the CAD file.
Returns
A reference to this ImportOptionsKit.
See also
Default value

◆ Show()

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

Copies this ImportOptionsKit into the given ImportOptionsKit.

Parameters
out_kitThe ImportOptionsKit to populate with the contents of this ImportOptionsKit.

◆ ShowAttributeMismatchBehavior()

bool HPS.Parasolid.ImportOptionsKit.ShowAttributeMismatchBehavior ( out HPS.Parasolid.MismatchBehavior  out_behavior)
inline

Shows the attribute mismatch behavior import setting.

Parameters
out_behaviorThe 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 ( out HPS.Parasolid.CompoundBodyBehavior  out_behavior)
inline

Shows the compound body behavior import setting.

Parameters
out_behaviorThe 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 ( out HPS.Parasolid.FacetTessellationKit  out_facet_tessellation)
inline

Shows the facet tessellation import setting.

Parameters
out_facet_tessellationThe facet tessellation setting for this import.
Returns
true if a facet tessellation setting was specified, false otherwise.

◆ ShowFormat()

bool HPS.Parasolid.ImportOptionsKit.ShowFormat ( out HPS.Parasolid.Format  out_format)
inline

Shows the format import setting.

Parameters
out_formatThe format setting for this import.
Returns
true if a format setting was specified, false otherwise.

◆ ShowLineTessellation()

bool HPS.Parasolid.ImportOptionsKit.ShowLineTessellation ( out HPS.Parasolid.LineTessellationKit  out_line_tessellation)
inline

Shows the line tessellation import setting.

Parameters
out_line_tessellationThe line tessellation setting for this import.
Returns
true if a line tessellation setting was specified, false otherwise.

◆ ShowLocation()

bool HPS.Parasolid.ImportOptionsKit.ShowLocation ( out HPS.ComponentPath  out_path,
out HPS.MatrixKit  out_transformation 
)
inline

Shows the location setting.

Parameters
out_pathThe path describing the location to insert the imported file into.
Returns
true if a location setting was specified, false otherwise.

◆ ShowUserFields()

bool HPS.Parasolid.ImportOptionsKit.ShowUserFields ( out bool  out_user_fields)
inline

Shows the user fields import setting.

Parameters
out_user_fieldsThe user fields setting for this import.
Returns
true if a user fields setting was specified, false otherwise.

◆ UnsetAttributeMismatchBehavior()

HPS.Parasolid.ImportOptionsKit HPS.Parasolid.ImportOptionsKit.UnsetAttributeMismatchBehavior ( )
inline

Removes the attribute mismatch behavior state.

Returns
A reference to this ImportOptionsKit.

◆ UnsetCompoundBodyBehavior()

HPS.Parasolid.ImportOptionsKit HPS.Parasolid.ImportOptionsKit.UnsetCompoundBodyBehavior ( )
inline

Removes the compound body behavior state.

Returns
A reference to this ImportOptionsKit.

◆ UnsetEverything()

HPS.Parasolid.ImportOptionsKit HPS.Parasolid.ImportOptionsKit.UnsetEverything ( )
inline

Removes all settings from this ImportOptionsKit.

Returns
A reference to this ImportOptionsKit.

◆ UnsetFacetTessellation()

HPS.Parasolid.ImportOptionsKit HPS.Parasolid.ImportOptionsKit.UnsetFacetTessellation ( )
inline

Removes the facet tessellation state.

Returns
A reference to this ImportOptionsKit.

◆ UnsetFormat()

HPS.Parasolid.ImportOptionsKit HPS.Parasolid.ImportOptionsKit.UnsetFormat ( )
inline

Removes the format import state.

Returns
A reference to this ImportOptionsKit.

◆ UnsetLineTessellation()

HPS.Parasolid.ImportOptionsKit HPS.Parasolid.ImportOptionsKit.UnsetLineTessellation ( )
inline

Removes the line tessellation state.

Returns
A reference to this ImportOptionsKit.

◆ UnsetLocation()

HPS.Parasolid.ImportOptionsKit HPS.Parasolid.ImportOptionsKit.UnsetLocation ( )
inline

Removes the location state.

Returns
A reference to this ImportOptionsKit.

◆ UnsetUserFields()

HPS.Parasolid.ImportOptionsKit HPS.Parasolid.ImportOptionsKit.UnsetUserFields ( )
inline

Removes the user fields import state.

Returns
A reference to this ImportOptionsKit.

The documentation for this class was generated from the following file:
  • internals/hps_sprk_parasolid/source/cs/HPS.Parasolid.cs