HPS::Exchange::ExportIGESOptionsKit Class Reference

The HPS::Exchange::ExportIGESOptionsKit class is a user space object. More...

#include <sprk_exchange.h>

Inheritance diagram for HPS::Exchange::ExportIGESOptionsKit:

Collaboration diagram for HPS::Exchange::ExportIGESOptionsKit:

Public Member Functions
	ExportIGESOptionsKit ()
	The default constructor creates an empty ExportIGESOptionsKit object. More...
	ExportIGESOptionsKit (ExportIGESOptionsKit const &in_kit)
	The copy constructor creates a new ExportIGESOptionsKit object that contains the same settings as the source ExportIGESOptionsKit. More...
	ExportIGESOptionsKit (ExportIGESOptionsKit &&in_that)
	The move constructor creates an ExportIGESOptionsKit by transferring the underlying object of the rvalue reference to this ExportIGESOptionsKit. More...
virtual	~ExportIGESOptionsKit ()
HPS::Type	ObjectType () const
void	Set (ExportIGESOptionsKit const &in_kit)
	Copies the source ExportIGESOptionsKit into this ExportIGESOptionsKit. More...
void	Show (ExportIGESOptionsKit &out_kit) const
	Copies this ExportIGESOptionsKit into the given ExportIGESOptionsKit. More...
ExportIGESOptionsKit &	operator= (ExportIGESOptionsKit const &in_kit)
	Copies the source ExportIGESOptionsKit into this ExportIGESOptionsKit. More...
ExportIGESOptionsKit &	operator= (ExportIGESOptionsKit &&in_that)
	The move assignment operator transfers the underlying object of the rvalue reference to this ExportIGESOptionsKit. More...
bool	Empty () const
	Indicates whether this ExportIGESOptionsKit has any values set on it. More...
bool	Equals (ExportIGESOptionsKit const &in_kit) const
	Check if the source ExportIGESOptionsKit is equivalent to this ExportIGESOptionsKit. More...
bool	operator== (ExportIGESOptionsKit const &in_kit) const
	Check if the source ExportIGESOptionsKit is equivalent to this ExportIGESOptionsKit. More...
bool	operator!= (ExportIGESOptionsKit const &in_kit) const
	Check if the source ExportIGESOptionsKit is not equivalent to this ExportIGESOptionsKit. More...
ExportIGESOptionsKit &	SetAnalyticsAsNURBS (bool in_state)
	Sets whether to convert analytic surfaces (planes, cones, cylinder, etc.) to NURBS surfaces for export. More...
ExportIGESOptionsKit &	SetFacetedAsWireframe (bool in_state)
	Sets whether to convert polyhedrics to wireframe data for export. More...
ExportIGESOptionsKit &	SetSolidsAsFaces (bool in_state)
	Sets whether to convert solids to a set of independent faces for export. More...
ExportIGESOptionsKit &	SetHiddenObjects (bool in_state)
	Sets whether to export hidden objects. More...
ExportIGESOptionsKit &	SetTessellation (bool in_state)
	Sets whether to export tessellation data. More...
ExportIGESOptionsKit &	SetApplication (char const *in_name)
	Sets the application name to put in the IGES data. More...
ExportIGESOptionsKit &	SetVersion (char const *in_version)
	Sets the version string to put in the IGES data. More...
ExportIGESOptionsKit &	UnsetAnalyticsAsNURBS ()
	Removes the analytics to NURBS conversion setting. More...
ExportIGESOptionsKit &	UnsetFacetedAsWireframe ()
	Removes the faceted to wireframe conversion setting. More...
ExportIGESOptionsKit &	UnsetSolidsAsFaces ()
	Removes the solids to faces conversion setting. More...
ExportIGESOptionsKit &	UnsetHiddenObjects ()
	Removes the hidden objects export setting. More...
ExportIGESOptionsKit &	UnsetTessellation ()
	Removes the tessellation export setting. More...
ExportIGESOptionsKit &	UnsetApplication ()
	Removes the application name setting. More...
ExportIGESOptionsKit &	UnsetVersion ()
	Removes the version string setting. More...
ExportIGESOptionsKit &	UnsetEverything ()
	Removes all settings from this ExportIGESOptionsKit. More...
bool	ShowAnalyticsAsNURBS (bool &out_state) const
	Shows the analytics to NURBS conversion setting. More...
