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

virtual bool Empty() const

Indicates whether this ExportGLTFOptionsKit has any values set on it.

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

bool Equals(ExportGLTFOptionsKit const &in_kit) const

Check if the source ExportGLTFOptionsKit is equivalent to this ExportGLTFOptionsKit.

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

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

ExportGLTFOptionsKit(ExportGLTFOptionsKit &&in_that)

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

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

ExportGLTFOptionsKit(ExportGLTFOptionsKit const &in_kit)

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

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

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

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

ExportGLTFOptionsKit &operator=(ExportGLTFOptionsKit &&in_that)

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

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

ExportGLTFOptionsKit &operator=(ExportGLTFOptionsKit const &in_kit)

Copies the source ExportGLTFOptionsKit into this ExportGLTFOptionsKit.

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

bool operator==(ExportGLTFOptionsKit const &in_kit) const

Check if the source ExportGLTFOptionsKit is equivalent to this ExportGLTFOptionsKit.

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

void Set(ExportGLTFOptionsKit const &in_kit)

Copies the source ExportGLTFOptionsKit into this ExportGLTFOptionsKit.

Parameters: in_kit – The source ExportGLTFOptionsKit to copy.

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

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

ExportGLTFOptionsKit &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 ExportGLTFOptionsKit.

void Show(ExportGLTFOptionsKit &out_kit) const

Copies this ExportGLTFOptionsKit into the given ExportGLTFOptionsKit.

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

bool ShowAscii(bool &out_state) const

Shows the ascii export setting.

Parameters: out_state – Whether to write GLTF 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.

ExportGLTFOptionsKit &UnsetAscii()

Removes the ascii export setting.

Returns: A reference to this ExportGLTFOptionsKit.

ExportGLTFOptionsKit &UnsetEverything()

Removes all settings from this ExportGLTFOptionsKit.

Returns: A reference to this ExportGLTFOptionsKit.

ExportGLTFOptionsKit &UnsetTextureFolder()

Removes the texture folder setting.

Returns: A reference to this ExportGLTFOptionsKit.

Public Static Functions

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

Returns: An ExportGLTFOptionsKit with the default settings.