Anim: add failure propagation to more lower-level keying functions #121517

Nathan Vegdahl · 2024-05-07T13:49:24+02:00

Nathan Vegdahl commented

2024-05-07 13:49:24 +02:00

Split off from #120428.

This changes the following keyframing functions to return
SingleKeyingResult, which is in turn used for better failure
reporting in the higher-level functions that call them:

KeyframeStrip::keyframe_insert()
insert_vert_fcurve()

As a side effect, this also means that
rna_KeyframeAnimationStrip_key_insert() can no longer return an
FCurve *, and now instead returns a bool indicating success.

This is part of an ongoing progressive refactor to improve error
messages and failure handling in the keyingframing code.

Split off from #120428. This changes the following keyframing functions to return `SingleKeyingResult`, which is in turn used for better failure reporting in the higher-level functions that call them: - `KeyframeStrip::keyframe_insert()` - `insert_vert_fcurve()` As a side effect, this also means that `rna_KeyframeAnimationStrip_key_insert()` can no longer return an `FCurve *`, and now instead returns a bool indicating success. This is part of an ongoing progressive refactor to improve error messages and failure handling in the keyingframing code.

Nathan Vegdahl added the

Module

Animation & Rigging

label 2024-05-07 13:49:24 +02:00

Nathan Vegdahl added 1 commit 2024-05-07 13:49:34 +02:00

Anim: add failure propagation to more lower-level keying functions bd1c103624

The following keyframing functions now return `SingleKeyingResult`,
which is in turn used for better failure reporting in the higher-level
functions that call them:

- `KeyframeStrip::keyframe_insert()`
- `insert_vert_fcurve()`

As a side effect, this also means that
`rna_KeyframeAnimationStrip_key_insert()` can no longer return an
`FCurve *`, and now instead returns a bool indicating success.

This is part of an ongoing progressive refactor to improve error
messages and failure handling in the keyingframing code.

Nathan Vegdahl requested review from Christoph Lendenfeld 2024-05-07 13:50:35 +02:00

Christoph Lendenfeld approved these changes 2024-05-07 14:22:34 +02:00

Christoph Lendenfeld left a comment

lgtm!

❤️ 1

Nathan Vegdahl referenced this issue from a commit

2024-05-07 15:07:07 +02:00

Anim: add failure propagation to more lower-level keying functions

Nathan Vegdahl merged commit 8dbd167e80 into main

2024-05-07 15:07:08 +02:00

Nathan Vegdahl deleted branch keyframing_failure_propagation

2024-05-07 15:07:10 +02:00