bool	ShowFacetedAsWireframe (bool &out_state) const
	Shows the faceted to wireframe conversion setting. More...
bool	ShowSolidsAsFaces (bool &out_state) const
	Shows the solids to faces conversion setting. More...
bool	ShowHiddenObjects (bool &out_state) const
	Shows the hidden object export setting. More...
bool	ShowTessellation (bool &out_state) const
	Shows the tessellation export setting. More...
bool	ShowApplication (UTF8 &out_name) const
	Shows the application name setting. More...
bool	ShowVersion (UTF8 &out_version) const
	Shows the version string setting. 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 ExportIGESOptionsKit	GetDefault ()
	Creates an ExportIGESOptionsKit 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::ExchangeExportIGESOptionsKit

Detailed Description

The HPS::Exchange::ExportIGESOptionsKit class is a user space object.

It contains settings controlling how IGES data is exported via Exchange. Calling HPS::Exchange::ExportIGESOptionsKit::GetDefault() will return an options kit with values found in here.

Constructor & Destructor Documentation

ExportIGESOptionsKit() [1/3]

HPS::Exchange::ExportIGESOptionsKit::ExportIGESOptionsKit

(

)

The default constructor creates an empty ExportIGESOptionsKit object.

ExportIGESOptionsKit() [2/3]

HPS::Exchange::ExportIGESOptionsKit::ExportIGESOptionsKit

(

ExportIGESOptionsKit const &

in_kit

)

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

Parameters

in_kit

The source ExportIGESOptionsKit to copy.

ExportIGESOptionsKit() [3/3]

HPS::Exchange::ExportIGESOptionsKit::ExportIGESOptionsKit

(

ExportIGESOptionsKit &&

in_that

)

The move constructor creates an ExportIGESOptionsKit by transferring the underlying object of the rvalue reference to this ExportIGESOptionsKit.

Parameters

in_that

An rvalue reference to an ExportIGESOptionsKit to take the underlying object from.

~ExportIGESOptionsKit()

virtual HPS::Exchange::ExportIGESOptionsKit::~ExportIGESOptionsKit ( )

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::Exchange::ExportIGESOptionsKit::Empty ( ) const

virtual

Indicates whether this ExportIGESOptionsKit has any values set on it.

Returns

true if no values are set on this ExportIGESOptionsKit, false otherwise.

Reimplemented from HPS::Object.

Equals()

bool HPS::Exchange::ExportIGESOptionsKit::Equals

(

ExportIGESOptionsKit const &

in_kit

)

const

Check if the source ExportIGESOptionsKit is equivalent to this ExportIGESOptionsKit.

Parameters

in_kit

The source ExportIGESOptionsKit to compare to this ExportIGESOptionsKit.

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 ExportIGESOptionsKit HPS::Exchange::ExportIGESOptionsKit::GetDefault ( )

static

Creates an ExportIGESOptionsKit 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::ExportIGES.

Returns

An ExportIGESOptionsKit 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::Exchange::ExportIGESOptionsKit::ObjectType ( ) const

inlinevirtual

Reimplemented from HPS::SprocketKit.

Here is the call graph for this function:

operator!=()

bool HPS::Exchange::ExportIGESOptionsKit::operator!=

(

ExportIGESOptionsKit const &

in_kit

)

const

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

Parameters

in_kit

The source ExportIGESOptionsKit to compare to this ExportIGESOptionsKit.

Returns

true if the objects are not equivalent, false otherwise.

operator=() [1/2]

ExportIGESOptionsKit& HPS::Exchange::ExportIGESOptionsKit::operator=

(

ExportIGESOptionsKit const &

in_kit

)

Copies the source ExportIGESOptionsKit into this ExportIGESOptionsKit.

Parameters

in_kit

The source ExportIGESOptionsKit to copy.

Returns

A reference to this ExportIGESOptionsKit.

operator=() [2/2]

ExportIGESOptionsKit& HPS::Exchange::ExportIGESOptionsKit::operator=

(

ExportIGESOptionsKit &&

in_that

)

The move assignment operator transfers the underlying object of the rvalue reference to this ExportIGESOptionsKit.

Parameters

in_that

An rvalue reference to an ExportIGESOptionsKit to take the underlying object from.

Returns

A reference to this ExportIGESOptionsKit.

operator==()

bool HPS::Exchange::ExportIGESOptionsKit::operator==

