HPS::Exchange::ExportACISOptionsKit Class Reference

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

#include <sprk_exchange.h>

Inheritance diagram for HPS::Exchange::ExportACISOptionsKit:

Collaboration diagram for HPS::Exchange::ExportACISOptionsKit:

Public Member Functions
	ExportACISOptionsKit ()
	The default constructor creates an empty ExportACISOptionsKit object. More...
	ExportACISOptionsKit (ExportACISOptionsKit const &in_kit)
	The copy constructor creates a new ExportACISOptionsKit object that contains the same settings as the source ExportACISOptionsKit. More...
	ExportACISOptionsKit (ExportACISOptionsKit &&in_that)
	The move constructor creates an ExportACISOptionsKit by transferring the underlying object of the rvalue reference to this ExportACISOptionsKit. More...
virtual	~ExportACISOptionsKit ()
HPS::Type	ObjectType () const
void	Set (ExportACISOptionsKit const &in_kit)
	Copies the source ExportACISOptionsKit into this ExportACISOptionsKit. More...
void	Show (ExportACISOptionsKit &out_kit) const
	Copies this ExportACISOptionsKit into the given ExportACISOptionsKit. More...
ExportACISOptionsKit &	operator= (ExportACISOptionsKit const &in_kit)
	Copies the source ExportACISOptionsKit into this ExportACISOptionsKit. More...
ExportACISOptionsKit &	operator= (ExportACISOptionsKit &&in_that)
	The move assignment operator transfers the underlying object of the rvalue reference to this ExportACISOptionsKit. More...
bool	Empty () const
	Indicates whether this ExportACISOptionsKit has any values set on it. More...
bool	Equals (ExportACISOptionsKit const &in_kit) const
	Check if the source ExportACISOptionsKit is equivalent to this ExportACISOptionsKit. More...
bool	operator== (ExportACISOptionsKit const &in_kit) const
	Check if the source ExportACISOptionsKit is equivalent to this ExportACISOptionsKit. More...
bool	operator!= (ExportACISOptionsKit const &in_kit) const
	Check if the source ExportACISOptionsKit is not equivalent to this ExportACISOptionsKit. More...
ExportACISOptionsKit &	SetMillimeterUnits (bool in_state)
	Sets whether to write ACIS data in millimeter units instead of the native units of the CADModel. More...
ExportACISOptionsKit &	SetBinary (bool in_state)
	Sets whether to write ACIS data in binary form. More...
ExportACISOptionsKit &	UnsetMillimeterUnits ()
	Removes the millimeter unit export setting. More...
ExportACISOptionsKit &	UnsetBinary ()
	Removes the binary export setting. More...
ExportACISOptionsKit &	UnsetEverything ()
	Removes all settings from this ExportACISOptionsKit. More...
bool	ShowMillimeterUnits (bool &out_state) const
	Shows the millimeter unit export setting. More...
bool	ShowBinary (bool &out_state) const
	Shows the binary export 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 ExportACISOptionsKit	GetDefault ()
	Creates an ExportACISOptionsKit 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::ExchangeExportACISOptionsKit

Detailed Description

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

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

Constructor & Destructor Documentation

ExportACISOptionsKit() [1/3]

HPS::Exchange::ExportACISOptionsKit::ExportACISOptionsKit

(

)

The default constructor creates an empty ExportACISOptionsKit object.

ExportACISOptionsKit() [2/3]

HPS::Exchange::ExportACISOptionsKit::ExportACISOptionsKit

(

ExportACISOptionsKit const &

in_kit

)

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

Parameters

in_kit

The source ExportACISOptionsKit to copy.

ExportACISOptionsKit() [3/3]

HPS::Exchange::ExportACISOptionsKit::ExportACISOptionsKit

(

ExportACISOptionsKit &&

in_that

)

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

Parameters

in_that

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

~ExportACISOptionsKit()

virtual HPS::Exchange::ExportACISOptionsKit::~ExportACISOptionsKit ( )

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

virtual

Indicates whether this ExportACISOptionsKit has any values set on it.

Returns

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

Reimplemented from HPS::Object.

Equals()

bool HPS::Exchange::ExportACISOptionsKit::Equals

(

ExportACISOptionsKit const &

in_kit

)

const

Check if the source ExportACISOptionsKit is equivalent to this ExportACISOptionsKit.

Parameters

in_kit

The source ExportACISOptionsKit to compare to this ExportACISOptionsKit.

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

static

