Merge pull request #492 from Unity-Technologies/v3.0.0-preview

v3.0.0-preview

Author: vkovec

CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changes in Fbx Exporter
 
+## [3.0.0-preview.2] - 2020-01-13
+### Added
+- Added FBX Recorder to record animations from the Unity Recorder directly to FBX (adds dependency to Unity Recorder).
+- Export animated focal length and lens shift of cameras.
+
+### Changed
+- Updated dependency to com.autodesk.fbx version 3.0.0-preview.1, which means we update to [FBX SDK 2020](http://help.autodesk.com/view/FBX/2020/ENU/).
+
+### Fixed
+- Fixed camera aspect and gate fit exporting as incorrect values.
+
+### Known Issues
+- Using the FBX Recorder to record animated characters is not supported yet, and fails in some cases.
 
 ## [2.0.3-preview.3] - 2019-09-24
 

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

@@ -3,6 +3,7 @@
 	* [FBX Linked Prefabs](prefabs)
 	* [Integration](integration)
 	* [FBX Export settings](options)
+	* [FBX Recorder](recorder)
 	* [Limitations](knownissues)
 	* [Troubleshooting](troubleshooting)
 	* [Developer's guide](devguide)

com.unity.formats.fbx/Documentation~/images/FBXExporter_AddRecorder.png

@@ -0,0 +1,26 @@
+# FBX Recorder
+
+With the FBX Exporter and the [Unity Recorder](https://docs.unity3d.com/Packages/[email protected]/index.html), it is possible to export animations (including [Cinemachine](https://docs.unity3d.com/Packages/[email protected]/manual/index.html) camera animations) directly to FBX in a few easy steps:
+
+1. Open the Recorder window by selecting (Window > General > Recorder > Recorder Window)
+2. In the Recorder window add a new FBX recorder
+
+![](images/FBXExporter_AddRecorder.png)
+
+3. Set the GameObject to record as well as any other desired settings
+4. Click "Start Recording" in the Recorder Window
+
+Alternatively, the FBX Recorder can be added as a track in the Timeline.
+
+## Fbx Recorder Settings
+
+![](images/FBXExporter_RecorderSettings.png)
+
+| Property:                     | Function:                                                    |
+| :---------------------------- | :----------------------------------------------------------- |
+| __File Name__            | The filename for the exported FBX. |
+| __Path__                 | The path to export the FBX to. Can be outside of the Assets folder. |
+| __Take Number__          | The take number can be set and used in the filename. It automatically increments after each recording. |
+| __Game Object__ | Set the Game Object in the scene to record. |
+| __Recorded Target(s)__     | Select which components of the selected GameObject to record. |
+| __Recorded Hierarchy__     | Check to record other objects in the hierarchy of the GameObject in addition to the selected GameObject. |

com.unity.formats.fbx/Documentation~/images/FBXExporter_RecorderSettings.png

@@ -8,6 +8,7 @@ This section covers the following issues:
 * [Overwriting FBX files](#OverwritingFiles)
 * [Tree primitive no longer editable after conversion](#EditableTree)
 * [Trail and line particles lose material after being converted](#ParticlesLoseMaterial)
+* [Uninstalling FBX Exporter breaks Unity Recorder](#BrokenRecorder)
 
 
 
@@ -71,3 +72,16 @@ To avoid this, make sure to convert only the Tree when finished editing. Otherwi
 
 If you lose Materials when converting trail or line particles, you need to re-apply the Materials to the FBX Linked Prefab after conversion.
 
+
+
+<a name="BrokenRecorder"></a>
+
+## Uninstalling FBX Exporter breaks Unity Recorder
+
+If you are uninstalling the FBX Exporter package but would like to continue using the Unity Recorder make sure to first remove all existing FBX Recorders.
+You can do this by right clicking on the FBX recorders in the Recorder Window or Timeline and selecting "Delete".
+
+If you have already uninstalled the FBX Exporter package and are now having issues with the Unity Recorder, follow these steps:
+1. Reinstall the FBX Exporter package
+2. Find and remove all FBX recorder instances (right click and Delete from the Recorder Window and Timeline(s))
+3. Uninstall the FBX Exporter from the Package Manager

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

@@ -16,6 +16,11 @@ protected override void RecordFrame(RecordingSession ctx)
 
         protected override void EndRecording(RecordingSession session)
         {
+            if(session == null)
+            {
+                throw new System.ArgumentNullException("session");
+            }
+
             var settings = (FbxRecorderSettings)session.settings;
 
             foreach (var input in m_Inputs)
@@ -58,10 +63,6 @@ protected override void EndRecording(RecordingSession session)
                 AnimationUtility.SetAnimationClips(animator, new AnimationClip[] { clip });
                 var exportSettings = new ExportModelSettingsSerialize();
                 var toInclude = ExportSettings.Include.ModelAndAnim;
-                if (!settings.ExportGeometry)
-                {
-                    toInclude = ExportSettings.Include.Anim;
-                } 
                 exportSettings.SetModelAnimIncludeOption(toInclude);
                 ModelExporter.ExportObject(clipName, root, exportSettings);
 

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

@@ -7,21 +7,8 @@
 namespace UnityEditor.Formats.Fbx.Exporter
 {
     [RecorderSettings(typeof(FbxRecorder), "FBX", "fbx_recorder")]
-    public class FbxRecorderSettings : RecorderSettings
+    internal class FbxRecorderSettings : RecorderSettings
     {
-        [SerializeField] bool m_exportGeometry = true;
-        public bool ExportGeometry
-        {
-            get
-            {
-                return m_exportGeometry;
-            }
-            set
-            {
-                m_exportGeometry = value;
-            }
-        }
-
         [SerializeField] AnimationInputSettings m_AnimationInputSettings = new AnimationInputSettings();
 
         public AnimationInputSettings animationInputSettings
@@ -76,6 +63,10 @@ protected override bool ValidityCheck(List<string> errors)
             if (m_AnimationInputSettings.gameObject == null)
             {
                 ok = false;
+                if(errors == null)
+                {
+                    throw new System.ArgumentNullException("errors");
+                }
                 errors.Add("No input object set");
             }
 

com.unity.formats.fbx/Editor/Sources/Recorders/FbxRecorder/FbxRecorder.cs

@@ -14,8 +14,6 @@ protected override void FileTypeAndFormatGUI()
             EditorGUILayout.LabelField("Format", "FBX");
 
             FbxRecorderSettings settings = target as FbxRecorderSettings;
-
-            settings.ExportGeometry = EditorGUILayout.Toggle("Export Geometry", settings.ExportGeometry);
         }
     }
 }

com.unity.formats.fbx/Editor/Sources/Recorders/FbxRecorder/FbxRecorderSettings.cs

@@ -1,11 +1,11 @@
 {
   "name": "com.unity.formats.fbx",
   "displayName": "FBX Exporter",
-  "version": "2.0.3-preview.3",
+  "version": "3.0.0-preview.2",
   "dependencies": {
     "com.unity.recorder": "2.1.0-preview.1",
     "com.unity.timeline": "1.0.0",
-    "com.autodesk.fbx": "2.0.1-preview.1"
+    "com.autodesk.fbx": "3.0.0-preview.1"
   },
   "unity": "2018.3",
   "unityRelease": "4f1",