#include <sprk_dwg.h>
|
static const HPS::Type | staticType = HPS::Type::DWGImportOptionsKit |
|
static const HPS::Type | staticType = HPS::Type::SprocketKit |
|
static const HPS::Type | staticType = HPS::Type::None |
|
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.
◆ ImportOptionsKit() [1/3]
HPS::DWG::ImportOptionsKit::ImportOptionsKit |
( |
| ) |
|
◆ ImportOptionsKit() [2/3]
◆ ImportOptionsKit() [3/3]
The move constructor creates an ImportOptionsKit by transferring the underlying impl of the rvalue reference to this ImportOptionsKit thereby avoiding a copy and allocation.
- Parameters
-
◆ Empty()
bool HPS::DWG::ImportOptionsKit::Empty |
( |
| ) |
const |
|
virtual |
◆ Equals()
bool HPS::DWG::ImportOptionsKit::Equals |
( |
ImportOptionsKit const & |
in_kit | ) |
const |
◆ 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.
- Returns
- An ImportOptionsKit with the default settings.
◆ ObjectType()
HPS::Type HPS::DWG::ImportOptionsKit::ObjectType |
( |
| ) |
const |
|
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.
◆ operator!=()
bool HPS::DWG::ImportOptionsKit::operator!= |
( |
ImportOptionsKit const & |
in_kit | ) |
const |
◆ operator=() [1/2]
The move assignment operator transfers the underlying impl of the rvalue reference to this ImportOptionsKit thereby avoiding a copy.
- Parameters
-
- Returns
- A reference to this ImportOptionsKit.
◆ operator=() [2/2]
◆ operator==()
bool HPS::DWG::ImportOptionsKit::operator== |
( |
ImportOptionsKit const & |
in_kit | ) |
const |
◆ Set()
◆ SetLogging()
ImportOptionsKit& HPS::DWG::ImportOptionsKit::SetLogging |
( |
const char * |
in_log_file | ) |
|
Sets whether to log internal HPS::DWG calls.
- Parameters
-
in_log_file | File name which will contain logging information. |
- Returns
- A reference to this ImportOptionsKit.
◆ SetMaxTessellationDeviation()
ImportOptionsKit& HPS::DWG::ImportOptionsKit::SetMaxTessellationDeviation |
( |
double |
in_deviation | ) |
|
Sets the maximum tessellation deviation. This corresponds to the value returned by AcGiCommonDraw::deviation()
- Parameters
-
in_deviation | Maximum deviation from tessellation. |
- Returns
- A reference to this ImportOptionsKit.
◆ SetTextureDirectories()
Sets a list of directories where the importer looks for textures.
- Parameters
-
in_texture_directories | An array of directories the importer searches for textures. |
- Returns
- A reference to this ImportOptionsKit.
◆ SetUnreferencedRecords()
ImportOptionsKit& HPS::DWG::ImportOptionsKit::SetUnreferencedRecords |
( |
bool |
in_state | ) |
|
Sets whether to import block table records which are not referenced in the drawing.
- Parameters
-
in_state | Whether to import block table records which are not referenced in the drawing. |
- Returns
- A reference to this ImportOptionsKit.
◆ Show()
◆ ShowLogging()
bool HPS::DWG::ImportOptionsKit::ShowLogging |
( |
HPS::UTF8 & |
out_log_file | ) |
const |
Shows the logging import setting.
- Parameters
-
out_log_file | The file which will contain the logging information. |
- Returns
- true if logging setting was specified, false otherwise.
◆ ShowMaxTessellationDeviation()
bool HPS::DWG::ImportOptionsKit::ShowMaxTessellationDeviation |
( |
double & |
out_deviation | ) |
const |
Shows the maximum tessellation deviation import setting.
- Parameters
-
out_deviation | The maximum tessellation deviation setting for this import. |
- Returns
- true if a maximum tessellation deviation was specified, false otherwise.
◆ ShowTextureDirectories()
bool HPS::DWG::ImportOptionsKit::ShowTextureDirectories |
( |
HPS::UTF8Array & |
out_texture_directories | ) |
const |
Shows the directories where the importer looks for textures.
- Parameters
-
out_texture_directories | The directories in which the importer looks for textures. |
- Returns
- true if texture directories were specified, false otherwise.
◆ ShowUnreferencedRecords()
bool HPS::DWG::ImportOptionsKit::ShowUnreferencedRecords |
( |
bool & |
out_state | ) |
const |
Shows the unreferenced records import setting.
- Parameters
-
out_state | The unreferenced record setting for this import. |
- Returns
- true if an unreferenced record setting was specified, false otherwise.
◆ UnsetEverything()
◆ UnsetLogging()
◆ UnsetMaxTessellationDeviation()
Removes the maximum tessellation deviation import state.
- Returns
- A reference to this ImportOptionsKit.
◆ UnsetTextureDirectories()
Removes the texture directory state.
- Returns
- A reference to this ImportOptionsKit.
◆ UnsetUnreferencedRecords()
Removes the unreferenced records import state.
- Returns
- A reference to this ImportOptionsKit.
The documentation for this class was generated from the following file: