2532 app create state machine for animations #2537

0reo · 2022-03-09T22:25:06Z

Initial state machine which will be used for animations. There is already a state system in place for player actions, which this will work along side. Future updates to this state machine will allow for an action to trigger animations with multiple states which will be managed here.

This PR currently has a minimal actual implementation, Avatars register themselves for tracking, and states are registered for the player avatar with dummy functions, but it's not actually controlling anything right now(although it could). Submitting this now because I want access to this as I decouple the animation function handling from the render loop.

State machine can currently:

register any object for state tracking
trigger state activation/deactivation
hold related state data(state name, run time, etc)
provide access to all tracked objects, all the relevant state information for a those objects
work along side the existing code base until a full transition can be done
associate animation functions to be triggered when a state is active(not using this until animation functions are decoupled from animationHelper)
execute animation functions internally(not using this until animation functions are decoupled from animationHelper)

To help with testing, you can add the following to avatars.ja at line 1132, which will provide access to the state machine and avatar via the console.

    window.StateMachine = StateMachine;
    window.avatar = this;

you can test triggering the dummy functions by running the following in the console

StateMachine; //access state machine, view all registered objects and states
avatar.tracker; //see tracked instance of avatar
avatar.tracker.addToGraph(['jump']) //replace jump with any available action, make sure it's an array when adding to graph
avatar.tracker.activate('jump') //triggers selected state function
avatar.tracker.deactivate('jump') //stop selected state function

Also, I'd recommend hiding white space changes when reviewing

…//github.com/webaverse/app into 2532-app-create-state-machine-for-animations

avaer · 2022-03-10T12:39:07Z

avatars/StateMachine.js

