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

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Exchange.ExportGLTFOptionsKit in_kit)
 
 ExportGLTFOptionsKit ()
 
 ExportGLTFOptionsKit (HPS.Exchange.ExportGLTFOptionsKit in_kit)
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 
void Set (HPS.Exchange.ExportGLTFOptionsKit in_kit)
 
HPS.Exchange.ExportGLTFOptionsKit SetAscii (bool in_state)
 
HPS.Exchange.ExportGLTFOptionsKit SetTextureFolder (string in_name)
 
void Show (out HPS.Exchange.ExportGLTFOptionsKit out_kit)
 
bool ShowAscii (out bool out_state)
 
bool ShowTextureFolder (out string out_path)
 
HPS.Exchange.ExportGLTFOptionsKit UnsetAscii ()
 
HPS.Exchange.ExportGLTFOptionsKit UnsetEverything ()
 
HPS.Exchange.ExportGLTFOptionsKit UnsetTextureFolder ()
 
- Public Member Functions inherited from HPS.SprocketKit
SprocketKit (HPS.SprocketKit in_that)
 
- Public Member Functions inherited from HPS.Sprocket
Sprocket (HPS.Sprocket in_that)
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
Object (HPS.Object that)
 
virtual void Reset ()
 
virtual HPS.Type Type ()
 

Static Public Member Functions

static HPS.Exchange.ExportGLTFOptionsKit GetDefault ()
 
static bool operator!= (HPS.Exchange.ExportGLTFOptionsKit a, HPS.Exchange.ExportGLTFOptionsKit b)
 
static bool operator== (HPS.Exchange.ExportGLTFOptionsKit a, HPS.Exchange.ExportGLTFOptionsKit b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

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/2]

HPS.Exchange.ExportGLTFOptionsKit.ExportGLTFOptionsKit ( )
inline

The default constructor creates an empty ExportGLTFOptionsKit object.

◆ ExportGLTFOptionsKit() [2/2]

HPS.Exchange.ExportGLTFOptionsKit.ExportGLTFOptionsKit ( HPS.Exchange.ExportGLTFOptionsKit  in_kit)
inline

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

Parameters
in_kitThe source ExportGLTFOptionsKit to copy.

Member Function Documentation

◆ Empty()

override bool HPS.Exchange.ExportGLTFOptionsKit.Empty ( )
inlinevirtual

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 ( HPS.Exchange.ExportGLTFOptionsKit  in_kit)
inline

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 HPS.Exchange.ExportGLTFOptionsKit HPS.Exchange.ExportGLTFOptionsKit.GetDefault ( )
inlinestatic

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()

override HPS.Type HPS.Exchange.ExportGLTFOptionsKit.ObjectType ( )
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.

◆ Set()

void HPS.Exchange.ExportGLTFOptionsKit.Set ( HPS.Exchange.ExportGLTFOptionsKit  in_kit)
inline

Copies the source ExportGLTFOptionsKit into this ExportGLTFOptionsKit.

Parameters
in_kitThe source ExportGLTFOptionsKit to copy.

◆ SetAscii()

HPS.Exchange.ExportGLTFOptionsKit HPS.Exchange.ExportGLTFOptionsKit.SetAscii ( bool  in_state)
inline

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()

HPS.Exchange.ExportGLTFOptionsKit HPS.Exchange.ExportGLTFOptionsKit.SetTextureFolder ( string  in_name)
inline

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 ( out HPS.Exchange.ExportGLTFOptionsKit  out_kit)
inline

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 ( out bool  out_state)
inline

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 ( out string  out_path)
inline

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()

HPS.Exchange.ExportGLTFOptionsKit HPS.Exchange.ExportGLTFOptionsKit.UnsetAscii ( )
inline

Removes the ascii export setting.

Returns
A reference to this ExportGLTFOptionsKit.

◆ UnsetEverything()

HPS.Exchange.ExportGLTFOptionsKit HPS.Exchange.ExportGLTFOptionsKit.UnsetEverything ( )
inline

Removes all settings from this ExportGLTFOptionsKit.

Returns
A reference to this ExportGLTFOptionsKit.

◆ UnsetTextureFolder()

HPS.Exchange.ExportGLTFOptionsKit HPS.Exchange.ExportGLTFOptionsKit.UnsetTextureFolder ( )
inline

Removes the texture folder setting.

Returns
A reference to this ExportGLTFOptionsKit.

The documentation for this class was generated from the following file:
  • internals/hps_sprk_exchange/source/cs/HPS.Exchange.cs