diff options
author | Joshua Leung <aligorith@gmail.com> | 2017-09-11 14:42:31 +0300 |
---|---|---|
committer | Joshua Leung <aligorith@gmail.com> | 2017-09-12 15:53:46 +0300 |
commit | a704a66914faa7e82bb5403f898d4a2c11f678a9 (patch) | |
tree | 73aabc5ec477cc15d847458d790bfb634128c80e /source/blender/editors/include/ED_anim_api.h | |
parent | fadc0797403070adb517ebe0f02801470334c9ab (diff) |
Adding some verbose documentation
I thought this was already clear enough, but apparently not.
Diffstat (limited to 'source/blender/editors/include/ED_anim_api.h')
-rw-r--r-- | source/blender/editors/include/ED_anim_api.h | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/source/blender/editors/include/ED_anim_api.h b/source/blender/editors/include/ED_anim_api.h index 4668d5d3d50..68a5dd8a94e 100644 --- a/source/blender/editors/include/ED_anim_api.h +++ b/source/blender/editors/include/ED_anim_api.h @@ -124,6 +124,15 @@ typedef struct bAnimListElem { void *key_data; /* motion data - mostly F-Curves, but can be other types too */ + /* NOTE: id here is the "IdAdtTemplate"-style datablock (e.g. Object, Material, Texture, NodeTree) + * from which evaluation of the RNA-paths takes place. It's used to figure out how deep + * channels should be nested (e.g. for Textures/NodeTrees) in the tree, and allows property + * lookups (e.g. for sliders and for inserting keyframes) to work. If we had instead used + * bAction or something similar, none of this would be possible: although it's trivial + * to use an IdAdtTemplate type to find the source action a channel (e.g. F-Curve) comes from + * (i.e. in the AnimEditors, it *must* be the active action, as only that can be edited), + * it's impossible to go the other way (i.e. one action may be used in multiple places). + */ struct ID *id; /* ID block that channel is attached to */ struct AnimData *adt; /* source of the animation data attached to ID block (for convenience) */ |