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

override bool Empty ()

Indicates whether this ExportU3DOptionsKit has any values set on it.

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

bool Equals (HPS.Exchange.ExportU3DOptionsKit in_kit)

Check if the source ExportU3DOptionsKit is equivalent to this ExportU3DOptionsKit.

Param in_kit: The source ExportU3DOptionsKit to compare to this ExportU3DOptionsKit.
Return: true if the objects are equivalent, false otherwise.

ExportU3DOptionsKit (): The default constructor creates an empty ExportU3DOptionsKit object.

ExportU3DOptionsKit (HPS.Exchange.ExportU3DOptionsKit in_kit)

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

Param in_kit: The source ExportU3DOptionsKit to copy.

override HPS.Type ObjectType ()

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).

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

void Set (HPS.Exchange.ExportU3DOptionsKit in_kit)

Copies the source ExportU3DOptionsKit into this ExportU3DOptionsKit.

Param in_kit: The source ExportU3DOptionsKit to copy.

HPS.Exchange.ExportU3DOptionsKit SetCompression (byte 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.

Param 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].
Return: A reference to this ExportU3DOptionsKit.

HPS.Exchange.ExportU3DOptionsKit SetVersion (HPS.Exchange.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

Param in_version: The version of the U3D data to export.
Return: A reference to this ExportU3DOptionsKit.

void Show (out HPS.Exchange.ExportU3DOptionsKit out_kit)

Copies this ExportU3DOptionsKit into the given ExportU3DOptionsKit.

Param out_kit: The ExportU3DOptionsKit to populate with the contents of this ExportU3DOptionsKit.

bool ShowCompression (out byte out_level)

Shows the compression setting.

Param out_level: The level of compression to apply to tessellations in the U3D data for export.
Return: true if a compression setting was specified, false otherwise.

bool ShowVersion (out HPS.Exchange.U3D.Version out_version)

Shows the version setting.

Param out_version: The version of the U3D data to export.
Return: true if a version setting was specified, false otherwise.

HPS.Exchange.ExportU3DOptionsKit UnsetCompression ()

Removes the compression setting.

Return: A reference to this ExportU3DOptionsKit.

HPS.Exchange.ExportU3DOptionsKit UnsetEverything ()

Removes all settings from this ExportU3DOptionsKit.

Return: A reference to this ExportU3DOptionsKit.

HPS.Exchange.ExportU3DOptionsKit UnsetVersion ()

Removes the version setting.

Return: A reference to this ExportU3DOptionsKit.

Public Static Functions

HPS.Exchange.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.

Return: An ExportU3DOptionsKit with the default settings.