(

ExportIGESOptionsKit const &

in_kit

)

const

Check if the source ExportIGESOptionsKit is equivalent to this ExportIGESOptionsKit.

Parameters

in_kit

The source ExportIGESOptionsKit to compare to this ExportIGESOptionsKit.

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::Exchange::ExportIGESOptionsKit::Set

(

ExportIGESOptionsKit const &

in_kit

)

Copies the source ExportIGESOptionsKit into this ExportIGESOptionsKit.

Parameters

in_kit

The source ExportIGESOptionsKit to copy.

SetAnalyticsAsNURBS()

ExportIGESOptionsKit& HPS::Exchange::ExportIGESOptionsKit::SetAnalyticsAsNURBS

(

bool

in_state

)

Sets whether to convert analytic surfaces (planes, cones, cylinder, etc.) to NURBS surfaces for export.

This corresponds to the value that will be passed to A3DRWParamsExportIgesData::m_bSaveAnalyticsToNurbs.

Parameters

in_state

Whether to convert analytic surfaces to NURBS surfaces for export.

Returns

A reference to this ExportIGESOptionsKit.

See also

Default value

SetApplication()

ExportIGESOptionsKit& HPS::Exchange::ExportIGESOptionsKit::SetApplication

(

char const *

in_name

)

Sets the application name to put in the IGES data.

This corresponds to the value that will be passed to A3DRWParamsExportIgesData::m_pcApplication.

Parameters

in_name

UTF8-encoded application name to put in the IGES data.

Returns

A reference to this ExportIGESOptionsKit.

SetFacetedAsWireframe()

ExportIGESOptionsKit& HPS::Exchange::ExportIGESOptionsKit::SetFacetedAsWireframe

(

bool

in_state

)

Sets whether to convert polyhedrics to wireframe data for export.

This corresponds to the value that will be passed to A3DRWParamsExportIgesData::m_bSaveFacetedToWireframe.

Parameters

in_state

Whether to convert polyhedrics to wireframe data for export.

Returns

A reference to this ExportIGESOptionsKit.

See also

Default value

SetHiddenObjects()

ExportIGESOptionsKit& HPS::Exchange::ExportIGESOptionsKit::SetHiddenObjects

(

bool

in_state

)

Sets whether to export hidden objects.

This corresponds to the value that will be passed to A3DRWParamsExportIgesData::m_bWriteHiddenObjects.

Parameters

in_state

Whether to export hidden objects.

Returns

A reference to this ExportIGESOptionsKit.

See also

Default value

SetSolidsAsFaces()

ExportIGESOptionsKit& HPS::Exchange::ExportIGESOptionsKit::SetSolidsAsFaces

(

bool

in_state

)

Sets whether to convert solids to a set of independent faces for export.

This corresponds to the value that will be passed to A3DRWParamsExportIgesData::m_bSaveSolidsAsFaces.

Parameters

in_state

Whether to convert solids to a set of independent faces for export.

Returns

A reference to this ExportIGESOptionsKit.

See also

Default value

SetTessellation()

ExportIGESOptionsKit& HPS::Exchange::ExportIGESOptionsKit::SetTessellation

(

bool

in_state

)

Sets whether to export tessellation data.

This corresponds to the value that will be passed to A3DRWParamsExportIgesData::m_bWriteTessellation.

Parameters

in_state

Whether to export tessellation data.

Returns

A reference to this ExportIGESOptionsKit.

See also

Default value

SetVersion()

ExportIGESOptionsKit& HPS::Exchange::ExportIGESOptionsKit::SetVersion

(

char const *

in_version

)

Sets the version string to put in the IGES data.

This corresponds to the value that will be passed to A3DRWParamsExportIgesData::m_pcVersion.

Parameters

in_version

UTF8-encoded version string to put in the IGES data.

Returns

A reference to this ExportIGESOptionsKit.

Show()

void HPS::Exchange::ExportIGESOptionsKit::Show

(

ExportIGESOptionsKit &

out_kit

)

const

Copies this ExportIGESOptionsKit into the given ExportIGESOptionsKit.

Parameters

out_kit

The ExportIGESOptionsKit to populate with the contents of this ExportIGESOptionsKit.

ShowAnalyticsAsNURBS()

bool HPS::Exchange::ExportIGESOptionsKit::ShowAnalyticsAsNURBS

