diff options
author | Sybren A. Stüvel <sybren> | 2020-07-17 18:38:09 +0300 |
---|---|---|
committer | Sybren A. Stüvel <sybren@blender.org> | 2020-07-20 12:51:09 +0300 |
commit | 686ab4c9401a90b22fb17e46c992eb513fe4f693 (patch) | |
tree | c83b4da92fbd12b0c78e2ce5c3041ada23b5ef4b /source/blender/python/intern/bpy_rna_anim.c | |
parent | 6fbfa522e66d41839449899ab53dbf20d280d5ec (diff) |
T77086 Animation: Passing Dependency Graph to Drivers
Custom driver functions need access to the dependency graph that is
triggering the evaluation of the driver. This patch passes the
dependency graph pointer through all the animation-related calls.
Instead of passing the evaluation time to functions, the code now passes
an `AnimationEvalContext` pointer:
```
typedef struct AnimationEvalContext {
struct Depsgraph *const depsgraph;
const float eval_time;
} AnimationEvalContext;
```
These structs are read-only, meaning that the code cannot change the
evaluation time. Note that the `depsgraph` pointer itself is const, but
it points to a non-const depsgraph.
FCurves and Drivers can be evaluated at a different time than the
current scene time, for example when evaluating NLA strips. This means
that, even though the current time is stored in the dependency graph, we
need an explicit evaluation time.
There are two functions that allow creation of `AnimationEvalContext`
objects:
- `BKE_animsys_eval_context_construct(Depsgraph *depsgraph, float
eval_time)`, which creates a new context object from scratch, and
- `BKE_animsys_eval_context_construct_at(AnimationEvalContext
*anim_eval_context, float eval_time)`, which can be used to create a
`AnimationEvalContext` with the same depsgraph, but at a different
time. This makes it possible to later add fields without changing any
of the code that just want to change the eval time.
This also provides a fix for T75553, although it does require a change
to the custom driver function. The driver should call
`custom_function(depsgraph)`, and the function should use that depsgraph
instead of information from `bpy.context`.
Reviewed By: brecht, sergey
Differential Revision: https://developer.blender.org/D8047
Diffstat (limited to 'source/blender/python/intern/bpy_rna_anim.c')
-rw-r--r-- | source/blender/python/intern/bpy_rna_anim.c | 22 |
1 files changed, 18 insertions, 4 deletions
diff --git a/source/blender/python/intern/bpy_rna_anim.c b/source/blender/python/intern/bpy_rna_anim.c index 1c84e95672f..8aba2ae8598 100644 --- a/source/blender/python/intern/bpy_rna_anim.c +++ b/source/blender/python/intern/bpy_rna_anim.c @@ -36,6 +36,7 @@ #include "ED_keyframing.h" #include "BKE_anim_data.h" +#include "BKE_animsys.h" #include "BKE_context.h" #include "BKE_fcurve.h" #include "BKE_global.h" @@ -332,7 +333,20 @@ PyObject *pyrna_struct_keyframe_insert(BPy_StructRNA *self, PyObject *args, PyOb &options) == -1) { return NULL; } - else if (self->ptr.type == &RNA_NlaStrip) { + + /* This assumes that keyframes are only added on original data & using the active depsgraph. If + * it turns out to be necessary for some reason to insert keyframes on evaluated objects, we can + * revisit this and add an explicit `depsgraph` keyword argument to the function call. + * + * It is unlikely that driver code (which is the reason this depsgraph pointer is obtained) will + * be executed from this function call, as this only happens when `options` has + * `INSERTKEY_DRIVER`, which is not exposed to Python. */ + bContext *C = BPy_GetContext(); + struct Depsgraph *depsgraph = CTX_data_depsgraph_pointer(C); + const AnimationEvalContext anim_eval_context = BKE_animsys_eval_context_construct(depsgraph, + cfra); + + if (self->ptr.type == &RNA_NlaStrip) { /* Handle special properties for NLA Strips, whose F-Curves are stored on the * strips themselves. These are stored separately or else the properties will * not have any effect. @@ -355,8 +369,8 @@ PyObject *pyrna_struct_keyframe_insert(BPy_StructRNA *self, PyObject *args, PyOb if (prop) { NlaStrip *strip = ptr.data; FCurve *fcu = BKE_fcurve_find(&strip->fcurves, RNA_property_identifier(prop), index); - - result = insert_keyframe_direct(&reports, ptr, prop, fcu, cfra, keytype, NULL, options); + result = insert_keyframe_direct( + &reports, ptr, prop, fcu, &anim_eval_context, keytype, NULL, options); } else { BKE_reportf(&reports, RPT_ERROR, "Could not resolve path (%s)", path_full); @@ -384,7 +398,7 @@ PyObject *pyrna_struct_keyframe_insert(BPy_StructRNA *self, PyObject *args, PyOb group_name, path_full, index, - cfra, + &anim_eval_context, keytype, NULL, options) != 0); |