Creates an ExportACISOptionsKit 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::ExportACIS.

Returns

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

inlinevirtual

Reimplemented from HPS::SprocketKit.

Here is the call graph for this function:

operator!=()

bool HPS::Exchange::ExportACISOptionsKit::operator!=

(

ExportACISOptionsKit const &

in_kit

)

const

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

Parameters

in_kit

The source ExportACISOptionsKit to compare to this ExportACISOptionsKit.

Returns

true if the objects are not equivalent, false otherwise.

operator=() [1/2]

ExportACISOptionsKit& HPS::Exchange::ExportACISOptionsKit::operator=

(

ExportACISOptionsKit const &

in_kit

)

Copies the source ExportACISOptionsKit into this ExportACISOptionsKit.

Parameters

in_kit

The source ExportACISOptionsKit to copy.

Returns

A reference to this ExportACISOptionsKit.

operator=() [2/2]

ExportACISOptionsKit& HPS::Exchange::ExportACISOptionsKit::operator=

(

ExportACISOptionsKit &&

in_that

)

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

Parameters

in_that

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

Returns

A reference to this ExportACISOptionsKit.

operator==()

bool HPS::Exchange::ExportACISOptionsKit::operator==

(

ExportACISOptionsKit const &

in_kit

)

const

Check if the source ExportACISOptionsKit is equivalent to this ExportACISOptionsKit.

Parameters

in_kit

The source ExportACISOptionsKit to compare to this ExportACISOptionsKit.

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

(

ExportACISOptionsKit const &

in_kit

)

Copies the source ExportACISOptionsKit into this ExportACISOptionsKit.

Parameters

in_kit

The source ExportACISOptionsKit to copy.

SetBinary()

ExportACISOptionsKit& HPS::Exchange::ExportACISOptionsKit::SetBinary

(

bool

in_state

)

Sets whether to write ACIS data in binary form.

This corresponds to the value that will be passed to A3DRWParamsExportAcisData::m_bSaveAsBinary.

Parameters

in_state

Whether to write ACIS data in binary form.

Returns

A reference to this ExportACISOptionsKit.

See also

Default value

SetMillimeterUnits()

ExportACISOptionsKit& HPS::Exchange::ExportACISOptionsKit::SetMillimeterUnits

(

bool

in_state

)

Sets whether to write ACIS data in millimeter units instead of the native units of the CADModel.

This corresponds to the value that will be passed to A3DRWParamsExportAcisData::m_bSaveAsMillimeter.

Parameters

in_state

Whether to write ACIS data in millimeter units instead of the native units of the CADModel.

Returns

A reference to this ExportACISOptionsKit.

See also

Default value

Show()

void HPS::Exchange::ExportACISOptionsKit::Show

(

ExportACISOptionsKit &

out_kit

)

const

Copies this ExportACISOptionsKit into the given ExportACISOptionsKit.

Parameters

out_kit

The ExportACISOptionsKit to populate with the contents of this ExportACISOptionsKit.

ShowBinary()

bool HPS::Exchange::ExportACISOptionsKit::ShowBinary

(

bool &

out_state

)

const

Shows the binary export setting.

Parameters

out_state

Whether to write ACIS data in binary form.

Returns

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

ShowMillimeterUnits()

bool HPS::Exchange::ExportACISOptionsKit::ShowMillimeterUnits

(

bool &

out_state

)

const

Shows the millimeter unit export setting.

Parameters

out_state

Whether to write ACIS data in millimeter units instead of the native units of the CADModel.

Returns

true if a millimeter unit export 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.

UnsetBinary()

ExportACISOptionsKit& HPS::Exchange::ExportACISOptionsKit::UnsetBinary

(

)

Removes the binary export setting.

Returns

A reference to this ExportACISOptionsKit.

UnsetEverything()

ExportACISOptionsKit& HPS::Exchange::ExportACISOptionsKit::UnsetEverything

(

)

Removes all settings from this ExportACISOptionsKit.

Returns

A reference to this ExportACISOptionsKit.

UnsetMillimeterUnits()

ExportACISOptionsKit& HPS::Exchange::ExportACISOptionsKit::UnsetMillimeterUnits

(

)

Removes the millimeter unit export setting.

Returns

A reference to this ExportACISOptionsKit.

Member Data Documentation

staticType

const HPS::Type HPS::Exchange::ExportACISOptionsKit::staticType = HPS::Type::ExchangeExportACISOptionsKit

static

---

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

• sprk_exchange.h