HPS::Exchange::Export3MFOptionsKit Class Reference

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

#include <sprk_exchange.h>

Inheritance diagram for HPS::Exchange::Export3MFOptionsKit:

Collaboration diagram for HPS::Exchange::Export3MFOptionsKit:

Public Member Functions
	Export3MFOptionsKit ()
	The default constructor creates an empty Export3MFOptionsKit object. More...
	Export3MFOptionsKit (Export3MFOptionsKit const &in_kit)
	The copy constructor creates a new Export3MFOptionsKit object that contains the same settings as the source Export3MFOptionsKit. More...
	Export3MFOptionsKit (Export3MFOptionsKit &&in_that)
	The move constructor creates an Export3MFOptionsKit by transferring the underlying object of the rvalue reference to this Export3MFOptionsKit. More...
virtual	~Export3MFOptionsKit ()
HPS::Type	ObjectType () const
void	Set (Export3MFOptionsKit const &in_kit)
	Copies the source Export3MFOptionsKit into this Export3MFOptionsKit. More...
void	Show (Export3MFOptionsKit &out_kit) const
	Copies this Export3MFOptionsKit into the given Export3MFOptionsKit. More...
Export3MFOptionsKit &	operator= (Export3MFOptionsKit const &in_kit)
	Copies the source Export3MFOptionsKit into this Export3MFOptionsKit. More...
Export3MFOptionsKit &	operator= (Export3MFOptionsKit &&in_that)
	The move assignment operator transfers the underlying object of the rvalue reference to this Export3MFOptionsKit. More...
bool	Empty () const
	Indicates whether this Export3MFOptionsKit has any values set on it. More...
bool	Equals (Export3MFOptionsKit const &in_kit) const
	Check if the source Export3MFOptionsKit is equivalent to this Export3MFOptionsKit. More...
bool	operator== (Export3MFOptionsKit const &in_kit) const
	Check if the source Export3MFOptionsKit is equivalent to this Export3MFOptionsKit. More...
bool	operator!= (Export3MFOptionsKit const &in_kit) const
	Check if the source Export3MFOptionsKit is not equivalent to this Export3MFOptionsKit. More...
Export3MFOptionsKit &	SetAdditionalKeyPaths (KeyPathArray const &in_additional_key_paths)
	Sets an array of key paths which will be exported in addition to the model. More...
Export3MFOptionsKit &	SetAdditionalKeyPaths (size_t in_count, KeyPath const in_additional_key_paths[])
	Sets an array of key paths which will be exported in addition to the model. More...
Export3MFOptionsKit &	UnsetAdditionalKeyPaths ()
	Removes the additional key paths setting. More...
bool	ShowAdditionalKeyPaths (KeyPathArray &out_additional_key_paths) const
	Shows the additional key paths setting. More...
Export3MFOptionsKit &	SetCurrentTessellationRetention (bool in_state, TessellationOptionsKit const &in_tessellation_kit=TessellationOptionsKit())
	Sets whether to retain the current tessellation during export. More...
Export3MFOptionsKit &	UnsetCurrentTessellationRetention ()
	Removes the KeepCurrentTessellation setting. More...
bool	ShowCurrentTessellationRetention (bool &out_state, Exchange::TessellationOptionsKit &out_tessellation_kit) const
	Shows the KeepCurrentTessellation setting. More...
Export3MFOptionsKit &	SetDescription (char const *in_description)
	Sets a description. More...
Export3MFOptionsKit &	UnsetDescription ()
	Removes the description setting. More...
bool	ShowDescription (HPS::UTF8 &out_state) const
	Shows the description setting. More...
Export3MFOptionsKit &	SetCopyright (char const *in_state)
	Sets the copyright metadata. More...
Export3MFOptionsKit &	UnsetCopyright ()
	Removes the Copyright setting. More...
bool	ShowCopyright (HPS::UTF8 &out_state) const
	Shows the copyright setting. More...
Export3MFOptionsKit &	SetLicenseTerms (char const *in_license)
	Sets license terms metadata. More...
Export3MFOptionsKit &	UnsetLicenseTerms ()
	Removes the license setting. More...
bool	ShowLicenseTerms (HPS::UTF8 &out_license) const
	Shows the license setting. More...
Export3MFOptionsKit &	UnsetEverything ()
	Removes all settings from this Export3MFOptionsKit. 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 Export3MFOptionsKit	GetDefault ()
	Creates an Export3MFOptionsKit 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::ExchangeExport3MFOptionsKit

Detailed Description

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

It contains settings controlling how 3MF data is exported via the Exchange interface.

Constructor & Destructor Documentation

Export3MFOptionsKit() [1/3]

HPS::Exchange::Export3MFOptionsKit::Export3MFOptionsKit

(

)

The default constructor creates an empty Export3MFOptionsKit object.

Export3MFOptionsKit() [2/3]

HPS::Exchange::Export3MFOptionsKit::Export3MFOptionsKit

(

Export3MFOptionsKit const &

in_kit

)

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

Parameters

in_kit

The source Export3MFOptionsKit to copy.

Export3MFOptionsKit() [3/3]

HPS::Exchange::Export3MFOptionsKit::Export3MFOptionsKit

(

Export3MFOptionsKit &&

in_that

)

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

Parameters

in_that

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

~Export3MFOptionsKit()

virtual HPS::Exchange::Export3MFOptionsKit::~Export3MFOptionsKit ( )

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

virtual

Indicates whether this Export3MFOptionsKit has any values set on it.

Returns

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

Reimplemented from HPS::Object.

Equals()

bool HPS::Exchange::Export3MFOptionsKit::Equals

(

Export3MFOptionsKit const &

in_kit

)

const

Check if the source Export3MFOptionsKit is equivalent to this Export3MFOptionsKit.

Parameters

in_kit

The source Export3MFOptionsKit to compare to this Export3MFOptionsKit.

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

static

Creates an Export3MFOptionsKit 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 defaults. These values will be used for export unless an option in overridden by the options passed to File::Export3MF.

Returns

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

inlinevirtual

Reimplemented from HPS::SprocketKit.

Here is the call graph for this function:

operator!=()

bool HPS::Exchange::Export3MFOptionsKit::operator!=

(

Export3MFOptionsKit const &

in_kit

)

const

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

Parameters

in_kit

The source Export3MFOptionsKit to compare to this Export3MFOptionsKit.

Returns

true if the objects are not equivalent, false otherwise.

operator=() [1/2]

Export3MFOptionsKit& HPS::Exchange::Export3MFOptionsKit::operator=

(

Export3MFOptionsKit const &

in_kit

)

Copies the source Export3MFOptionsKit into this Export3MFOptionsKit.

Parameters

in_kit

The source Export3MFOptionsKit to copy.

Returns

A reference to this Export3MFOptionsKit.

operator=() [2/2]

Export3MFOptionsKit& HPS::Exchange::Export3MFOptionsKit::operator=

(

Export3MFOptionsKit &&

in_that

)

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

Parameters

in_that

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

Returns

A reference to this Export3MFOptionsKit.

operator==()

bool HPS::Exchange::Export3MFOptionsKit::operator==

(

Export3MFOptionsKit const &

in_kit

)

const

Check if the source Export3MFOptionsKit is equivalent to this Export3MFOptionsKit.

Parameters

in_kit

The source Export3MFOptionsKit to compare to this Export3MFOptionsKit.

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

(

Export3MFOptionsKit const &

in_kit

)

Copies the source Export3MFOptionsKit into this Export3MFOptionsKit.

Parameters

in_kit

The source Export3MFOptionsKit to copy.

SetAdditionalKeyPaths() [1/2]

Export3MFOptionsKit& HPS::Exchange::Export3MFOptionsKit::SetAdditionalKeyPaths

(

KeyPathArray const &

in_additional_key_paths

)

Sets an array of key paths which will be exported in addition to the model.

Use this setting to export Visualize geometry to 3MF.

Parameters

in_additional_key_paths

The key paths to be exported.

Returns

A reference to this Export3MFOptionsKit.

SetAdditionalKeyPaths() [2/2]

Export3MFOptionsKit& HPS::Exchange::Export3MFOptionsKit::SetAdditionalKeyPaths	(	size_t	in_count,
		KeyPath const	in_additional_key_paths[]
	)

Sets an array of key paths which will be exported in addition to the model.

Use this setting to export Visualize geometry to 3MF.

Parameters

in-count	The number of key paths contained in in_additional_key_paths.
in_additional_key_paths	The key paths to be exported.

Returns

A reference to this Export3MFOptionsKit.

SetCopyright()

Export3MFOptionsKit& HPS::Exchange::Export3MFOptionsKit::SetCopyright

(

char const *

in_state

)

Sets the copyright metadata.

Parameters

in_copyright

The copyright metadata.

Returns

A reference to this Export3MFOptionsKit.

SetCurrentTessellationRetention()

Export3MFOptionsKit& HPS::Exchange::Export3MFOptionsKit::SetCurrentTessellationRetention	(	bool	in_state,
		TessellationOptionsKit const &	in_tessellation_kit = TessellationOptionsKit()
	)

