Update property when adding or removing keyframe #90041

New Issue

Richard Antalik · 2021-07-22T11:34:41+02:00

Richard Antalik commented

2021-07-22 11:34:41 +02:00

Removing keyframe can cause issues in all editors and adding keyframe needs to update VSE.

When removing keyframe, RNA update function should be called, since property value may change. This is reproducible with simple 3 keyframe animation, place CFRA on middle keyframe, remove (press Shift + Alt +I on propery in side panel) it and no update will happen.

When adding keyframe, sequencer prefetch is not notified about this change. So it works on outdated data until keyframe is added. Simply notifying prefetch is not enough and cache must be cleared too which is currently done from RNA update function.
Similar case is speed effect, where it calculates input frame based on animation, which is integrated over time. Array mapping current to input frames is cached and recalculated in RNA update function.

Removing keyframe can cause issues in all editors and adding keyframe needs to update VSE. When removing keyframe, RNA update function should be called, since property value may change. This is reproducible with simple 3 keyframe animation, place CFRA on middle keyframe, remove (press Shift + Alt +I on propery in side panel) it and no update will happen. When adding keyframe, sequencer prefetch is not notified about this change. So it works on outdated data until keyframe is added. Simply notifying prefetch is not enough and cache must be cleared too which is currently done from RNA update function. Similar case is speed effect, where it calculates input frame based on animation, which is integrated over time. Array mapping current to input frames is cached and recalculated in RNA update function.

Richard Antalik commented

2021-07-22 11:34:41 +02:00

Changed status from 'Needs Triage' to: 'Confirmed'

Richard Antalik commented

2021-07-22 11:34:41 +02:00

Added subscriber: @iss

blender-admin commented

2021-07-22 11:34:41 +02:00

#98433 was marked as duplicate of this issue

Sybren A. Stüvel commented

2021-07-22 11:35:55 +02:00

Added subscriber: @dr.sybren

Alexander Gavrilov commented

2021-07-22 11:37:00 +02:00

Added subscriber: @angavrilov

Alexander Gavrilov commented

2021-07-22 11:37:00 +02:00

I wonder if it is possible to notify Python add-on code too somehow. Currently something like Cycle-Aware Keying can only be implemented in C since checks have to be added directly into the insertion code.

Philipp Oeser commented

2021-07-22 12:07:58 +02:00

Added subscriber: @lichtwerk

Philipp Oeser commented

2022-01-13 13:04:10 +01:00

Removing keyframe can cause issues in all editors and adding keyframe needs to update VSE.

When removing keyframe, RNA update function should be called, since property value may change. This is reproducible with simple 3 keyframe animation, place CFRA on middle keyframe, remove it and no update will happen.

Dont think this is quite right? See my comment from #94542:

In #94542#1282733, @lichtwerk wrote:
There is just no cache invalidation in regards to animation in many places.
Only doing direct RNA property manipulation calls this afaics (so e.g. button tweaking).

This has quite broad reach as all of these (if not more) dont invalidate the cache:

clearing keyframes

deleting actions

removing drivers

removing dopsheet channels

removing graph editor channels

removing nla tracks

removing nla strips

removing fcurve modifiers

Interestingly, removing a keyframe (in the dopesheet or graph editor) will invalidate the cache correctly.
But this is because delete_graph_keys does ANIM_animdata_update / ANIM_list_elem_update (and that in turn touches the RNA updates, see RNA_property_update_main there... if, and only if ANIM_animdata_update is called with ANIM_UPDATE_DEPS which is included in ANIM_UPDATE_DEFAULT which delete_graph_keys uses)

So removing a single keyframe (or multiple - but not all) will actually touch/fire RNA callbacks afaict, but removing all keyframes (or any of the operations mentioned above) dont.

> Removing keyframe can cause issues in all editors and adding keyframe needs to update VSE. > > When removing keyframe, RNA update function should be called, since property value may change. This is reproducible with simple 3 keyframe animation, place CFRA on middle keyframe, remove it and no update will happen. Dont think this is quite right? See my comment from #94542: > In #94542#1282733, @lichtwerk wrote: > There is just no cache invalidation in regards to animation in many places. > Only doing direct RNA property manipulation calls this afaics (so e.g. button tweaking). > > This has quite broad reach as all of these (if not more) dont invalidate the cache: > - clearing keyframes > - deleting actions > - removing drivers > - removing dopsheet channels > - removing graph editor channels > - removing nla tracks > - removing nla strips > - removing fcurve modifiers > > Interestingly, removing a keyframe (in the dopesheet or graph editor) **will invalidate the cache correctly**. > But this is because `delete_graph_keys` does `ANIM_animdata_update` / `ANIM_list_elem_update` (and that in turn touches the RNA updates, see `RNA_property_update_main` there... if, and only if `ANIM_animdata_update` is called with `ANIM_UPDATE_DEPS` which is included in `ANIM_UPDATE_DEFAULT` which `delete_graph_keys` uses) So removing a single keyframe (or multiple - but not all) will actually touch/fire RNA callbacks afaict, but removing all keyframes (or any of the operations mentioned above) dont.

Richard Antalik commented

2022-01-14 15:13:12 +01:00

In #90041#1287515, @lichtwerk wrote:
So removing a single keyframe (or multiple - but not all) will actually touch/fire RNA callbacks afaict, but removing all keyframes (or any of the operations mentioned above) dont.

I saw that comment and I should clarify, this happes when you press Shift + Alt +I on propery in side panel, not when removing keyframe in timeline editor.

> In #90041#1287515, @lichtwerk wrote: > So removing a single keyframe (or multiple - but not all) will actually touch/fire RNA callbacks afaict, but removing all keyframes (or any of the operations mentioned above) dont. I saw that comment and I should clarify, this happes when you press Shift + Alt +I on propery in side panel, not when removing keyframe in timeline editor.

Philipp Oeser commented

2022-05-30 09:12:56 +02:00

Added subscriber: @OmarEmaraDev

Philipp Oeser removed the

Download

What's New

Blender Studio

Manual

Developers Blog

Documentation

Benchmark

Blender Conference

Development Fund

One-time Donations

Update property when adding or removing keyframe #90041