HPS::DWG::ImportOptionsKit Class Reference

The HPS::DWG::ImportOptionsKit class is a user space object. More...

#include <sprk_dwg.h>

Inheritance diagram for HPS::DWG::ImportOptionsKit:

Collaboration diagram for HPS::DWG::ImportOptionsKit:

Public Member Functions
	ImportOptionsKit ()
	The default constructor creates an empty ImportOptionsKit object. More...
	ImportOptionsKit (ImportOptionsKit const &in_kit)
	The copy constructor creates a new ImportOptionsKit object that contains the same settings as the source ImportOptionsKit. More...
	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. More...
ImportOptionsKit &	operator= (ImportOptionsKit &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this ImportOptionsKit thereby avoiding a copy. More...
virtual	~ImportOptionsKit ()
HPS::Type	ObjectType () const
void	Set (ImportOptionsKit const &in_kit)
	Copies the source ImportOptionsKit into this ImportOptionsKit. More...
void	Show (ImportOptionsKit &out_kit) const
	Copies this ImportOptionsKit into the given ImportOptionsKit. More...
ImportOptionsKit &	operator= (ImportOptionsKit const &in_kit)
	Copies the source ImportOptionsKit into this ImportOptionsKit. More...
bool	Empty () const
	Indicates whether this ImportOptionsKit has any values set on it. More...
bool	Equals (ImportOptionsKit const &in_kit) const
	Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit. More...
bool	operator== (ImportOptionsKit const &in_kit) const
	Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit. More...
bool	operator!= (ImportOptionsKit const &in_kit) const
	Check if the source ImportOptionsKit is not equivalent to this ImportOptionsKit. More...
ImportOptionsKit &	SetMaxTessellationDeviation (double in_deviation)
	Sets the maximum tessellation deviation. More...
ImportOptionsKit &	SetUnreferencedRecords (bool in_state)
	Sets whether to import block table records which are not referenced in the drawing. More...
ImportOptionsKit &	SetLogging (const char *in_log_file)
	Sets whether to log internal HPS::DWG calls. More...
ImportOptionsKit &	SetTextureDirectories (HPS::UTF8Array const &in_texture_directories)
	Sets a list of directories where the importer looks for textures. More...
ImportOptionsKit &	UnsetMaxTessellationDeviation ()
	Removes the maximum tessellation deviation import state. More...
ImportOptionsKit &	UnsetUnreferencedRecords ()
	Removes the unreferenced records import state. More...
ImportOptionsKit &	UnsetLogging ()
	Removes the logging import state. More...
ImportOptionsKit &	UnsetTextureDirectories ()
	Removes the texture directory state. More...
ImportOptionsKit &	UnsetEverything ()
	Removes all settings from this ImportOptionsKit. More...
bool	ShowMaxTessellationDeviation (double &out_deviation) const
	Shows the maximum tessellation deviation import setting. More...
bool	ShowUnreferencedRecords (bool &out_state) const
	Shows the unreferenced records import setting. More...
bool	ShowLogging (HPS::UTF8 &out_log_file) const
	Shows the logging import setting. More...
bool	ShowTextureDirectories (HPS::UTF8Array &out_texture_directories) const
	Shows the directories where the importer looks for textures. More...
virtual HPS::Type	Type () const
	This function returns the true type of the underlying object. More...
virtual void	Reset ()
	Resets this object to its initial, uninitialized state. More...
bool	HasType (HPS::Type in_mask) const
	This function indicates whether this Object has the given Type mask. More...
intptr_t	GetClassID () const
	Returns a unique identifier that is shared by all objects of the same class. More...
intptr_t	GetInstanceID () const
	Returns an identifier that can be used to identify which instance of a class an object is. More...

Static Public Member Functions
static ImportOptionsKit	GetDefault ()
	Creates an ImportOptionsKit which contains the default settings. More...
template<typename T >
static intptr_t	ClassID ()
	Unique identifier for this class. More...

Static Public Attributes
static const HPS::Type	staticType = HPS::Type::DWGImportOptionsKit

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.

~ImportOptionsKit()

virtual HPS::DWG::ImportOptionsKit::~ImportOptionsKit ( )

virtual

Member Function Documentation

ClassID()

template<typename T >

static intptr_t HPS::Object::ClassID ( )

inlinestaticinherited

Unique identifier for this class.

Note: this method uses construction of static objects. If used in a constructor, it should be used in the body not the initializer list.

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.

GetClassID()

intptr_t HPS::Object::GetClassID ( ) const

inherited

Returns a unique identifier that is shared by all objects of the same class.

Returns

A unique value shared by all objects of the same class.

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.

GetInstanceID()

intptr_t HPS::Object::GetInstanceID ( ) const

inherited

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.

Returns

A value unique to an instance of an object and all objects that are backed by the same database resource.

HasType()

bool HPS::Object::HasType ( HPS::Type  in_mask ) const

inherited

This function indicates whether this Object has the given Type mask.

Parameters

in_mask

The Type mask to check against this Object.

Returns

true if this Object has the given Type mask, false otherwise.

ObjectType()

HPS::Type HPS::DWG::ImportOptionsKit::ObjectType ( ) const

inlinevirtual

Reimplemented from HPS::SprocketKit.

Here is the call graph for this function:

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.

Reset()

virtual void HPS::Object::Reset ( )

virtualinherited

Resets this object to its initial, uninitialized state.

Reimplemented in HPS::EventHandler, HPS::EventDispatcher, HPS::World, HPS::HighlightSearchResults, HPS::HighlightSearchResultsIterator, HPS::SelectionResults, HPS::SelectionResultsIterator, HPS::FontSearchResults, HPS::FontSearchResultsIterator, HPS::SearchResults, and HPS::SearchResultsIterator.

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.

Type()

virtual HPS::Type HPS::Object::Type ( ) const

virtualinherited

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.

Returns

The true type of the object in question.

Reimplemented in HPS::UpdateOptionsControl, HPS::HighlightControl, HPS::SelectionOptionsControl, HPS::OffScreenWindowOptionsControl, HPS::ApplicationWindowOptionsControl, HPS::StandAloneWindowOptionsControl, HPS::AttributeLockControl, HPS::WindowInfoControl, HPS::DebuggingControl, HPS::SubwindowControl, HPS::ContourLineControl, HPS::VisualEffectsControl, HPS::TransformMaskControl, HPS::PostProcessEffectsControl, HPS::DrawingAttributeControl, HPS::HiddenLineAttributeControl, HPS::PerformanceControl, HPS::NURBSSurfaceAttributeControl, HPS::ConditionControl, HPS::StyleControl, HPS::PortfolioControl, HPS::MaterialMappingControl, HPS::TextureMatrixControl, HPS::ModellingMatrixControl, HPS::CurveAttributeControl, HPS::EdgeAttributeControl, HPS::LineAttributeControl, HPS::TextAttributeControl, HPS::CuttingSectionAttributeControl, HPS::CylinderAttributeControl, HPS::LightingAttributeControl, HPS::SphereAttributeControl, HPS::MarkerAttributeControl, HPS::CullingControl, HPS::ColorInterpolationControl, HPS::TransparencyControl, HPS::SelectabilityControl, HPS::CameraControl, HPS::VisibilityControl, HPS::BoundingControl, HPS::Kit, and HPS::Control.

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.

Member Data Documentation

staticType

const HPS::Type HPS::DWG::ImportOptionsKit::staticType = HPS::Type::DWGImportOptionsKit

static

---

The documentation for this class was generated from the following file:

• sprk_dwg.h