2 * ***** BEGIN GPL LICENSE BLOCK *****
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public License
6 * as published by the Free Software Foundation; either version 2
7 * of the License, or (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software Foundation,
16 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * The Original Code is Copyright (C) 2005 Blender Foundation.
19 * All rights reserved.
21 * The Original Code is: all of this file.
23 * Contributor(s): Bob Holcomb.
25 * ***** END GPL LICENSE BLOCK *****
28 /** \file blender/blenkernel/intern/node.c
32 #include "MEM_guardedalloc.h"
39 #include "DNA_action_types.h"
40 #include "DNA_anim_types.h"
41 #include "DNA_lamp_types.h"
42 #include "DNA_material_types.h"
43 #include "DNA_node_types.h"
44 #include "DNA_scene_types.h"
45 #include "DNA_texture_types.h"
46 #include "DNA_world_types.h"
48 #include "BLI_string.h"
50 #include "BLI_listbase.h"
51 #include "BLI_path_util.h"
52 #include "BLI_utildefines.h"
54 #include "BLF_translation.h"
56 #include "BKE_animsys.h"
57 #include "BKE_action.h"
58 #include "BKE_fcurve.h"
59 #include "BKE_global.h"
60 #include "BKE_idprop.h"
61 #include "BKE_image.h"
62 #include "BKE_library.h"
66 #include "BLI_ghash.h"
67 #include "RNA_access.h"
68 #include "RNA_define.h"
70 #include "NOD_socket.h"
71 #include "NOD_common.h"
72 #include "NOD_composite.h"
73 #include "NOD_shader.h"
74 #include "NOD_texture.h"
76 /* Fallback types for undefined tree, nodes, sockets */
77 bNodeTreeType NodeTreeTypeUndefined;
78 bNodeType NodeTypeUndefined;
79 bNodeSocketType NodeSocketTypeUndefined;
82 static void node_add_sockets_from_type(bNodeTree *ntree, bNode *node, bNodeType *ntype)
84 bNodeSocketTemplate *sockdef;
85 /* bNodeSocket *sock; */ /* UNUSED */
88 sockdef = ntype->inputs;
89 while (sockdef->type != -1) {
90 /* sock = */ node_add_socket_from_template(ntree, node, sockdef, SOCK_IN);
96 sockdef = ntype->outputs;
97 while (sockdef->type != -1) {
98 /* sock = */ node_add_socket_from_template(ntree, node, sockdef, SOCK_OUT);
105 /* Note: This function is called to initialize node data based on the type.
106 * The bNodeType may not be registered at creation time of the node,
107 * so this can be delayed until the node type gets registered.
109 static void node_init(const struct bContext *C, bNodeTree *ntree, bNode *node)
111 bNodeType *ntype = node->typeinfo;
112 if (ntype == &NodeTypeUndefined)
115 /* only do this once */
116 if (node->flag & NODE_INIT)
119 node->flag = NODE_SELECT | NODE_OPTIONS | ntype->flag;
120 node->width = ntype->width;
121 node->miniwidth = 42.0f;
122 node->height = ntype->height;
123 node->color[0] = node->color[1] = node->color[2] = 0.608; /* default theme color */
124 /* initialize the node name with the node label.
125 * note: do this after the initfunc so nodes get their data set which may be used in naming
126 * (node groups for example) */
127 /* XXX Do not use nodeLabel() here, it returns translated content for UI, which should *only* be used
128 * in UI, *never* in data... Data have their own translation option!
129 * This solution may be a bit rougher than nodeLabel()'s returned string, but it's simpler
130 * than adding "do_translate" flags to this func (and labelfunc() as well). */
131 BLI_strncpy(node->name, DATA_(ntype->ui_name), NODE_MAXSTR);
132 nodeUniqueName(ntree, node);
134 node_add_sockets_from_type(ntree, node, ntype);
136 if (ntype->initfunc != NULL)
137 ntype->initfunc(ntree, node);
139 if (ntree->typeinfo->node_add_init != NULL)
140 ntree->typeinfo->node_add_init(ntree, node);
142 /* extra init callback */
143 if (ntype->initfunc_api) {
145 RNA_pointer_create((ID *)ntree, &RNA_Node, node, &ptr);
147 /* XXX Warning: context can be NULL in case nodes are added in do_versions.
148 * Delayed init is not supported for nodes with context-based initfunc_api atm.
150 BLI_assert(C != NULL);
151 ntype->initfunc_api(C, &ptr);
155 id_us_plus(node->id);
157 node->flag |= NODE_INIT;
160 static void ntree_set_typeinfo(bNodeTree *ntree, bNodeTreeType *typeinfo)
163 ntree->typeinfo = typeinfo;
165 /* deprecated integer type */
166 ntree->type = typeinfo->type;
169 ntree->typeinfo = &NodeTreeTypeUndefined;
171 ntree->init &= ~NTREE_TYPE_INIT;
175 static void node_set_typeinfo(const struct bContext *C, bNodeTree *ntree, bNode *node, bNodeType *typeinfo)
178 node->typeinfo = typeinfo;
180 /* deprecated integer type */
181 node->type = typeinfo->type;
183 /* initialize the node if necessary */
184 node_init(C, ntree, node);
187 node->typeinfo = &NodeTypeUndefined;
189 ntree->init &= ~NTREE_TYPE_INIT;
193 static void node_socket_set_typeinfo(bNodeTree *ntree, bNodeSocket *sock, bNodeSocketType *typeinfo)
196 sock->typeinfo = typeinfo;
198 /* deprecated integer type */
199 sock->type = typeinfo->type;
201 if (sock->default_value == NULL) {
202 /* initialize the default_value pointer used by standard socket types */
203 node_socket_init_default_value(sock);
207 sock->typeinfo = &NodeSocketTypeUndefined;
209 ntree->init &= ~NTREE_TYPE_INIT;
213 /* Set specific typeinfo pointers in all node trees on register/unregister */
214 static void update_typeinfo(Main *bmain, const struct bContext *C, bNodeTreeType *treetype, bNodeType *nodetype, bNodeSocketType *socktype, bool unregister)
219 FOREACH_NODETREE(bmain, ntree, id) {
223 ntree->init |= NTREE_TYPE_INIT;
225 if (treetype && STREQ(ntree->idname, treetype->idname))
226 ntree_set_typeinfo(ntree, unregister ? NULL : treetype);
228 /* initialize nodes */
229 for (node = ntree->nodes.first; node; node = node->next) {
230 if (nodetype && STREQ(node->idname, nodetype->idname))
231 node_set_typeinfo(C, ntree, node, unregister ? NULL : nodetype);
233 /* initialize node sockets */
234 for (sock = node->inputs.first; sock; sock = sock->next)
235 if (socktype && STREQ(sock->idname, socktype->idname))
236 node_socket_set_typeinfo(ntree, sock, unregister ? NULL : socktype);
237 for (sock = node->outputs.first; sock; sock = sock->next)
238 if (socktype && STREQ(sock->idname, socktype->idname))
239 node_socket_set_typeinfo(ntree, sock, unregister ? NULL : socktype);
242 /* initialize tree sockets */
243 for (sock = ntree->inputs.first; sock; sock = sock->next)
244 if (socktype && STREQ(sock->idname, socktype->idname))
245 node_socket_set_typeinfo(ntree, sock, unregister ? NULL : socktype);
246 for (sock = ntree->outputs.first; sock; sock = sock->next)
247 if (socktype && STREQ(sock->idname, socktype->idname))
248 node_socket_set_typeinfo(ntree, sock, unregister ? NULL : socktype);
253 /* Try to initialize all typeinfo in a node tree.
254 * NB: In general undefined typeinfo is a perfectly valid case, the type may just be registered later.
255 * In that case the update_typeinfo function will set typeinfo on registration
256 * and do necessary updates.
258 void ntreeSetTypes(const struct bContext *C, bNodeTree *ntree)
263 ntree->init |= NTREE_TYPE_INIT;
265 ntree_set_typeinfo(ntree, ntreeTypeFind(ntree->idname));
267 for (node = ntree->nodes.first; node; node = node->next) {
268 node_set_typeinfo(C, ntree, node, nodeTypeFind(node->idname));
270 for (sock = node->inputs.first; sock; sock = sock->next)
271 node_socket_set_typeinfo(ntree, sock, nodeSocketTypeFind(sock->idname));
272 for (sock = node->outputs.first; sock; sock = sock->next)
273 node_socket_set_typeinfo(ntree, sock, nodeSocketTypeFind(sock->idname));
276 for (sock = ntree->inputs.first; sock; sock = sock->next)
277 node_socket_set_typeinfo(ntree, sock, nodeSocketTypeFind(sock->idname));
278 for (sock = ntree->outputs.first; sock; sock = sock->next)
279 node_socket_set_typeinfo(ntree, sock, nodeSocketTypeFind(sock->idname));
283 static GHash *nodetreetypes_hash = NULL;
284 static GHash *nodetypes_hash = NULL;
285 static GHash *nodesockettypes_hash = NULL;
287 bNodeTreeType *ntreeTypeFind(const char *idname)
292 nt = BLI_ghash_lookup(nodetreetypes_hash, idname);
300 void ntreeTypeAdd(bNodeTreeType *nt)
302 BLI_ghash_insert(nodetreetypes_hash, (void *)nt->idname, nt);
303 /* XXX pass Main to register function? */
304 update_typeinfo(G.main, NULL, nt, NULL, NULL, false);
307 /* callback for hash value free function */
308 static void ntree_free_type(void *treetype_v)
310 bNodeTreeType *treetype = treetype_v;
311 /* XXX pass Main to unregister function? */
312 update_typeinfo(G.main, NULL, treetype, NULL, NULL, true);
316 void ntreeTypeFreeLink(bNodeTreeType *nt)
318 BLI_ghash_remove(nodetreetypes_hash, nt->idname, NULL, ntree_free_type);
321 bool ntreeIsRegistered(bNodeTree *ntree)
323 return (ntree->typeinfo != &NodeTreeTypeUndefined);
326 GHashIterator *ntreeTypeGetIterator(void)
328 return BLI_ghashIterator_new(nodetreetypes_hash);
331 bNodeType *nodeTypeFind(const char *idname)
336 nt = BLI_ghash_lookup(nodetypes_hash, idname);
344 static void free_dynamic_typeinfo(bNodeType *ntype)
346 if (ntype->type == NODE_DYNAMIC) {
348 MEM_freeN(ntype->inputs);
350 if (ntype->outputs) {
351 MEM_freeN(ntype->outputs);
356 /* callback for hash value free function */
357 static void node_free_type(void *nodetype_v)
359 bNodeType *nodetype = nodetype_v;
360 /* XXX pass Main to unregister function? */
361 update_typeinfo(G.main, NULL, NULL, nodetype, NULL, true);
364 if (nodetype->type == NODE_DYNAMIC)
365 free_dynamic_typeinfo(nodetype);
367 if (nodetype->needs_free)
371 void nodeRegisterType(bNodeType *nt)
373 /* debug only: basic verification of registered types */
374 BLI_assert(nt->idname[0] != '\0');
375 BLI_assert(nt->poll != NULL);
377 BLI_ghash_insert(nodetypes_hash, (void *)nt->idname, nt);
378 /* XXX pass Main to register function? */
379 update_typeinfo(G.main, NULL, NULL, nt, NULL, false);
382 void nodeUnregisterType(bNodeType *nt)
384 BLI_ghash_remove(nodetypes_hash, nt->idname, NULL, node_free_type);
387 bool nodeIsRegistered(bNode *node)
389 return (node->typeinfo != &NodeTypeUndefined);
392 GHashIterator *nodeTypeGetIterator(void)
394 return BLI_ghashIterator_new(nodetypes_hash);
397 bNodeSocketType *nodeSocketTypeFind(const char *idname)
402 st = BLI_ghash_lookup(nodesockettypes_hash, idname);
410 /* callback for hash value free function */
411 static void node_free_socket_type(void *socktype_v)
413 bNodeSocketType *socktype = socktype_v;
414 /* XXX pass Main to unregister function? */
415 update_typeinfo(G.main, NULL, NULL, NULL, socktype, true);
420 void nodeRegisterSocketType(bNodeSocketType *st)
422 BLI_ghash_insert(nodesockettypes_hash, (void *)st->idname, st);
423 /* XXX pass Main to register function? */
424 update_typeinfo(G.main, NULL, NULL, NULL, st, false);
427 void nodeUnregisterSocketType(bNodeSocketType *st)
429 BLI_ghash_remove(nodesockettypes_hash, st->idname, NULL, node_free_socket_type);
432 bool nodeSocketIsRegistered(bNodeSocket *sock)
434 return (sock->typeinfo != &NodeSocketTypeUndefined);
437 GHashIterator *nodeSocketTypeGetIterator(void)
439 return BLI_ghashIterator_new(nodesockettypes_hash);
442 struct bNodeSocket *nodeFindSocket(bNode *node, int in_out, const char *identifier)
444 bNodeSocket *sock = (in_out == SOCK_IN ? node->inputs.first : node->outputs.first);
445 for (; sock; sock = sock->next) {
446 if (STREQ(sock->identifier, identifier))
452 /* find unique socket identifier */
453 static bool unique_identifier_check(void *arg, const char *identifier)
455 struct ListBase *lb = arg;
457 for (sock = lb->first; sock; sock = sock->next) {
458 if (STREQ(sock->identifier, identifier))
464 static bNodeSocket *make_socket(bNodeTree *ntree, bNode *UNUSED(node), int in_out, ListBase *lb,
465 const char *idname, const char *identifier, const char *name)
468 char auto_identifier[MAX_NAME];
470 if (identifier && identifier[0] != '\0') {
471 /* use explicit identifier */
472 BLI_strncpy(auto_identifier, identifier, sizeof(auto_identifier));
475 /* if no explicit identifier is given, assign a unique identifier based on the name */
476 BLI_strncpy(auto_identifier, name, sizeof(auto_identifier));
478 /* make the identifier unique */
479 BLI_uniquename_cb(unique_identifier_check, lb, "socket", '.', auto_identifier, sizeof(auto_identifier));
481 sock = MEM_callocN(sizeof(bNodeSocket), "sock");
482 sock->in_out = in_out;
484 BLI_strncpy(sock->identifier, auto_identifier, NODE_MAXSTR);
485 sock->limit = (in_out == SOCK_IN ? 1 : 0xFFF);
487 BLI_strncpy(sock->name, name, NODE_MAXSTR);
488 sock->storage = NULL;
489 sock->flag |= SOCK_COLLAPSED;
490 sock->type = SOCK_CUSTOM; /* int type undefined by default */
492 BLI_strncpy(sock->idname, idname, sizeof(sock->idname));
493 node_socket_set_typeinfo(ntree, sock, nodeSocketTypeFind(idname));
498 bNodeSocket *nodeAddSocket(bNodeTree *ntree, bNode *node, int in_out, const char *idname,
499 const char *identifier, const char *name)
501 ListBase *lb = (in_out == SOCK_IN ? &node->inputs : &node->outputs);
502 bNodeSocket *sock = make_socket(ntree, node, in_out, lb, idname, identifier, name);
504 BLI_remlink(lb, sock); /* does nothing for new socket */
505 BLI_addtail(lb, sock);
507 node->update |= NODE_UPDATE;
512 bNodeSocket *nodeInsertSocket(bNodeTree *ntree, bNode *node, int in_out, const char *idname,
513 bNodeSocket *next_sock, const char *identifier, const char *name)
515 ListBase *lb = (in_out == SOCK_IN ? &node->inputs : &node->outputs);
516 bNodeSocket *sock = make_socket(ntree, node, in_out, lb, idname, identifier, name);
518 BLI_remlink(lb, sock); /* does nothing for new socket */
519 BLI_insertlinkbefore(lb, next_sock, sock);
521 node->update |= NODE_UPDATE;
526 const char *nodeStaticSocketType(int type, int subtype)
532 return "NodeSocketFloatUnsigned";
533 case PROP_PERCENTAGE:
534 return "NodeSocketFloatPercentage";
536 return "NodeSocketFloatFactor";
538 return "NodeSocketFloatAngle";
540 return "NodeSocketFloatTime";
543 return "NodeSocketFloat";
548 return "NodeSocketIntUnsigned";
549 case PROP_PERCENTAGE:
550 return "NodeSocketIntPercentage";
552 return "NodeSocketIntFactor";
555 return "NodeSocketInt";
558 return "NodeSocketBool";
561 case PROP_TRANSLATION:
562 return "NodeSocketVectorTranslation";
564 return "NodeSocketVectorDirection";
566 return "NodeSocketVectorVelocity";
567 case PROP_ACCELERATION:
568 return "NodeSocketVectorAcceleration";
570 return "NodeSocketVectorEuler";
572 return "NodeSocketVectorXYZ";
575 return "NodeSocketVector";
578 return "NodeSocketColor";
580 return "NodeSocketString";
582 return "NodeSocketShader";
587 const char *nodeStaticSocketInterfaceType(int type, int subtype)
593 return "NodeSocketInterfaceFloatUnsigned";
594 case PROP_PERCENTAGE:
595 return "NodeSocketInterfaceFloatPercentage";
597 return "NodeSocketInterfaceFloatFactor";
599 return "NodeSocketInterfaceFloatAngle";
601 return "NodeSocketInterfaceFloatTime";
604 return "NodeSocketInterfaceFloat";
609 return "NodeSocketInterfaceIntUnsigned";
610 case PROP_PERCENTAGE:
611 return "NodeSocketInterfaceIntPercentage";
613 return "NodeSocketInterfaceIntFactor";
616 return "NodeSocketInterfaceInt";
619 return "NodeSocketInterfaceBool";
622 case PROP_TRANSLATION:
623 return "NodeSocketInterfaceVectorTranslation";
625 return "NodeSocketInterfaceVectorDirection";
627 return "NodeSocketInterfaceVectorVelocity";
628 case PROP_ACCELERATION:
629 return "NodeSocketInterfaceVectorAcceleration";
631 return "NodeSocketInterfaceVectorEuler";
633 return "NodeSocketInterfaceVectorXYZ";
636 return "NodeSocketInterfaceVector";
639 return "NodeSocketInterfaceColor";
641 return "NodeSocketInterfaceString";
643 return "NodeSocketInterfaceShader";
648 bNodeSocket *nodeAddStaticSocket(bNodeTree *ntree, bNode *node, int in_out, int type, int subtype,
649 const char *identifier, const char *name)
651 const char *idname = nodeStaticSocketType(type, subtype);
655 printf("Error: static node socket type %d undefined\n", type);
659 sock = nodeAddSocket(ntree, node, in_out, idname, identifier, name);
664 bNodeSocket *nodeInsertStaticSocket(bNodeTree *ntree, bNode *node, int in_out, int type, int subtype,
665 bNodeSocket *next_sock, const char *identifier, const char *name)
667 const char *idname = nodeStaticSocketType(type, subtype);
671 printf("Error: static node socket type %d undefined\n", type);
675 sock = nodeInsertSocket(ntree, node, in_out, idname, next_sock, identifier, name);
680 static void node_socket_free(bNodeTree *UNUSED(ntree), bNodeSocket *sock, bNode *UNUSED(node))
683 IDP_FreeProperty(sock->prop);
684 MEM_freeN(sock->prop);
687 if (sock->default_value)
688 MEM_freeN(sock->default_value);
691 void nodeRemoveSocket(bNodeTree *ntree, bNode *node, bNodeSocket *sock)
693 bNodeLink *link, *next;
695 for (link = ntree->links.first; link; link = next) {
697 if (link->fromsock == sock || link->tosock == sock) {
698 nodeRemLink(ntree, link);
702 /* this is fast, this way we don't need an in_out argument */
703 BLI_remlink(&node->inputs, sock);
704 BLI_remlink(&node->outputs, sock);
706 node_socket_free(ntree, sock, node);
709 node->update |= NODE_UPDATE;
712 void nodeRemoveAllSockets(bNodeTree *ntree, bNode *node)
714 bNodeSocket *sock, *sock_next;
715 bNodeLink *link, *next;
717 for (link = ntree->links.first; link; link = next) {
719 if (link->fromnode == node || link->tonode == node) {
720 nodeRemLink(ntree, link);
724 for (sock = node->inputs.first; sock; sock = sock_next) {
725 sock_next = sock->next;
726 node_socket_free(ntree, sock, node);
729 for (sock = node->outputs.first; sock; sock = sock_next) {
730 sock_next = sock->next;
731 node_socket_free(ntree, sock, node);
735 node->update |= NODE_UPDATE;
738 /* finds a node based on its name */
739 bNode *nodeFindNodebyName(bNodeTree *ntree, const char *name)
741 return BLI_findstring(&ntree->nodes, name, offsetof(bNode, name));
744 /* finds a node based on given socket */
745 int nodeFindNode(bNodeTree *ntree, bNodeSocket *sock, bNode **nodep, int *sockindex)
747 int in_out = sock->in_out;
752 for (node = ntree->nodes.first; node; node = node->next) {
753 tsock = (in_out == SOCK_IN ? node->inputs.first : node->outputs.first);
754 for (index = 0; tsock; tsock = tsock->next, index++) {
764 if (sockindex) *sockindex = index;
772 /* ************** Add stuff ********** */
774 /* Find the first available, non-duplicate name for a given node */
775 void nodeUniqueName(bNodeTree *ntree, bNode *node)
777 BLI_uniquename(&ntree->nodes, node, DATA_("Node"), '.', offsetof(bNode, name), sizeof(node->name));
780 bNode *nodeAddNode(const struct bContext *C, bNodeTree *ntree, const char *idname)
784 node = MEM_callocN(sizeof(bNode), "new node");
785 BLI_addtail(&ntree->nodes, node);
787 BLI_strncpy(node->idname, idname, sizeof(node->idname));
788 node_set_typeinfo(C, ntree, node, nodeTypeFind(idname));
790 ntree->update |= NTREE_UPDATE_NODES;
795 bNode *nodeAddStaticNode(const struct bContext *C, bNodeTree *ntree, int type)
797 const char *idname = NULL;
799 NODE_TYPES_BEGIN(ntype)
800 /* do an extra poll here, because some int types are used
801 * for multiple node types, this helps find the desired type
803 if (ntype->type == type && (!ntype->poll || ntype->poll(ntype, ntree))) {
804 idname = ntype->idname;
809 printf("Error: static node type %d undefined\n", type);
812 return nodeAddNode(C, ntree, idname);
815 static void node_socket_copy(bNodeSocket *dst, bNodeSocket *src)
820 dst->prop = IDP_CopyProperty(src->prop);
822 if (src->default_value)
823 dst->default_value = MEM_dupallocN(src->default_value);
825 dst->stack_index = 0;
826 /* XXX some compositor node (e.g. image, render layers) still store
827 * some persistent buffer data here, need to clear this to avoid dangling pointers.
832 /* keep socket listorder identical, for copying links */
833 /* ntree is the target tree */
834 bNode *nodeCopyNode(struct bNodeTree *ntree, struct bNode *node)
836 bNode *nnode = MEM_callocN(sizeof(bNode), "dupli node");
837 bNodeSocket *sock, *oldsock;
838 bNodeLink *link, *oldlink;
841 /* can be called for nodes outside a node tree (e.g. clipboard) */
843 nodeUniqueName(ntree, nnode);
845 BLI_addtail(&ntree->nodes, nnode);
848 BLI_duplicatelist(&nnode->inputs, &node->inputs);
849 oldsock = node->inputs.first;
850 for (sock = nnode->inputs.first; sock; sock = sock->next, oldsock = oldsock->next)
851 node_socket_copy(sock, oldsock);
853 BLI_duplicatelist(&nnode->outputs, &node->outputs);
854 oldsock = node->outputs.first;
855 for (sock = nnode->outputs.first; sock; sock = sock->next, oldsock = oldsock->next)
856 node_socket_copy(sock, oldsock);
859 nnode->prop = IDP_CopyProperty(node->prop);
861 BLI_duplicatelist(&nnode->internal_links, &node->internal_links);
862 oldlink = node->internal_links.first;
863 for (link = nnode->internal_links.first; link; link = link->next, oldlink = oldlink->next) {
864 link->fromnode = nnode;
865 link->tonode = nnode;
866 link->fromsock = link->fromsock->new_sock;
867 link->tosock = link->tosock->new_sock;
870 /* don't increase node->id users, freenode doesn't decrement either */
872 if (node->typeinfo->copyfunc)
873 node->typeinfo->copyfunc(ntree, nnode, node);
875 node->new_node = nnode;
876 nnode->new_node = NULL;
878 if (nnode->typeinfo->copyfunc_api) {
880 RNA_pointer_create((ID *)ntree, &RNA_Node, nnode, &ptr);
882 nnode->typeinfo->copyfunc_api(&ptr, node);
886 ntree->update |= NTREE_UPDATE_NODES;
891 /* also used via rna api, so we check for proper input output direction */
892 bNodeLink *nodeAddLink(bNodeTree *ntree, bNode *fromnode, bNodeSocket *fromsock, bNode *tonode, bNodeSocket *tosock)
894 bNodeLink *link = NULL;
896 /* test valid input */
897 BLI_assert(fromnode);
900 if (fromsock->in_out == SOCK_OUT && tosock->in_out == SOCK_IN) {
901 link = MEM_callocN(sizeof(bNodeLink), "link");
903 BLI_addtail(&ntree->links, link);
904 link->fromnode = fromnode;
905 link->fromsock = fromsock;
906 link->tonode = tonode;
907 link->tosock = tosock;
909 else if (fromsock->in_out == SOCK_IN && tosock->in_out == SOCK_OUT) {
911 link = MEM_callocN(sizeof(bNodeLink), "link");
913 BLI_addtail(&ntree->links, link);
914 link->fromnode = tonode;
915 link->fromsock = tosock;
916 link->tonode = fromnode;
917 link->tosock = fromsock;
921 ntree->update |= NTREE_UPDATE_LINKS;
926 void nodeRemLink(bNodeTree *ntree, bNodeLink *link)
928 /* can be called for links outside a node tree (e.g. clipboard) */
930 BLI_remlink(&ntree->links, link);
933 link->tosock->link = NULL;
937 ntree->update |= NTREE_UPDATE_LINKS;
940 void nodeRemSocketLinks(bNodeTree *ntree, bNodeSocket *sock)
942 bNodeLink *link, *next;
944 for (link = ntree->links.first; link; link = next) {
946 if (link->fromsock == sock || link->tosock == sock) {
947 nodeRemLink(ntree, link);
951 ntree->update |= NTREE_UPDATE_LINKS;
954 int nodeLinkIsHidden(bNodeLink *link)
956 return nodeSocketIsHidden(link->fromsock) || nodeSocketIsHidden(link->tosock);
959 void nodeInternalRelink(bNodeTree *ntree, bNode *node)
961 bNodeLink *link, *link_next;
963 /* store link pointers in output sockets, for efficient lookup */
964 for (link = node->internal_links.first; link; link = link->next)
965 link->tosock->link = link;
967 /* redirect downstream links */
968 for (link = ntree->links.first; link; link = link_next) {
969 link_next = link->next;
971 /* do we have internal link? */
972 if (link->fromnode == node) {
973 if (link->fromsock->link) {
974 /* get the upstream input link */
975 bNodeLink *fromlink = link->fromsock->link->fromsock->link;
978 link->fromnode = fromlink->fromnode;
979 link->fromsock = fromlink->fromsock;
981 /* if the up- or downstream link is invalid,
982 * the replacement link will be invalid too.
984 if (!(fromlink->flag & NODE_LINK_VALID))
985 link->flag &= ~NODE_LINK_VALID;
987 ntree->update |= NTREE_UPDATE_LINKS;
990 nodeRemLink(ntree, link);
993 nodeRemLink(ntree, link);
997 /* remove remaining upstream links */
998 for (link = ntree->links.first; link; link = link_next) {
999 link_next = link->next;
1001 if (link->tonode == node)
1002 nodeRemLink(ntree, link);
1006 void nodeToView(bNode *node, float x, float y, float *rx, float *ry)
1009 nodeToView(node->parent, x + node->locx, y + node->locy, rx, ry);
1012 *rx = x + node->locx;
1013 *ry = y + node->locy;
1017 void nodeFromView(bNode *node, float x, float y, float *rx, float *ry)
1020 nodeFromView(node->parent, x, y, rx, ry);
1025 *rx = x - node->locx;
1026 *ry = y - node->locy;
1030 int nodeAttachNodeCheck(bNode *node, bNode *parent)
1032 bNode *parent_recurse;
1033 for (parent_recurse = node; parent_recurse; parent_recurse = parent_recurse->parent) {
1034 if (parent_recurse == parent) {
1042 void nodeAttachNode(bNode *node, bNode *parent)
1046 BLI_assert(parent->type == NODE_FRAME);
1047 BLI_assert(nodeAttachNodeCheck(parent, node) == FALSE);
1049 nodeToView(node, 0.0f, 0.0f, &locx, &locy);
1051 node->parent = parent;
1052 /* transform to parent space */
1053 nodeFromView(parent, locx, locy, &node->locx, &node->locy);
1056 void nodeDetachNode(struct bNode *node)
1062 BLI_assert(node->parent->type == NODE_FRAME);
1064 /* transform to view space */
1065 nodeToView(node, 0.0f, 0.0f, &locx, &locy);
1068 node->parent = NULL;
1072 bNodeTree *ntreeAddTree(Main *bmain, const char *name, const char *idname)
1076 /* trees are created as local trees for compositor, material or texture nodes,
1077 * node groups and other tree types are created as library data.
1080 ntree = BKE_libblock_alloc(bmain, ID_NT, name);
1083 ntree = MEM_callocN(sizeof(bNodeTree), "new node tree");
1084 *( (short *)ntree->id.name ) = ID_NT;
1085 BLI_strncpy(ntree->id.name + 2, name, sizeof(ntree->id.name));
1088 /* Types are fully initialized at this point,
1089 * if an undefined node is added later this will be reset.
1091 ntree->init |= NTREE_TYPE_INIT;
1093 BLI_strncpy(ntree->idname, idname, sizeof(ntree->idname));
1094 ntree_set_typeinfo(ntree, ntreeTypeFind(idname));
1099 /* Warning: this function gets called during some rather unexpected times
1100 * - this gets called when executing compositing updates (for threaded previews)
1101 * - when the nodetree datablock needs to be copied (i.e. when users get copied)
1102 * - for scene duplication use ntreeSwapID() after so we don't have stale pointers.
1104 * do_make_extern: keep enabled for general use, only reason _not_ to enable is when
1105 * copying for internal use (threads for eg), where you wont want it to modify the
1108 static bNodeTree *ntreeCopyTree_internal(bNodeTree *ntree, Main *bmain, bool do_id_user, bool do_make_extern, bool copy_previews)
1111 bNode *node /*, *nnode */ /* UNUSED */, *last;
1112 bNodeSocket *sock, *oldsock;
1115 if (ntree == NULL) return NULL;
1117 /* is ntree part of library? */
1118 if (bmain && BLI_findindex(&bmain->nodetree, ntree) >= 0) {
1119 newtree = BKE_libblock_copy(&ntree->id);
1122 newtree = BKE_libblock_copy_nolib(&ntree->id);
1123 newtree->id.lib = NULL; /* same as owning datablock id.lib */
1126 id_us_plus((ID *)newtree->gpd);
1128 /* in case a running nodetree is copied */
1129 newtree->execdata = NULL;
1131 BLI_listbase_clear(&newtree->nodes);
1132 BLI_listbase_clear(&newtree->links);
1134 last = ntree->nodes.last;
1135 for (node = ntree->nodes.first; node; node = node->next) {
1137 /* ntreeUserDecrefID inline */
1139 id_us_plus(node->id);
1142 if (do_make_extern) {
1143 id_lib_extern(node->id);
1146 node->new_node = NULL;
1147 /* nnode = */ nodeCopyNode(newtree, node); /* sets node->new */
1149 /* make sure we don't copy new nodes again! */
1155 BLI_duplicatelist(&newtree->links, &ntree->links);
1156 for (link = newtree->links.first; link; link = link->next) {
1157 link->fromnode = (link->fromnode ? link->fromnode->new_node : NULL);
1158 link->fromsock = (link->fromsock ? link->fromsock->new_sock : NULL);
1159 link->tonode = (link->tonode ? link->tonode->new_node : NULL);
1160 link->tosock = (link->tosock ? link->tosock->new_sock : NULL);
1161 /* update the link socket's pointer */
1163 link->tosock->link = link;
1166 /* copy interface sockets */
1167 BLI_duplicatelist(&newtree->inputs, &ntree->inputs);
1168 oldsock = ntree->inputs.first;
1169 for (sock = newtree->inputs.first; sock; sock = sock->next, oldsock = oldsock->next)
1170 node_socket_copy(sock, oldsock);
1172 BLI_duplicatelist(&newtree->outputs, &ntree->outputs);
1173 oldsock = ntree->outputs.first;
1174 for (sock = newtree->outputs.first; sock; sock = sock->next, oldsock = oldsock->next)
1175 node_socket_copy(sock, oldsock);
1177 /* copy preview hash */
1178 if (ntree->previews && copy_previews) {
1179 bNodeInstanceHashIterator iter;
1181 newtree->previews = BKE_node_instance_hash_new("node previews");
1183 NODE_INSTANCE_HASH_ITER(iter, ntree->previews) {
1184 bNodeInstanceKey key = BKE_node_instance_hash_iterator_get_key(&iter);
1185 bNodePreview *preview = BKE_node_instance_hash_iterator_get_value(&iter);
1186 BKE_node_instance_hash_insert(newtree->previews, key, BKE_node_preview_copy(preview));
1190 newtree->previews = NULL;
1192 /* update node->parent pointers */
1193 for (node = newtree->nodes.first; node; node = node->next) {
1195 node->parent = node->parent->new_node;
1198 /* node tree will generate its own interface type */
1199 newtree->interface_type = NULL;
1204 bNodeTree *ntreeCopyTree_ex(bNodeTree *ntree, const bool do_id_user)
1206 return ntreeCopyTree_internal(ntree, G.main, do_id_user, TRUE, TRUE);
1208 bNodeTree *ntreeCopyTree(bNodeTree *ntree)
1210 return ntreeCopyTree_ex(ntree, TRUE);
1213 /* use when duplicating scenes */
1214 void ntreeSwitchID_ex(bNodeTree *ntree, ID *id_from, ID *id_to, const bool do_id_user)
1218 if (id_from == id_to) {
1219 /* should never happen but may as well skip if it does */
1223 /* for scene duplication only */
1224 for (node = ntree->nodes.first; node; node = node->next) {
1225 if (node->id == id_from) {
1235 void ntreeSwitchID(bNodeTree *ntree, ID *id_from, ID *id_to)
1237 ntreeSwitchID_ex(ntree, id_from, id_to, TRUE);
1240 void ntreeUserIncrefID(bNodeTree *ntree)
1243 for (node = ntree->nodes.first; node; node = node->next) {
1244 id_us_plus(node->id);
1247 void ntreeUserDecrefID(bNodeTree *ntree)
1250 for (node = ntree->nodes.first; node; node = node->next) {
1251 id_us_min(node->id);
1255 /* *************** Node Preview *********** */
1257 /* XXX this should be removed eventually ...
1258 * Currently BKE functions are modelled closely on previous code,
1259 * using BKE_node_preview_init_tree to set up previews for a whole node tree in advance.
1260 * This should be left more to the individual node tree implementations.
1262 int BKE_node_preview_used(bNode *node)
1264 /* XXX check for closed nodes? */
1265 return (node->typeinfo->flag & NODE_PREVIEW) != 0;
1268 bNodePreview *BKE_node_preview_verify(bNodeInstanceHash *previews, bNodeInstanceKey key, int xsize, int ysize, int create)
1270 bNodePreview *preview;
1272 preview = BKE_node_instance_hash_lookup(previews, key);
1275 preview = MEM_callocN(sizeof(bNodePreview), "node preview");
1276 BKE_node_instance_hash_insert(previews, key, preview);
1282 /* node previews can get added with variable size this way */
1283 if (xsize == 0 || ysize == 0)
1286 /* sanity checks & initialize */
1287 if (preview->rect) {
1288 if (preview->xsize != xsize || preview->ysize != ysize) {
1289 MEM_freeN(preview->rect);
1290 preview->rect = NULL;
1294 if (preview->rect == NULL) {
1295 preview->rect = MEM_callocN(4 * xsize + xsize * ysize * sizeof(char) * 4, "node preview rect");
1296 preview->xsize = xsize;
1297 preview->ysize = ysize;
1299 /* no clear, makes nicer previews */
1304 bNodePreview *BKE_node_preview_copy(bNodePreview *preview)
1306 bNodePreview *new_preview = MEM_dupallocN(preview);
1308 new_preview->rect = MEM_dupallocN(preview->rect);
1312 void BKE_node_preview_free(bNodePreview *preview)
1315 MEM_freeN(preview->rect);
1319 static void node_preview_init_tree_recursive(bNodeInstanceHash *previews, bNodeTree *ntree, bNodeInstanceKey parent_key, int xsize, int ysize, int create)
1322 for (node = ntree->nodes.first; node; node = node->next) {
1323 bNodeInstanceKey key = BKE_node_instance_key(parent_key, ntree, node);
1325 if (BKE_node_preview_used(node)) {
1326 node->preview_xsize = xsize;
1327 node->preview_ysize = ysize;
1329 BKE_node_preview_verify(previews, key, xsize, ysize, create);
1332 if (node->type == NODE_GROUP && node->id)
1333 node_preview_init_tree_recursive(previews, (bNodeTree *)node->id, key, xsize, ysize, create);
1337 void BKE_node_preview_init_tree(bNodeTree *ntree, int xsize, int ysize, int create_previews)
1342 if (!ntree->previews)
1343 ntree->previews = BKE_node_instance_hash_new("node previews");
1345 node_preview_init_tree_recursive(ntree->previews, ntree, NODE_INSTANCE_KEY_BASE, xsize, ysize, create_previews);
1348 static void node_preview_tag_used_recursive(bNodeInstanceHash *previews, bNodeTree *ntree, bNodeInstanceKey parent_key)
1351 for (node = ntree->nodes.first; node; node = node->next) {
1352 bNodeInstanceKey key = BKE_node_instance_key(parent_key, ntree, node);
1354 if (BKE_node_preview_used(node))
1355 BKE_node_instance_hash_tag_key(previews, key);
1357 if (node->type == NODE_GROUP && node->id)
1358 node_preview_tag_used_recursive(previews, (bNodeTree *)node->id, key);
1362 void BKE_node_preview_remove_unused(bNodeTree *ntree)
1364 if (!ntree || !ntree->previews)
1367 /* use the instance hash functions for tagging and removing unused previews */
1368 BKE_node_instance_hash_clear_tags(ntree->previews);
1369 node_preview_tag_used_recursive(ntree->previews, ntree, NODE_INSTANCE_KEY_BASE);
1371 BKE_node_instance_hash_remove_untagged(ntree->previews, (bNodeInstanceValueFP)BKE_node_preview_free);
1374 void BKE_node_preview_free_tree(bNodeTree *ntree)
1379 if (ntree->previews) {
1380 BKE_node_instance_hash_free(ntree->previews, (bNodeInstanceValueFP)BKE_node_preview_free);
1381 ntree->previews = NULL;
1385 void BKE_node_preview_clear(bNodePreview *preview)
1387 if (preview && preview->rect)
1388 memset(preview->rect, 0, MEM_allocN_len(preview->rect));
1391 void BKE_node_preview_clear_tree(bNodeTree *ntree)
1393 bNodeInstanceHashIterator iter;
1395 if (!ntree || !ntree->previews)
1398 NODE_INSTANCE_HASH_ITER(iter, ntree->previews) {
1399 bNodePreview *preview = BKE_node_instance_hash_iterator_get_value(&iter);
1400 BKE_node_preview_clear(preview);
1404 static void node_preview_sync(bNodePreview *to, bNodePreview *from)
1406 /* sizes should have been initialized by BKE_node_preview_init_tree */
1407 BLI_assert(to->xsize == from->xsize && to->ysize == from->ysize);
1409 /* copy over contents of previews */
1410 if (to->rect && from->rect) {
1411 int xsize = to->xsize;
1412 int ysize = to->ysize;
1413 memcpy(to->rect, from->rect, 4 * xsize + xsize * ysize * sizeof(char) * 4);
1417 void BKE_node_preview_sync_tree(bNodeTree *to_ntree, bNodeTree *from_ntree)
1419 bNodeInstanceHash *from_previews = from_ntree->previews;
1420 bNodeInstanceHash *to_previews = to_ntree->previews;
1421 bNodeInstanceHashIterator iter;
1423 if (!from_previews || !to_previews)
1426 NODE_INSTANCE_HASH_ITER(iter, from_previews) {
1427 bNodeInstanceKey key = BKE_node_instance_hash_iterator_get_key(&iter);
1428 bNodePreview *from = BKE_node_instance_hash_iterator_get_value(&iter);
1429 bNodePreview *to = BKE_node_instance_hash_lookup(to_previews, key);
1432 node_preview_sync(to, from);
1436 void BKE_node_preview_merge_tree(bNodeTree *to_ntree, bNodeTree *from_ntree, bool remove_old)
1438 if (remove_old || !to_ntree->previews) {
1439 /* free old previews */
1440 if (to_ntree->previews)
1441 BKE_node_instance_hash_free(to_ntree->previews, (bNodeInstanceValueFP)BKE_node_preview_free);
1443 /* transfer previews */
1444 to_ntree->previews = from_ntree->previews;
1445 from_ntree->previews = NULL;
1447 /* clean up, in case any to_ntree nodes have been removed */
1448 BKE_node_preview_remove_unused(to_ntree);
1451 bNodeInstanceHashIterator iter;
1453 if (from_ntree->previews) {
1454 NODE_INSTANCE_HASH_ITER(iter, from_ntree->previews) {
1455 bNodeInstanceKey key = BKE_node_instance_hash_iterator_get_key(&iter);
1456 bNodePreview *preview = BKE_node_instance_hash_iterator_get_value(&iter);
1458 /* replace existing previews */
1459 BKE_node_instance_hash_remove(to_ntree->previews, key, (bNodeInstanceValueFP)BKE_node_preview_free);
1460 BKE_node_instance_hash_insert(to_ntree->previews, key, preview);
1463 /* Note: NULL free function here, because pointers have already been moved over to to_ntree->previews! */
1464 BKE_node_instance_hash_free(from_ntree->previews, NULL);
1465 from_ntree->previews = NULL;
1470 /* hack warning! this function is only used for shader previews, and
1471 * since it gets called multiple times per pixel for Ztransp we only
1472 * add the color once. Preview gets cleared before it starts render though */
1473 void BKE_node_preview_set_pixel(bNodePreview *preview, const float col[4], int x, int y, bool do_manage)
1476 if (x >= 0 && y >= 0) {
1477 if (x < preview->xsize && y < preview->ysize) {
1478 unsigned char *tar = preview->rect + 4 * ((preview->xsize * y) + x);
1481 linearrgb_to_srgb_uchar4(tar, col);
1484 rgba_float_to_uchar(tar, col);
1487 //else printf("prv out bound x y %d %d\n", x, y);
1489 //else printf("prv out bound x y %d %d\n", x, y);
1494 static void nodeClearPreview(bNode *node)
1496 if (node->preview && node->preview->rect)
1497 memset(node->preview->rect, 0, MEM_allocN_len(node->preview->rect));
1500 /* use it to enforce clear */
1501 void ntreeClearPreview(bNodeTree *ntree)
1508 for (node = ntree->nodes.first; node; node = node->next) {
1509 if (node->typeinfo->flag & NODE_PREVIEW)
1510 nodeClearPreview(node);
1511 if (node->type == NODE_GROUP)
1512 ntreeClearPreview((bNodeTree *)node->id);
1516 /* hack warning! this function is only used for shader previews, and
1517 * since it gets called multiple times per pixel for Ztransp we only
1518 * add the color once. Preview gets cleared before it starts render though */
1519 void nodeAddToPreview(bNode *node, const float col[4], int x, int y, int do_manage)
1521 bNodePreview *preview = node->preview;
1523 if (x >= 0 && y >= 0) {
1524 if (x < preview->xsize && y < preview->ysize) {
1525 unsigned char *tar = preview->rect + 4 * ((preview->xsize * y) + x);
1528 linearrgb_to_srgb_uchar4(tar, col);
1531 rgba_float_to_uchar(tar, col);
1534 //else printf("prv out bound x y %d %d\n", x, y);
1536 //else printf("prv out bound x y %d %d\n", x, y);
1541 /* ************** Free stuff ********** */
1543 /* goes over entire tree */
1544 void nodeUnlinkNode(bNodeTree *ntree, bNode *node)
1546 bNodeLink *link, *next;
1550 for (link = ntree->links.first; link; link = next) {
1553 if (link->fromnode == node) {
1554 lb = &node->outputs;
1556 link->tonode->update |= NODE_UPDATE;
1558 else if (link->tonode == node)
1564 for (sock = lb->first; sock; sock = sock->next) {
1565 if (link->fromsock == sock || link->tosock == sock)
1569 nodeRemLink(ntree, link);
1575 static void node_unlink_attached(bNodeTree *ntree, bNode *parent)
1578 for (node = ntree->nodes.first; node; node = node->next) {
1579 if (node->parent == parent)
1580 nodeDetachNode(node);
1584 /** \note caller needs to manage node->id user */
1585 static void node_free_node_ex(bNodeTree *ntree, bNode *node, bool remove_animdata, bool use_api_free_cb)
1587 bNodeSocket *sock, *nextsock;
1589 /* don't remove node animdata if the tree is localized,
1590 * Action is shared with the original tree (T38221)
1592 remove_animdata &= ntree && !(ntree->flag & NTREE_IS_LOCALIZED);
1594 /* extra free callback */
1595 if (use_api_free_cb && node->typeinfo->freefunc_api) {
1597 RNA_pointer_create((ID *)ntree, &RNA_Node, node, &ptr);
1599 node->typeinfo->freefunc_api(&ptr);
1602 /* since it is called while free database, node->id is undefined */
1604 /* can be called for nodes outside a node tree (e.g. clipboard) */
1606 /* remove all references to this node */
1607 nodeUnlinkNode(ntree, node);
1608 node_unlink_attached(ntree, node);
1610 BLI_remlink(&ntree->nodes, node);
1612 if (remove_animdata) {
1613 char propname_esc[MAX_IDPROP_NAME * 2];
1614 char prefix[MAX_IDPROP_NAME * 2];
1616 BLI_strescape(propname_esc, node->name, sizeof(propname_esc));
1617 BLI_snprintf(prefix, sizeof(prefix), "nodes[\"%s\"]", propname_esc);
1619 BKE_animdata_fix_paths_remove((ID *)ntree, prefix);
1622 if (ntree->typeinfo->free_node_cache)
1623 ntree->typeinfo->free_node_cache(ntree, node);
1625 /* texture node has bad habit of keeping exec data around */
1626 if (ntree->type == NTREE_TEXTURE && ntree->execdata) {
1627 ntreeTexEndExecTree(ntree->execdata);
1628 ntree->execdata = NULL;
1631 if (node->typeinfo->freefunc)
1632 node->typeinfo->freefunc(node);
1635 for (sock = node->inputs.first; sock; sock = nextsock) {
1636 nextsock = sock->next;
1637 node_socket_free(ntree, sock, node);
1640 for (sock = node->outputs.first; sock; sock = nextsock) {
1641 nextsock = sock->next;
1642 node_socket_free(ntree, sock, node);
1646 BLI_freelistN(&node->internal_links);
1649 IDP_FreeProperty(node->prop);
1650 MEM_freeN(node->prop);
1656 ntree->update |= NTREE_UPDATE_NODES;
1659 void nodeFreeNode(bNodeTree *ntree, bNode *node)
1661 node_free_node_ex(ntree, node, true, true);
1664 static void node_socket_interface_free(bNodeTree *UNUSED(ntree), bNodeSocket *sock)
1667 IDP_FreeProperty(sock->prop);
1668 MEM_freeN(sock->prop);
1671 if (sock->default_value)
1672 MEM_freeN(sock->default_value);
1675 static void free_localized_node_groups(bNodeTree *ntree)
1679 /* Only localized node trees store a copy for each node group tree.
1680 * Each node group tree in a localized node tree can be freed,
1681 * since it is a localized copy itself (no risk of accessing free'd
1682 * data in main, see [#37939]).
1684 if (!(ntree->flag & NTREE_IS_LOCALIZED))
1687 for (node = ntree->nodes.first; node; node = node->next) {
1688 if (node->type == NODE_GROUP && node->id) {
1689 bNodeTree *ngroup = (bNodeTree *)node->id;
1690 ntreeFreeTree_ex(ngroup, false);
1696 /* do not free ntree itself here, BKE_libblock_free calls this function too */
1697 void ntreeFreeTree_ex(bNodeTree *ntree, const bool do_id_user)
1701 bNodeSocket *sock, *nextsock;
1703 if (ntree == NULL) return;
1705 /* XXX hack! node trees should not store execution graphs at all.
1706 * This should be removed when old tree types no longer require it.
1707 * Currently the execution data for texture nodes remains in the tree
1708 * after execution, until the node tree is updated or freed.
1710 if (ntree->execdata) {
1711 switch (ntree->type) {
1713 ntreeShaderEndExecTree(ntree->execdata);
1716 ntreeTexEndExecTree(ntree->execdata);
1717 ntree->execdata = NULL;
1722 /* XXX not nice, but needed to free localized node groups properly */
1723 free_localized_node_groups(ntree);
1725 /* unregister associated RNA types */
1726 ntreeInterfaceTypeFree(ntree);
1728 BKE_free_animdata((ID *)ntree);
1730 id_us_min((ID *)ntree->gpd);
1732 BLI_freelistN(&ntree->links); /* do first, then unlink_node goes fast */
1734 for (node = ntree->nodes.first; node; node = next) {
1737 /* ntreeUserIncrefID inline */
1739 /* XXX, this is correct, however when freeing the entire database
1740 * this ends up accessing freed data which isn't properly unlinking
1741 * its self from scene nodes, SO - for now prefer invalid usercounts
1742 * on free rather then bad memory access - Campbell */
1745 id_us_min(node->id);
1751 node_free_node_ex(ntree, node, false, false);
1754 /* free interface sockets */
1755 for (sock = ntree->inputs.first; sock; sock = nextsock) {
1756 nextsock = sock->next;
1757 node_socket_interface_free(ntree, sock);
1760 for (sock = ntree->outputs.first; sock; sock = nextsock) {
1761 nextsock = sock->next;
1762 node_socket_interface_free(ntree, sock);
1766 /* free preview hash */
1767 if (ntree->previews) {
1768 BKE_node_instance_hash_free(ntree->previews, (bNodeInstanceValueFP)BKE_node_preview_free);
1771 /* if ntree is not part of library, free the libblock data explicitly */
1772 for (tntree = G.main->nodetree.first; tntree; tntree = tntree->id.next)
1773 if (tntree == ntree)
1775 if (tntree == NULL) {
1776 BKE_libblock_free_data(&ntree->id);
1779 /* same as ntreeFreeTree_ex but always manage users */
1780 void ntreeFreeTree(bNodeTree *ntree)
1782 ntreeFreeTree_ex(ntree, TRUE);
1785 void ntreeFreeCache(bNodeTree *ntree)
1787 if (ntree == NULL) return;
1789 if (ntree->typeinfo->free_cache)
1790 ntree->typeinfo->free_cache(ntree);
1793 void ntreeSetOutput(bNodeTree *ntree)
1797 /* find the active outputs, might become tree type dependent handler */
1798 for (node = ntree->nodes.first; node; node = node->next) {
1799 if (node->typeinfo->nclass == NODE_CLASS_OUTPUT) {
1803 /* we need a check for which output node should be tagged like this, below an exception */
1804 if (node->type == CMP_NODE_OUTPUT_FILE)
1807 /* there is more types having output class, each one is checked */
1808 for (tnode = ntree->nodes.first; tnode; tnode = tnode->next) {
1809 if (tnode->typeinfo->nclass == NODE_CLASS_OUTPUT) {
1811 if (ntree->type == NTREE_COMPOSIT) {
1813 /* same type, exception for viewer */
1814 if (tnode->type == node->type ||
1815 (ELEM(tnode->type, CMP_NODE_VIEWER, CMP_NODE_SPLITVIEWER) &&
1816 ELEM(node->type, CMP_NODE_VIEWER, CMP_NODE_SPLITVIEWER)))
1818 if (tnode->flag & NODE_DO_OUTPUT) {
1821 tnode->flag &= ~NODE_DO_OUTPUT;
1827 if (tnode->type == node->type) {
1828 if (tnode->flag & NODE_DO_OUTPUT) {
1831 tnode->flag &= ~NODE_DO_OUTPUT;
1838 node->flag |= NODE_DO_OUTPUT;
1841 /* group node outputs use this flag too */
1842 if (node->type == NODE_GROUP_OUTPUT) {
1846 for (tnode = ntree->nodes.first; tnode; tnode = tnode->next) {
1847 if (tnode->type == NODE_GROUP_OUTPUT) {
1848 if (tnode->flag & NODE_DO_OUTPUT) {
1851 tnode->flag &= ~NODE_DO_OUTPUT;
1856 node->flag |= NODE_DO_OUTPUT;
1860 /* here we could recursively set which nodes have to be done,
1861 * might be different for editor or for "real" use... */
1864 bNodeTree *ntreeFromID(ID *id)
1866 switch (GS(id->name)) {
1867 case ID_MA: return ((Material *)id)->nodetree;
1868 case ID_LA: return ((Lamp *)id)->nodetree;
1869 case ID_WO: return ((World *)id)->nodetree;
1870 case ID_TE: return ((Tex *)id)->nodetree;
1871 case ID_SCE: return ((Scene *)id)->nodetree;
1872 default: return NULL;
1876 void ntreeMakeLocal(bNodeTree *ntree)
1878 Main *bmain = G.main;
1879 int lib = FALSE, local = FALSE;
1881 /* - only lib users: do nothing
1882 * - only local users: set flag
1883 * - mixed: make copy
1886 if (ntree->id.lib == NULL) return;
1887 if (ntree->id.us == 1) {
1888 id_clear_lib_data(bmain, (ID *)ntree);
1892 /* now check users of groups... again typedepending, callback... */
1893 FOREACH_NODETREE(G.main, tntree, owner_id) {
1895 /* find if group is in tree */
1896 for (node = tntree->nodes.first; node; node = node->next) {
1897 if (node->id == (ID *)ntree) {
1904 } FOREACH_NODETREE_END
1906 /* if all users are local, we simply make tree local */
1907 if (local && !lib) {
1908 id_clear_lib_data(bmain, (ID *)ntree);
1910 else if (local && lib) {
1911 /* this is the mixed case, we copy the tree and assign it to local users */
1912 bNodeTree *newtree = ntreeCopyTree(ntree);
1916 FOREACH_NODETREE(G.main, tntree, owner_id) {
1918 /* find if group is in tree */
1919 for (node = tntree->nodes.first; node; node = node->next) {
1920 if (node->id == (ID *)ntree) {
1921 if (owner_id->lib == NULL) {
1922 node->id = (ID *)newtree;
1928 } FOREACH_NODETREE_END
1932 int ntreeNodeExists(bNodeTree *ntree, bNode *testnode)
1934 bNode *node = ntree->nodes.first;
1935 for (; node; node = node->next)
1936 if (node == testnode)
1941 int ntreeOutputExists(bNode *node, bNodeSocket *testsock)
1943 bNodeSocket *sock = node->outputs.first;
1944 for (; sock; sock = sock->next)
1945 if (sock == testsock)
1950 /* returns localized tree for execution in threads */
1951 bNodeTree *ntreeLocalize(bNodeTree *ntree)
1957 bAction *action_backup = NULL, *tmpact_backup = NULL;
1959 /* Workaround for copying an action on each render!
1960 * set action to NULL so animdata actions don't get copied */
1961 AnimData *adt = BKE_animdata_from_id(&ntree->id);
1964 action_backup = adt->action;
1965 tmpact_backup = adt->tmpact;
1972 * Note: previews are not copied here.
1974 ltree = ntreeCopyTree_internal(ntree, NULL, FALSE, FALSE, FALSE);
1975 ltree->flag |= NTREE_IS_LOCALIZED;
1977 for (node = ltree->nodes.first; node; node = node->next) {
1978 if (node->type == NODE_GROUP && node->id) {
1979 node->id = (ID *)ntreeLocalize((bNodeTree *)node->id);
1984 AnimData *ladt = BKE_animdata_from_id(<ree->id);
1986 adt->action = ladt->action = action_backup;
1987 adt->tmpact = ladt->tmpact = tmpact_backup;
1989 if (action_backup) action_backup->id.us++;
1990 if (tmpact_backup) tmpact_backup->id.us++;
1993 /* end animdata uglyness */
1995 /* ensures only a single output node is enabled */
1996 ntreeSetOutput(ntree);
1998 for (node = ntree->nodes.first; node; node = node->next) {
1999 /* store new_node pointer to original */
2000 node->new_node->new_node = node;
2003 if (ntree->typeinfo->localize)
2004 ntree->typeinfo->localize(ltree, ntree);
2012 /* sync local composite with real tree */
2013 /* local tree is supposed to be running, be careful moving previews! */
2014 /* is called by jobs manager, outside threads, so it doesnt happen during draw */
2015 void ntreeLocalSync(bNodeTree *localtree, bNodeTree *ntree)
2017 if (localtree && ntree) {
2018 if (ntree->typeinfo->local_sync)
2019 ntree->typeinfo->local_sync(localtree, ntree);
2023 /* merge local tree results back, and free local tree */
2024 /* we have to assume the editor already changed completely */
2025 void ntreeLocalMerge(bNodeTree *localtree, bNodeTree *ntree)
2027 if (ntree && localtree) {
2028 if (ntree->typeinfo->local_merge)
2029 ntree->typeinfo->local_merge(localtree, ntree);
2031 ntreeFreeTree_ex(localtree, FALSE);
2032 MEM_freeN(localtree);
2037 /* ************ NODE TREE INTERFACE *************** */
2039 static bNodeSocket *make_socket_interface(bNodeTree *ntree, int in_out,
2040 const char *idname, const char *name)
2042 bNodeSocketType *stype = nodeSocketTypeFind(idname);
2044 int own_index = ntree->cur_index++;
2046 if (stype == NULL) {
2050 sock = MEM_callocN(sizeof(bNodeSocket), "socket template");
2051 BLI_strncpy(sock->idname, stype->idname, sizeof(sock->idname));
2052 node_socket_set_typeinfo(ntree, sock, stype);
2053 sock->in_out = in_out;
2054 sock->type = SOCK_CUSTOM; /* int type undefined by default */
2056 /* assign new unique index */
2057 own_index = ntree->cur_index++;
2058 /* use the own_index as socket identifier */
2059 if (in_out == SOCK_IN)
2060 BLI_snprintf(sock->identifier, MAX_NAME, "Input_%d", own_index);
2062 BLI_snprintf(sock->identifier, MAX_NAME, "Output_%d", own_index);
2063 #ifdef USE_NODE_COMPAT_CUSTOMNODES
2064 /* XXX forward compatibility:
2065 * own_index is deprecated, but needs to be set here.
2066 * Node sockets generally use the identifier string instead now,
2067 * but reconstructing own_index in writefile.c would require parsing the identifier string.
2070 #if (defined(__GNUC__) && ((__GNUC__ * 100 + __GNUC_MINOR__) >= 406)) || defined(__clang__)
2071 # pragma GCC diagnostic push
2072 # pragma GCC diagnostic ignored "-Wdeprecated-declarations"
2075 sock->own_index = own_index;
2077 #if (defined(__GNUC__) && ((__GNUC__ * 100 + __GNUC_MINOR__) >= 406)) || defined(__clang__)
2078 # pragma GCC diagnostic pop
2081 #endif /* USE_NODE_COMPAT_CUSTOMNODES */
2083 sock->limit = (in_out == SOCK_IN ? 1 : 0xFFF);
2085 BLI_strncpy(sock->name, name, NODE_MAXSTR);
2086 sock->storage = NULL;
2087 sock->flag |= SOCK_COLLAPSED;
2092 bNodeSocket *ntreeFindSocketInterface(bNodeTree *ntree, int in_out, const char *identifier)
2094 bNodeSocket *iosock = (in_out == SOCK_IN ? ntree->inputs.first : ntree->outputs.first);
2095 for (; iosock; iosock = iosock->next)
2096 if (STREQ(iosock->identifier, identifier))
2101 bNodeSocket *ntreeAddSocketInterface(bNodeTree *ntree, int in_out, const char *idname, const char *name)
2103 bNodeSocket *iosock;
2105 iosock = make_socket_interface(ntree, in_out, idname, name);
2106 if (in_out == SOCK_IN) {
2107 BLI_addtail(&ntree->inputs, iosock);
2108 ntree->update |= NTREE_UPDATE_GROUP_IN;
2110 else if (in_out == SOCK_OUT) {
2111 BLI_addtail(&ntree->outputs, iosock);
2112 ntree->update |= NTREE_UPDATE_GROUP_OUT;
2118 bNodeSocket *ntreeInsertSocketInterface(bNodeTree *ntree, int in_out, const char *idname,
2119 bNodeSocket *next_sock, const char *name)
2121 bNodeSocket *iosock;
2123 iosock = make_socket_interface(ntree, in_out, idname, name);
2124 if (in_out == SOCK_IN) {
2125 BLI_insertlinkbefore(&ntree->inputs, next_sock, iosock);
2126 ntree->update |= NTREE_UPDATE_GROUP_IN;
2128 else if (in_out == SOCK_OUT) {
2129 BLI_insertlinkbefore(&ntree->outputs, next_sock, iosock);
2130 ntree->update |= NTREE_UPDATE_GROUP_OUT;
2136 struct bNodeSocket *ntreeAddSocketInterfaceFromSocket(bNodeTree *ntree, bNode *from_node, bNodeSocket *from_sock)
2138 bNodeSocket *iosock = ntreeAddSocketInterface(ntree, from_sock->in_out, from_sock->idname, from_sock->name);
2140 if (iosock->typeinfo->interface_from_socket)
2141 iosock->typeinfo->interface_from_socket(ntree, iosock, from_node, from_sock);
2146 struct bNodeSocket *ntreeInsertSocketInterfaceFromSocket(bNodeTree *ntree, bNodeSocket *next_sock, bNode *from_node, bNodeSocket *from_sock)
2148 bNodeSocket *iosock = ntreeInsertSocketInterface(ntree, from_sock->in_out, from_sock->idname, next_sock, from_sock->name);
2150 if (iosock->typeinfo->interface_from_socket)
2151 iosock->typeinfo->interface_from_socket(ntree, iosock, from_node, from_sock);
2156 void ntreeRemoveSocketInterface(bNodeTree *ntree, bNodeSocket *sock)
2158 /* this is fast, this way we don't need an in_out argument */
2159 BLI_remlink(&ntree->inputs, sock);
2160 BLI_remlink(&ntree->outputs, sock);
2162 node_socket_interface_free(ntree, sock);
2165 ntree->update |= NTREE_UPDATE_GROUP;
2168 /* generates a valid RNA identifier from the node tree name */
2169 static void ntree_interface_identifier_base(bNodeTree *ntree, char *base)
2171 /* generate a valid RNA identifier */
2172 sprintf(base, "NodeTreeInterface_%s", ntree->id.name + 2);
2173 RNA_identifier_sanitize(base, FALSE);
2176 /* check if the identifier is already in use */
2177 static bool ntree_interface_unique_identifier_check(void *UNUSED(data), const char *identifier)
2179 return (RNA_struct_find(identifier) != NULL);
2182 /* generates the actual unique identifier and ui name and description */
2183 static void ntree_interface_identifier(bNodeTree *ntree, const char *base, char *identifier, int maxlen, char *name, char *description)
2185 /* There is a possibility that different node tree names get mapped to the same identifier
2186 * after sanitization (e.g. "SomeGroup_A", "SomeGroup.A" both get sanitized to "SomeGroup_A").
2187 * On top of the sanitized id string add a number suffix if necessary to avoid duplicates.
2189 identifier[0] = '\0';
2190 BLI_uniquename_cb(ntree_interface_unique_identifier_check, NULL, base, '_', identifier, maxlen);
2192 sprintf(name, "Node Tree %s Interface", ntree->id.name + 2);
2193 sprintf(description, "Interface properties of node group %s", ntree->id.name + 2);
2196 static void ntree_interface_type_create(bNodeTree *ntree)
2200 /* strings are generated from base string + ID name, sizes are sufficient */
2201 char base[MAX_ID_NAME + 64], identifier[MAX_ID_NAME + 64], name[MAX_ID_NAME + 64], description[MAX_ID_NAME + 64];
2203 /* generate a valid RNA identifier */
2204 ntree_interface_identifier_base(ntree, base);
2205 ntree_interface_identifier(ntree, base, identifier, sizeof(identifier), name, description);
2207 /* register a subtype of PropertyGroup */
2208 srna = RNA_def_struct_ptr(&BLENDER_RNA, identifier, &RNA_PropertyGroup);
2209 RNA_def_struct_ui_text(srna, name, description);
2210 RNA_def_struct_duplicate_pointers(srna);
2212 /* associate the RNA type with the node tree */
2213 ntree->interface_type = srna;
2214 RNA_struct_blender_type_set(srna, ntree);
2216 /* add socket properties */
2217 for (sock = ntree->inputs.first; sock; sock = sock->next) {
2218 bNodeSocketType *stype = sock->typeinfo;
2219 if (stype && stype->interface_register_properties)
2220 stype->interface_register_properties(ntree, sock, srna);
2222 for (sock = ntree->outputs.first; sock; sock = sock->next) {
2223 bNodeSocketType *stype = sock->typeinfo;
2224 if (stype && stype->interface_register_properties)
2225 stype->interface_register_properties(ntree, sock, srna);
2229 StructRNA *ntreeInterfaceTypeGet(bNodeTree *ntree, int create)
2231 if (ntree->interface_type) {
2232 /* strings are generated from base string + ID name, sizes are sufficient */
2233 char base[MAX_ID_NAME + 64], identifier[MAX_ID_NAME + 64], name[MAX_ID_NAME + 64], description[MAX_ID_NAME + 64];
2235 /* A bit of a hack: when changing the ID name, update the RNA type identifier too,
2236 * so that the names match. This is not strictly necessary to keep it working,
2237 * but better for identifying associated NodeTree blocks and RNA types.
2239 StructRNA *srna = ntree->interface_type;
2241 ntree_interface_identifier_base(ntree, base);
2243 /* RNA identifier may have a number suffix, but should start with the idbase string */
2244 if (strncmp(RNA_struct_identifier(srna), base, sizeof(base)) != 0) {
2245 /* generate new unique RNA identifier from the ID name */
2246 ntree_interface_identifier(ntree, base, identifier, sizeof(identifier), name, description);
2248 /* rename the RNA type */
2249 RNA_def_struct_free_pointers(srna);
2250 RNA_def_struct_identifier(srna, identifier);
2251 RNA_def_struct_ui_text(srna, name, description);
2252 RNA_def_struct_duplicate_pointers(srna);
2256 ntree_interface_type_create(ntree);
2259 return ntree->interface_type;
2262 void ntreeInterfaceTypeFree(bNodeTree *ntree)
2264 if (ntree->interface_type) {
2265 RNA_struct_free(&BLENDER_RNA, ntree->interface_type);
2266 ntree->interface_type = NULL;
2270 void ntreeInterfaceTypeUpdate(bNodeTree *ntree)
2272 /* XXX it would be sufficient to just recreate all properties
2273 * instead of re-registering the whole struct type,
2274 * but there is currently no good way to do this in the RNA functions.
2275 * Overhead should be negligible.
2277 ntreeInterfaceTypeFree(ntree);
2278 ntree_interface_type_create(ntree);
2282 /* ************ find stuff *************** */
2284 bool ntreeHasType(const bNodeTree *ntree, int type)
2289 for (node = ntree->nodes.first; node; node = node->next)
2290 if (node->type == type)
2295 bool ntreeHasTree(const bNodeTree *ntree, const bNodeTree *lookup)
2299 if (ntree == lookup)
2302 for (node = ntree->nodes.first; node; node = node->next)
2303 if (node->type == NODE_GROUP && node->id)
2304 if (ntreeHasTree((bNodeTree *)node->id, lookup))
2310 bNodeLink *nodeFindLink(bNodeTree *ntree, bNodeSocket *from, bNodeSocket *to)
2314 for (link = ntree->links.first; link; link = link->next) {
2315 if (link->fromsock == from && link->tosock == to)
2317 if (link->fromsock == to && link->tosock == from) /* hrms? */
2323 int nodeCountSocketLinks(bNodeTree *ntree, bNodeSocket *sock)
2328 for (link = ntree->links.first; link; link = link->next) {
2329 if (link->fromsock == sock || link->tosock == sock)
2335 bNode *nodeGetActive(bNodeTree *ntree)
2339 if (ntree == NULL) return NULL;
2341 for (node = ntree->nodes.first; node; node = node->next)
2342 if (node->flag & NODE_ACTIVE)
2347 static bNode *node_get_active_id_recursive(bNodeInstanceKey active_key, bNodeInstanceKey parent_key, bNodeTree *ntree, short idtype)
2349 if (parent_key.value == active_key.value || active_key.value == 0) {
2351 for (node = ntree->nodes.first; node; node = node->next)
2352 if (node->id && GS(node->id->name) == idtype)
2353 if (node->flag & NODE_ACTIVE_ID)
2357 bNode *node, *tnode;
2358 /* no node with active ID in this tree, look inside groups */
2359 for (node = ntree->nodes.first; node; node = node->next) {
2360 if (node->type == NODE_GROUP) {
2361 bNodeTree *group = (bNodeTree *)node->id;
2363 bNodeInstanceKey group_key = BKE_node_instance_key(parent_key, ntree, node);
2364 tnode = node_get_active_id_recursive(active_key, group_key, group, idtype);
2375 /* two active flags, ID nodes have special flag for buttons display */
2376 bNode *nodeGetActiveID(bNodeTree *ntree, short idtype)
2379 return node_get_active_id_recursive(ntree->active_viewer_key, NODE_INSTANCE_KEY_BASE, ntree, idtype);
2384 bool nodeSetActiveID(bNodeTree *ntree, short idtype, ID *id)
2389 if (ntree == NULL) return ok;
2391 for (node = ntree->nodes.first; node; node = node->next) {
2392 if (node->id && GS(node->id->name) == idtype) {
2393 if (id && ok == FALSE && node->id == id) {
2394 node->flag |= NODE_ACTIVE_ID;
2398 node->flag &= ~NODE_ACTIVE_ID;
2403 /* update all groups linked from here
2404 * if active ID node has been found already,
2405 * just pass NULL so other matching nodes are deactivated.
2407 for (node = ntree->nodes.first; node; node = node->next) {
2408 if (node->type == NODE_GROUP)
2409 ok |= nodeSetActiveID((bNodeTree *)node->id, idtype, (ok == false ? id : NULL));
2416 /* two active flags, ID nodes have special flag for buttons display */
2417 void nodeClearActiveID(bNodeTree *ntree, short idtype)
2421 if (ntree == NULL) return;
2423 for (node = ntree->nodes.first; node; node = node->next)
2424 if (node->id && GS(node->id->name) == idtype)
2425 node->flag &= ~NODE_ACTIVE_ID;
2428 void nodeSetSelected(bNode *node, int select)
2431 node->flag |= NODE_SELECT;
2436 node->flag &= ~NODE_SELECT;
2438 /* deselect sockets too */
2439 for (sock = node->inputs.first; sock; sock = sock->next)
2440 sock->flag &= ~NODE_SELECT;
2441 for (sock = node->outputs.first; sock; sock = sock->next)
2442 sock->flag &= ~NODE_SELECT;
2446 void nodeClearActive(bNodeTree *ntree)
2450 if (ntree == NULL) return;
2452 for (node = ntree->nodes.first; node; node = node->next)
2453 node->flag &= ~(NODE_ACTIVE | NODE_ACTIVE_ID);
2456 /* two active flags, ID nodes have special flag for buttons display */
2457 void nodeSetActive(bNodeTree *ntree, bNode *node)
2461 /* make sure only one node is active, and only one per ID type */
2462 for (tnode = ntree->nodes.first; tnode; tnode = tnode->next) {
2463 tnode->flag &= ~NODE_ACTIVE;
2465 if (node->id && tnode->id) {
2466 if (GS(node->id->name) == GS(tnode->id->name))
2467 tnode->flag &= ~NODE_ACTIVE_ID;
2469 if (node->typeinfo->nclass == NODE_CLASS_TEXTURE)
2470 tnode->flag &= ~NODE_ACTIVE_TEXTURE;
2473 node->flag |= NODE_ACTIVE;
2475 node->flag |= NODE_ACTIVE_ID;
2476 if (node->typeinfo->nclass == NODE_CLASS_TEXTURE)
2477 node->flag |= NODE_ACTIVE_TEXTURE;
2480 int nodeSocketIsHidden(bNodeSocket *sock)
2482 return ((sock->flag & (SOCK_HIDDEN | SOCK_UNAVAIL)) != 0);
2485 /* ************** Node Clipboard *********** */
2487 #define USE_NODE_CB_VALIDATE
2489 #ifdef USE_NODE_CB_VALIDATE
2491 * This data structure is to validate the node on creation,
2492 * otherwise we may reference missing data.
2494 * Currently its only used for ID's, but nodes may one day
2495 * reference other pointers which need validation.
2497 typedef struct bNodeClipboardExtraInfo {
2498 struct bNodeClipboardExtraInfo *next, *prev;
2500 char id_name[MAX_ID_NAME];
2501 char library_name[FILE_MAX];
2502 } bNodeClipboardExtraInfo;
2503 #endif /* USE_NODE_CB_VALIDATE */
2506 typedef struct bNodeClipboard {
2509 #ifdef USE_NODE_CB_VALIDATE
2510 ListBase nodes_extra_info;
2517 static bNodeClipboard node_clipboard = {{NULL}};
2519 void BKE_node_clipboard_init(struct bNodeTree *ntree)
2521 node_clipboard.type = ntree->type;
2524 void BKE_node_clipboard_clear(void)
2526 bNode *node, *node_next;
2527 bNodeLink *link, *link_next;
2529 for (link = node_clipboard.links.first; link; link = link_next) {
2530 link_next = link->next;
2531 nodeRemLink(NULL, link);
2533 BLI_listbase_clear(&node_clipboard.links);
2535 for (node = node_clipboard.nodes.first; node; node = node_next) {
2536 node_next = node->next;
2537 node_free_node_ex(NULL, node, false, false);
2539 BLI_listbase_clear(&node_clipboard.nodes);
2541 #ifdef USE_NODE_CB_VALIDATE
2542 BLI_freelistN(&node_clipboard.nodes_extra_info);
2546 /* return FALSE when one or more ID's are lost */
2547 bool BKE_node_clipboard_validate(void)
2551 #ifdef USE_NODE_CB_VALIDATE
2552 bNodeClipboardExtraInfo *node_info;
2556 /* lists must be aligned */
2557 BLI_assert(BLI_countlist(&node_clipboard.nodes) ==
2558 BLI_countlist(&node_clipboard.nodes_extra_info));
2560 for (node = node_clipboard.nodes.first, node_info = node_clipboard.nodes_extra_info.first;
2562 node = node->next, node_info = node_info->next)
2564 /* validate the node against the stored node info */
2566 /* re-assign each loop since we may clear,
2567 * open a new file where the ID is valid, and paste again */
2568 node->id = node_info->id;
2570 /* currently only validate the ID */
2572 ListBase *lb = which_libbase(G.main, GS(node_info->id_name));
2573 BLI_assert(lb != NULL);
2575 if (BLI_findindex(lb, node_info->id) == -1) {
2576 /* may assign NULL */
2577 node->id = BLI_findstring(lb, node_info->id_name + 2, offsetof(ID, name) + 2);
2579 if (node->id == NULL) {
2585 #endif /* USE_NODE_CB_VALIDATE */
2590 void BKE_node_clipboard_add_node(bNode *node)
2592 #ifdef USE_NODE_CB_VALIDATE
2593 /* add extra info */
2594 bNodeClipboardExtraInfo *node_info = MEM_mallocN(sizeof(bNodeClipboardExtraInfo), "bNodeClipboardExtraInfo");
2596 node_info->id = node->id;
2598 BLI_strncpy(node_info->id_name, node->id->name, sizeof(node_info->id_name));
2599 if (node->id->lib) {
2600 BLI_strncpy(node_info->library_name, node->id->lib->filepath, sizeof(node_info->library_name));
2603 node_info->library_name[0] = '\0';
2607 node_info->id_name[0] = '\0';
2608 node_info->library_name[0] = '\0';
2610 BLI_addtail(&node_clipboard.nodes_extra_info, node_info);
2611 /* end extra info */
2612 #endif /* USE_NODE_CB_VALIDATE */
2615 BLI_addtail(&node_clipboard.nodes, node);
2619 void BKE_node_clipboard_add_link(bNodeLink *link)
2621 BLI_addtail(&node_clipboard.links, link);
2624 const ListBase *BKE_node_clipboard_get_nodes(void)
2626 return &node_clipboard.nodes;
2629 const ListBase *BKE_node_clipboard_get_links(void)
2631 return &node_clipboard.links;
2634 int BKE_node_clipboard_get_type(void)
2636 return node_clipboard.type;
2640 /* Node Instance Hash */
2642 /* magic number for initial hash key */
2643 const bNodeInstanceKey NODE_INSTANCE_KEY_BASE = {5381};
2644 const bNodeInstanceKey NODE_INSTANCE_KEY_NONE = {0};
2646 /* Generate a hash key from ntree and node names
2647 * Uses the djb2 algorithm with xor by Bernstein:
2648 * http://www.cse.yorku.ca/~oz/hash.html
2650 static bNodeInstanceKey node_hash_int_str(bNodeInstanceKey hash, const char *str)
2654 while ((c = *str++))
2655 hash.value = ((hash.value << 5) + hash.value) ^ c; /* (hash * 33) ^ c */
2657 /* separator '\0' character, to avoid ambiguity from concatenated strings */
2658 hash.value = (hash.value << 5) + hash.value; /* hash * 33 */
2663 bNodeInstanceKey BKE_node_instance_key(bNodeInstanceKey parent_key, bNodeTree *ntree, bNode *node)
2665 bNodeInstanceKey key;
2667 key = node_hash_int_str(parent_key, ntree->id.name + 2);
2670 key = node_hash_int_str(key, node->name);
2675 static unsigned int node_instance_hash_key(const void *key)
2677 return ((const bNodeInstanceKey *)key)->value;
2680 static int node_instance_hash_key_cmp(const void *a, const void *b)
2682 unsigned int value_a = ((const bNodeInstanceKey *)a)->value;
2683 unsigned int value_b = ((const bNodeInstanceKey *)b)->value;
2684 if (value_a == value_b)
2686 else if (value_a < value_b)
2692 bNodeInstanceHash *BKE_node_instance_hash_new(const char *info)
2694 bNodeInstanceHash *hash = MEM_mallocN(sizeof(bNodeInstanceHash), info);
2695 hash->ghash = BLI_ghash_new(node_instance_hash_key, node_instance_hash_key_cmp, "node instance hash ghash");
2699 void BKE_node_instance_hash_free(bNodeInstanceHash *hash, bNodeInstanceValueFP valfreefp)
2701 BLI_ghash_free(hash->ghash, NULL, (GHashValFreeFP)valfreefp);
2705 void BKE_node_instance_hash_insert(bNodeInstanceHash *hash, bNodeInstanceKey key, void *value)
2707 bNodeInstanceHashEntry *entry = value;
2710 BLI_ghash_insert(hash->ghash, &entry->key, value);
2713 void *BKE_node_instance_hash_lookup(bNodeInstanceHash *hash, bNodeInstanceKey key)
2715 return BLI_ghash_lookup(hash->ghash, &key);
2718 int BKE_node_instance_hash_remove(bNodeInstanceHash *hash, bNodeInstanceKey key, bNodeInstanceValueFP valfreefp)
2720 return BLI_ghash_remove(hash->ghash, &key, NULL, (GHashValFreeFP)valfreefp);
2723 void BKE_node_instance_hash_clear(bNodeInstanceHash *hash, bNodeInstanceValueFP valfreefp)
2725 BLI_ghash_clear(hash->ghash, NULL, (GHashValFreeFP)valfreefp);
2728 void *BKE_node_instance_hash_pop(bNodeInstanceHash *hash, bNodeInstanceKey key)
2730 return BLI_ghash_popkey(hash->ghash, &key, NULL);
2733 int BKE_node_instance_hash_haskey(bNodeInstanceHash *hash, bNodeInstanceKey key)
2735 return BLI_ghash_haskey(hash->ghash, &key);
2738 int BKE_node_instance_hash_size(bNodeInstanceHash *hash)
2740 return BLI_ghash_size(hash->ghash);
2743 void BKE_node_instance_hash_clear_tags(bNodeInstanceHash *hash)
2745 bNodeInstanceHashIterator iter;
2747 NODE_INSTANCE_HASH_ITER(iter, hash) {
2748 bNodeInstanceHashEntry *value = BKE_node_instance_hash_iterator_get_value(&iter);
2754 void BKE_node_instance_hash_tag(bNodeInstanceHash *UNUSED(hash), void *value)
2756 bNodeInstanceHashEntry *entry = value;
2760 int BKE_node_instance_hash_tag_key(bNodeInstanceHash *hash, bNodeInstanceKey key)
2762 bNodeInstanceHashEntry *entry = BKE_node_instance_hash_lookup(hash, key);
2772 void BKE_node_instance_hash_remove_untagged(bNodeInstanceHash *hash, bNodeInstanceValueFP valfreefp)
2774 /* NOTE: Hash must not be mutated during iterating!
2775 * Store tagged entries in a separate list and remove items afterward.
2777 bNodeInstanceKey *untagged = MEM_mallocN(sizeof(bNodeInstanceKey) * BKE_node_instance_hash_size(hash), "temporary node instance key list");
2778 bNodeInstanceHashIterator iter;
2779 int num_untagged, i;
2782 NODE_INSTANCE_HASH_ITER(iter, hash) {
2783 bNodeInstanceHashEntry *value = BKE_node_instance_hash_iterator_get_value(&iter);
2786 untagged[num_untagged++] = BKE_node_instance_hash_iterator_get_key(&iter);
2789 for (i = 0; i < num_untagged; ++i) {
2790 BKE_node_instance_hash_remove(hash, untagged[i], valfreefp);
2793 MEM_freeN(untagged);
2797 /* ************** dependency stuff *********** */
2799 /* node is guaranteed to be not checked before */
2800 static int node_get_deplist_recurs(bNodeTree *ntree, bNode *node, bNode ***nsort)
2808 /* check linked nodes */
2809 for (link = ntree->links.first; link; link = link->next) {
2810 if (link->tonode == node) {
2811 fromnode = link->fromnode;
2812 if (fromnode->done == 0)
2813 fromnode->level = node_get_deplist_recurs(ntree, fromnode, nsort);
2814 if (fromnode->level <= level)
2815 level = fromnode->level - 1;
2819 /* check parent node */
2821 if (node->parent->done == 0)
2822 node->parent->level = node_get_deplist_recurs(ntree, node->parent, nsort);
2823 if (node->parent->level <= level)
2824 level = node->parent->level - 1;
2835 void ntreeGetDependencyList(struct bNodeTree *ntree, struct bNode ***deplist, int *totnodes)
2837 bNode *node, **nsort;
2841 /* first clear data */
2842 for (node = ntree->nodes.first; node; node = node->next) {
2846 if (*totnodes == 0) {
2851 nsort = *deplist = MEM_callocN((*totnodes) * sizeof(bNode *), "sorted node array");
2853 /* recursive check */
2854 for (node = ntree->nodes.first; node; node = node->next) {
2855 if (node->done == 0) {
2856 node->level = node_get_deplist_recurs(ntree, node, &nsort);
2861 /* only updates node->level for detecting cycles links */
2862 static void ntree_update_node_level(bNodeTree *ntree)
2866 /* first clear tag */
2867 for (node = ntree->nodes.first; node; node = node->next) {
2871 /* recursive check */
2872 for (node = ntree->nodes.first; node; node = node->next) {
2873 if (node->done == 0) {
2874 node->level = node_get_deplist_recurs(ntree, node, NULL);
2879 static void ntree_update_link_pointers(bNodeTree *ntree)
2885 /* first clear data */
2886 for (node = ntree->nodes.first; node; node = node->next) {
2887 for (sock = node->inputs.first; sock; sock = sock->next) {
2889 sock->flag &= ~SOCK_IN_USE;
2891 for (sock = node->outputs.first; sock; sock = sock->next) {
2892 sock->flag &= ~SOCK_IN_USE;
2896 for (link = ntree->links.first; link; link = link->next) {
2897 link->tosock->link = link;
2899 link->fromsock->flag |= SOCK_IN_USE;
2900 link->tosock->flag |= SOCK_IN_USE;
2904 static void ntree_validate_links(bNodeTree *ntree)
2908 for (link = ntree->links.first; link; link = link->next) {
2909 link->flag |= NODE_LINK_VALID;
2910 if (link->fromnode && link->tonode && link->fromnode->level <= link->tonode->level)
2911 link->flag &= ~NODE_LINK_VALID;
2912 else if (ntree->typeinfo->validate_link) {
2913 if (!ntree->typeinfo->validate_link(ntree, link))
2914 link->flag &= ~NODE_LINK_VALID;
2919 void ntreeVerifyNodes(struct Main *main, struct ID *id)
2921 FOREACH_NODETREE(main, ntree, owner_id) {
2924 for (node = ntree->nodes.first; node; node = node->next)
2925 if (node->typeinfo->verifyfunc)
2926 node->typeinfo->verifyfunc(ntree, node, id);
2927 } FOREACH_NODETREE_END
2930 void ntreeUpdateTree(Main *bmain, bNodeTree *ntree)
2937 /* avoid reentrant updates, can be caused by RNA update callbacks */
2938 if (ntree->is_updating)
2940 ntree->is_updating = TRUE;
2942 if (ntree->update & (NTREE_UPDATE_LINKS | NTREE_UPDATE_NODES)) {
2943 /* set the bNodeSocket->link pointers */
2944 ntree_update_link_pointers(ntree);
2947 /* update individual nodes */
2948 for (node = ntree->nodes.first; node; node = node->next) {
2949 /* node tree update tags override individual node update flags */
2950 if ((node->update & NODE_UPDATE) || (ntree->update & NTREE_UPDATE)) {
2951 if (node->typeinfo->updatefunc)
2952 node->typeinfo->updatefunc(ntree, node);
2954 nodeUpdateInternalLinks(ntree, node);
2958 /* generic tree update callback */
2959 if (ntree->typeinfo->update)
2960 ntree->typeinfo->update(ntree);
2961 /* XXX this should be moved into the tree type update callback for tree supporting node groups.
2962 * Currently the node tree interface is still a generic feature of the base NodeTree type.
2964 if (ntree->update & NTREE_UPDATE_GROUP)
2965 ntreeInterfaceTypeUpdate(ntree);
2967 /* XXX hack, should be done by depsgraph!! */
2969 ntreeVerifyNodes(bmain, &ntree->id);
2971 if (ntree->update & (NTREE_UPDATE_LINKS | NTREE_UPDATE_NODES)) {
2972 /* node updates can change sockets or links, repeat link pointer update afterward */
2973 ntree_update_link_pointers(ntree);
2975 /* update the node level from link dependencies */
2976 ntree_update_node_level(ntree);
2978 /* check link validity */
2979 ntree_validate_links(ntree);
2982 /* clear update flags */
2983 for (node = ntree->nodes.first; node; node = node->next) {
2988 ntree->is_updating = FALSE;
2991 void nodeUpdate(bNodeTree *ntree, bNode *node)
2993 /* avoid reentrant updates, can be caused by RNA update callbacks */
2994 if (ntree->is_updating)
2996 ntree->is_updating = TRUE;
2998 if (node->typeinfo->updatefunc)
2999 node->typeinfo->updatefunc(ntree, node);
3001 nodeUpdateInternalLinks(ntree, node);
3003 /* clear update flag */
3006 ntree->is_updating = FALSE;
3009 bool nodeUpdateID(bNodeTree *ntree, ID *id)
3012 bool changed = false;
3014 if (ELEM(NULL, id, ntree))
3017 /* avoid reentrant updates, can be caused by RNA update callbacks */
3018 if (ntree->is_updating)
3020 ntree->is_updating = true;
3022 for (node = ntree->nodes.first; node; node = node->next) {
3023 if (node->id == id) {
3025 node->update |= NODE_UPDATE_ID;
3026 if (node->typeinfo->updatefunc)
3027 node->typeinfo->updatefunc(ntree, node);
3028 /* clear update flag */
3033 for (node = ntree->nodes.first; node; node = node->next) {
3034 nodeUpdateInternalLinks(ntree, node);
3037 ntree->is_updating = FALSE;
3041 void nodeUpdateInternalLinks(bNodeTree *ntree, bNode *node)
3043 BLI_freelistN(&node->internal_links);
3045 if (node->typeinfo && node->typeinfo->update_internal_links)
3046 node->typeinfo->update_internal_links(ntree, node);
3050 /* nodes that use ID data get synced with local data */
3051 void nodeSynchronizeID(bNode *node, bool copy_to_id)
3053 if (node->id == NULL) return;
3055 if (ELEM(node->type, SH_NODE_MATERIAL, SH_NODE_MATERIAL_EXT)) {
3057 Material *ma = (Material *)node->id;
3060 /* hrmf, case in loop isn't super fast, but we don't edit 100s of material at same time either! */
3061 for (a = 0, sock = node->inputs.first; sock; sock = sock->next, a++) {
3062 if (!nodeSocketIsHidden(sock)) {
3066 copy_v3_v3(&ma->r, ((bNodeSocketValueRGBA *)sock->default_value)->value); break;
3068 copy_v3_v3(&ma->specr, ((bNodeSocketValueRGBA *)sock->default_value)->value); break;
3070 ma->ref = ((bNodeSocketValueFloat *)sock->default_value)->value; break;
3072 copy_v3_v3(&ma->mirr, ((bNodeSocketValueRGBA *)sock->default_value)->value); break;
3074 ma->amb = ((bNodeSocketValueFloat *)sock->default_value)->value; break;
3076 ma->emit = ((bNodeSocketValueFloat *)sock->default_value)->value; break;
3077 case MAT_IN_SPECTRA:
3078 ma->spectra = ((bNodeSocketValueFloat *)sock->default_value)->value; break;
3079 case MAT_IN_RAY_MIRROR:
3080 ma->ray_mirror = ((bNodeSocketValueFloat *)sock->default_value)->value; break;
3082 ma->alpha = ((bNodeSocketValueFloat *)sock->default_value)->value; break;
3083 case MAT_IN_TRANSLUCENCY:
3084 ma->translucency = ((bNodeSocketValueFloat *)sock->default_value)->value; break;
3090 copy_v3_v3(((bNodeSocketValueRGBA *)sock->default_value)->value, &ma->r); break;
3092 copy_v3_v3(((bNodeSocketValueRGBA *)sock->default_value)->value, &ma->specr); break;
3094 ((bNodeSocketValueFloat *)sock->default_value)->value = ma->ref; break;
3096 copy_v3_v3(((bNodeSocketValueRGBA *)sock->default_value)->value, &ma->mirr); break;
3098 ((bNodeSocketValueFloat *)sock->default_value)->value = ma->amb; break;
3100 ((bNodeSocketValueFloat *)sock->default_value)->value = ma->emit; break;
3101 case MAT_IN_SPECTRA:
3102 ((bNodeSocketValueFloat *)sock->default_value)->value = ma->spectra; break;
3103 case MAT_IN_RAY_MIRROR:
3104 ((bNodeSocketValueFloat *)sock->default_value)->value = ma->ray_mirror; break;
3106 ((bNodeSocketValueFloat *)sock->default_value)->value = ma->alpha; break;
3107 case MAT_IN_TRANSLUCENCY:
3108 ((bNodeSocketValueFloat *)sock->default_value)->value = ma->translucency; break;
3117 /* ************* node type access ********** */
3119 void nodeLabel(bNodeTree *ntree, bNode *node, char *label, int maxlen)
3121 if (node->label[0] != '\0')
3122 BLI_strncpy(label, node->label, maxlen);
3123 else if (node->typeinfo->labelfunc)
3124 node->typeinfo->labelfunc(ntree, node, label, maxlen);
3126 BLI_strncpy(label, IFACE_(node->typeinfo->ui_name), maxlen);
3129 static void node_type_base_defaults(bNodeType *ntype)
3131 /* default size values */
3132 node_type_size_preset(ntype, NODE_SIZE_DEFAULT);
3133 ntype->height = 100;
3134 ntype->minheight = 30;
3135 ntype->maxheight = FLT_MAX;
3138 /* allow this node for any tree type */
3139 static int node_poll_default(bNodeType *UNUSED(ntype), bNodeTree *UNUSED(ntree))
3144 /* use the basic poll function */
3145 static int node_poll_instance_default(bNode *node, bNodeTree *ntree)
3147 return node->typeinfo->poll(node->typeinfo, ntree);
3150 void node_type_base(bNodeType *ntype, int type, const char *name, short nclass, short flag)
3152 /* Use static type info header to map static int type to identifier string and RNA struct type.
3153 * Associate the RNA struct type with the bNodeType.
3154 * Dynamically registered nodes will create an RNA type at runtime
3155 * and call RNA_struct_blender_type_set, so this only needs to be done for old RNA types
3156 * created in makesrna, which can not be associated to a bNodeType immediately,
3157 * since bNodeTypes are registered afterward ...
3159 #define DefNode(Category, ID, DefFunc, EnumName, StructName, UIName, UIDesc) \
3161 BLI_strncpy(ntype->idname, #Category #StructName, sizeof(ntype->idname)); \
3162 ntype->ext.srna = RNA_struct_find(#Category #StructName); \
3163 BLI_assert(ntype->ext.srna != NULL); \
3164 RNA_struct_blender_type_set(ntype->ext.srna, ntype); \
3168 #include "NOD_static_types.h"
3171 /* make sure we have a valid type (everything registered) */
3172 BLI_assert(ntype->idname[0] != '\0');
3175 BLI_strncpy(ntype->ui_name, name, sizeof(ntype->ui_name));
3176 ntype->nclass = nclass;
3179 node_type_base_defaults(ntype);
3181 ntype->poll = node_poll_default;
3182 ntype->poll_instance = node_poll_instance_default;
3185 void node_type_base_custom(bNodeType *ntype, const char *idname, const char *name, short nclass, short flag)
3187 BLI_strncpy(ntype->idname, idname, sizeof(ntype->idname));
3188 ntype->type = NODE_CUSTOM;
3189 BLI_strncpy(ntype->ui_name, name, sizeof(ntype->ui_name));
3190 ntype->nclass = nclass;
3193 node_type_base_defaults(ntype);
3196 static bool unique_socket_template_identifier_check(void *arg, const char *name)
3198 bNodeSocketTemplate *ntemp;
3199 struct {bNodeSocketTemplate *list; bNodeSocketTemplate *ntemp;} *data = arg;
3201 for (ntemp = data->list; ntemp->type >= 0; ++ntemp) {
3202 if (ntemp != data->ntemp) {
3203 if (STREQ(ntemp->identifier, name)) {
3212 static void unique_socket_template_identifier(bNodeSocketTemplate *list, bNodeSocketTemplate *ntemp, const char defname[], char delim)
3214 struct {bNodeSocketTemplate *list; bNodeSocketTemplate *ntemp;} data;
3218 BLI_uniquename_cb(unique_socket_template_identifier_check, &data, defname, delim, ntemp->identifier, sizeof(ntemp->identifier));
3221 void node_type_socket_templates(struct bNodeType *ntype, struct bNodeSocketTemplate *inputs, struct bNodeSocketTemplate *outputs)
3223 bNodeSocketTemplate *ntemp;
3225 ntype->inputs = inputs;
3226 ntype->outputs = outputs;
3228 /* automatically generate unique identifiers */
3230 /* clear identifier strings (uninitialized memory) */
3231 for (ntemp = inputs; ntemp->type >= 0; ++ntemp)
3232 ntemp->identifier[0] = '\0';
3234 for (ntemp = inputs; ntemp->type >= 0; ++ntemp) {
3235 BLI_strncpy(ntemp->identifier, ntemp->name, sizeof(ntemp->identifier));
3236 unique_socket_template_identifier(inputs, ntemp, ntemp->identifier, '_');
3240 /* clear identifier strings (uninitialized memory) */
3241 for (ntemp = outputs; ntemp->type >= 0; ++ntemp)
3242 ntemp->identifier[0] = '\0';
3244 for (ntemp = outputs; ntemp->type >= 0; ++ntemp) {
3245 BLI_strncpy(ntemp->identifier, ntemp->name, sizeof(ntemp->identifier));
3246 unique_socket_template_identifier(outputs, ntemp, ntemp->identifier, '_');
3251 void node_type_init(struct bNodeType *ntype, void (*initfunc)(struct bNodeTree *ntree, struct bNode *node))
3253 ntype->initfunc = initfunc;
3256 void node_type_size(struct bNodeType *ntype, int width, int minwidth, int maxwidth)
3258 ntype->width = width;
3259 ntype->minwidth = minwidth;
3260 if (maxwidth <= minwidth)
3261 ntype->maxwidth = FLT_MAX;
3263 ntype->maxwidth = maxwidth;
3266 void node_type_size_preset(struct bNodeType *ntype, eNodeSizePreset size)
3269 case NODE_SIZE_DEFAULT: