HPS::Exchange::ExportSTEPOptionsKit Class Reference

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

#include <sprk_exchange.h>

Inheritance diagram for HPS::Exchange::ExportSTEPOptionsKit:

Collaboration diagram for HPS::Exchange::ExportSTEPOptionsKit:

Public Member Functions
	ExportSTEPOptionsKit ()
	The default constructor creates an empty ExportSTEPOptionsKit object. More...
	ExportSTEPOptionsKit (ExportSTEPOptionsKit const &in_kit)
	The copy constructor creates a new ExportSTEPOptionsKit object that contains the same settings as the source ExportSTEPOptionsKit. More...
	ExportSTEPOptionsKit (ExportSTEPOptionsKit &&in_that)
	The move constructor creates an ExportSTEPOptionsKit by transferring the underlying object of the rvalue reference to this ExportSTEPOptionsKit. More...
virtual	~ExportSTEPOptionsKit ()
HPS::Type	ObjectType () const
void	Set (ExportSTEPOptionsKit const &in_kit)
	Copies the source ExportSTEPOptionsKit into this ExportSTEPOptionsKit. More...
void	Show (ExportSTEPOptionsKit &out_kit) const
	Copies this ExportSTEPOptionsKit into the given ExportSTEPOptionsKit. More...
ExportSTEPOptionsKit &	operator= (ExportSTEPOptionsKit const &in_kit)
	Copies the source ExportSTEPOptionsKit into this ExportSTEPOptionsKit. More...
ExportSTEPOptionsKit &	operator= (ExportSTEPOptionsKit &&in_that)
	The move assignment operator transfers the underlying object of the rvalue reference to this ExportSTEPOptionsKit. More...
bool	Empty () const
	Indicates whether this ExportSTEPOptionsKit has any values set on it. More...
bool	Equals (ExportSTEPOptionsKit const &in_kit) const
	Check if the source ExportSTEPOptionsKit is equivalent to this ExportSTEPOptionsKit. More...
bool	operator== (ExportSTEPOptionsKit const &in_kit) const
	Check if the source ExportSTEPOptionsKit is equivalent to this ExportSTEPOptionsKit. More...
bool	operator!= (ExportSTEPOptionsKit const &in_kit) const
	Check if the source ExportSTEPOptionsKit is not equivalent to this ExportSTEPOptionsKit. More...
ExportSTEPOptionsKit &	SetFormat (STEP::Format in_format)
	Sets the format of the STEP data to export. More...
ExportSTEPOptionsKit &	SetAnalyticsAsNURBS (bool in_state)
	Sets whether to convert analytic surfaces (planes, cones, cylinder, etc.) to NURBS surfaces for export. More...
ExportSTEPOptionsKit &	SetFacetedAsWireframe (bool in_state)
	Sets whether to convert polyhedrics to wireframe data for export. More...
ExportSTEPOptionsKit &	SetNameShortening (bool in_state)
	Sets whether to shorten names in the STEP data for export. More...
ExportSTEPOptionsKit &	SetApplication (char const *in_name)
	Sets the application name to put in the STEP data. More...
ExportSTEPOptionsKit &	SetVersion (char const *in_version)
	Sets the version string to put in the STEP data. More...
ExportSTEPOptionsKit &	SetPMI (bool in_state)
	Sets whether to export PMI. More...
ExportSTEPOptionsKit &	SetCurves (bool in_state)
	Sets whether to export curves. More...
ExportSTEPOptionsKit &	SetAttributes (bool in_state)
	Sets whether to export attributes. More...
ExportSTEPOptionsKit &	UnsetFormat ()
	Removes the format setting. More...
ExportSTEPOptionsKit &	UnsetAnalyticsAsNURBS ()
	Removes the analytics to NURBS conversion setting. More...
ExportSTEPOptionsKit &	UnsetFacetedAsWireframe ()
	Removes the faceted to wireframe conversion setting. More...
ExportSTEPOptionsKit &	UnsetNameShortening ()
	Removes the name shortening setting. More...
ExportSTEPOptionsKit &	UnsetApplication ()
	Removes the application name setting. More...
ExportSTEPOptionsKit &	UnsetVersion ()
	Removes the version string setting. More...
ExportSTEPOptionsKit &	UnsetPMI ()
	Removes the PMI setting. More...
ExportSTEPOptionsKit &	UnsetCurves ()
	Removes the curves setting. More...
ExportSTEPOptionsKit &	UnsetAttributes ()
	Removes the attributes setting. More...
ExportSTEPOptionsKit &	UnsetEverything ()
	Removes all settings from this ExportSTEPOptionsKit. More...
bool	ShowFormat (STEP::Format &out_format) const
	Shows the format setting. 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	ShowNameShortening (bool &out_state) const
	Shows the name shortening 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...
bool	ShowPMI (bool &out_state) const
	Shows the pmi setting. More...
bool	ShowCurves (bool &out_state) const
	Shows the curves setting. More...
bool	ShowAttributes (bool &out_state) const
	Shows the attributes 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 ExportSTEPOptionsKit	GetDefault ()
	Creates an ExportSTEPOptionsKit 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::ExchangeExportSTEPOptionsKit

Detailed Description

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

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

Constructor & Destructor Documentation

ExportSTEPOptionsKit() [1/3]

HPS::Exchange::ExportSTEPOptionsKit::ExportSTEPOptionsKit

(

)

The default constructor creates an empty ExportSTEPOptionsKit object.

ExportSTEPOptionsKit() [2/3]

HPS::Exchange::ExportSTEPOptionsKit::ExportSTEPOptionsKit

(

ExportSTEPOptionsKit const &

in_kit

)

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

Parameters

in_kit

The source ExportSTEPOptionsKit to copy.

ExportSTEPOptionsKit() [3/3]

HPS::Exchange::ExportSTEPOptionsKit::ExportSTEPOptionsKit

(

ExportSTEPOptionsKit &&

in_that

)

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

Parameters

in_that

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

~ExportSTEPOptionsKit()

virtual HPS::Exchange::ExportSTEPOptionsKit::~ExportSTEPOptionsKit ( )

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

virtual

Indicates whether this ExportSTEPOptionsKit has any values set on it.

Returns

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

Reimplemented from HPS::Object.

Equals()

bool HPS::Exchange::ExportSTEPOptionsKit::Equals

(

ExportSTEPOptionsKit const &

in_kit

)

const

Check if the source ExportSTEPOptionsKit is equivalent to this ExportSTEPOptionsKit.

Parameters

in_kit

The source ExportSTEPOptionsKit to compare to this ExportSTEPOptionsKit.

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

static

Creates an ExportSTEPOptionsKit 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::ExportSTEP.

Returns

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

inlinevirtual

Reimplemented from HPS::SprocketKit.

Here is the call graph for this function:

operator!=()

bool HPS::Exchange::ExportSTEPOptionsKit::operator!=

(

ExportSTEPOptionsKit const &

in_kit

)

const

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

Parameters

in_kit

The source ExportSTEPOptionsKit to compare to this ExportSTEPOptionsKit.

Returns

true if the objects are not equivalent, false otherwise.

operator=() [1/2]

ExportSTEPOptionsKit& HPS::Exchange::ExportSTEPOptionsKit::operator=

(

ExportSTEPOptionsKit const &

in_kit

)

Copies the source ExportSTEPOptionsKit into this ExportSTEPOptionsKit.

Parameters

in_kit

The source ExportSTEPOptionsKit to copy.

Returns

A reference to this ExportSTEPOptionsKit.

operator=() [2/2]

ExportSTEPOptionsKit& HPS::Exchange::ExportSTEPOptionsKit::operator=

(

ExportSTEPOptionsKit &&

in_that

)

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

Parameters

in_that

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

Returns

A reference to this ExportSTEPOptionsKit.

operator==()

bool HPS::Exchange::ExportSTEPOptionsKit::operator==

(

ExportSTEPOptionsKit const &

in_kit

)

const

Check if the source ExportSTEPOptionsKit is equivalent to this ExportSTEPOptionsKit.

Parameters

in_kit

The source ExportSTEPOptionsKit to compare to this ExportSTEPOptionsKit.

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::ExportSTEPOptionsKit::Set

(

ExportSTEPOptionsKit const &

in_kit

)

Copies the source ExportSTEPOptionsKit into this ExportSTEPOptionsKit.

Parameters

in_kit

The source ExportSTEPOptionsKit to copy.

SetAnalyticsAsNURBS()

ExportSTEPOptionsKit& HPS::Exchange::ExportSTEPOptionsKit::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 A3DRWParamsExportStepData::m_bSaveAnalyticsToNurbs.

Parameters

in_state

Whether to convert analytic surfaces to NURBS surfaces for export.

Returns

A reference to this ExportSTEPOptionsKit.

See also

Default value

SetApplication()

ExportSTEPOptionsKit& HPS::Exchange::ExportSTEPOptionsKit::SetApplication

(

char const *

in_name

)

Sets the application name to put in the STEP data.

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

Parameters

in_name

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

Returns

A reference to this ExportSTEPOptionsKit.

SetAttributes()

ExportSTEPOptionsKit& HPS::Exchange::ExportSTEPOptionsKit::SetAttributes

(

bool

in_state

)

Sets whether to export attributes.

This corresponds to the value that will be passed to A3DRWParamsExportStepData::m_bWriteAttributes.

Parameters

in_state

Whether to export attributes.

Returns

A reference to this ExportSTEPOptionsKit.

SetCurves()

ExportSTEPOptionsKit& HPS::Exchange::ExportSTEPOptionsKit::SetCurves

(

bool

in_state

)

Sets whether to export curves.

This corresponds to the value that will be passed to A3DRWParamsExportStepData::m_bWriteUVCurves.

Parameters

in_state

Whether to export curves.

Returns

A reference to this ExportSTEPOptionsKit.

SetFacetedAsWireframe()

ExportSTEPOptionsKit& HPS::Exchange::ExportSTEPOptionsKit::SetFacetedAsWireframe

(

bool

in_state

)

Sets whether to convert polyhedrics to wireframe data for export.

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

Parameters

in_state

Whether to convert polyhedrics to wireframe data for export.

Returns

A reference to this ExportSTEPOptionsKit.

See also

Default value

SetFormat()

ExportSTEPOptionsKit& HPS::Exchange::ExportSTEPOptionsKit::SetFormat

(

STEP::Format

in_format

)

Sets the format of the STEP data to export.

This corresponds to the value that will be passed to A3DRWParamsExportStepData::m_eStepFormat.

Parameters

in_format

The format of the STEP data to export.

Returns

A reference to this ExportSTEPOptionsKit.

See also

Default value

SetNameShortening()

ExportSTEPOptionsKit& HPS::Exchange::ExportSTEPOptionsKit::SetNameShortening

(

bool

in_state

)

Sets whether to shorten names in the STEP data for export.

This corresponds to the value that will be passed to A3DRWParamsExportStepData::m_bUseShortNames.

Parameters

in_state

Whether to shorten names in the STEP data for export.

Returns

A reference to this ExportSTEPOptionsKit.

See also

Default value

SetPMI()

ExportSTEPOptionsKit& HPS::Exchange::ExportSTEPOptionsKit::SetPMI

(

bool

in_state

)

Sets whether to export PMI.

This corresponds to the value that will be passed to A3DRWParamsExportStepData::m_bWritePMI.

Parameters

in_state

Whether to export PMI.

Returns

A reference to this ExportSTEPOptionsKit.

SetVersion()

ExportSTEPOptionsKit& HPS::Exchange::ExportSTEPOptionsKit::SetVersion

(

char const *

in_version

)

Sets the version string to put in the STEP data.

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

Parameters

in_version

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

Returns

A reference to this ExportSTEPOptionsKit.

Show()

void HPS::Exchange::ExportSTEPOptionsKit::Show

(

ExportSTEPOptionsKit &

out_kit

)

const

Copies this ExportSTEPOptionsKit into the given ExportSTEPOptionsKit.

Parameters

out_kit

The ExportSTEPOptionsKit to populate with the contents of this ExportSTEPOptionsKit.

ShowAnalyticsAsNURBS()

bool HPS::Exchange::ExportSTEPOptionsKit::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::ExportSTEPOptionsKit::ShowApplication

(

UTF8 &

out_name

)

const

Shows the application name setting.

Parameters

out_name

The application name to put in the STEP data.

Returns

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

ShowAttributes()

bool HPS::Exchange::ExportSTEPOptionsKit::ShowAttributes

(

bool &

out_state

)

const

