Interactivity Runtime Playback

[Jmangles]

Migration of everything from https://github.com/magicleap/UnityGLTF-Interactivity to UnityGLTF itself.

Some extra work required to implement behaviour engine and wrapper component creation in ImporterPlugin/Context files before merging.

Supports every node in the current spec along with core pointers and most extension pointers. Includes unit tests for every node that can be run in Unity and automatically export as json for consumption in other engines.

[hybridherbst]

Thanks! Are you going to push those extra work as well in the next days?
Also, please rebase the PR on dev, not on main, to ensure there are no conflicts with latest changes. Thank you!

[Jmangles]

@hybridherbst Rebased on dev, I should be able to finish the importer context stuff this week I think.

[Jmangles]

Behaviour engine and wrappers are now added in the InteractivityImporterContext so no additional work needs to be done by devs to enable runtime playback beyond the checkbox in their GLTFSettings asset.

[robertdorn83]

Are this logs still necessary?

[Jmangles]

The majority of the logs in this PR are using Util.Log which is a wrapper using the [Conditional] attribute. As a result they are excluded from builds as if they were wrapped in #if DEBUG_MESSAGES/#endif.

This way the package doesn't spam someone's console but if I want to get all my debug messages back I can do it package-wide by adding DEBUG_MESSAGES to my script compilation symbols in the player settings or add define DEBUG_MESSAGES at the top of classes that I specifically want to enable them for.

[robertdorn83]

i get an error in Unity:
",,,NodeRegistry.cs(27,51): error CS0246: The type or namespace name 'DebugLog' could not be found (are you missing a using directive or an assembly reference?)"

[robertdorn83]

and i would suggest to change the plugin names to "KHR_interactivity Playback Importer" and "KHR_interactivity Playback Exporter", just for cleareance :)

[robertdorn83]

Do you have an exactly reason why are you not using "OnAfterImportScene" , so you're required to add OnLoadingComplete? Between these both callbacks are mostly only memory disposables and cleanups

[Jmangles]

Do you have an exactly reason why are you not using "OnAfterImportScene" , so you're required to add OnLoadingComplete? Between these both callbacks are mostly only memory disposables and cleanups

I found that in OnAfterImportScene that scene.Extensions is null. I guess that's more of a bug to be fixed than a reason to add another callback.

[robertdorn83]

Do you have an exactly reason why are you not using "OnAfterImportScene" , so you're required to add OnLoadingComplete? Between these both callbacks are mostly only memory disposables and cleanups

I found that in OnAfterImportScene that scene.Extensions is null. I guess that's more of a bug to be fixed than a reason to add another callback.

OnAfterImportScene has the Scene not the Root as parameter. Don't get confused here, the Extensions of the Gltf are on the Root, not the scene. But you already get correctly the Root in your OnLoadComplete callback with _context.SceneImporter.Root. So just use the OnAfterImportScene with the same code as in OnLoadComplete.

[robertdorn83]

I tried to import a Gltf Asset with interactivity, sadly... your BehaviourEngine is not serializable. Would be really great if you can make it serializable, so your implementation would also work with Gltf Assets. Or maybe save your imported Graph as an subasset, not sure.
Also the EventWrapper name is a bit confusing. Maybe BehaviourEnginePlayer or something like that would match better :)

[hybridherbst]

@Jmangles I believe this code path (and other places where inputs are used) should use Unity's event system. Otherwise this won't work in e.g. XR, for multitouch, and accessibility cases, where inputs come from "somewhere else than he mouse".