HPS::DWG::ImportOptionsKit Class Reference

#include <sprk_dwg.h>

Inheritance diagram for HPS::DWG::ImportOptionsKit:

Public Member Functions
bool	Empty () const
bool	Equals (ImportOptionsKit const &in_kit) const
	ImportOptionsKit ()
	ImportOptionsKit (ImportOptionsKit const &in_kit)
	ImportOptionsKit (ImportOptionsKit &&in_that)
HPS::Type	ObjectType () const
bool	operator!= (ImportOptionsKit const &in_kit) const
ImportOptionsKit &	operator= (ImportOptionsKit &&in_that)
ImportOptionsKit &	operator= (ImportOptionsKit const &in_kit)
bool	operator== (ImportOptionsKit const &in_kit) const
void	Set (ImportOptionsKit const &in_kit)
ImportOptionsKit &	SetLogging (const char *in_log_file)
ImportOptionsKit &	SetMaxTessellationDeviation (double in_deviation)
ImportOptionsKit &	SetTextureDirectories (HPS::UTF8Array const &in_texture_directories)
ImportOptionsKit &	SetUnreferencedRecords (bool in_state)
void	Show (ImportOptionsKit &out_kit) const
bool	ShowLogging (HPS::UTF8 &out_log_file) const
bool	ShowMaxTessellationDeviation (double &out_deviation) const
bool	ShowTextureDirectories (HPS::UTF8Array &out_texture_directories) const
bool	ShowUnreferencedRecords (bool &out_state) const
ImportOptionsKit &	UnsetEverything ()
ImportOptionsKit &	UnsetLogging ()
ImportOptionsKit &	UnsetMaxTessellationDeviation ()
ImportOptionsKit &	UnsetTextureDirectories ()
ImportOptionsKit &	UnsetUnreferencedRecords ()
Public Member Functions inherited from HPS::Sprocket
	Sprocket (Sprocket &&in_that)
Public Member Functions inherited from HPS::Object
intptr_t	GetClassID () const
intptr_t	GetInstanceID () const
bool	HasType (HPS::Type in_mask) const
	Object (Object const &that)
	Object (Object &&in_that)
Object &	operator= (Object const &other_object)
Object &	operator= (Object &&in_that)
virtual void	Reset ()
virtual HPS::Type	Type () const

Static Public Member Functions
static ImportOptionsKit	GetDefault ()
Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t	ClassID ()

Static Public Attributes
static const HPS::Type	staticType = HPS::Type::DWGImportOptionsKit
Static Public Attributes inherited from HPS::SprocketKit
static const HPS::Type	staticType = HPS::Type::SprocketKit
Static Public Attributes inherited from HPS::Object
static const HPS::Type	staticType = HPS::Type::None

Additional Inherited Members
Protected Member Functions inherited from HPS::SprocketKit
SprocketKit &	operator= (SprocketKit &&in_that)
	SprocketKit (SprocketKit &&in_that)

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

HPS::DWG::ImportOptionsKit::ImportOptionsKit

(

)

The default constructor creates an empty ImportOptionsKit object.

ImportOptionsKit() [2/3]

HPS::DWG::ImportOptionsKit::ImportOptionsKit

(

ImportOptionsKit const &

in_kit

)

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

Parameters

in_kit

The source ImportOptionsKit to copy.

ImportOptionsKit() [3/3]

HPS::DWG::ImportOptionsKit::ImportOptionsKit

(

ImportOptionsKit &&

in_that

)

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

in_that

An rvalue reference to an ImportOptionsKit to take the impl from.

Member Function Documentation

Empty()

bool HPS::DWG::ImportOptionsKit::Empty ( ) const

virtual

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

(

ImportOptionsKit const &

in_kit

)

const

Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit.

Parameters

in_kit

The source ImportOptionsKit to compare to this ImportOptionsKit.

Returns

true if the objects are equivalent, false otherwise.

GetDefault()

static ImportOptionsKit HPS::DWG::ImportOptionsKit::GetDefault ( )

static

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

Check if the source ImportOptionsKit is not equivalent to this ImportOptionsKit.

Parameters

in_kit

The source ImportOptionsKit to compare to this ImportOptionsKit.

Returns

true if the objects are not equivalent, false otherwise.

operator=() [1/2]

ImportOptionsKit& HPS::DWG::ImportOptionsKit::operator=

(

ImportOptionsKit &&

in_that

)

The move assignment operator transfers the underlying impl of the rvalue reference to this ImportOptionsKit thereby avoiding a copy.

Parameters

in_that

An rvalue reference to an ImportOptionsKit to take the impl from.

Returns

A reference to this ImportOptionsKit.

operator=() [2/2]

ImportOptionsKit& HPS::DWG::ImportOptionsKit::operator=

(

ImportOptionsKit const &

in_kit

)

Copies the source ImportOptionsKit into this ImportOptionsKit.

Parameters

in_kit

The source ImportOptionsKit to copy.

Returns

A reference to this ImportOptionsKit.

operator==()

bool HPS::DWG::ImportOptionsKit::operator==

(

ImportOptionsKit const &

in_kit

)

const

Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit.

Parameters

in_kit

The source ImportOptionsKit to compare to this ImportOptionsKit.

Returns

true if the objects are equivalent, false otherwise.

Set()

void HPS::DWG::ImportOptionsKit::Set

(

ImportOptionsKit const &

in_kit

)

Copies the source ImportOptionsKit into this ImportOptionsKit.

Parameters

in_kit

The source ImportOptionsKit to copy.

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

ImportOptionsKit& HPS::DWG::ImportOptionsKit::SetTextureDirectories

(

HPS::UTF8Array const &

in_texture_directories

)

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

void HPS::DWG::ImportOptionsKit::Show

(

ImportOptionsKit &

out_kit

)

const

Copies this ImportOptionsKit into the given ImportOptionsKit.

Parameters

out_kit

The ImportOptionsKit to populate with the contents of this ImportOptionsKit.

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

ImportOptionsKit& HPS::DWG::ImportOptionsKit::UnsetEverything

(

)

Removes all settings from this ImportOptionsKit.

Returns

A reference to this ImportOptionsKit.

UnsetLogging()

ImportOptionsKit& HPS::DWG::ImportOptionsKit::UnsetLogging

(

)

Removes the logging import state.

Returns

A reference to this ImportOptionsKit.

UnsetMaxTessellationDeviation()

ImportOptionsKit& HPS::DWG::ImportOptionsKit::UnsetMaxTessellationDeviation

(

)

Removes the maximum tessellation deviation import state.

Returns

A reference to this ImportOptionsKit.

UnsetTextureDirectories()

ImportOptionsKit& HPS::DWG::ImportOptionsKit::UnsetTextureDirectories

(

)

Removes the texture directory state.

Returns

A reference to this ImportOptionsKit.

UnsetUnreferencedRecords()

ImportOptionsKit& HPS::DWG::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:

• include/sprk_dwg.h