Skip to content

Commit fb5a8e9

Browse files
unitALGDavid Lassonde
authored andcommitted
Edited content of FBX Exporter documentation for v2.x
1 parent 1931250 commit fb5a8e9

File tree

8 files changed

+290
-178
lines changed

8 files changed

+290
-178
lines changed

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

Lines changed: 269 additions & 166 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
{
@@ -4093,33 +4096,39 @@ internal static string ExportObject (
40934096
}
40944097

40954098
/// <summary>
4096-
/// Exports an array of Unity game objects to an FBX file.
4097-
/// Returns the FBX file path if successful, otherwise returns null.
4099+
/// Exports an array of Unity GameObjects to an FBX file.
40984100
/// </summary>
4101+
/// <returns>
4102+
/// Returns the FBX file path if successful; otherwise returns null.
4103+
/// </returns>
40994104
/// <param name="filePath">Absolute file path to use for the FBX file.</param>
4100-
/// <param name="objects">Array of Unity objects to export.</param>
4105+
/// <param name="objects">Array of Unity GameObjects to export.</param>
41014106
[SecurityPermission(SecurityAction.LinkDemand)]
41024107
public static string ExportObjects(string filePath, UnityEngine.Object[] objects = null)
41034108
{
41044109
return ExportObjects(filePath, objects, exportOptions: null, exportData: null);
41054110
}
41064111

41074112
/// <summary>
4108-
/// Exports a single Unity game object to an FBX file.
4109-
/// Returns the FBX file path if successful, otherwise returns null.
4113+
/// Exports a single Unity GameObject to an FBX file.
41104114
/// </summary>
4115+
/// <returns>
4116+
/// The FBX file path if successful; otherwise null.
4117+
/// </returns>
41114118
/// <param name="filePath">Absolute file path to use for the FBX file.</param>
4112-
/// <param name="singleObject">The Unity object to export.</param>
4119+
/// <param name="singleObject">The Unity GameObject to export.</param>
41134120
[SecurityPermission(SecurityAction.LinkDemand)]
41144121
public static string ExportObject (string filePath, UnityEngine.Object singleObject)
41154122
{
41164123
return ExportObjects(filePath, new Object[] {singleObject}, exportOptions: null);
41174124
}
41184125

41194126
/// <summary>
4120-
/// Export a list of (Game) objects to FBX file.
4121-
/// Use the SaveFile panel to allow user to enter a file name.
4122-
/// <summary>
4127+
/// Exports a list of GameObjects to an FBX file.
4128+
/// <para>
4129+
/// Use the SaveFile panel to allow the user to enter a file name.
4130+
/// </para>
4131+
/// </summary>
41234132
[SecurityPermission(SecurityAction.LinkDemand)]
41244133
internal static string ExportObjects (
41254134
string filePath,

0 commit comments

Comments
 (0)