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

virtual bool Empty() const

Indicates whether this ExportOBJOptionsKit has any values set on it.

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

bool Equals(ExportOBJOptionsKit const &in_kit) const

Check if the source ExportOBJOptionsKit is equivalent to this ExportOBJOptionsKit.

Parameters: in_kit – The source ExportOBJOptionsKit to compare to this ExportOBJOptionsKit.
Returns: true if the objects are equivalent, false otherwise.

ExportOBJOptionsKit(): The default constructor creates an empty ExportOBJOptionsKit object.

ExportOBJOptionsKit(ExportOBJOptionsKit &&in_that)

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

Parameters: in_that – An rvalue reference to an ExportOBJOptionsKit to take the underlying object from.

ExportOBJOptionsKit(ExportOBJOptionsKit const &in_kit)

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

Parameters: in_kit – The source ExportOBJOptionsKit 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!=(ExportOBJOptionsKit const &in_kit) const

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

Parameters: in_kit – The source ExportOBJOptionsKit to compare to this ExportOBJOptionsKit.
Returns: true if the objects are not equivalent, false otherwise.

ExportOBJOptionsKit &operator=(ExportOBJOptionsKit &&in_that)

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

Parameters: in_that – An rvalue reference to an ExportOBJOptionsKit to take the underlying object from.
Returns: A reference to this ExportOBJOptionsKit.

ExportOBJOptionsKit &operator=(ExportOBJOptionsKit const &in_kit)

Copies the source ExportOBJOptionsKit into this ExportOBJOptionsKit.

Parameters: in_kit – The source ExportOBJOptionsKit to copy.
Returns: A reference to this ExportOBJOptionsKit.

bool operator==(ExportOBJOptionsKit const &in_kit) const

Check if the source ExportOBJOptionsKit is equivalent to this ExportOBJOptionsKit.

Parameters: in_kit – The source ExportOBJOptionsKit to compare to this ExportOBJOptionsKit.
Returns: true if the objects are equivalent, false otherwise.

void Set(ExportOBJOptionsKit const &in_kit)

Copies the source ExportOBJOptionsKit into this ExportOBJOptionsKit.

Parameters: in_kit – The source ExportOBJOptionsKit to copy.

ExportOBJOptionsKit &SetTextureFolder(char const *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)

Parameters: 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.
Returns: A reference to this ExportOBJOptionsKit.

void Show(ExportOBJOptionsKit &out_kit) const

Copies this ExportOBJOptionsKit into the given ExportOBJOptionsKit.

Parameters: out_kit – The ExportOBJOptionsKit to populate with the contents of this ExportOBJOptionsKit.

bool ShowTextureFolder(UTF8 &out_path) const

Shows the texture folder setting.

Parameters: out_path – The path to the folder where texture will be exported.
Returns: true if a texture folder setting was specified, false otherwise.

ExportOBJOptionsKit &UnsetEverything()

Removes all settings from this ExportOBJOptionsKit.

Returns: A reference to this ExportOBJOptionsKit.

ExportOBJOptionsKit &UnsetTextureFolder()

Removes the texture folder setting.

Returns: A reference to this ExportOBJOptionsKit.

virtual ~ExportOBJOptionsKit()

Public Static Functions

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

Returns: An ExportOBJOptionsKit with the default settings.

Public Static Attributes

static const HPS::Type staticType = HPS::Type::ExchangeExportOBJOptionsKit