HPS::Exchange::ExportU3DOptionsKit

class HPS::Exchange::ExportU3DOptionsKit : public HPS::SprocketKit

The HPS::Exchange::ExportU3DOptionsKit class is a user space object. It contains settings controlling how U3D data is exported via Exchange. Calling HPS::Exchange::ExportU3DOptionsKit::GetDefault() will return an options kit with values found in here.

Public Functions

virtual bool Empty() const

Indicates whether this ExportU3DOptionsKit has any values set on it.

Returns

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

bool Equals(ExportU3DOptionsKit const &in_kit) const

Check if the source ExportU3DOptionsKit is equivalent to this ExportU3DOptionsKit.

Parameters

in_kit – The source ExportU3DOptionsKit to compare to this ExportU3DOptionsKit.

Returns

true if the objects are equivalent, false otherwise.

ExportU3DOptionsKit()

The default constructor creates an empty ExportU3DOptionsKit object.

ExportU3DOptionsKit(ExportU3DOptionsKit &&in_that)

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

Parameters

in_that – An rvalue reference to an ExportU3DOptionsKit to take the underlying object from.

ExportU3DOptionsKit(ExportU3DOptionsKit const &in_kit)

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

Parameters

in_kit – The source ExportU3DOptionsKit to copy.

inline virtual HPS::Type ObjectType() const

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

Returns

The declared type of the object in question, which may differ from the true, underlying type.

bool operator!=(ExportU3DOptionsKit const &in_kit) const

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

Parameters

in_kit – The source ExportU3DOptionsKit to compare to this ExportU3DOptionsKit.

Returns

true if the objects are not equivalent, false otherwise.

ExportU3DOptionsKit &operator=(ExportU3DOptionsKit &&in_that)

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

Parameters

in_that – An rvalue reference to an ExportU3DOptionsKit to take the underlying object from.

Returns

A reference to this ExportU3DOptionsKit.

ExportU3DOptionsKit &operator=(ExportU3DOptionsKit const &in_kit)

Copies the source ExportU3DOptionsKit into this ExportU3DOptionsKit.

Parameters

in_kit – The source ExportU3DOptionsKit to copy.

Returns

A reference to this ExportU3DOptionsKit.

bool operator==(ExportU3DOptionsKit const &in_kit) const

Check if the source ExportU3DOptionsKit is equivalent to this ExportU3DOptionsKit.

Parameters

in_kit – The source ExportU3DOptionsKit to compare to this ExportU3DOptionsKit.

Returns

true if the objects are equivalent, false otherwise.

void Set(ExportU3DOptionsKit const &in_kit)

Copies the source ExportU3DOptionsKit into this ExportU3DOptionsKit.

Parameters

in_kit – The source ExportU3DOptionsKit to copy.

ExportU3DOptionsKit &SetCompression(unsigned char in_level)

Sets the level of compression to apply to tessellations in the U3D data for export. If no compression level is set, no compression will be applied. This corresponds to the value that will be passed to A3DRWParamsExportU3DData::m_ucMeshQualityValue.

Parameters

in_level – The level of compression to apply to tessellations in the U3D data for export. This value should be in the range [0, 100].

Returns

A reference to this ExportU3DOptionsKit.

ExportU3DOptionsKit &SetVersion(U3D::Version in_version)

Sets the version of the U3D data to export. This corresponds to the value that will be passed to A3DRWParamsExportU3DData::m_eU3DVersion.

See

Default value

Parameters

in_version – The version of the U3D data to export.

Returns

A reference to this ExportU3DOptionsKit.

void Show(ExportU3DOptionsKit &out_kit) const

Copies this ExportU3DOptionsKit into the given ExportU3DOptionsKit.

Parameters

out_kit – The ExportU3DOptionsKit to populate with the contents of this ExportU3DOptionsKit.

bool ShowCompression(unsigned char &out_level) const

Shows the compression setting.

Parameters

out_level – The level of compression to apply to tessellations in the U3D data for export.

Returns

true if a compression setting was specified, false otherwise.

bool ShowVersion(U3D::Version &out_version) const

Shows the version setting.

Parameters

out_version – The version of the U3D data to export.

Returns

true if a version setting was specified, false otherwise.

ExportU3DOptionsKit &UnsetCompression()

Removes the compression setting.

Returns

A reference to this ExportU3DOptionsKit.

ExportU3DOptionsKit &UnsetEverything()

Removes all settings from this ExportU3DOptionsKit.

Returns

A reference to this ExportU3DOptionsKit.

ExportU3DOptionsKit &UnsetVersion()

Removes the version setting.

Returns

A reference to this ExportU3DOptionsKit.

Public Static Functions

static ExportU3DOptionsKit GetDefault()

Creates an ExportU3DOptionsKit 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::ExportU3D.

Returns

An ExportU3DOptionsKit with the default settings.