API Search || Global Search

More...

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

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 Indicates whether this ImportOptionsKit has any values set on it. More...
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.DWG.ImportOptionsKit in_kit)
 Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit. More...
 
override int GetHashCode ()
 
 ImportOptionsKit ()
 The default constructor creates an empty ImportOptionsKit object. More...
 
 ImportOptionsKit (HPS.DWG.ImportOptionsKit in_kit)
 The copy constructor creates a new ImportOptionsKit object that contains the same settings as the source ImportOptionsKit. More...
 
override HPS.Type ObjectType ()
 
void Set (HPS.DWG.ImportOptionsKit in_kit)
 Copies the source ImportOptionsKit into this ImportOptionsKit. More...
 
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() More...
 
HPS.DWG.ImportOptionsKit SetTextureDirectories (string[] in_texture_directories)
 Sets a list of directories where the importer looks for textures. More...
 
HPS.DWG.ImportOptionsKit SetUnreferencedRecords (bool in_state)
 Sets whether to import block table records which are not referenced in the drawing. More...
 
void Show (out HPS.DWG.ImportOptionsKit out_kit)
 Copies this ImportOptionsKit into the given ImportOptionsKit. More...
 
bool ShowLogging (out string out_log_file)
 Shows the logging import setting. More...
 
bool ShowMaxTessellationDeviation (out double out_deviation)
 Shows the maximum tessellation deviation import setting. More...
 
bool ShowTextureDirectories (out string[] out_texture_directories)
 Shows the directories where the importer looks for textures. More...
 
bool ShowUnreferencedRecords (out bool out_state)
 Shows the unreferenced records import setting. More...
 
HPS.DWG.ImportOptionsKit UnsetEverything ()
 Removes all settings from this ImportOptionsKit. More...
 
HPS.DWG.ImportOptionsKit UnsetLogging ()
 Removes the logging import state. More...
 
HPS.DWG.ImportOptionsKit UnsetMaxTessellationDeviation ()
 Removes the maximum tessellation deviation import state. More...
 
HPS.DWG.ImportOptionsKit UnsetTextureDirectories ()
 Removes the texture directory state. More...
 
HPS.DWG.ImportOptionsKit UnsetUnreferencedRecords ()
 Removes the unreferenced records import state. More...
 
- 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 ()
 Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object that)
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
virtual HPS.Type Type ()
 This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More...
 

Static Public Member Functions

static 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. More...
 
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

HPS.DWG.ImportOptionsKit.ImportOptionsKit ( )
inline

The default constructor creates an empty ImportOptionsKit object.

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

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.

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.
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.
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.
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.
HPS.DWG.ImportOptionsKit HPS.DWG.ImportOptionsKit.SetTextureDirectories ( string[]  in_texture_directories)
inline

Sets a list of directories where the importer looks for textures.

Parameters
in_texture_directoriesAn array of directories the importer searches for textures.
Returns
    A reference to this ImportOptionsKit.
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.
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.
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.
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.
bool HPS.DWG.ImportOptionsKit.ShowTextureDirectories ( out string[]  out_texture_directories)
inline

Shows the directories where the importer looks for textures.

Parameters
out_texture_directoriesThe directories in which the importer looks for textures.
Returns
    true if texture directories were specified, false otherwise.
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.
HPS.DWG.ImportOptionsKit HPS.DWG.ImportOptionsKit.UnsetEverything ( )
inline

Removes all settings from this ImportOptionsKit.

Returns
    A reference to this ImportOptionsKit.
HPS.DWG.ImportOptionsKit HPS.DWG.ImportOptionsKit.UnsetLogging ( )
inline

Removes the logging import state.

Returns
    A reference to this ImportOptionsKit.
HPS.DWG.ImportOptionsKit HPS.DWG.ImportOptionsKit.UnsetMaxTessellationDeviation ( )
inline

Removes the maximum tessellation deviation import state.

Returns
    A reference to this ImportOptionsKit.
HPS.DWG.ImportOptionsKit HPS.DWG.ImportOptionsKit.UnsetTextureDirectories ( )
inline

Removes the texture directory state.

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