Handle low memory situations and change API of Importer/Exporter to take in option classes (#454)

* exporter options

* Switch to import options.  Add an option to throw when out of memory.  Implement throwing when out of memory.  Still need to properly clean up when that occurs.

* Clean up nodes when exceptions are thrown.

* more clean up when exception is thrown

* Add windows using.  Comments.  Tabs.

* move null check into Cleanup now that it's called multiple places

* Rename from CheckMemory to ThrowOnLowMemory to make it more clear what it does.  Add comments in all Obsolete attributes.

Author: AdamMitchell-ms

UnityGLTF/Assets/UnityGLTF/Examples/GLTFExporterTest.cs

@@ -5,15 +5,10 @@ namespace UnityGLTF.Examples
 {
 	public class GLTFExporterTest : MonoBehaviour
 	{
-		public string RetrieveTexturePath(UnityEngine.Texture texture)
-		{
-			return texture.name;
-		}
-
 		// Use this for initialization
 		void Awake()
 		{
-			var exporter = new GLTFSceneExporter(new[] {transform}, RetrieveTexturePath);
+			var exporter = new GLTFSceneExporter(new[] {transform}, new ExportOptions());
 			var appPath = Application.dataPath;
 			var wwwPath = appPath.Substring(0, appPath.LastIndexOf("Assets")) + "www";
 			exporter.SaveGLTFandBin(Path.Combine(wwwPath, "TestScene"), "TestScene");

UnityGLTF/Assets/UnityGLTF/Examples/MultiSceneComponent.cs

@@ -11,17 +11,19 @@ public class MultiSceneComponent : MonoBehaviour
 		public string Url;
 
 		private GLTFSceneImporter _importer;
-		private AsyncCoroutineHelper _asyncCoroutineHelper;
-		private ILoader _loader;
+		private ImportOptions _importOptions;
 		private string _fileName;
 
 		void Start()
 		{
 			Debug.Log("Hit spacebar to change the scene.");
-			_asyncCoroutineHelper = gameObject.AddComponent<AsyncCoroutineHelper>();
 			Uri uri = new Uri(Url);
 			var directoryPath = URIHelper.AbsoluteUriPath(uri);
-			_loader = new WebRequestLoader(directoryPath);
+			_importOptions = new ImportOptions
+			{
+				ExternalDataLoader = new WebRequestLoader(directoryPath),
+				AsyncCoroutineHelper = gameObject.AddComponent<AsyncCoroutineHelper>(),
+			};
 			_fileName = URIHelper.GetFileFromUri(uri);
 
 			LoadScene(SceneIndex);
@@ -46,8 +48,7 @@ async void LoadScene(int SceneIndex)
 
 			_importer = new GLTFSceneImporter(
 				_fileName,
-				_loader,
-				_asyncCoroutineHelper
+				_importOptions
 				);
 
 			_importer.SceneParent = gameObject.transform;

UnityGLTF/Assets/UnityGLTF/Examples/RootMergeComponent.cs

@@ -69,9 +69,12 @@ private async Task Start()
 			}
 			GLTFSceneImporter importer = new GLTFSceneImporter(
 				asset1Root,
-				loader1,
-				gameObject.AddComponent<AsyncCoroutineHelper>()
-				);
+				null,
+				new ImportOptions
+				{
+					ExternalDataLoader = loader1,
+					AsyncCoroutineHelper = gameObject.AddComponent<AsyncCoroutineHelper>()
+				});
 
 			importer.MaximumLod = MaximumLod;
 			importer.IsMultithreaded = Multithreaded;

UnityGLTF/Assets/UnityGLTF/Scripts/Editor/GLTFExportMenu.cs

@@ -42,7 +42,8 @@ static void ExportSelected()
 		else
 			throw new Exception("No objects selected, cannot export.");
 
-		var exporter = new GLTFSceneExporter(Selection.transforms, RetrieveTexturePath);
+		var exportOptions = new ExportOptions { TexturePathRetriever = RetrieveTexturePath };
+		var exporter = new GLTFSceneExporter(Selection.transforms, exportOptions);
 
 		var path = EditorUtility.OpenFolderPanel("glTF Export Path", "", "");
 		if (!string.IsNullOrEmpty(path)) {
@@ -61,7 +62,8 @@ static void ExportGLBSelected()
 		else
 			throw new Exception("No objects selected, cannot export.");
 
-		var exporter = new GLTFSceneExporter(Selection.transforms, RetrieveTexturePath);
+		var exportOptions = new ExportOptions { TexturePathRetriever = RetrieveTexturePath };
+		var exporter = new GLTFSceneExporter(Selection.transforms, exportOptions);
 
 		var path = EditorUtility.OpenFolderPanel("glTF Export Path", "", "");
 		if (!string.IsNullOrEmpty(path))
@@ -77,7 +79,8 @@ static void ExportScene()
 		var gameObjects = scene.GetRootGameObjects();
 		var transforms = Array.ConvertAll(gameObjects, gameObject => gameObject.transform);
 
-		var exporter = new GLTFSceneExporter(transforms, RetrieveTexturePath);
+		var exportOptions = new ExportOptions { TexturePathRetriever = RetrieveTexturePath };
+		var exporter = new GLTFSceneExporter(transforms, exportOptions);
 		var path = EditorUtility.OpenFolderPanel("glTF Export Path", "", "");
 		if (path != "") {
 			exporter.SaveGLTFandBin (path, scene.name);

UnityGLTF/Assets/UnityGLTF/Scripts/Editor/GLTFImporter.cs

@@ -334,12 +334,15 @@ public override void OnImportAsset(AssetImportContext ctx)
 
         private GameObject CreateGLTFScene(string projectFilePath)
         {
-			ILoader fileLoader = new FileLoader(Path.GetDirectoryName(projectFilePath));
+			var importOptions = new ImportOptions
+			{
+				ExternalDataLoader = new FileLoader(Path.GetDirectoryName(projectFilePath)),
+			};
 			using (var stream = File.OpenRead(projectFilePath))
 			{
 				GLTFRoot gLTFRoot;
 				GLTFParser.ParseJson(stream, out gLTFRoot);
-				var loader = new GLTFSceneImporter(gLTFRoot, fileLoader, null, stream);
+				var loader = new GLTFSceneImporter(gLTFRoot, stream, importOptions);
 				loader.MaximumLod = _maximumLod;
 				loader.IsMultithreaded = true;
 

UnityGLTF/Assets/UnityGLTF/Scripts/Factories/ImporterFactory.cs

@@ -5,14 +5,14 @@ namespace UnityGLTF
 {
 	public abstract class ImporterFactory : ScriptableObject
 	{
-		public abstract GLTFSceneImporter CreateSceneImporter(string gltfFileName, ILoader externalDataLoader, AsyncCoroutineHelper asyncCoroutineHelper);
+		public abstract GLTFSceneImporter CreateSceneImporter(string gltfFileName, ImportOptions options);
 	}
 
 	public class DefaultImporterFactory : ImporterFactory
 	{
-		public override GLTFSceneImporter CreateSceneImporter(string gltfFileName, ILoader externalDataLoader, AsyncCoroutineHelper asyncCoroutineHelper)
+		public override GLTFSceneImporter CreateSceneImporter(string gltfFileName, ImportOptions options)
 		{
-			return new GLTFSceneImporter(gltfFileName, externalDataLoader, asyncCoroutineHelper);
+			return new GLTFSceneImporter(gltfFileName, options);
 		}
 	}
 }

UnityGLTF/Assets/UnityGLTF/Scripts/GLTFComponent.cs

@@ -38,8 +38,6 @@ public class GLTFComponent : MonoBehaviour
 		public GLTFSceneImporter.ColliderType Collider = GLTFSceneImporter.ColliderType.None;
 		public GameObject LastLoadedScene { get; private set; } = null;
 
-		private AsyncCoroutineHelper asyncCoroutineHelper;
-
 		[SerializeField]
 		private Shader shaderOverride = null;
 
@@ -68,9 +66,13 @@ private async void Start()
 
 		public async Task Load()
 		{
-			asyncCoroutineHelper = gameObject.GetComponent<AsyncCoroutineHelper>() ?? gameObject.AddComponent<AsyncCoroutineHelper>();
+			var importOptions = new ImportOptions
+			{
+				AsyncCoroutineHelper = gameObject.GetComponent<AsyncCoroutineHelper>() ?? gameObject.AddComponent<AsyncCoroutineHelper>(),
+				ExternalDataLoader = null,
+			};
+
 			GLTFSceneImporter sceneImporter = null;
-			ILoader loader = null;
 			try
 			{
                 Factory = Factory ?? ScriptableObject.CreateInstance<DefaultImporterFactory>();
@@ -90,22 +92,20 @@ public async Task Load()
 						fullPath = GLTFUri;
 					}
 					string directoryPath = URIHelper.GetDirectoryName(fullPath);
-					loader = new FileLoader(directoryPath);
+					importOptions.ExternalDataLoader = new FileLoader(directoryPath);
 					sceneImporter = Factory.CreateSceneImporter(
 						Path.GetFileName(GLTFUri),
-						loader,
-						asyncCoroutineHelper
+						importOptions
 						);
 				}
 				else
 				{
 					string directoryPath = URIHelper.GetDirectoryName(GLTFUri);
-					loader = new WebRequestLoader(directoryPath);
+					importOptions.ExternalDataLoader = new WebRequestLoader(directoryPath);
 
 					sceneImporter = Factory.CreateSceneImporter(
 						URIHelper.GetFileFromUri(new Uri(GLTFUri)),
-						loader,
-						asyncCoroutineHelper
+						importOptions
 						);
 
 				}
@@ -151,11 +151,11 @@ public async Task Load()
 			}
 			finally
 			{
-				if(loader != null)
+				if(importOptions.ExternalDataLoader != null)
 				{
 					sceneImporter?.Dispose();
 					sceneImporter = null;
-					loader = null;
+					importOptions.ExternalDataLoader = null;
 				}
 			}
 		}

UnityGLTF/Assets/UnityGLTF/Scripts/GLTFSceneExporter.cs

@@ -11,6 +11,12 @@
 
 namespace UnityGLTF
 {
+	public class ExportOptions
+	{
+		public GLTFSceneExporter.RetrieveTexturePathDelegate TexturePathRetriever = (texture) => texture.name;
+		public bool ExportInactivePrimitives = true;
+	}
+
 	public class GLTFSceneExporter
 	{
 		public delegate string RetrieveTexturePathDelegate(Texture texture);
@@ -53,7 +59,7 @@ private struct ImageInfo
 		private List<Material> _materials;
 		private bool _shouldUseInternalBufferForImages;
 
-		private RetrieveTexturePathDelegate _retrieveTexturePathDelegate;
+		private ExportOptions _exportOptions;
 
 		private Material _metalGlossChannelSwapMaterial;
 		private Material _normalChannelMaterial;
@@ -82,9 +88,19 @@ protected struct PrimKey
 		/// Create a GLTFExporter that exports out a transform
 		/// </summary>
 		/// <param name="rootTransforms">Root transform of object to export</param>
-		public GLTFSceneExporter(Transform[] rootTransforms, RetrieveTexturePathDelegate retrieveTexturePathDelegate)
+		[Obsolete("Please switch to GLTFSceneExporter(Transform[] rootTransforms, ExportOptions options).  This constructor is deprecated and will be removed in a future release.")]
+		public GLTFSceneExporter(Transform[] rootTransforms, RetrieveTexturePathDelegate texturePathRetriever)
+			: this(rootTransforms, new ExportOptions { TexturePathRetriever = texturePathRetriever })
+		{
+		}
+
+		/// <summary>
+		/// Create a GLTFExporter that exports out a transform
+		/// </summary>
+		/// <param name="rootTransforms">Root transform of object to export</param>
+		public GLTFSceneExporter(Transform[] rootTransforms, ExportOptions options)
 		{
-			_retrieveTexturePathDelegate = retrieveTexturePathDelegate;
+			_exportOptions = options;
 
 			var metalGlossChannelSwapShader = Resources.Load("MetalGlossChannelSwap", typeof(Shader)) as Shader;
 			_metalGlossChannelSwapMaterial = new Material(metalGlossChannelSwapShader);
@@ -412,7 +428,7 @@ private void ExportTexture(Texture2D texture, string outputPath)
 
 		private string ConstructImageFilenamePath(Texture2D texture, string outputPath)
 		{
-			var imagePath = _retrieveTexturePathDelegate(texture);
+			var imagePath = _exportOptions.TexturePathRetriever(texture);
 			if (string.IsNullOrEmpty(imagePath))
 			{
 				imagePath = Path.Combine(outputPath, texture.name);
@@ -1254,7 +1270,7 @@ private ImageId ExportImage(Texture texture, TextureMapType texturMapType)
 				textureMapType = texturMapType
 			});
 
-			var imagePath =_retrieveTexturePathDelegate(texture);
+			var imagePath = _exportOptions.TexturePathRetriever(texture);
 			if (string.IsNullOrEmpty(imagePath))
 			{
 				imagePath = texture.name;