diff options
author | Campbell Barton <ideasman42@gmail.com> | 2021-12-10 04:11:43 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2021-12-10 04:19:36 +0300 |
commit | 566a458950ee30f60400a7624746342d19cf9695 (patch) | |
tree | 78792e4d8bdf519d86ecd9336c5fc335f811b541 /source/blender/depsgraph/intern/builder/deg_builder_nodes.h | |
parent | dffd032bc9b9cd0dbb710f1f3d3f0b14361bc267 (diff) |
Cleanup: move public doc-strings into headers for 'depsgraph'
- Added space below non doc-string comments to make it clear
these aren't comments for the symbols directly below them.
- Use doxy sections for some headers.
Ref T92709
Diffstat (limited to 'source/blender/depsgraph/intern/builder/deg_builder_nodes.h')
-rw-r--r-- | source/blender/depsgraph/intern/builder/deg_builder_nodes.h | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/source/blender/depsgraph/intern/builder/deg_builder_nodes.h b/source/blender/depsgraph/intern/builder/deg_builder_nodes.h index d31290ecbff..c1c80042833 100644 --- a/source/blender/depsgraph/intern/builder/deg_builder_nodes.h +++ b/source/blender/depsgraph/intern/builder/deg_builder_nodes.h @@ -102,6 +102,10 @@ class DepsgraphNodeBuilder : public DepsgraphBuilder { virtual void begin_build(); virtual void end_build(); + /** + * `id_cow_self` is the user of `id_pointer`, + * see also `LibraryIDLinkCallbackData` struct definition. + */ int foreach_id_cow_detect_need_for_update_callback(ID *id_cow_self, ID *id_pointer); IDNode *add_id_node(ID *id); @@ -199,10 +203,23 @@ class DepsgraphNodeBuilder : public DepsgraphBuilder { virtual void build_rigidbody(Scene *scene); virtual void build_particle_systems(Object *object, bool is_object_visible); virtual void build_particle_settings(ParticleSettings *part); + /** + * Build graph nodes for #AnimData block and any animated images used. + * \param id: ID-Block which hosts the #AnimData + */ virtual void build_animdata(ID *id); virtual void build_animdata_nlastrip_targets(ListBase *strips); + /** + * Build graph nodes to update the current frame in image users. + */ virtual void build_animation_images(ID *id); virtual void build_action(bAction *action); + /** + * Build graph node(s) for Driver + * \param id: ID-Block that driver is attached to + * \param fcu: Driver-FCurve + * \param driver_index: Index in animation data drivers list + */ virtual void build_driver(ID *id, FCurve *fcurve, int driver_index); virtual void build_driver_variables(ID *id, FCurve *fcurve); virtual void build_driver_id_property(ID *id, const char *rna_path); @@ -280,6 +297,10 @@ class DepsgraphNodeBuilder : public DepsgraphBuilder { void *user_data); void tag_previously_tagged_nodes(); + /** + * Check for IDs that need to be flushed (COW-updated) + * because the depsgraph itself created or removed some of their evaluated dependencies. + */ void update_invalid_cow_pointers(); /* State which demotes currently built entities. */ |