Skip to content

Commit 99e2189

Browse files
committed
Edited content of FBX Exporter documentation for v2.x
1 parent 53675fc commit 99e2189

File tree

8 files changed

+293
-192
lines changed

8 files changed

+293
-192
lines changed

Packages/com.unity.formats.fbx/Documentation~/com.unity.formats.fbx.md

Lines changed: 272 additions & 180 deletions
Large diffs are not rendered by default.
Binary file not shown.
-64 KB
Loading
-58.8 KB
Loading
-60.6 KB
Loading
Binary file not shown.
14.6 KB
Loading

Packages/com.unity.formats.fbx/Editor/Scripts/FbxExporter.cs

Lines changed: 21 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -58,9 +58,12 @@ protected ModelExportException(SerializationInfo info, StreamingContext context)
5858
}
5959

6060
/// <summary>
61-
/// The ModelExporter class can be used to export Unity game objects to an FBX File.
62-
/// To do so, simply use its ExportObject and ExportObjects methods. The default export
61+
/// Use the ModelExporter class to export Unity GameObjects to an FBX file.
62+
/// <para>
63+
/// Use the ExportObject and ExportObjects methods. The default export
6364
/// options are used when exporting the objects to the FBX file.
65+
/// <para>
66+
/// <para>For information on using the ModelExporter class.</para>
6467
/// </summary>
6568
public sealed class ModelExporter : System.IDisposable
6669
{
@@ -4051,7 +4054,7 @@ bool ExportMesh (GameObject gameObject, FbxNode fbxNode)
40514054
internal int NumTriangles { set; get; }
40524055

40534056
/// <summary>
4054-
/// Clean up this class on garbage collection
4057+
/// Cleans up this class on garbage collection
40554058
/// </summary>
40564059
public void Dispose ()
40574060
{
@@ -4098,33 +4101,39 @@ internal static string ExportObject (
40984101
}
40994102

41004103
/// <summary>
4101-
/// Exports an array of Unity game objects to an FBX file.
4102-
/// Returns the FBX file path if successful, otherwise returns null.
4104+
/// Exports an array of Unity GameObjects to an FBX file.
41034105
/// </summary>
4106+
/// <returns>
4107+
/// Returns the FBX file path if successful; otherwise returns null.
4108+
/// </returns>
41044109
/// <param name="filePath">Absolute file path to use for the FBX file.</param>
4105-
/// <param name="objects">Array of Unity objects to export.</param>
4110+
/// <param name="objects">Array of Unity GameObjects to export.</param>
41064111
[SecurityPermission(SecurityAction.LinkDemand)]
41074112
public static string ExportObjects(string filePath, UnityEngine.Object[] objects = null)
41084113
{
41094114
return ExportObjects(filePath, objects, exportOptions: null, exportData: null);
41104115
}
41114116

41124117
/// <summary>
4113-
/// Exports a single Unity game object to an FBX file.
4114-
/// Returns the FBX file path if successful, otherwise returns null.
4118+
/// Exports a single Unity GameObject to an FBX file.
41154119
/// </summary>
4120+
/// <returns>
4121+
/// The FBX file path if successful; otherwise null.
4122+
/// </returns>
41164123
/// <param name="filePath">Absolute file path to use for the FBX file.</param>
4117-
/// <param name="singleObject">The Unity object to export.</param>
4124+
/// <param name="singleObject">The Unity GameObject to export.</param>
41184125
[SecurityPermission(SecurityAction.LinkDemand)]
41194126
public static string ExportObject (string filePath, UnityEngine.Object singleObject)
41204127
{
41214128
return ExportObjects(filePath, new Object[] {singleObject}, exportOptions: null);
41224129
}
41234130

41244131
/// <summary>
4125-
/// Export a list of (Game) objects to FBX file.
4126-
/// Use the SaveFile panel to allow user to enter a file name.
4127-
/// <summary>
4132+
/// Exports a list of GameObjects to an FBX file.
4133+
/// <para>
4134+
/// Use the SaveFile panel to allow the user to enter a file name.
4135+
/// </para>
4136+
/// </summary>
41284137
[SecurityPermission(SecurityAction.LinkDemand)]
41294138
internal static string ExportObjects (
41304139
string filePath,

0 commit comments

Comments
 (0)