#include <sprk_exchange.h>

Inheritance diagram for HPS::Exchange::ExportGLTFOptionsKit:
HPS::SprocketKit HPS::Sprocket HPS::Object

Public Member Functions

bool Empty () const
 
bool Equals (ExportGLTFOptionsKit const &in_kit) const
 
 ExportGLTFOptionsKit ()
 
 ExportGLTFOptionsKit (ExportGLTFOptionsKit const &in_kit)
 
 ExportGLTFOptionsKit (ExportGLTFOptionsKit &&in_that)
 
HPS::Type ObjectType () const
 
bool operator!= (ExportGLTFOptionsKit const &in_kit) const
 
ExportGLTFOptionsKitoperator= (ExportGLTFOptionsKit const &in_kit)
 
ExportGLTFOptionsKitoperator= (ExportGLTFOptionsKit &&in_that)
 
bool operator== (ExportGLTFOptionsKit const &in_kit) const
 
void Set (ExportGLTFOptionsKit const &in_kit)
 
ExportGLTFOptionsKitSetAscii (bool in_state)
 
ExportGLTFOptionsKitSetTextureFolder (char const *in_name)
 
void Show (ExportGLTFOptionsKit &out_kit) const
 
bool ShowAscii (bool &out_state) const
 
bool ShowTextureFolder (UTF8 &out_path) const
 
ExportGLTFOptionsKitUnsetAscii ()
 
ExportGLTFOptionsKitUnsetEverything ()
 
ExportGLTFOptionsKitUnsetTextureFolder ()
 
- Public Member Functions inherited from HPS::Sprocket
Sprocket (Sprocket &&in_that)
 
- Public Member Functions inherited from HPS::Object
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 
virtual HPS::Type Type () const
 

Static Public Member Functions

static ExportGLTFOptionsKit GetDefault ()
 
- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::ExchangeExportGLTFOptionsKit
 
- Static Public Attributes inherited from HPS::SprocketKit
static const HPS::Type staticType = HPS::Type::SprocketKit
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Protected Member Functions inherited from HPS::SprocketKit
SprocketKitoperator= (SprocketKit &&in_that)
 
 SprocketKit (SprocketKit &&in_that)
 

Detailed Description

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.

Constructor & Destructor Documentation

◆ ExportGLTFOptionsKit() [1/3]

HPS::Exchange::ExportGLTFOptionsKit::ExportGLTFOptionsKit ( )

The default constructor creates an empty ExportGLTFOptionsKit object.

◆ ExportGLTFOptionsKit() [2/3]

HPS::Exchange::ExportGLTFOptionsKit::ExportGLTFOptionsKit ( ExportGLTFOptionsKit const &  in_kit)

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

Parameters
in_kitThe source ExportGLTFOptionsKit to copy.

◆ ExportGLTFOptionsKit() [3/3]

HPS::Exchange::ExportGLTFOptionsKit::ExportGLTFOptionsKit ( ExportGLTFOptionsKit &&  in_that)

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

Parameters
in_thatAn rvalue reference to an ExportGLTFOptionsKit to take the underlying object from.

Member Function Documentation

◆ Empty()

bool HPS::Exchange::ExportGLTFOptionsKit::Empty ( ) const
virtual

Indicates whether this ExportGLTFOptionsKit has any values set on it.

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

Reimplemented from HPS::Object.

◆ Equals()

bool HPS::Exchange::ExportGLTFOptionsKit::Equals ( ExportGLTFOptionsKit const &  in_kit) const

Check if the source ExportGLTFOptionsKit is equivalent to this ExportGLTFOptionsKit.

Parameters
in_kitThe source ExportGLTFOptionsKit to compare to this ExportGLTFOptionsKit.
Returns
true if the objects are equivalent, false otherwise.

◆ GetDefault()

static ExportGLTFOptionsKit HPS::Exchange::ExportGLTFOptionsKit::GetDefault ( )
static

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.

◆ ObjectType()

