HPS.Exchange.ExportGLTFOptionsKit

class HPS.Exchange.ExportGLTFOptionsKit : public HPS.SprocketKit

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

Public Functions

override bool Empty ()

Indicates whether this ExportGLTFOptionsKit has any values set on it.

Return

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

bool Equals (HPS.Exchange.ExportGLTFOptionsKit in_kit)

Check if the source ExportGLTFOptionsKit is equivalent to this ExportGLTFOptionsKit.

Param in_kit

The source ExportGLTFOptionsKit to compare to this ExportGLTFOptionsKit.

Return

true if the objects are equivalent, false otherwise.

ExportGLTFOptionsKit ()

The default constructor creates an empty ExportGLTFOptionsKit object.

ExportGLTFOptionsKit (HPS.Exchange.ExportGLTFOptionsKit in_kit)

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

Param in_kit

The source ExportGLTFOptionsKit 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.ExportGLTFOptionsKit in_kit)

Copies the source ExportGLTFOptionsKit into this ExportGLTFOptionsKit.

Param in_kit

The source ExportGLTFOptionsKit to copy.

HPS.Exchange.ExportGLTFOptionsKit SetAscii (bool in_state)

Sets whether to write GLTF data in ascii form. This corresponds to the value that will be passed to A3DRWParamsExportGLTFData::m_bAscii.

See

Default value

Param in_state

Whether to write GLTF data in ascii form.

Return

A reference to this ExportGLTFOptionsKit.

HPS.Exchange.ExportGLTFOptionsKit SetTextureFolder (string in_name)

Sets folder where texture will be exported (if any). If NULL, then texture are written in the same directory as the .fbx. Symbol @ is expanded as Filename of current file (without extension) Example: If the output file is ‘C:/out/myfile.obj’ and the texture folder is set to ‘C:/out/myfile.obj’, the export process will create a directory called ‘C:/out/myfile’ and place the textures there

See

Default value

Param in_name

UTF8-encoded path to the folder where texture will be exported. This corresponds to the value that will be passed to and A3DRWParamsExportFbxData::m_pcTextureFolder.

Return

A reference to this ExportGLTFOptionsKit.

void Show (out HPS.Exchange.ExportGLTFOptionsKit out_kit)

Copies this ExportGLTFOptionsKit into the given ExportGLTFOptionsKit.

Param out_kit

The ExportGLTFOptionsKit to populate with the contents of this ExportGLTFOptionsKit.

bool ShowAscii (out bool out_state)

Shows the ascii export setting.

Param out_state

Whether to write GLTF data in ascii form.

Return

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

bool ShowTextureFolder (out string out_path)

Shows the texture folder setting.

Param out_path

The path to the folder where texture will be exported.

Return

true if a texture folder setting was specified, false otherwise.

HPS.Exchange.ExportGLTFOptionsKit UnsetAscii ()

Removes the ascii export setting.

Return

A reference to this ExportGLTFOptionsKit.

HPS.Exchange.ExportGLTFOptionsKit UnsetEverything ()

Removes all settings from this ExportGLTFOptionsKit.

Return

A reference to this ExportGLTFOptionsKit.

HPS.Exchange.ExportGLTFOptionsKit UnsetTextureFolder ()

Removes the texture folder setting.

Return

A reference to this ExportGLTFOptionsKit.

Public Static Functions

HPS.Exchange.ExportGLTFOptionsKit GetDefault ()

Creates an ExportGLTFOptionsKit 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.ExportGLTF.

Return

An ExportGLTFOptionsKit with the default settings.