diff options
author | Campbell Barton <ideasman42@gmail.com> | 2021-12-08 09:37:44 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2021-12-08 09:51:45 +0300 |
commit | 4f48b2992bdfa2926c61457b364b75900d7416b0 (patch) | |
tree | 74992624a706803e3aa135722f39735338431cf3 /source/blender/blenloader/intern/versioning_common.h | |
parent | 93ba5e237546f58819cdff838334470e30ec0294 (diff) |
Cleanup: move public doc-strings into headers for 'blenloader'
Ref T92709
Diffstat (limited to 'source/blender/blenloader/intern/versioning_common.h')
-rw-r--r-- | source/blender/blenloader/intern/versioning_common.h | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/source/blender/blenloader/intern/versioning_common.h b/source/blender/blenloader/intern/versioning_common.h index 3788d8f5595..0613484b754 100644 --- a/source/blender/blenloader/intern/versioning_common.h +++ b/source/blender/blenloader/intern/versioning_common.h @@ -34,6 +34,11 @@ struct ARegion *do_versions_add_region_if_not_found(struct ListBase *regionbase, const char *name, int link_after_region_type); +/** + * Rename if the ID doesn't exist. + * + * \return the ID (if found). + */ ID *do_versions_rename_id(Main *bmain, const short id_type, const char *name_src, @@ -52,6 +57,23 @@ void version_node_output_socket_name(struct bNodeTree *ntree, const char *old_name, const char *new_name); +/** + * Adjust animation data for newly added node sockets. + * + * Node sockets are addressed by their index (in their RNA path, and thus FCurves/drivers), and + * thus when a new node is added in the middle of the list, existing animation data needs to be + * adjusted. + * + * Since this is about animation data, it only concerns input sockets. + * + * \param node_tree_type: Node tree type that has these nodes, for example #NTREE_SHADER. + * \param node_type: Node type to adjust, for example #SH_NODE_BSDF_PRINCIPLED. + * \param socket_index_orig: The original index of the moved socket; when socket 4 moved to 6, + * pass 4 here. + * \param socket_index_offset: The offset of the nodes, so when socket 4 moved to 6, + * pass 2 here. + * \param total_number_of_sockets: The total number of sockets in the node. + */ void version_node_socket_index_animdata( Main *bmain, int node_tree_type, /* NTREE_....., e.g. NTREE_SHADER */ @@ -60,8 +82,14 @@ void version_node_socket_index_animdata( int socket_index_offset, int total_number_of_sockets); +/** + * Replace the ID name of all nodes in the tree with the given type with the new name. + */ void version_node_id(struct bNodeTree *ntree, const int node_type, const char *new_name); +/** + * Convert `SocketName.001` unique name format to `SocketName_001`. Previously both were used. + */ void version_node_socket_id_delim(bNodeSocket *socket); struct bNodeSocket *version_node_add_socket_if_not_exist(struct bNodeTree *ntree, |