HPS::Type HPS::Exchange::ExportGLTFOptionsKit::ObjectType ( ) const
inlinevirtual

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.

Reimplemented from HPS::SprocketKit.

◆ operator!=()

bool HPS::Exchange::ExportGLTFOptionsKit::operator!= ( ExportGLTFOptionsKit const &  in_kit) const

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

Parameters
in_kitThe source ExportGLTFOptionsKit to compare to this ExportGLTFOptionsKit.
Returns
true if the objects are not equivalent, false otherwise.

◆ operator=() [1/2]

ExportGLTFOptionsKit& HPS::Exchange::ExportGLTFOptionsKit::operator= ( ExportGLTFOptionsKit const &  in_kit)

Copies the source ExportGLTFOptionsKit into this ExportGLTFOptionsKit.

Parameters
in_kitThe source ExportGLTFOptionsKit to copy.
Returns
A reference to this ExportGLTFOptionsKit.

◆ operator=() [2/2]

ExportGLTFOptionsKit& HPS::Exchange::ExportGLTFOptionsKit::operator= ( ExportGLTFOptionsKit &&  in_that)

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

Parameters
in_thatAn rvalue reference to an ExportGLTFOptionsKit to take the underlying object from.
Returns
A reference to this ExportGLTFOptionsKit.

◆ operator==()

bool HPS::Exchange::ExportGLTFOptionsKit::operator== ( ExportGLTFOptionsKit const &  in_kit) const

Check if the source ExportGLTFOptionsKit is equivalent to this ExportGLTFOptionsKit.

Parameters
in_kitThe source ExportGLTFOptionsKit to compare to this ExportGLTFOptionsKit.
Returns
true if the objects are equivalent, false otherwise.

◆ Set()

void HPS::Exchange::ExportGLTFOptionsKit::Set ( ExportGLTFOptionsKit const &  in_kit)

Copies the source ExportGLTFOptionsKit into this ExportGLTFOptionsKit.

Parameters
in_kitThe source ExportGLTFOptionsKit to copy.

◆ SetAscii()

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

Parameters
in_stateWhether to write GLTF data in ascii form.
Returns
A reference to this ExportGLTFOptionsKit.
See also
Default value

◆ SetTextureFolder()

ExportGLTFOptionsKit& HPS::Exchange::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 exoport process will create a directory called 'C:/out/myfile' and place the textures there

Parameters
in_nameUTF8-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.
See also
Default value

◆ Show()

void HPS::Exchange::ExportGLTFOptionsKit::Show ( ExportGLTFOptionsKit out_kit) const

Copies this ExportGLTFOptionsKit into the given ExportGLTFOptionsKit.

Parameters
out_kitThe ExportGLTFOptionsKit to populate with the contents of this ExportGLTFOptionsKit.

◆ ShowAscii()

bool HPS::Exchange::ExportGLTFOptionsKit::ShowAscii ( bool &  out_state) const

Shows the ascii export setting.

Parameters
out_stateWhether to write GLTF data in ascii form.
Returns
true if a ascii export setting was specified, false otherwise.

◆ ShowTextureFolder()

bool HPS::Exchange::ExportGLTFOptionsKit::ShowTextureFolder ( UTF8 out_path) const

Shows the texture folder setting.

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

◆ UnsetAscii()

ExportGLTFOptionsKit& HPS::Exchange::ExportGLTFOptionsKit::UnsetAscii ( )

Removes the ascii export setting.

Returns
A reference to this ExportGLTFOptionsKit.

◆ UnsetEverything()

ExportGLTFOptionsKit& HPS::Exchange::ExportGLTFOptionsKit::UnsetEverything ( )

Removes all settings from this ExportGLTFOptionsKit.

Returns
A reference to this ExportGLTFOptionsKit.

◆ UnsetTextureFolder()

ExportGLTFOptionsKit& HPS::Exchange::ExportGLTFOptionsKit::UnsetTextureFolder ( )

Removes the texture folder setting.

Returns
A reference to this ExportGLTFOptionsKit.

The documentation for this class was generated from the following file: