Skip to content

#USDU-155 Create import/export helpers to clean the UsdMenu #237

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Mar 12, 2021
Merged

#USDU-155 Create import/export helpers to clean the UsdMenu #237

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
2a32c2f
Extract import/export logic from UsdMenu
judubu Feb 17, 2021
3cd29eb
Improve ExportHelpers for runtime
judubu Feb 22, 2021
53a493c
Fix ImportHelpers for runtime use
judubu Feb 22, 2021
ace6d65
Add ImportHelpersTests and BaseFixture class
judubu Feb 26, 2021
9e7fbec
Disable the usdFullPath textField. We have a button for that.
judubu Feb 26, 2021
4090a9a
Add ExportHelpersTests
judubu Feb 26, 2021
045b6ff
Add missing Scene.Close call to export tests
judubu Mar 8, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion package/com.unity.formats.usd/Editor/Scripts/Behaviors/UsdAssetEditor.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,10 @@ private void DrawSimpleInspector(UsdAsset usdAsset)

EditorGUILayout.BeginHorizontal();
EditorGUILayout.PrefixLabel("USD File");
usdAsset.usdFullPath = EditorGUILayout.TextField(usdAsset.usdFullPath, EditorStyles.textField);
GUI.enabled = false;
EditorGUILayout.TextField(usdAsset.usdFullPath, EditorStyles.textField);
GUI.enabled = true;

