HPS::Exchange::ExportOBJOptionsKit

class HPS.Exchange.ExportOBJOptionsKit : public HPS.SprocketKit

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

Public Functions

override void Dispose ()

override bool Empty ()

Indicates whether this ExportOBJOptionsKit has any values set on it.

Return

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

bool Equals (HPS.Exchange.ExportOBJOptionsKit in_kit)

Check if the source ExportOBJOptionsKit is equivalent to this ExportOBJOptionsKit.

Param in_kit

The source ExportOBJOptionsKit to compare to this ExportOBJOptionsKit.

Return

true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

ExportOBJOptionsKit ()

The default constructor creates an empty ExportOBJOptionsKit object.

ExportOBJOptionsKit (HPS.Exchange.ExportOBJOptionsKit in_kit)

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

Param in_kit

The source ExportOBJOptionsKit to copy.

override int GetHashCode ()

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

Copies the source ExportOBJOptionsKit into this ExportOBJOptionsKit.

Param in_kit

The source ExportOBJOptionsKit to copy.

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

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 A3DRWParamsExportObjData::m_pcTextureFolder.

Return

A reference to this ExportOBJOptionsKit.

void Show (out HPS.Exchange.ExportOBJOptionsKit out_kit)

Copies this ExportOBJOptionsKit into the given ExportOBJOptionsKit.

Param out_kit

The ExportOBJOptionsKit to populate with the contents of this ExportOBJOptionsKit.

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.ExportOBJOptionsKit UnsetEverything ()

Removes all settings from this ExportOBJOptionsKit.

Return

A reference to this ExportOBJOptionsKit.

HPS.Exchange.ExportOBJOptionsKit UnsetTextureFolder ()

Removes the texture folder setting.

Return

A reference to this ExportOBJOptionsKit.

Public Static Functions

HPS.Exchange.ExportOBJOptionsKit GetDefault ()

Creates an ExportOBJOptionsKit 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.ExportOBJ.

Return

An ExportOBJOptionsKit with the default settings.

bool operator!= (HPS.Exchange.ExportOBJOptionsKit a, HPS.Exchange.ExportOBJOptionsKit b)

bool operator== (HPS.Exchange.ExportOBJOptionsKit a, HPS.Exchange.ExportOBJOptionsKit b)