Shows the attributes setting.

Parameters

out_state

Whether to export attributes.

Returns

true if an attributes setting was specified, false otherwise.

ShowCurves()

bool HPS::Exchange::ExportSTEPOptionsKit::ShowCurves

(

bool &

out_state

)

const

Shows the curves setting.

Parameters

out_state

Whether to export curves.

Returns

true if a curves setting was specified, false otherwise.

ShowFacetedAsWireframe()

bool HPS::Exchange::ExportSTEPOptionsKit::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.

ShowFormat()

bool HPS::Exchange::ExportSTEPOptionsKit::ShowFormat

(

STEP::Format &

out_format

)

const

Shows the format setting.

Parameters

out_format

The format of the STEP data to export.

Returns

true if a format setting was specified, false otherwise.

ShowNameShortening()

bool HPS::Exchange::ExportSTEPOptionsKit::ShowNameShortening

(

bool &

out_state

)

const

Shows the name shortening setting.

Parameters

out_state

Whether to shorten names in the STEP data for export.

Returns

true if a name shortening setting was specified, false otherwise.

ShowPMI()

bool HPS::Exchange::ExportSTEPOptionsKit::ShowPMI

(

bool &

out_state

)

const

Shows the pmi setting.

Parameters

out_state

Whether to export PMI.

Returns

true if a PMI setting was specified, false otherwise.

ShowVersion()

bool HPS::Exchange::ExportSTEPOptionsKit::ShowVersion

(

UTF8 &

out_version

)

const

Shows the version string setting.

Parameters

out_version

The version string to put in the STEP 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()

ExportSTEPOptionsKit& HPS::Exchange::ExportSTEPOptionsKit::UnsetAnalyticsAsNURBS

(

)

Removes the analytics to NURBS conversion setting.

Returns

A reference to this ExportSTEPOptionsKit.

UnsetApplication()

ExportSTEPOptionsKit& HPS::Exchange::ExportSTEPOptionsKit::UnsetApplication

(

)

Removes the application name setting.

Returns

A reference to this ExportSTEPOptionsKit.

UnsetAttributes()

ExportSTEPOptionsKit& HPS::Exchange::ExportSTEPOptionsKit::UnsetAttributes

(

)

Removes the attributes setting.

Returns

A reference to this ExportSTEPOptionsKit.

UnsetCurves()

ExportSTEPOptionsKit& HPS::Exchange::ExportSTEPOptionsKit::UnsetCurves

(

)

Removes the curves setting.

Returns

A reference to this ExportSTEPOptionsKit.

UnsetEverything()

ExportSTEPOptionsKit& HPS::Exchange::ExportSTEPOptionsKit::UnsetEverything

(

)

Removes all settings from this ExportSTEPOptionsKit.

Returns

A reference to this ExportSTEPOptionsKit.

UnsetFacetedAsWireframe()

ExportSTEPOptionsKit& HPS::Exchange::ExportSTEPOptionsKit::UnsetFacetedAsWireframe

(

)

Removes the faceted to wireframe conversion setting.

Returns

A reference to this ExportSTEPOptionsKit.

UnsetFormat()

ExportSTEPOptionsKit& HPS::Exchange::ExportSTEPOptionsKit::UnsetFormat

(

)

Removes the format setting.

Returns

A reference to this ExportSTEPOptionsKit.

UnsetNameShortening()

ExportSTEPOptionsKit& HPS::Exchange::ExportSTEPOptionsKit::UnsetNameShortening

(

)

Removes the name shortening setting.

Returns

A reference to this ExportSTEPOptionsKit.

UnsetPMI()

ExportSTEPOptionsKit& HPS::Exchange::ExportSTEPOptionsKit::UnsetPMI

(

)

Removes the PMI setting.

Returns

A reference to this ExportSTEPOptionsKit.

UnsetVersion()

ExportSTEPOptionsKit& HPS::Exchange::ExportSTEPOptionsKit::UnsetVersion

(

)

Removes the version string setting.

Returns

A reference to this ExportSTEPOptionsKit.

Member Data Documentation

staticType

const HPS::Type HPS::Exchange::ExportSTEPOptionsKit::staticType = HPS::Type::ExchangeExportSTEPOptionsKit

static

---

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

• sprk_exchange.h