+  // add object to state machine
+  registerObj(name, obj) {
+    this.tracking.has(name) || this.tracking.set(name, {
+      id: crypto.randomUUID(),


We have makeId in utils:

app/util.js

Line 609 in 51acb44

export function makeId(length) {

It could be changed to crypto.randomUUID() but the codebase should have one place that defines the shape of IDs (since that may need to be changed).

I'm easy either way, I'll have the SM use makeId and we can have it use UUID's in another ticket if we want to

Just moving to makeId is fine for now.

avaer · 2022-03-10T12:39:59Z

character-controller.js

+        this.getActionsList().forEach((name) => {
+          this.avatar.tracker.registerState({
+            name,
+            animationFn: ()=>{console.log(`${name} func ran`);}


For debugging? Probably shouldn't ship this in PR.

yes, for debugging, will remove

avaer · 2022-03-10T12:46:54Z

The state engine needs thinking about how we are blending states (lerp, multiply, or something else), in which order, and for which bone subset. The order and bone blend functions both matter a lot, and are not easily defined declaratively.

Is the plan just to copy the execution logic from Avatar's update, but to abstract the state setting?

avaer · 2022-03-10T12:48:19Z

window.StateMachine = StateMachine;
window.avatar = this;

If you want this you could just float this change yourself. I use the same trick but by committing this it actually breaks clean global assumptions for everyone.

Can we remove?

avaer

Looks fine, some questions.

0reo · 2022-03-10T20:06:30Z

The state engine needs thinking about how we are blending states (lerp, multiply, or something else), in which order, and for which bone subset. The order and bone blend functions both matter a lot, and are not easily defined declaratively.

Is the plan just to copy the execution logic from Avatar's update, but to abstract the state setting?

I'm planning on creating an animation factory which will handle how blending is handled and other animation specific code. To keep things moving swiftly I'm setting things up the new system to follow the same general execution logic we're currently using, and once the new system is handling that I will continue to expand ordering. The state machine graph will be used to chain and order animation sub-states when actions trigger a state transition. For example, action A1 could trigger state S1, which has animation X, and action A2 could trigger state S2, which has animation X, then Y, then Z, then back to X. And yes, they aren't easily defined declaratively which is why that part's not yet included.

#2533 is the animation factory ticket, it doesn't reference bone subsets specifically but I'll make it explicit

0reo · 2022-03-10T20:07:52Z

window.StateMachine = StateMachine;
window.avatar = this;
If you want this you could just float this change yourself. I use the same trick but by committing this it actually breaks clean global assumptions for everyone.

Can we remove?

this is not actually in this PR, just a note for QA if it's helpful for them when testing

avaer · 2022-03-11T17:24:03Z

avatars/avatars.js

@@ -408,6 +409,9 @@ class Avatar {
      };
    }

+    const stateName = "playerAvatar"
+    StateMachine.registerObj(options.name ?? stateName, this);


I know this isn't used yet, but we cannot depend on options.name being unique, so this will collide and overwrite.

What was the intent here?

Also, why is this mutating its argument this rather than returning a tracker?

Registering objects first checks to see if it's already being tracked on line 55 of StateMachine.js. If it is, it won't reregister it, it will just take the object being passed and provide it with the tracker.

avaer · 2022-03-11T18:20:52Z

The state mechanism probably needs a redesign. This PR is fine but it's not adding any functionality, and the state engine tracking is bugged (name collisions resulting in shared state).

When there is functionality to add we can re-open.

0reo added 11 commits March 8, 2022 18:16

state machine(wip)

b48062a

testing state machine(wip)

0b4b70e

state machine(wip)

e8d8efb

testing state machine(wip)

e59ab5e

Merge branch '2532-app-create-state-machine-for-animations' of https:…

159df59

…//github.com/webaverse/app into 2532-app-create-state-machine-for-animations

graph adjustments and trigger node children

7d651ea

pass dummy function for graph tests

4c9f6de

minor adjsutments

98d4338

name avatars for state machine

c1bceea

eslint

00ec5ba

remove debug code

62f0a29

0reo linked an issue Mar 9, 2022 that may be closed by this pull request

App: Create state machine for animations #2532

Open

avaer reviewed Mar 10, 2022

View reviewed changes

use makeId rather than uuid

fdbf92b

0reo had a problem deploying to Production March 10, 2022 21:14 Failure

Merge branch 'master' into 2532-app-create-state-machine-for-animations

d81e5b2

0reo had a problem deploying to Production March 10, 2022 21:17 Failure

removed debug animationFn's

4ebe63f

0reo had a problem deploying to Production March 10, 2022 21:31 Failure

0reo added this to the Animations milestone Mar 11, 2022

avaer reviewed Mar 11, 2022

View reviewed changes

avaer closed this Mar 11, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

2532 app create state machine for animations #2537

2532 app create state machine for animations #2537

0reo commented Mar 9, 2022 •

edited

Loading

avaer Mar 10, 2022

0reo Mar 10, 2022

avaer Mar 10, 2022

avaer Mar 10, 2022 •

edited

Loading

0reo Mar 10, 2022

avaer commented Mar 10, 2022

avaer commented Mar 10, 2022 •

edited

Loading

avaer left a comment

0reo commented Mar 10, 2022

0reo commented Mar 10, 2022

avaer Mar 11, 2022

avaer Mar 11, 2022 •

edited

Loading

0reo Mar 11, 2022

avaer commented Mar 11, 2022

2532 app create state machine for animations #2537

2532 app create state machine for animations #2537

Conversation

0reo commented Mar 9, 2022 • edited Loading

avaer Mar 10, 2022

Choose a reason for hiding this comment

0reo Mar 10, 2022

Choose a reason for hiding this comment

avaer Mar 10, 2022

Choose a reason for hiding this comment

avaer Mar 10, 2022 • edited Loading

Choose a reason for hiding this comment

0reo Mar 10, 2022

Choose a reason for hiding this comment

avaer commented Mar 10, 2022

avaer commented Mar 10, 2022 • edited Loading

avaer left a comment

Choose a reason for hiding this comment

0reo commented Mar 10, 2022

0reo commented Mar 10, 2022

avaer Mar 11, 2022

Choose a reason for hiding this comment

avaer Mar 11, 2022 • edited Loading

Choose a reason for hiding this comment

0reo Mar 11, 2022

Choose a reason for hiding this comment

avaer commented Mar 11, 2022

0reo commented Mar 9, 2022 •

edited

Loading

avaer Mar 10, 2022 •

edited

Loading

avaer commented Mar 10, 2022 •

edited

Loading

avaer Mar 11, 2022 •

edited

Loading