
Public Member Functions | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this ExportOBJOptionsKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.Exchange.ExportOBJOptionsKit in_kit) |
Check if the source ExportOBJOptionsKit is equivalent to this ExportOBJOptionsKit. More... | |
ExportOBJOptionsKit () | |
The default constructor creates an empty ExportOBJOptionsKit object. More... | |
ExportOBJOptionsKit (HPS.Exchange.ExportOBJOptionsKit in_kit) | |
The copy constructor creates a new ExportOBJOptionsKit object that contains the same settings as the source ExportOBJOptionsKit. More... | |
override int | GetHashCode () |
override HPS.Type | ObjectType () |
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). More... | |
void | Set (HPS.Exchange.ExportOBJOptionsKit in_kit) |
Copies the source ExportOBJOptionsKit into this ExportOBJOptionsKit. More... | |
HPS.Exchange.ExportOBJOptionsKit | SetTextureFolder (string 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) More... | |
void | Show (out HPS.Exchange.ExportOBJOptionsKit out_kit) |
Copies this ExportOBJOptionsKit into the given ExportOBJOptionsKit. More... | |
bool | ShowTextureFolder (out string out_path) |
Shows the texture folder setting. More... | |
HPS.Exchange.ExportOBJOptionsKit | UnsetEverything () |
Removes all settings from this ExportOBJOptionsKit. More... | |
HPS.Exchange.ExportOBJOptionsKit | UnsetTextureFolder () |
Removes the texture folder setting. More... | |
![]() | |
SprocketKit (HPS.SprocketKit in_that) | |
![]() | |
Sprocket (HPS.Sprocket in_that) | |
![]() | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns the object's database handle, which can be used to determine which instance of a class the object is. For example, controls are simply aliases for segment keys that group related functions. Therefore, a SegmentKey and all of its controls would return the same instance id. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object that) | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
virtual HPS.Type | Type () |
This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More... | |
Static Public Member Functions | |
static HPS.Exchange.ExportOBJOptionsKit | GetDefault () |
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. More... | |
static bool | operator!= (HPS.Exchange.ExportOBJOptionsKit a, HPS.Exchange.ExportOBJOptionsKit b) |
static bool | operator== (HPS.Exchange.ExportOBJOptionsKit a, HPS.Exchange.ExportOBJOptionsKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
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/2]
|
inline |
The default constructor creates an empty ExportOBJOptionsKit object.
◆ ExportOBJOptionsKit() [2/2]
|
inline |
The copy constructor creates a new ExportOBJOptionsKit object that contains the same settings as the source ExportOBJOptionsKit.
- Parameters
-
in_kit The source ExportOBJOptionsKit to copy.
Member Function Documentation
◆ Empty()
|
inlinevirtual |
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()
|
inline |
Check if the source ExportOBJOptionsKit is equivalent to this ExportOBJOptionsKit.
- Parameters
-
in_kit The source ExportOBJOptionsKit to compare to this ExportOBJOptionsKit.
- Returns
- true if the objects are equivalent, false otherwise.
◆ GetDefault()
|
inlinestatic |
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()
|
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()
|
inline |
Copies the source ExportOBJOptionsKit into this ExportOBJOptionsKit.
- Parameters
-
in_kit The source ExportOBJOptionsKit to copy.
◆ SetTextureFolder()
|
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)
- 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 A3DRWParamsExportObjData::m_pcTextureFolder.
- Returns
- A reference to this ExportOBJOptionsKit.
◆ Show()
|
inline |
Copies this ExportOBJOptionsKit into the given ExportOBJOptionsKit.
- Parameters
-
out_kit The ExportOBJOptionsKit to populate with the contents of this ExportOBJOptionsKit.
◆ ShowTextureFolder()
|
inline |
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.
◆ UnsetEverything()
|
inline |
Removes all settings from this ExportOBJOptionsKit.
- Returns
- A reference to this ExportOBJOptionsKit.
◆ UnsetTextureFolder()
|
inline |
Removes the texture folder setting.
- Returns
- A reference to this ExportOBJOptionsKit.
The documentation for this class was generated from the following file:
- internals/hps_sprk_exchange/source/cs/HPS.Exchange.cs