Onion skinning #12572

RandomShaper · 2017-11-01T22:46:20Z

This allows you to see a ghosted view of the animated stuff a numbers of steps to the past or the future (based on the step value of the animation).

Some commits add some infrastructure to some areas of the engine, needed for this to be implemented on top of them.

It works better if the animated hierarchy is edited in a scene by itself because the background color is used as a hint to differentiate frames.

Closes #10425.

Images

Menu in the animation editor

(Nice onion icon by @djrm)

Sample with 1-step depth, past & future

Sample with 3-step depth, only past, differences only

Current limitations

~~It is always on (as long as the animation editor is visible). No UI to enable/disable or configure yet.~~
~~It's very slow because I haven't found yet a way of working with viewport captures on VRAM.~~
There isn't a way of seeing in realtime how the past state would be affected according to, e.g., the position of a node as you move it, until you really insert a keyframe or update the current one.
The ghost view corresponds to one frame (engine loop frame) earlier. No big issue.

Anyway, please test and report or give suggestions.

Spatial transform and bone transform are handled separately so it'd be nice that testers tried on these kind of properties specifically.

Changelog

UPDATED 11/06

Viewport capture achieved and easily extensible to more past and/or future frames.

UPDATED 11/09

Menu added to the animation editor. I need a nice onion icon for it. Currently it allows to enable/disable, but the direction and depth settings are ignored.
Works for 3D as well.

UPDATED 11/13

Now every option in the onion skinning menu work.
Editor settings for past/future colors added.
Some images added to the post.
Description edited.

UPDATED 11/18

Better shader.
Much less VRAM use.
Images updated.

UPDATED 11/20

Editor stuff like grids, guides, etc. removed from the onion layer for a less cluttered view.
That also applies to environment to keep the viewport clear color as the background as far as possible, since it's the base for the differentiation.
New Differences only mode, better described by the second animated sample above. Makes the layering much less noisy if enabled.
Images updated.

UPDATED 11/20 (2)

Added two more settings: force white modulate to override the colors for past/future in editor settings and include gizmos (3D) to have bones and other stuff in onion layers,
Menu image updated.

blurymind · 2017-11-02T11:19:04Z

This is very nice!
It would be great if we also get an autokeyframe mode :D

RandomShaper · 2017-11-06T01:16:21Z

I need suggestions on how to combine full-scene captures of past/future frames with the current.

Rendering past with 50% opacity on top of the current is not good enough since both display as "dimmed". Yhe problem is the background of the captured frame is also overlaid on top of the present time scene.

A solution may be to render non-current frames on a transparent background, but that would just remove the plain color. Maybe not too much a problem as long as animated characters are edited in their separate scene.

Any better ideas?

HeadClot · 2017-11-06T01:44:19Z

Will this work with 3D?

reduz · 2017-11-06T01:59:57Z

Auto keyframe mode would be great

…

On Nov 5, 2017 10:44 PM, "Benjamin Stanley" ***@***.***> wrote: Will this work with 3D? — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <#12572 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AF-Z273PSg2M4B-qGXnY51RsX3Pa9Asaks5szmR7gaJpZM4QO7jW> .

djrm · 2017-11-06T02:10:48Z

@RandomShaper i think you might have already considered this, but just to be sure, usually past and present are represented by a blue and red tint or (green blue).

RandomShaper · 2017-11-06T08:43:29Z

@HeadClot, I think so.

@reduz, I'll try.

@djrm, that'd be great and colors could be configurable. But I'm not sure yet about the way.

The past/future viewport captures could be rendered on top of the viewport with a screen-reading shader that does some kind of comparison.

A shader pseudocode proposal would help a lot.

Guys, thank you for your feedback. :)

RandomShaper · 2017-11-09T00:12:16Z

Dear followers, I've pushed some more progress and updated the original comment.

@akien-mga, I need a nice onion icon for the dropdown menu. Where/how can I ask for it?

djrm · 2017-11-09T06:15:11Z

@RandomShaper dont worry i will do the icon.

RandomShaper · 2017-11-09T07:50:36Z

@djrm, thank you!

HummusSamurai · 2017-11-09T08:29:18Z

Pictures please :3

RandomShaper · 2017-11-12T13:17:21Z

@HummusSamurai, I'll try.

@djrm, I'll need an icon for auto-keyframing as well.

I'll try to move all this forward a lot today.

Auto-keyframing makes onion skinning more useful so I think it's better to add it to this PR, in separate commit(s). Do you agree?

RandomShaper · 2017-11-13T21:38:44Z

Code and main post updated! Please check.

RandomShaper · 2017-11-18T01:53:05Z

New update! Getting better...

I'd like to ask @reduz and @akien-mga what would they say it's needed before considering this finished.

blurymind · 2017-11-18T19:42:54Z

would be cool if onion skin had a mode that includes only keyframed poses and not interpolation

Does this also work for 2d?

RandomShaper · 2017-11-19T15:58:54Z

@blurymind, yes it works for 2D, too.

RandomShaper · 2017-11-19T16:09:27Z

Oh, and I'll add that feature soon.

blurymind · 2017-11-19T16:12:23Z

