#include <sprk_exchange.h>

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

Public Member Functions

bool Empty () const
 
bool Equals (ExportFBXOptionsKit const &in_kit) const
 
 ExportFBXOptionsKit ()
 
 ExportFBXOptionsKit (ExportFBXOptionsKit const &in_kit)
 
 ExportFBXOptionsKit (ExportFBXOptionsKit &&in_that)
 
HPS::Type ObjectType () const
 
bool operator!= (ExportFBXOptionsKit const &in_kit) const
 
ExportFBXOptionsKitoperator= (ExportFBXOptionsKit const &in_kit)
 
ExportFBXOptionsKitoperator= (ExportFBXOptionsKit &&in_that)
 
bool operator== (ExportFBXOptionsKit const &in_kit) const
 
void Set (ExportFBXOptionsKit const &in_kit)
 
ExportFBXOptionsKitSetAscii (bool in_state)
 
ExportFBXOptionsKitSetTextureFolder (char const *in_name)
 
void Show (ExportFBXOptionsKit &out_kit) const
 
bool ShowAscii (bool &out_state) const
 
bool ShowTextureFolder (UTF8 &out_path) const
 
ExportFBXOptionsKitUnsetAscii ()
 
ExportFBXOptionsKitUnsetEverything ()
 
ExportFBXOptionsKitUnsetTextureFolder ()
 
- 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 ExportFBXOptionsKit 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::ExchangeExportFBXOptionsKit
 
- 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::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.

Constructor & Destructor Documentation

◆ ExportFBXOptionsKit() [1/3]

HPS::Exchange::ExportFBXOptionsKit::ExportFBXOptionsKit ( )

The default constructor creates an empty ExportFBXOptionsKit object.

◆ ExportFBXOptionsKit() [2/3]

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

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

Parameters
in_kitThe source ExportFBXOptionsKit to copy.

◆ ExportFBXOptionsKit() [3/3]

HPS::Exchange::ExportFBXOptionsKit::ExportFBXOptionsKit ( ExportFBXOptionsKit &&  in_that)

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

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

Member Function Documentation

◆ Empty()

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

Indicates whether this ExportFBXOptionsKit has any values set on it.

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

Reimplemented from HPS::Object.

◆ Equals()

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

Check if the source ExportFBXOptionsKit is equivalent to this ExportFBXOptionsKit.

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

◆ GetDefault()

static ExportFBXOptionsKit HPS::Exchange::ExportFBXOptionsKit::GetDefault ( )
static

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.

◆ ObjectType()

HPS::Type HPS::Exchange::ExportFBXOptionsKit::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::ExportFBXOptionsKit::operator!= ( ExportFBXOptionsKit const &  in_kit) const

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

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

◆ operator=() [1/2]

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

Copies the source ExportFBXOptionsKit into this ExportFBXOptionsKit.

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

◆ operator=() [2/2]

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

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

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

◆ operator==()

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

Check if the source ExportFBXOptionsKit is equivalent to this ExportFBXOptionsKit.

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

◆ Set()

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

Copies the source ExportFBXOptionsKit into this ExportFBXOptionsKit.

Parameters
in_kitThe source ExportFBXOptionsKit to copy.

◆ SetAscii()

ExportFBXOptionsKit& HPS::Exchange::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.

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

◆ SetTextureFolder()

ExportFBXOptionsKit& HPS::Exchange::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 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 ExportFBXOptionsKit.
See also
Default value

◆ Show()

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

Copies this ExportFBXOptionsKit into the given ExportFBXOptionsKit.

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

◆ ShowAscii()

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

Shows the ascii export setting.

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

◆ ShowTextureFolder()

bool HPS::Exchange::ExportFBXOptionsKit::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()

ExportFBXOptionsKit& HPS::Exchange::ExportFBXOptionsKit::UnsetAscii ( )

Removes the ascii export setting.

Returns
A reference to this ExportFBXOptionsKit.

◆ UnsetEverything()

ExportFBXOptionsKit& HPS::Exchange::ExportFBXOptionsKit::UnsetEverything ( )

Removes all settings from this ExportFBXOptionsKit.

Returns
A reference to this ExportFBXOptionsKit.

◆ UnsetTextureFolder()

ExportFBXOptionsKit& HPS::Exchange::ExportFBXOptionsKit::UnsetTextureFolder ( )

Removes the texture folder setting.

Returns
A reference to this ExportFBXOptionsKit.

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