#include <sprk_exchange.h>

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

Public Member Functions

bool Empty () const
 
bool Equals (ExportOBJOptionsKit const &in_kit) const
 
 ExportOBJOptionsKit ()
 
 ExportOBJOptionsKit (ExportOBJOptionsKit const &in_kit)
 
 ExportOBJOptionsKit (ExportOBJOptionsKit &&in_that)
 
HPS::Type ObjectType () const
 
bool operator!= (ExportOBJOptionsKit const &in_kit) const
 
ExportOBJOptionsKitoperator= (ExportOBJOptionsKit const &in_kit)
 
ExportOBJOptionsKitoperator= (ExportOBJOptionsKit &&in_that)
 
bool operator== (ExportOBJOptionsKit const &in_kit) const
 
void Set (ExportOBJOptionsKit const &in_kit)
 
ExportOBJOptionsKitSetTextureFolder (char const *in_name)
 
void Show (ExportOBJOptionsKit &out_kit) const
 
bool ShowTextureFolder (UTF8 &out_path) const
 
ExportOBJOptionsKitUnsetEverything ()
 
ExportOBJOptionsKitUnsetTextureFolder ()
 
- 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 ExportOBJOptionsKit 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::ExchangeExportOBJOptionsKit
 
- 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::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.

Constructor & Destructor Documentation

◆ ExportOBJOptionsKit() [1/3]

HPS::Exchange::ExportOBJOptionsKit::ExportOBJOptionsKit ( )

The default constructor creates an empty ExportOBJOptionsKit object.

◆ ExportOBJOptionsKit() [2/3]

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

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

Parameters
in_kitThe source ExportOBJOptionsKit to copy.

◆ ExportOBJOptionsKit() [3/3]

HPS::Exchange::ExportOBJOptionsKit::ExportOBJOptionsKit ( ExportOBJOptionsKit &&  in_that)

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

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

Member Function Documentation

◆ Empty()

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

Indicates whether this ExportOBJOptionsKit has any values set on it.

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

Reimplemented from HPS::Object.

◆ Equals()

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

Check if the source ExportOBJOptionsKit is equivalent to this ExportOBJOptionsKit.

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

◆ GetDefault()

static ExportOBJOptionsKit HPS::Exchange::ExportOBJOptionsKit::GetDefault ( )
static

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.

◆ ObjectType()

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

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

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

◆ operator=() [1/2]

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

Copies the source ExportOBJOptionsKit into this ExportOBJOptionsKit.

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

◆ operator=() [2/2]

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

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

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

◆ operator==()

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

Check if the source ExportOBJOptionsKit is equivalent to this ExportOBJOptionsKit.

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

◆ Set()

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

Copies the source ExportOBJOptionsKit into this ExportOBJOptionsKit.

Parameters
in_kitThe source ExportOBJOptionsKit to copy.

◆ SetTextureFolder()

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

◆ Show()

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

Copies this ExportOBJOptionsKit into the given ExportOBJOptionsKit.

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

◆ ShowTextureFolder()

bool HPS::Exchange::ExportOBJOptionsKit::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.

◆ UnsetEverything()

ExportOBJOptionsKit& HPS::Exchange::ExportOBJOptionsKit::UnsetEverything ( )

Removes all settings from this ExportOBJOptionsKit.

Returns
A reference to this ExportOBJOptionsKit.

◆ UnsetTextureFolder()

ExportOBJOptionsKit& HPS::Exchange::ExportOBJOptionsKit::UnsetTextureFolder ( )

Removes the texture folder setting.

Returns
A reference to this ExportOBJOptionsKit.

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