hai-vr / av3-animator-as-code

Generate animator layers and animations from a fluent builder syntax. Initially designed for use in VRChat, this is now a generic package that does not require it.

av3-animator-as-code's Issues

Calling Or() on a TransitionsFromEntry() fails with an exception

var mainSubStateMachine = layer.NewSubStateMachine("Main");
mainSubStateMachine.Restarts();

var state = mainSubStateMachine.NewState("S1");

state.TransitionsFromEntry()
    .When(rightTrackPadParamBool.IsFalse())
    .Or()
    .When(rightAButtonParamBool.IsTrue());

InvalidOperationException: _sourceNullableIfAny is not null but does not contain an AnimatorStateMachine

Reported on: https://discord.com/channels/923123027879813150/946570418892988457/1205619208822591579

Add PropertyFinder companion editor

Make it easier to find animatable property names for use in animation clips

Disable Undo to improve generation time

Make an AAC "getting started" first steps, as in how to create a MonoBehaviour, etc.

Issue stemming from conversation on Discord

AacFlFloatParameterGroup and AacFlIntParameterGroup have incorrect ToList() signature and implementation

Reported by DeltaNeverUsed

Change the weight of the created layer

Please add support for copying a parameter

Currently there's a state .Drives idiom, but there's no way to drive a parameter to be a copy of another currently. This would be handy to have in a gimmick I'm currently developing; I think I can work around it by manually constructing the parameter driver, but it'd be nice not to have to do so.

Mixing linear and easing curves causes an unexpected result

Mixing linear and easing curves causes an unexpected result

Define the default state of a layer `AacFlLayer WithDefaultState(AacFlState newDefaultState)`

Forbid the use of periods in the state name

Periods . in the state name can cause the Animator to misbehave.

Unity_IbrrzAOGer.mp4

Probably a side effect of https://docs.unity3d.com/ScriptReference/AnimatorTransitionInfo-fullPathHash.html

Animator introspection functionnality

Many of the functionality in AAC is bound to the active animator sublayer created within it, but some may be reaching out to other layers or outside the animator:

• Getting the layer index for sub-layer blending behaviours
• Reordering layers
• Removing unused parameters
• Creating an avatar mask for the base Gesture layer
• Creating an avatar mask for FX sub-layers

Some of these operations require introspecting the entire animator's state machine and animations, which can be expensive depending on the size of the animator.

There may be a need to expose a dedicated API in AAC that is specialized in animator introspection.

AacFl's SubStateMachine.Any* is ineffective on sub-state machines

Calling AacFl's SubStateMachine.Any* does not result in the generation of a transition in the graph.

The fix may be to make invocation of this method from within sub-state machines proxy to the top level state machine's Any state node.

Add RemoveParameters

There is RemoveAllMainLayers() and RemoveAllSupportingLayers(string suffix) but, no method to remove parameter.
I can understand that there is danger of removing parameter used by layers that were added by hand, but I don't think removing the parameters that are not used by the Animator Controller would do much harm.

Clarify or enforce what the asset container asset is supposed to be

Issue stemming from #27

Speed issue (oninvalidateanimatorcontroller)

im noticing the main reason large animators take a while to generate, is every single operation that is called seems to invoke AnimatorControllerCallback.OnInvalidateAnimatorController()

if there was a way to avoid this invoke till we are done completely editing the graph, then call it do do it all at once, I think itd singificantly speed up large graph generation. Right now im working on a project where this is 50% of the profiled time, and it is called over 21039 times

Sometimes animator states get named "\x01"

