Merge branch 'master' into UT-3102-use-deepconvert

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

@@ -1,13 +1,23 @@
 using UnityEngine;
 using Autodesk.Fbx;
 using UnityEditor.Formats.Fbx.Exporter.CustomExtensions;
+using System.Collections.Generic;
 
 namespace UnityEditor.Formats.Fbx.Exporter
 {
     namespace Visitors
     {
         internal static class CameraVisitor
         {
+            private static Dictionary<Camera.GateFitMode, FbxCamera.EGateFit> s_mapGateFit = new Dictionary<Camera.GateFitMode, FbxCamera.EGateFit>()
+            {
+                { Camera.GateFitMode.Fill, FbxCamera.EGateFit.eFitFill },
+                { Camera.GateFitMode.Horizontal, FbxCamera.EGateFit.eFitHorizontal },
+                { Camera.GateFitMode.None, FbxCamera.EGateFit.eFitNone },
+                { Camera.GateFitMode.Overscan, FbxCamera.EGateFit.eFitOverscan },
+                { Camera.GateFitMode.Vertical, FbxCamera.EGateFit.eFitVertical }
+            };
+
             /// <summary>
             /// Visit Object and configure FbxCamera
             /// </summary>
@@ -56,6 +66,14 @@ private static void ConfigureGameCamera (FbxCamera fbxCamera, Camera unityCamera
                 return ;
             }
 
+            public static Vector2 GetSizeOfMainGameView()
+            {
+                System.Type T = System.Type.GetType("UnityEditor.GameView,UnityEditor");
+                System.Reflection.MethodInfo GetSizeOfMainGameView = T.GetMethod("GetSizeOfMainGameView", System.Reflection.BindingFlags.NonPublic | System.Reflection.BindingFlags.Static);
+                System.Object Res = GetSizeOfMainGameView.Invoke(null, null);
+                return (Vector2)Res;
+            }
+
             /// <summary>
             /// Configure FbxCameras from a Physical Camera 
             /// </summary>
@@ -80,16 +98,19 @@ private static void ConfigurePhysicalCamera (FbxCamera fbxCamera, Camera unityCa
 
                 fbxCamera.ProjectionType.Set(projectionType);
                 fbxCamera.FilmAspectRatio.Set(aspectRatio);
+
+                Vector2 gameViewSize = GetSizeOfMainGameView();
+                fbxCamera.SetAspect(FbxCamera.EAspectRatioMode.eFixedRatio, gameViewSize.x/gameViewSize.y, 1.0);
                 fbxCamera.SetApertureWidth (apertureWidthInInches);
                 fbxCamera.SetApertureHeight (apertureHeightInInches);
 
                 // Fit the resolution gate horizontally within the film gate.
-                fbxCamera.GateFit.Set(FbxCamera.EGateFit.eFitHorizontal);
+                fbxCamera.GateFit.Set(s_mapGateFit[unityCamera.gateFit]);
 
                 // Lens Shift ( Film Offset ) as a percentage 0..1
                 // FBX FilmOffset is in inches
-                fbxCamera.FilmOffsetX.Set(apertureWidthInInches * Mathf.Clamp(unityCamera.lensShift.x, 0f, 1f));
-                fbxCamera.FilmOffsetY.Set(apertureHeightInInches * Mathf.Clamp(unityCamera.lensShift.y, 0f, 1f));
+                fbxCamera.FilmOffsetX.Set(apertureWidthInInches * Mathf.Clamp(Mathf.Abs(unityCamera.lensShift.x), 0f, 1f) * Mathf.Sign(unityCamera.lensShift.x));
+                fbxCamera.FilmOffsetY.Set(apertureHeightInInches * Mathf.Clamp(Mathf.Abs(unityCamera.lensShift.y), 0f, 1f) * Mathf.Sign(unityCamera.lensShift.y));
 
                 // Focal Length
                 fbxCamera.SetApertureMode (FbxCamera.EApertureMode.eFocalLength); 
@@ -102,7 +123,6 @@ private static void ConfigurePhysicalCamera (FbxCamera fbxCamera, Camera unityCa
 
                 // FarPlane
                 fbxCamera.SetFarPlane ((float)unityCamera.farClipPlane.Meters().ToCentimeters());
-
                 return ;
             }
         }

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

@@ -1939,14 +1939,22 @@ private void ExportAnimationCurve (FbxNode fbxNode,
                     Debug.LogError (string.Format ("no fbx property {0} found on {1} node or nodeAttribute ", fbxPropertyChannelPair.Property, fbxNode.GetName ()));
                     return;
                 }
+                if (!fbxProperty.GetFlag(FbxPropertyFlags.EFlags.eAnimatable))
+                {
+                    Debug.LogErrorFormat("fbx property {0} found on node {1} is not animatable", fbxPropertyChannelPair.Property, fbxNode.GetName());
+                }
 
                 // Create the AnimCurve on the channel
                 FbxAnimCurve fbxAnimCurve = fbxProperty.GetCurve (fbxAnimLayer, fbxPropertyChannelPair.Channel, true);
+                if(fbxAnimCurve == null)
+                {
+                    return;
+                }
 
                 // create a convert scene helper so that we can convert from Unity to Maya
                 // AxisSystem (LeftHanded to RightHanded) and FBX's default units 
                 // (Meters to Centimetres)
-                var convertSceneHelper = new UnityToMayaConvertSceneHelper (uniPropertyName);
+                var convertSceneHelper = new UnityToMayaConvertSceneHelper (uniPropertyName, fbxNode);
 
                 if (ModelExporter.ExportSettings.BakeAnimationProperty) {
                     ExportAnimationSamples (uniAnimCurve, fbxAnimCurve, frameRate, convertSceneHelper);
@@ -1960,10 +1968,14 @@ internal class UnityToMayaConvertSceneHelper
         {
             bool convertDistance = false;
             bool convertToRadian = false;
+            bool convertLensShiftX = false;
+            bool convertLensShiftY = false;
+
+            FbxCamera camera = null;
 
             float unitScaleFactor = 1f;
 
-            public UnityToMayaConvertSceneHelper(string uniPropertyName)
+            public UnityToMayaConvertSceneHelper(string uniPropertyName, FbxNode fbxNode)
             {
                 System.StringComparison cc = System.StringComparison.CurrentCulture;
 
@@ -1972,6 +1984,12 @@ public UnityToMayaConvertSceneHelper(string uniPropertyName)
                 convertDistance |= partT;
                 convertDistance |= uniPropertyName.StartsWith ("m_Intensity", cc);
                 convertDistance |= uniPropertyName.ToLower().EndsWith("weight", cc);
+                convertLensShiftX |= uniPropertyName.StartsWith("m_LensShift.x", cc);
+                convertLensShiftY |= uniPropertyName.StartsWith("m_LensShift.y", cc);
+                if (convertLensShiftX || convertLensShiftY)
+                {
+                    camera = fbxNode.GetCamera();
+                }
 
                 // The ParentConstraint's source Rotation Offsets are read in as radians, so make sure they are exported as radians
                 convertToRadian = uniPropertyName.StartsWith("m_RotationOffsets.Array.data", cc);
@@ -1987,9 +2005,26 @@ public UnityToMayaConvertSceneHelper(string uniPropertyName)
 
             public float Convert(float value)
             {
+                float convertedValue = value;
+                if (convertLensShiftX || convertLensShiftY)
+                {
+                    convertedValue = Mathf.Clamp(Mathf.Abs(value), 0f, 1f)*Mathf.Sign(value);
+                }
+                if (camera != null)
+                {
+                    if (convertLensShiftX)
+                    {
+                        convertedValue *= (float)camera.GetApertureWidth();
+                    }
+                    else if (convertLensShiftY)
+                    {
+                        convertedValue *= (float)camera.GetApertureHeight();
+                    }
+                }
+
                 // left handed to right handed conversion
                 // meters to centimetres conversion
-                return unitScaleFactor * value;
+                return unitScaleFactor * convertedValue;
             }
 
         }

com.unity.formats.fbx/Editor/CameraVisitor.cs

@@ -91,7 +91,10 @@ public PropertyChannelMap(Dictionary<string,string> propertyMap, Dictionary<stri
             {
                 { "m_Intensity", "Intensity" },
                 { "field of view", "FieldOfView" },
-                { "m_Weight", "Weight" }
+                { "m_Weight", "Weight" },
+                { "m_FocalLength", "FocalLength" },
+                { "m_LensShift.x", "FilmOffsetX" },
+                { "m_LensShift.y", "FilmOffsetY" }
             };
 
         /// <summary>