HPS::DWG::ImportOptionsKit

class HPS.DWG.ImportOptionsKit : public HPS.SprocketKit

The HPS.DWG.ImportOptionsKit class is a user space object. It contains settings controlling what and how data is imported via DWG. Calling HPS.DWG.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.DWG.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.DWG.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.DWG.ImportOptionsKit in_kit)

Copies the source ImportOptionsKit into this ImportOptionsKit.

Param in_kit

The source ImportOptionsKit to copy.

HPS.DWG.ImportOptionsKit SetLogging (string in_log_file)

HPS.DWG.ImportOptionsKit SetMaxTessellationDeviation (double in_deviation)

Sets the maximum tessellation deviation. This corresponds to the value returned by AcGiCommonDraw.deviation()

Param in_deviation

Maximum deviation from tessellation.

Return

A reference to this ImportOptionsKit.

HPS.DWG.ImportOptionsKit SetTextureDirectories (string[] in_texture_directories)

HPS.DWG.ImportOptionsKit SetUnreferencedRecords (bool in_state)

Sets whether to import block table records which are not referenced in the drawing.

Param in_state

Whether to import block table records which are not referenced in the drawing.

Return

A reference to this ImportOptionsKit.

void Show (out HPS.DWG.ImportOptionsKit out_kit)

Copies this ImportOptionsKit into the given ImportOptionsKit.

Param out_kit

The ImportOptionsKit to populate with the contents of this ImportOptionsKit.

bool ShowLogging (out string out_log_file)

Shows the logging import setting.

Param out_log_file

The file which will contain the logging information.

Return

true if logging setting was specified, false otherwise.

bool ShowMaxTessellationDeviation (out double out_deviation)

Shows the maximum tessellation deviation import setting.

Param out_deviation

The maximum tessellation deviation setting for this import.

Return

true if a maximum tessellation deviation was specified, false otherwise.

bool ShowTextureDirectories (out string[] out_texture_directories)

bool ShowUnreferencedRecords (out bool out_state)

Shows the unreferenced records import setting.

Param out_state

The unreferenced record setting for this import.

Return

true if an unreferenced record setting was specified, false otherwise.

HPS.DWG.ImportOptionsKit UnsetEverything ()

Removes all settings from this ImportOptionsKit.

Return

A reference to this ImportOptionsKit.

HPS.DWG.ImportOptionsKit UnsetLogging ()

Removes the logging import state.

Return

A reference to this ImportOptionsKit.

HPS.DWG.ImportOptionsKit UnsetMaxTessellationDeviation ()

Removes the maximum tessellation deviation import state.

Return

A reference to this ImportOptionsKit.

HPS.DWG.ImportOptionsKit UnsetTextureDirectories ()

Removes the texture directory state.

Return

A reference to this ImportOptionsKit.

HPS.DWG.ImportOptionsKit UnsetUnreferencedRecords ()

Removes the unreferenced records import state.

Return

A reference to this ImportOptionsKit.

Public Static Functions

HPS.DWG.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.DWG.ImportOptionsKit a, HPS.DWG.ImportOptionsKit b)

bool operator== (HPS.DWG.ImportOptionsKit a, HPS.DWG.ImportOptionsKit b)