@RandomShaper Thank you! Also thank you for looking into autokeyframe mode.
Your additions will make animating in godot so much faster and smoother!

RandomShaper · 2017-11-20T01:01:55Z

New update! This is getting pretty interesting, I think. As always, please have a look at the updated description.

@djrm, any news about the onion icon? :)

djrm · 2017-11-20T06:05:46Z

@RandomShaper its ready will do a PR soon, it will be called Onion (if you want to change it in your PR)

reduz · 2017-11-20T14:04:13Z

editor/plugins/animation_player_editor_plugin.h

@@ -202,6 +259,8 @@ class AnimationPlayerEditorPlugin : public EditorPlugin {
 	virtual bool handles(Object *p_object) const;
 	virtual void make_visible(bool p_visible);

+	virtual void forward_force_draw_over_viewport(Control *p_overlay) { anim_editor->forward_force_draw_over_viewport(p_overlay); }


I don't quite understand this. Should there not be one for 2D and one for 3D?

For this use case, I designed the API dimension-agnostic, but I can split it easily into 2D and 3D if you find it to make more sense to plugin writers.

reduz · 2017-11-20T14:05:54Z

scene/animation/animation_player.cpp

+		}
+	}
+}
+#endif


technically, you should be able to call MessageQueue::flush() for this to happen, though make sure that you are not called from this function when doing it.

I did it that way because I wasn't sure no unrelated messages that can interfere somehow with the process are in the queue by that point.

Furthermore, this is called during a deferred call to _prepare_onion_layers_2() so we are already there.

reduz · 2017-11-20T14:06:28Z

scene/main/scene_tree.cpp

@@ -127,7 +127,7 @@ void SceneTree::remove_from_group(const StringName &p_group, Node *p_node) {
 		group_map.erase(E);
 }

-void SceneTree::_flush_transform_notifications() {
+void SceneTree::flush_transform_notifications() {


This is a good idea, I like it.

Glad to read that. :)

akien-mga · 2017-11-20T14:11:19Z

It should be fine to merge for 3.0 if it's ready in the coming days :)

djrm · 2017-11-20T19:10:51Z

@RandomShaper the Onion icon is on master.

RandomShaper · 2017-11-20T19:23:27Z

@djrm, looks good!

RandomShaper · 2017-11-20T19:48:00Z

I think I'm feature-freezing this so it can be merged to 3.0.

Key-based steps are pretty hard to implement so they'll have to wait. :(
I'm out of time for auto-keyframing as well.

Aside from code reviews and bug fixing, this is all I can do for 3.0.

blurymind · 2017-11-21T13:13:32Z

@RandomShaper autokeyframe for 3.1 ? :)

Also does the differences mode show only onion skin on frames that contain keyframes, or does it also include the tweens?

RandomShaper · 2017-11-21T16:06:16Z

Yes, I'll try. In the meantime you could open a feature request so we don't forget.

To your other question, it's just a different, les cluttered way of seeing the layers. No stop-at-keys-per-track by now. I studied how it could be done, but it looks pretty hard to do now for 3.0.
Another feat request for that would be nice. :)

RandomShaper · 2017-11-21T16:06:46Z

I'll fix the CI errors ASAP.

- Now it is usable from both `CanvasItem` and `Spatial` editors. - `EditorPlugin` API changes: - `forward_draw_over_canvas()` becomes `forward_draw_over_viewport()`. - `update_canvas()` becomes `update_overlays()`, which now triggers the update of every overlay on top of any 2D or 3D viewports present. Also now it returns the number of such viewports, which is useful whenever you need to know the number of draw-over calls you'll get. - New: `[set/is]_force_draw_over_forwarding_enabled()` to force overlaying regardless it handles the current object type, in a similar fashion as `[set/is]_input_event_forwarding_always_enabled`. This kind of overlay is also on top of those for regular handled node types. - New: `forward_force_draw_over_canvas()`, which is the callback that gets called for plugins that enable forced overlaying.

RandomShaper · 2017-11-25T13:33:59Z

Builds fixed!

@reduz, are you satisfied with my replies to your reviews? Would you like me to change something before merging?

RandomShaper added feature proposal topic:editor labels Nov 1, 2017

RandomShaper added this to the 3.0 milestone Nov 1, 2017

RandomShaper mentioned this pull request Nov 1, 2017

Onion skinning for AnimationPlayer #10425

Closed

RandomShaper force-pushed the onion-skinning branch from 952bea3 to 2e006cd Compare November 1, 2017 22:51

RandomShaper mentioned this pull request Nov 4, 2017

GODOT 3.0 BETA APPROACHING! #12543

Closed

RandomShaper force-pushed the onion-skinning branch from 2e006cd to eb148d6 Compare November 9, 2017 00:08

RandomShaper force-pushed the onion-skinning branch 2 times, most recently from a7e1b39 to eaa15de Compare November 13, 2017 21:38

RandomShaper force-pushed the onion-skinning branch 2 times, most recently from 552fdc6 to febffa7 Compare November 18, 2017 01:52

RandomShaper force-pushed the onion-skinning branch from febffa7 to 6ec9732 Compare November 19, 2017 16:02

RandomShaper force-pushed the onion-skinning branch from 6ec9732 to 3db5495 Compare November 20, 2017 00:47

reduz requested changes Nov 20, 2017

View reviewed changes

RandomShaper force-pushed the onion-skinning branch from 3db5495 to 807bd83 Compare November 20, 2017 18:49

RandomShaper changed the title ~~Onion skinning [WIP]~~ Onion skinning Nov 20, 2017

RandomShaper force-pushed the onion-skinning branch from 807bd83 to 98443a5 Compare November 24, 2017 20:38

RandomShaper added 4 commits November 25, 2017 02:18

Implement backup/restore for animated values

ff03a0b

Add ability to opt-out buffer swapping in VS::draw()

3aa79fc

Update clang-format in modified files

81c49fb

Improve/fix SpatialEditor state saving/restoring

1964d5f

RandomShaper force-pushed the onion-skinning branch from 98443a5 to 4851240 Compare November 25, 2017 01:19

Implement onion skinning for the animation editor

d0e09d8

RandomShaper force-pushed the onion-skinning branch from 4851240 to d0e09d8 Compare November 25, 2017 12:25

reduz merged commit 22415e5 into godotengine:master Nov 26, 2017

RandomShaper deleted the onion-skinning branch November 26, 2017 19:40

realkotob mentioned this pull request Feb 2, 2019

Signal when Inspector updates/exported property changes #16365

Closed

EricEzaM mentioned this pull request Dec 6, 2020

Useless "force" draw and input options for EditorPlugins? #44142

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Onion skinning #12572

Onion skinning #12572

RandomShaper commented Nov 1, 2017 •

edited

Loading

blurymind commented Nov 2, 2017

RandomShaper commented Nov 6, 2017

HeadClot commented Nov 6, 2017

reduz commented Nov 6, 2017 via email

djrm commented Nov 6, 2017

RandomShaper commented Nov 6, 2017

RandomShaper commented Nov 9, 2017

djrm commented Nov 9, 2017

RandomShaper commented Nov 9, 2017

HummusSamurai commented Nov 9, 2017

RandomShaper commented Nov 12, 2017

RandomShaper commented Nov 13, 2017

RandomShaper commented Nov 18, 2017

blurymind commented Nov 18, 2017

RandomShaper commented Nov 19, 2017

RandomShaper commented Nov 19, 2017

blurymind commented Nov 19, 2017

RandomShaper commented Nov 20, 2017

djrm commented Nov 20, 2017

reduz Nov 20, 2017

RandomShaper Nov 20, 2017

reduz Nov 20, 2017

RandomShaper Nov 20, 2017

reduz Nov 20, 2017

RandomShaper Nov 20, 2017

akien-mga commented Nov 20, 2017

djrm commented Nov 20, 2017

RandomShaper commented Nov 20, 2017

RandomShaper commented Nov 20, 2017

blurymind commented Nov 21, 2017 •

edited

Loading

RandomShaper commented Nov 21, 2017

RandomShaper commented Nov 21, 2017

RandomShaper commented Nov 25, 2017

Onion skinning #12572

Onion skinning #12572

Conversation

RandomShaper commented Nov 1, 2017 • edited Loading

Images

Menu in the animation editor

Sample with 1-step depth, past & future

Sample with 3-step depth, only past, differences only

Current limitations

Changelog

blurymind commented Nov 2, 2017

RandomShaper commented Nov 6, 2017

HeadClot commented Nov 6, 2017

reduz commented Nov 6, 2017 via email

djrm commented Nov 6, 2017

RandomShaper commented Nov 6, 2017

RandomShaper commented Nov 9, 2017

djrm commented Nov 9, 2017

RandomShaper commented Nov 9, 2017

HummusSamurai commented Nov 9, 2017

RandomShaper commented Nov 12, 2017

RandomShaper commented Nov 13, 2017

RandomShaper commented Nov 18, 2017

blurymind commented Nov 18, 2017

RandomShaper commented Nov 19, 2017

RandomShaper commented Nov 19, 2017

blurymind commented Nov 19, 2017

RandomShaper commented Nov 20, 2017

djrm commented Nov 20, 2017

reduz Nov 20, 2017

Choose a reason for hiding this comment

RandomShaper Nov 20, 2017

Choose a reason for hiding this comment

reduz Nov 20, 2017

Choose a reason for hiding this comment

RandomShaper Nov 20, 2017

Choose a reason for hiding this comment

reduz Nov 20, 2017

Choose a reason for hiding this comment

RandomShaper Nov 20, 2017

Choose a reason for hiding this comment

akien-mga commented Nov 20, 2017

djrm commented Nov 20, 2017

RandomShaper commented Nov 20, 2017

RandomShaper commented Nov 20, 2017

blurymind commented Nov 21, 2017 • edited Loading

RandomShaper commented Nov 21, 2017

RandomShaper commented Nov 21, 2017

RandomShaper commented Nov 25, 2017

RandomShaper commented Nov 1, 2017 •

edited

Loading

blurymind commented Nov 21, 2017 •

edited

Loading