(

bool &

out_state

)

const

Shows the analytics to NURBS conversion setting.

Parameters

out_state

Whether to convert analytic surfaces to NURBS surfaces for export.

Returns

true if an analytics to NURBS conversion setting was specified, false otherwise.

ShowApplication()

bool HPS::Exchange::ExportIGESOptionsKit::ShowApplication

(

UTF8 &

out_name

)

const

Shows the application name setting.

Parameters

out_name

The application name to put in the IGES data.

Returns

true if an application name setting was specified, false otherwise.

ShowFacetedAsWireframe()

bool HPS::Exchange::ExportIGESOptionsKit::ShowFacetedAsWireframe

(

bool &

out_state

)

const

Shows the faceted to wireframe conversion setting.

Parameters

out_state

Whether to convert polyhedrics to wireframe data for export.

Returns

true if a faceted to wireframe conversion setting was specified, false otherwise.

ShowHiddenObjects()

bool HPS::Exchange::ExportIGESOptionsKit::ShowHiddenObjects

(

bool &

out_state

)

const

Shows the hidden object export setting.

Parameters

out_state

Whether to export hidden objects.

Returns

true if a hidden object export setting was specified, false otherwise.

ShowSolidsAsFaces()

bool HPS::Exchange::ExportIGESOptionsKit::ShowSolidsAsFaces

(

bool &

out_state

)

const

Shows the solids to faces conversion setting.

Parameters

out_state

Whether to convert solids to a set of independent faces for export.

Returns

true if a solids to faces conversion setting was specified, false otherwise.

ShowTessellation()

bool HPS::Exchange::ExportIGESOptionsKit::ShowTessellation

(

bool &

out_state

)

const

Shows the tessellation export setting.

Parameters

out_state

Whether to export tessellation data.

Returns

true if a tessellation export setting was specified, false otherwise.

ShowVersion()

bool HPS::Exchange::ExportIGESOptionsKit::ShowVersion

(

UTF8 &

out_version

)

const

Shows the version string setting.

Parameters

out_version

The version string to put in the IGES data.

Returns

true if a version string 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.

UnsetAnalyticsAsNURBS()

ExportIGESOptionsKit& HPS::Exchange::ExportIGESOptionsKit::UnsetAnalyticsAsNURBS

(

)

Removes the analytics to NURBS conversion setting.

Returns

A reference to this ExportIGESOptionsKit.

UnsetApplication()

ExportIGESOptionsKit& HPS::Exchange::ExportIGESOptionsKit::UnsetApplication

(

)

Removes the application name setting.

Returns

A reference to this ExportIGESOptionsKit.

UnsetEverything()

ExportIGESOptionsKit& HPS::Exchange::ExportIGESOptionsKit::UnsetEverything

(

)

Removes all settings from this ExportIGESOptionsKit.

Returns

A reference to this ExportIGESOptionsKit.

UnsetFacetedAsWireframe()

ExportIGESOptionsKit& HPS::Exchange::ExportIGESOptionsKit::UnsetFacetedAsWireframe

(

)

Removes the faceted to wireframe conversion setting.

Returns

A reference to this ExportIGESOptionsKit.

UnsetHiddenObjects()

ExportIGESOptionsKit& HPS::Exchange::ExportIGESOptionsKit::UnsetHiddenObjects

(

)

Removes the hidden objects export setting.

Returns

A reference to this ExportIGESOptionsKit.

UnsetSolidsAsFaces()

ExportIGESOptionsKit& HPS::Exchange::ExportIGESOptionsKit::UnsetSolidsAsFaces

(

)

Removes the solids to faces conversion setting.

Returns

A reference to this ExportIGESOptionsKit.

UnsetTessellation()

ExportIGESOptionsKit& HPS::Exchange::ExportIGESOptionsKit::UnsetTessellation

(

)

Removes the tessellation export setting.

Returns

A reference to this ExportIGESOptionsKit.

UnsetVersion()

ExportIGESOptionsKit& HPS::Exchange::ExportIGESOptionsKit::UnsetVersion

(

)

Removes the version string setting.

Returns

A reference to this ExportIGESOptionsKit.

Member Data Documentation

staticType

const HPS::Type HPS::Exchange::ExportIGESOptionsKit::staticType = HPS::Type::ExchangeExportIGESOptionsKit

static

---

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

• sprk_exchange.h