HPS::Exchange::ExportFBXOptionsKit

class HPS::Exchange::ExportFBXOptionsKit : public HPS::SprocketKit

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

Public Functions

virtual bool Empty() const

Indicates whether this ExportFBXOptionsKit has any values set on it.

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

bool Equals(ExportFBXOptionsKit const &in_kit) const

Check if the source ExportFBXOptionsKit is equivalent to this ExportFBXOptionsKit.

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

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

ExportFBXOptionsKit(ExportFBXOptionsKit &&in_that)

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

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

ExportFBXOptionsKit(ExportFBXOptionsKit const &in_kit)

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

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

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

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

ExportFBXOptionsKit &operator=(ExportFBXOptionsKit &&in_that)

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

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

ExportFBXOptionsKit &operator=(ExportFBXOptionsKit const &in_kit)

Copies the source ExportFBXOptionsKit into this ExportFBXOptionsKit.

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

bool operator==(ExportFBXOptionsKit const &in_kit) const

Check if the source ExportFBXOptionsKit is equivalent to this ExportFBXOptionsKit.

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

void Set(ExportFBXOptionsKit const &in_kit)

Copies the source ExportFBXOptionsKit into this ExportFBXOptionsKit.

Parameters: in_kit – The source ExportFBXOptionsKit to copy.

ExportFBXOptionsKit &SetAscii(bool in_state)

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

See: Default value

Parameters: in_state – Whether to write FBX data in ascii form.
Returns: A reference to this ExportFBXOptionsKit.

ExportFBXOptionsKit &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) 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

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 A3DRWParamsExportFbxData::m_pcTextureFolder.
Returns: A reference to this ExportFBXOptionsKit.

void Show(ExportFBXOptionsKit &out_kit) const

Copies this ExportFBXOptionsKit into the given ExportFBXOptionsKit.

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

bool ShowAscii(bool &out_state) const

Shows the ascii export setting.

Parameters: out_state – Whether to write FBX data in ascii form.
Returns: true if a ascii export setting was specified, false otherwise.

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.

ExportFBXOptionsKit &UnsetAscii()

Removes the ascii export setting.

Returns: A reference to this ExportFBXOptionsKit.

ExportFBXOptionsKit &UnsetEverything()

Removes all settings from this ExportFBXOptionsKit.

Returns: A reference to this ExportFBXOptionsKit.

ExportFBXOptionsKit &UnsetTextureFolder()

Removes the texture folder setting.

Returns: A reference to this ExportFBXOptionsKit.

virtual ~ExportFBXOptionsKit()

Public Static Functions

static ExportFBXOptionsKit GetDefault()

Creates an ExportFBXOptionsKit 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::ExportFBX.

Returns: An ExportFBXOptionsKit with the default settings.

Public Static Attributes

static const HPS::Type staticType = HPS::Type::ExchangeExportFBXOptionsKit