if (GUILayout.Button("..."))
{
string lastDir;
Expand Down
274 changes: 13 additions & 261 deletions package/com.unity.formats.usd/Editor/Scripts/Behaviors/UsdMenu.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,50 +21,8 @@

namespace Unity.Formats.USD
{
public class UsdMenu : MonoBehaviour
public static class UsdMenu
{
public static Scene InitForSave(string defaultName, string fileExtension = "usd,usda,usdc")
{
var filePath = EditorUtility.SaveFilePanel("Export USD File", "", defaultName, fileExtension);

if (filePath == null || filePath.Length == 0)
{
return null;
}

var fileDir = Path.GetDirectoryName(filePath);

if (!Directory.Exists(fileDir))
{
var di = Directory.CreateDirectory(fileDir);
if (!di.Exists)
{
Debug.LogError("Failed to create directory: " + fileDir);
return null;
}
}

InitUsd.Initialize();
var scene = Scene.Create(filePath);
scene.Time = 0;
scene.StartTime = 0;
scene.EndTime = 0;
return scene;
}

public static Scene InitForOpen()
{
string path = EditorUtility.OpenFilePanel("Import USD File", "", "usd,usda,usdc,abc");
if (path == null || path.Length == 0)
{
return null;
}

InitUsd.Initialize();
var stage = pxr.UsdStage.Open(path, pxr.UsdStage.InitialLoadSet.LoadNone);
return Scene.Open(stage);
}

[MenuItem("USD/Export Selected with Children", true)]
static bool EnableMenuExportSelectedWithChildren()
{
Expand All @@ -74,7 +32,10 @@ static bool EnableMenuExportSelectedWithChildren()
[MenuItem("USD/Export Selected with Children", priority = 50)]
static void MenuExportSelectedWithChildren()
{
ExportSelected(BasisTransformation.SlowAndSafe);
var go = Selection.gameObjects.First();
var filePath = EditorUtility.SaveFilePanel("Export USD File", "", go.name, "usd,usda,usdc");
var scene = ExportHelpers.InitForSave(filePath);
ExportHelpers.ExportGameObjects(Selection.gameObjects, scene,BasisTransformation.SlowAndSafe);
}

[MenuItem("USD/Export Transform Overrides", true)]
Expand All @@ -87,7 +48,8 @@ static bool EnableMenuExportTransforms()
static public void MenuExportTransforms()
{
var root = Selection.activeGameObject.GetComponentInParent<UsdAsset>();
var overs = InitForSave(Path.GetFileNameWithoutExtension(root.usdFullPath) + "_overs");
var filePath = EditorUtility.SaveFilePanel("Export USD File", "", Path.GetFileNameWithoutExtension(root.usdFullPath) + "_overs", "usd,usda,usdc");
var overs = ExportHelpers.InitForSave(filePath);
root.ExportOverrides(overs);
}

Expand Down Expand Up @@ -167,188 +129,42 @@ static void MenuExportLoadFromUsd() {
}
#endif

static private pxr.SdfPath GetDefaultRoot(Scene scene)
{
// We can't safely assume the default prim is the model root, because Alembic files will
// always have a default prim set arbitrarily.

// If there is only one root prim, reference this prim.
var children = scene.Stage.GetPseudoRoot().GetChildren().ToList();
if (children.Count == 1)
{
return children[0].GetPath();
}

// Otherwise there are 0 or many root prims, in this case the best option is to reference
// them all, to avoid confusion.
return pxr.SdfPath.AbsoluteRootPath();
}

static void ExportSelected(BasisTransformation basisTransform,
string fileExtension = "usd,usda,usdc",
bool exportMonoBehaviours = false)
{
Scene scene = null;

foreach (GameObject go in Selection.gameObjects)
{
if (scene == null)
{
scene = InitForSave(go.name, fileExtension);
if (scene == null)
{
return;
}
}

try
{
SceneExporter.Export(go, scene, basisTransform,
exportUnvarying: true, zeroRootTransform: false,
exportMonoBehaviours: exportMonoBehaviours);
}
catch (System.Exception ex)
{
Debug.LogException(ex);
continue;
}
}

if (scene != null)
{
scene.Save();
scene.Close();
}
}

[MenuItem("USD/Import as GameObjects", priority = 0)]
public static void MenuImportAsGameObjects()
{
var scene = InitForOpen();
var scene = ImportHelpers.InitForOpen();
if (scene == null)
{
return;
}

ImportSceneAsGameObject(scene);
ImportHelpers.ImportSceneAsGameObject(scene, Selection.activeGameObject);
scene.Close();
}

public static GameObject ImportSceneAsGameObject(Scene scene, SceneImportOptions importOptions = null)
{
string path = scene.FilePath;

// Time-varying data is not supported and often scenes are written without "Default" time
// values, which makes setting an arbitrary time safer (because if only default was authored
// the time will be ignored and values will resolve to default time automatically).
scene.Time = 1.0;

if (importOptions == null)
{
importOptions = new SceneImportOptions();
importOptions.changeHandedness = BasisTransformation.SlowAndSafe;
importOptions.materialImportMode = MaterialImportMode.ImportDisplayColor;
importOptions.usdRootPath = GetDefaultRoot(scene);
}

GameObject root = new GameObject(GetObjectName(importOptions.usdRootPath, path));

if (Selection.gameObjects.Length > 0)
{
root.transform.SetParent(Selection.gameObjects[0].transform);
}

try
{
UsdToGameObject(root, scene, importOptions);
return root;
}
catch (SceneImporter.ImportException)
{
GameObject.DestroyImmediate(root);
return null;
}
}

[MenuItem("USD/Import as Prefab", priority = 1)]
public static void MenuImportAsPrefab()
{
var scene = InitForOpen();
var scene = ImportHelpers.InitForOpen();
if (scene == null)
{
return;
}

string path = scene.FilePath;

// Time-varying data is not supported and often scenes are written without "Default" time
// values, which makes setting an arbitrary time safer (because if only default was authored
// the time will be ignored and values will resolve to default time automatically).
scene.Time = 1.0;

var importOptions = new SceneImportOptions();
importOptions.projectAssetPath = GetSelectedAssetPath();
importOptions.changeHandedness = BasisTransformation.SlowAndSafe;
importOptions.materialImportMode = MaterialImportMode.ImportDisplayColor;
importOptions.usdRootPath = GetDefaultRoot(scene);

var invalidChars = Path.GetInvalidFileNameChars();
var prefabName = string.Join("_", GetPrefabName(path).Split(invalidChars,
System.StringSplitOptions.RemoveEmptyEntries)).TrimEnd('.');
string prefabPath = importOptions.projectAssetPath + prefabName + ".prefab";
prefabPath = AssetDatabase.GenerateUniqueAssetPath(prefabPath);
string clipName = Path.GetFileNameWithoutExtension(path);

var go = new GameObject(GetObjectName(importOptions.usdRootPath, path));
try
{
UsdToGameObject(go, scene, importOptions);
SceneImporter.SavePrefab(go, prefabPath, clipName, importOptions);
}
finally
{
GameObject.DestroyImmediate(go);
scene.Close();
}
ImportHelpers.ImportAsPrefab(scene);
}

[MenuItem("USD/Import as Timeline Clip", priority = 2)]
public static void MenuImportAsTimelineClip()
{
var scene = InitForOpen();
var scene = ImportHelpers.InitForOpen();
if (scene == null)
{
return;
}

string path = scene.FilePath;

var invalidChars = Path.GetInvalidFileNameChars();
var prefabName = string.Join("_", GetPrefabName(path).Split(invalidChars,
System.StringSplitOptions.RemoveEmptyEntries)).TrimEnd('.');

string prefabPath = GetSelectedAssetPath() + prefabName + ".prefab";
prefabPath = AssetDatabase.GenerateUniqueAssetPath(prefabPath);
string clipName = Path.GetFileNameWithoutExtension(path);

var importOptions = new SceneImportOptions();
importOptions.projectAssetPath = GetSelectedAssetPath();
importOptions.changeHandedness = BasisTransformation.FastWithNegativeScale;
importOptions.materialImportMode = MaterialImportMode.ImportDisplayColor;
importOptions.usdRootPath = GetDefaultRoot(scene);

var go = new GameObject(GetObjectName(importOptions.usdRootPath, path));

try
{
// Ensure we have at least one GameObject with the import settings.
XformImporter.BuildSceneRoot(scene, go.transform, importOptions);
SceneImporter.SavePrefab(go, prefabPath, clipName, importOptions);
}
finally
{
GameObject.DestroyImmediate(go);
}
ImportHelpers.ImportAsTimelineClip(scene);
}

[MenuItem("USD/Unload Subtree", true)]
Expand Down Expand Up @@ -418,69 +234,5 @@ public static void MenuLoadSubtree()
return;
}
}

/// <summary>
/// Returns the selected object path or "Assets/" if no object is selected.
/// </summary>
public static string GetSelectedAssetPath()
{
Object[] selectedAsset = Selection.GetFiltered(typeof(Object), SelectionMode.Assets);
foreach (Object obj in selectedAsset)
{
var path = AssetDatabase.GetAssetPath(obj.GetInstanceID());
if (string.IsNullOrEmpty(path))
{
continue;
}

if (File.Exists(path))
{
path = Path.GetDirectoryName(path);
}

if (!path.EndsWith("/"))
{
path += "/";
}

return path;
}

return "Assets/";
}

public static GameObject UsdToGameObject(GameObject parent,
Scene scene,
SceneImportOptions importOptions)
{
try
{
SceneImporter.ImportUsd(parent, scene, new PrimMap(), importOptions);
}
finally
{
scene.Close();
}

return parent;
}

private static string GetObjectName(pxr.SdfPath rootPrimName, string path)
{
return pxr.UsdCs.TfIsValidIdentifier(rootPrimName.GetName())
? rootPrimName.GetName()
: GetObjectName(path);
}

private static string GetObjectName(string path)
{
return UnityTypeConverter.MakeValidIdentifier(Path.GetFileNameWithoutExtension(path));
}

private static string GetPrefabName(string path)
{
var fileName = GetObjectName(path);
return fileName + "_prefab";
}
}
}
Loading