Inheritance diagram for HPS.DWG.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.DWG.ImportOptionsKit in_kit)
 
override int GetHashCode ()
 
 ImportOptionsKit ()
 
 ImportOptionsKit (HPS.DWG.ImportOptionsKit in_kit)
 
override HPS.Type ObjectType ()
 
void Set (HPS.DWG.ImportOptionsKit in_kit)
 
HPS.DWG.ImportOptionsKit SetLogging (string in_log_file)
 
HPS.DWG.ImportOptionsKit SetMaxTessellationDeviation (double in_deviation)
 
HPS.DWG.ImportOptionsKit SetTextureDirectories (string[] in_texture_directories)
 
HPS.DWG.ImportOptionsKit SetUnreferencedRecords (bool in_state)
 
void Show (out HPS.DWG.ImportOptionsKit out_kit)
 
bool ShowLogging (out string out_log_file)
 
bool ShowMaxTessellationDeviation (out double out_deviation)
 
bool ShowTextureDirectories (out string[] out_texture_directories)
 
bool ShowUnreferencedRecords (out bool out_state)
 
HPS.DWG.ImportOptionsKit UnsetEverything ()
 
HPS.DWG.ImportOptionsKit UnsetLogging ()
 
HPS.DWG.ImportOptionsKit UnsetMaxTessellationDeviation ()
 
HPS.DWG.ImportOptionsKit UnsetTextureDirectories ()
 
HPS.DWG.ImportOptionsKit UnsetUnreferencedRecords ()
 
- 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.DWG.ImportOptionsKit GetDefault ()
 
static bool operator!= (HPS.DWG.ImportOptionsKit a, HPS.DWG.ImportOptionsKit b)
 
static bool operator== (HPS.DWG.ImportOptionsKit a, HPS.DWG.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 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.

Constructor & Destructor Documentation

◆ ImportOptionsKit() [1/2]

HPS.DWG.ImportOptionsKit.ImportOptionsKit ( )
inline

The default constructor creates an empty ImportOptionsKit object.

◆ ImportOptionsKit() [2/2]

HPS.DWG.ImportOptionsKit.ImportOptionsKit ( HPS.DWG.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.DWG.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.DWG.ImportOptionsKit.Equals ( HPS.DWG.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.DWG.ImportOptionsKit HPS.DWG.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.DWG.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.DWG.ImportOptionsKit.Set ( HPS.DWG.ImportOptionsKit  in_kit)
inline

Copies the source ImportOptionsKit into this ImportOptionsKit.

Parameters
in_kitThe source ImportOptionsKit to copy.

◆ SetMaxTessellationDeviation()

HPS.DWG.ImportOptionsKit HPS.DWG.ImportOptionsKit.SetMaxTessellationDeviation ( double  in_deviation)
inline

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

Parameters
in_deviationMaximum deviation from tessellation.
Returns
A reference to this ImportOptionsKit.

◆ SetUnreferencedRecords()

HPS.DWG.ImportOptionsKit HPS.DWG.ImportOptionsKit.SetUnreferencedRecords ( bool  in_state)
inline

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

Parameters
in_stateWhether to import block table records which are not referenced in the drawing.
Returns
A reference to this ImportOptionsKit.

◆ Show()

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

Copies this ImportOptionsKit into the given ImportOptionsKit.

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

◆ ShowLogging()

bool HPS.DWG.ImportOptionsKit.ShowLogging ( out string  out_log_file)
inline

Shows the logging import setting.

Parameters
out_log_fileThe file which will contain the logging information.
Returns
true if logging setting was specified, false otherwise.

◆ ShowMaxTessellationDeviation()

bool HPS.DWG.ImportOptionsKit.ShowMaxTessellationDeviation ( out double  out_deviation)
inline

Shows the maximum tessellation deviation import setting.

Parameters
out_deviationThe maximum tessellation deviation setting for this import.
Returns
true if a maximum tessellation deviation was specified, false otherwise.

◆ ShowUnreferencedRecords()

bool HPS.DWG.ImportOptionsKit.ShowUnreferencedRecords ( out bool  out_state)
inline

Shows the unreferenced records import setting.

Parameters
out_stateThe unreferenced record setting for this import.
Returns
true if an unreferenced record setting was specified, false otherwise.

◆ UnsetEverything()

HPS.DWG.ImportOptionsKit HPS.DWG.ImportOptionsKit.UnsetEverything ( )
inline

Removes all settings from this ImportOptionsKit.

Returns
A reference to this ImportOptionsKit.

◆ UnsetLogging()

HPS.DWG.ImportOptionsKit HPS.DWG.ImportOptionsKit.UnsetLogging ( )
inline

Removes the logging import state.

Returns
A reference to this ImportOptionsKit.

◆ UnsetMaxTessellationDeviation()

HPS.DWG.ImportOptionsKit HPS.DWG.ImportOptionsKit.UnsetMaxTessellationDeviation ( )
inline

Removes the maximum tessellation deviation import state.

Returns
A reference to this ImportOptionsKit.

◆ UnsetTextureDirectories()

HPS.DWG.ImportOptionsKit HPS.DWG.ImportOptionsKit.UnsetTextureDirectories ( )
inline

Removes the texture directory state.

Returns
A reference to this ImportOptionsKit.

◆ UnsetUnreferencedRecords()

HPS.DWG.ImportOptionsKit HPS.DWG.ImportOptionsKit.UnsetUnreferencedRecords ( )
inline

Removes the unreferenced records import state.

Returns
A reference to this ImportOptionsKit.

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