This is probably a unity bug: When a state name is passed in to unity's StateMachine.NewState, sometimes it's ignored and the state is given the name "\x01" instead. This could be worked around in AAC (I'll probably put together a PR later)

Generate documentation

Let the user instantiate custom assets inside a container

Let the user instantiate custom assets inside a container.

This can let the user generate assets of their own that will be cleaned on every generation.

Example:

MeshRenderer mr;

Material modifiedAsset = aac.CopyAsset(mr.materials[0]);
modifiedAsset.SetColor("_Color", Color.green);

aac.NewClip().SwappingMaterial(mr, 0, modifiedAsset);

BlendTree builder

Something along these lines:

aac.NewBlendTree() // AacFlUnconstructedBlendTree
    .Cartesian(fx.FloatParameter("X"), fx.FloatParameter("Y")) // AacFlBlendTree2D : AacFlBlendTree
    .Blending(blend -> { // AacFlEditBlendTree2D
        blend.At(0f, 0f).WithAnimation(aac.NewBlendTree()/*...*/);
    });

NDMF: Allow AssetContainer to be something else than an Animator Controller

[Enhancement] Allow taking arbitrary boolean expressions

From this limitation, conditions with nested OR cannot be expressed easily, such as:

• 🚫 (F && (G || H) && (J || K))

As I understand it, state transitions naturally follow/allow for Sum Of Products boolean expressions. (each transition contains a number of ANDs between different conditions, and then you can OR the result of each transition together). Since any boolean expression can be rewritten into a Sum Of Products (SOP) form, we should be able to take any expression, rewrite it in SOP form, then generate the transitions accordingly.

Finding a SOP expression given an arbitrary expression shouldn't be too difficult, i think. Finding the optimal SOP expression is likely out of scope.

A way to Merge or Base off an existing controller

Having a way to either merge in a controller before/after or use a controller as a base to build on would allow using AAC with existing prefabs such as GoGo Loco or other locomotion prefabs

Keep track of created states

Keeping track of created state to clean them afterwards is tedious, so why not make AacFlBase keep track of them?
Having mutable state in AacFlBase class might have some consequences of unintuitive behavior, so this feature might need some discussion.

Review suspicious state machine exposure in V1

Review whether AacFlLayer exposes state machines correctly

Storing AnimatorControllers in a non-persistent asset container is problematic

Storing AnimatorControllers in an asset container is problematic:

• Non-animator controllers should continue to be added to the asset container, regardless of whether it is persistent
• Animator controller should be able to be added to a persistent asset container, or be created individually as garbage asset otherwise

Make sure V0 and V1 can coexist in the same Unity project

Remove layer on arbitrary controller

⚠️ Animator As Code V1

Animator As Code will prepare to move from V0 to V1.

• WIP Migration guide: https://docs.hai-vr.dev/docs/products/animator-as-code/migrating-v0-to-v1
• Branch: https://github.com/hai-vr/av3-animator-as-code/tree/wip-v1

Consider a different/custom asset naming scheme

hai-vr/combo-gesture-expressions-av3#366

Review how internal states are exposed in the public API

Reconsider the use of `void` returning functions

Some functions return void.

• For some of them, it can be argued that returning void marks the effective consumption of what precedes it (i.e. AacFlSettingCurve).
• For others, it may be justified to continue allow chaining.

Reconsider the use of void returning functions for cases where chaining could be justified.

Avatar mask is generated in the controller instead of the container

Ensure compatibility of VrcAssets() with package manager version of VRChat SDK

Normalize all SettingCurve* functions

[Issue]: Too many Assets in a single Container

https://github.com/hai-vr/av3-animator-as-code/blob/main/Framework/Editor/V0/Aac.cs#L33
https://github.com/hai-vr/av3-animator-as-code/blob/main/Framework/Editor/V0/Aac.cs#L42
https://github.com/hai-vr/av3-animator-as-code/blob/main/Framework/Editor/V0/Aac.cs#L238

There appears to be only a certain amount of assets that can be packed into 1 another.
Somewhere around the neighborhood of 20+ assets.
When there is too many assets in a container the engine starts culling them out by destroying them thereby breaking the setup.

A workaround to this is manually creating the assets in a folder on their own rather than containerizing them.
When I started doing this for AnimationClip creation everything worked properly once again.

An idea for a solution would be doing a size comparison and splitting the 1 container into multiple containers.