HPS::Parasolid::ExportOptionsKit Class Reference

The ExportOptionsKit class is a user space object. More...

#include <sprk_parasolid.h>

Inheritance diagram for HPS::Parasolid::ExportOptionsKit:

Collaboration diagram for HPS::Parasolid::ExportOptionsKit:

Public Member Functions
	ExportOptionsKit ()
	The default constructor creates an empty ExportOptionsKit object. More...
	ExportOptionsKit (ExportOptionsKit const &in_kit)
	The copy constructor creates a new ExportOptionsKit object that contains the same settings as the source ExportOptionsKit. More...
	ExportOptionsKit (ExportOptionsKit &&in_that)
	The move constructor creates an ExportOptionsKit by transferring the underlying impl of the rvalue reference to this ExportOptionsKit thereby avoiding a copy and allocation. More...
ExportOptionsKit &	operator= (ExportOptionsKit &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this ExportOptionsKit thereby avoiding a copy. More...
virtual	~ExportOptionsKit ()
HPS::Type	ObjectType () const
void	Set (ExportOptionsKit const &in_kit)
	Copies the source ExportOptionsKit into this ExportOptionsKit. More...
void	Show (ExportOptionsKit &out_kit) const
	Copies this ExportOptionsKit into the given ExportOptionsKit. More...
ExportOptionsKit &	operator= (ExportOptionsKit const &in_kit)
	Copies the source ExportOptionsKit into this ExportOptionsKit. More...
bool	Empty () const
	Indicates whether this ExportOptionsKit has any values set on it. More...
bool	Equals (ExportOptionsKit const &in_kit) const
	Check if the source ExportOptionsKit is equivalent to this ExportOptionsKit. More...
bool	operator== (ExportOptionsKit const &in_kit) const
	Check if the source ExportOptionsKit is equivalent to this ExportOptionsKit. More...
bool	operator!= (ExportOptionsKit const &in_kit) const
	Check if the source ExportOptionsKit is not equivalent to this ExportOptionsKit. More...
ExportOptionsKit &	SetFormat (Parasolid::Format in_format)
	Sets the format type to be exported. More...
ExportOptionsKit &	SetUserFields (bool in_export_user_fields)
	Sets whether to export user fields from the CAD file. More...
ExportOptionsKit &	UnsetFormat ()
	Removes the format export state. More...
ExportOptionsKit &	UnsetUserFields ()
	Removes the user fields export state. More...
ExportOptionsKit &	UnsetEverything ()
	Removes all settings from this ExportOptionsKit. More...
bool	ShowFormat (Parasolid::Format &out_format) const
	Shows the format export setting. More...
bool	ShowUserFields (bool &out_user_fields) const
	Shows the user fields 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 ExportOptionsKit	GetDefault ()
	Creates an ExportOptionsKit 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::ParasolidExportOptionsKit

Detailed Description

The ExportOptionsKit class is a user space object.

It contains settings controlling what and how data is exported via Parasolid. Default values for the various fields of this class can be found here.

Constructor & Destructor Documentation

ExportOptionsKit() [1/3]

HPS::Parasolid::ExportOptionsKit::ExportOptionsKit

(

)

The default constructor creates an empty ExportOptionsKit object.

ExportOptionsKit() [2/3]

HPS::Parasolid::ExportOptionsKit::ExportOptionsKit

(

ExportOptionsKit const &

in_kit

)

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

Parameters

in_kit

The source ExportOptionsKit to copy.

ExportOptionsKit() [3/3]

HPS::Parasolid::ExportOptionsKit::ExportOptionsKit

(

ExportOptionsKit &&

in_that

)

The move constructor creates an ExportOptionsKit by transferring the underlying impl of the rvalue reference to this ExportOptionsKit thereby avoiding a copy and allocation.

Parameters

in_that

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

~ExportOptionsKit()

virtual HPS::Parasolid::ExportOptionsKit::~ExportOptionsKit ( )

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

virtual

Indicates whether this ExportOptionsKit has any values set on it.

Returns

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

Reimplemented from HPS::Object.

Equals()

bool HPS::Parasolid::ExportOptionsKit::Equals

(

ExportOptionsKit const &

in_kit

)

const

Check if the source ExportOptionsKit is equivalent to this ExportOptionsKit.

Parameters

in_kit

The source ExportOptionsKit to compare to this ExportOptionsKit.

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 ExportOptionsKit HPS::Parasolid::ExportOptionsKit::GetDefault ( )

static

Creates an ExportOptionsKit 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::Export.

Returns

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

inlinevirtual

Reimplemented from HPS::SprocketKit.

Here is the call graph for this function:

operator!=()

bool HPS::Parasolid::ExportOptionsKit::operator!=

(

ExportOptionsKit const &

in_kit

)

const

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

Parameters

in_kit

The source ExportOptionsKit to compare to this ExportOptionsKit.

Returns

true if the objects are not equivalent, false otherwise.

operator=() [1/2]

ExportOptionsKit& HPS::Parasolid::ExportOptionsKit::operator=

(

ExportOptionsKit &&

in_that

)

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

Parameters

in_that

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

Returns

A reference to this ExportOptionsKit.

operator=() [2/2]

ExportOptionsKit& HPS::Parasolid::ExportOptionsKit::operator=

(

ExportOptionsKit const &

in_kit

)

Copies the source ExportOptionsKit into this ExportOptionsKit.

Parameters

in_kit

The source ExportOptionsKit to copy.

Returns

A reference to this ExportOptionsKit.

operator==()

bool HPS::Parasolid::ExportOptionsKit::operator==

(

ExportOptionsKit const &

in_kit

)

const

Check if the source ExportOptionsKit is equivalent to this ExportOptionsKit.

Parameters

in_kit

The source ExportOptionsKit to compare to this ExportOptionsKit.

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::Parasolid::ExportOptionsKit::Set

(

ExportOptionsKit const &

in_kit

)

Copies the source ExportOptionsKit into this ExportOptionsKit.

Parameters

in_kit

The source ExportOptionsKit to copy.

SetFormat()

ExportOptionsKit& HPS::Parasolid::ExportOptionsKit::SetFormat

(

Parasolid::Format

in_format

)

Sets the format type to be exported.

This corresponds to the value that will be passed to PK_PART_transmit_o_t.transmit_format.

Parameters

in_format

The format of the file to be exported.

Returns

A reference to this ExportOptionsKit.

See also

Default value

SetUserFields()

ExportOptionsKit& HPS::Parasolid::ExportOptionsKit::SetUserFields

(

bool

in_export_user_fields

)

Sets whether to export user fields from the CAD file.

This corresponds to the value that will be passed to PK_PART_transmit_o_t.receive_user_fields.

Parameters

in_export_user_fields

Whether to export user fields from the CAD file.

Returns

A reference to this ExportOptionsKit.

Show()

void HPS::Parasolid::ExportOptionsKit::Show

(

ExportOptionsKit &

out_kit

)

const

Copies this ExportOptionsKit into the given ExportOptionsKit.

Parameters

out_kit

The ExportOptionsKit to populate with the contents of this ExportOptionsKit.

ShowFormat()

bool HPS::Parasolid::ExportOptionsKit::ShowFormat

(

Parasolid::Format &

out_format

)

const

Shows the format export setting.

Parameters

out_format

The format setting for this export.

Returns

true if a format setting was specified, false otherwise.

ShowUserFields()

bool HPS::Parasolid::ExportOptionsKit::ShowUserFields

(

bool &

out_user_fields

)

const

Shows the user fields export setting.

Parameters

out_user_fields

The user fields setting for this export.

Returns

true if a user fields 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()

ExportOptionsKit& HPS::Parasolid::ExportOptionsKit::UnsetEverything

(

)

Removes all settings from this ExportOptionsKit.

Returns

A reference to this ExportOptionsKit.

UnsetFormat()

ExportOptionsKit& HPS::Parasolid::ExportOptionsKit::UnsetFormat

(

)

Removes the format export state.

Returns

A reference to this ExportOptionsKit.

UnsetUserFields()

ExportOptionsKit& HPS::Parasolid::ExportOptionsKit::UnsetUserFields

(

)

Removes the user fields export state.

Returns

A reference to this ExportOptionsKit.

Member Data Documentation

staticType

const HPS::Type HPS::Parasolid::ExportOptionsKit::staticType = HPS::Type::ParasolidExportOptionsKit

static

---

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

• sprk_parasolid.h