Sets whether to retain the current tessellation during export.

Parameters

in_state	Whether to retain the current tessellation during export.
in_tessellation_kit	The tessellation to use during export. Only used if in_state is false, or if no tessellation is present.

Returns

A reference to this Export3MFOptionsKit.

SetDescription()

Export3MFOptionsKit& HPS::Exchange::Export3MFOptionsKit::SetDescription

(

char const *

in_description

)

Sets a description.

This will be reported in the output file as metadata.

Parameters

in_description

The description.

Returns

A reference to this Export3MFOptionsKit .

SetLicenseTerms()

Export3MFOptionsKit& HPS::Exchange::Export3MFOptionsKit::SetLicenseTerms

(

char const *

in_license

)

Sets license terms metadata.

Parameters

in_license

The license terms metadata.

Returns

A reference to this Export3MFOptionsKit.

Show()

void HPS::Exchange::Export3MFOptionsKit::Show

(

Export3MFOptionsKit &

out_kit

)

const

Copies this Export3MFOptionsKit into the given Export3MFOptionsKit.

Parameters

out_kit

The Export3MFOptionsKit to populate with the contents of this Export3MFOptionsKit.

ShowAdditionalKeyPaths()

bool HPS::Exchange::Export3MFOptionsKit::ShowAdditionalKeyPaths

(

KeyPathArray &

out_additional_key_paths

)

const

Shows the additional key paths setting.

Parameters

out_additional_key_paths

The key paths which will be added to the model

Returns

true if an additional key paths setting was specified, false otherwise.

ShowCopyright()

bool HPS::Exchange::Export3MFOptionsKit::ShowCopyright

(

HPS::UTF8 &

out_state

)

const

Shows the copyright setting.

Parameters

out_copyright

The copyright metadata.

Returns

true if a copyright setting was specified, false otherwise.

ShowCurrentTessellationRetention()

bool HPS::Exchange::Export3MFOptionsKit::ShowCurrentTessellationRetention	(	bool &	out_state,
		Exchange::TessellationOptionsKit &	out_tessellation_kit
	)		const

Shows the KeepCurrentTessellation setting.

Parameters

out_state	Whether to retain the current tessellation during export.
out_tessellation_kit	The tessellation options to use during export. Only valid if out_state is false.

Returns

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

ShowDescription()

bool HPS::Exchange::Export3MFOptionsKit::ShowDescription

(

HPS::UTF8 &

out_state

)

const

Shows the description setting.

Parameters

out_description

The description.

Returns

true if a description setting was specified, false otherwise.

ShowLicenseTerms()

bool HPS::Exchange::Export3MFOptionsKit::ShowLicenseTerms

(

HPS::UTF8 &

out_license

)

const

Shows the license setting.

Parameters

out_license

The license metadata

Returns

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

UnsetAdditionalKeyPaths()

Export3MFOptionsKit& HPS::Exchange::Export3MFOptionsKit::UnsetAdditionalKeyPaths

(

)

Removes the additional key paths setting.

Returns

A reference to this Export3MFOptionsKit.

UnsetCopyright()

Export3MFOptionsKit& HPS::Exchange::Export3MFOptionsKit::UnsetCopyright

(

)

Removes the Copyright setting.

Returns

A reference to this Export3MFOptionsKit.

UnsetCurrentTessellationRetention()

Export3MFOptionsKit& HPS::Exchange::Export3MFOptionsKit::UnsetCurrentTessellationRetention

(

)

Removes the KeepCurrentTessellation setting.

Returns

A reference to this Export3MFOptionsKit.

UnsetDescription()

Export3MFOptionsKit& HPS::Exchange::Export3MFOptionsKit::UnsetDescription

(

)

Removes the description setting.

Returns

A reference to this Export3MFOptionsKit.

UnsetEverything()

Export3MFOptionsKit& HPS::Exchange::Export3MFOptionsKit::UnsetEverything

(

)

Removes all settings from this Export3MFOptionsKit.

Returns

A reference to this Export3MFOptionsKit.

UnsetLicenseTerms()

Export3MFOptionsKit& HPS::Exchange::Export3MFOptionsKit::UnsetLicenseTerms

(

)

Removes the license setting.

Returns

A reference to this Export3MFOptionsKit.

Member Data Documentation

staticType

const HPS::Type HPS::Exchange::Export3MFOptionsKit::staticType = HPS::Type::ExchangeExport3MFOptionsKit

static

---

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

• sprk_exchange.h